Skip to content

Commit 57c8fd5

Browse files
makowskidclaude
andcommitted
Remove SharpApiJobTypeEnum entirely from core package
Specialized packages now use direct endpoint URL strings instead of importing SharpApiJobTypeEnum from core. Each package owns its own endpoint path, making the enum unnecessary. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 117052a commit 57c8fd5

File tree

4 files changed

+4
-156
lines changed

4 files changed

+4
-156
lines changed

README.md

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The SharpAPI Core package provides:
3535
- **Rate Limiting**: Two-layer rate limiting — proactive sliding window throttling + reactive 429 retry logic
3636
- **Rate Limit Header Tracking**: Automatic extraction of `X-RateLimit-Limit` and `X-RateLimit-Remaining` headers
3737
- **Error Handling**: `SharpApiError` with HTTP status codes for timeout and rate limit errors
38-
- **Type Definitions**: Enums for job types, statuses, languages, and voice tones
38+
- **Type Definitions**: Enums for job statuses, languages, and voice tones
3939
- **DTO Classes**: Data Transfer Objects for API responses (`SharpApiJob`, `SharpApiSubscriptionInfo`)
4040

4141
---
@@ -63,7 +63,6 @@ sharpapi-node-core/
6363
│ │ ├── SharpApiJob.js # Job DTO
6464
│ │ └── SharpApiSubscriptionInfo.js # Subscription DTO
6565
│ ├── Enums/
66-
│ │ ├── SharpApiJobTypeEnum.js # API endpoint types
6766
│ │ ├── SharpApiJobStatusEnum.js # Job statuses
6867
│ │ ├── SharpApiLanguages.js # Supported languages
6968
│ │ └── SharpApiVoiceTone.js # Voice tone options
@@ -161,20 +160,6 @@ try {
161160

162161
### Enums
163162

164-
#### SharpApiJobTypeEnum
165-
166-
Defines all available API endpoints:
167-
168-
```javascript
169-
const { SharpApiJobTypeEnum } = require('@sharpapi/sharpapi-node-core');
170-
171-
SharpApiJobTypeEnum.ECOMMERCE_PRODUCT_CATEGORIES // { value, url }
172-
SharpApiJobTypeEnum.HR_PARSE_RESUME
173-
SharpApiJobTypeEnum.CONTENT_SUMMARIZE
174-
SharpApiJobTypeEnum.CONTENT_TRANSLATE
175-
// ... and more
176-
```
177-
178163
#### SharpApiJobStatusEnum
179164

180165
```javascript
@@ -315,7 +300,7 @@ service.setRateLimitState(state);
315300
Extend `SharpApiCoreService` to create custom API integrations:
316301

317302
```javascript
318-
const { SharpApiCoreService, SharpApiJobTypeEnum } = require('@sharpapi/sharpapi-node-core');
303+
const { SharpApiCoreService } = require('@sharpapi/sharpapi-node-core');
319304

320305
class MyCustomService extends SharpApiCoreService {
321306
constructor(apiKey, apiBaseUrl = 'https://sharpapi.com/api/v1') {
@@ -324,11 +309,7 @@ class MyCustomService extends SharpApiCoreService {
324309

325310
async analyzeContent(text) {
326311
const data = { content: text };
327-
const response = await this.makeRequest(
328-
'POST',
329-
SharpApiJobTypeEnum.CONTENT_SUMMARIZE.url,
330-
data
331-
);
312+
const response = await this.makeRequest('POST', '/content/summarize', data);
332313
return this.parseStatusUrl(response);
333314
}
334315
}

src/Dto/SharpApiJob.js

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,3 @@
1-
const { SharpApiJobStatusEnum } = require('../Enums/SharpApiJobStatusEnum');
2-
const { SharpApiJobTypeEnum } = require('../Enums/SharpApiJobTypeEnum');
3-
41
/**
52
* SharpApiJob DTO
63
*/
@@ -29,7 +26,7 @@ class SharpApiJob {
2926
}
3027

3128
/**
32-
* Returns one of the job types available in SharpApiJobTypeEnum
29+
* Returns the job type string
3330
*/
3431
getType() {
3532
return this.type;

src/Enums/SharpApiJobTypeEnum.js

Lines changed: 0 additions & 128 deletions
This file was deleted.

src/index.js

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ const { SharpApiSubscriptionInfo } = require('./Dto/SharpApiSubscriptionInfo');
55

66
// Export Enums
77
const { SharpApiJobStatusEnum } = require('./Enums/SharpApiJobStatusEnum');
8-
const { SharpApiJobTypeEnum } = require('./Enums/SharpApiJobTypeEnum');
98
const { SharpApiVoiceTone } = require('./Enums/SharpApiVoiceTone');
109
const { SharpApiLanguages } = require('./Enums/SharpApiLanguages');
1110

@@ -18,7 +17,6 @@ module.exports = {
1817
SharpApiJob,
1918
SharpApiSubscriptionInfo,
2019
SharpApiJobStatusEnum,
21-
SharpApiJobTypeEnum,
2220
SharpApiVoiceTone,
2321
SharpApiLanguages,
2422
SlidingWindowRateLimiter,

0 commit comments

Comments
 (0)