@xcrop/sdk 0.0.0-stage → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (108) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +415 -2
  3. package/dist/cjs/client.d.ts +65 -0
  4. package/dist/cjs/client.d.ts.map +1 -0
  5. package/dist/cjs/client.js +84 -0
  6. package/dist/cjs/client.js.map +1 -0
  7. package/dist/cjs/errors.d.ts +46 -0
  8. package/dist/cjs/errors.d.ts.map +1 -0
  9. package/dist/cjs/errors.js +79 -0
  10. package/dist/cjs/errors.js.map +1 -0
  11. package/dist/cjs/http.d.ts +28 -0
  12. package/dist/cjs/http.d.ts.map +1 -0
  13. package/dist/cjs/http.js +250 -0
  14. package/dist/cjs/http.js.map +1 -0
  15. package/dist/cjs/index.d.ts +13 -0
  16. package/dist/cjs/index.d.ts.map +1 -0
  17. package/dist/cjs/index.js +36 -0
  18. package/dist/cjs/index.js.map +1 -0
  19. package/dist/cjs/package.json +3 -0
  20. package/dist/cjs/resources/account.d.ts +28 -0
  21. package/dist/cjs/resources/account.d.ts.map +1 -0
  22. package/dist/cjs/resources/account.js +63 -0
  23. package/dist/cjs/resources/account.js.map +1 -0
  24. package/dist/cjs/resources/communities.d.ts +29 -0
  25. package/dist/cjs/resources/communities.d.ts.map +1 -0
  26. package/dist/cjs/resources/communities.js +56 -0
  27. package/dist/cjs/resources/communities.js.map +1 -0
  28. package/dist/cjs/resources/lists.d.ts +24 -0
  29. package/dist/cjs/resources/lists.d.ts.map +1 -0
  30. package/dist/cjs/resources/lists.js +66 -0
  31. package/dist/cjs/resources/lists.js.map +1 -0
  32. package/dist/cjs/resources/search.d.ts +60 -0
  33. package/dist/cjs/resources/search.d.ts.map +1 -0
  34. package/dist/cjs/resources/search.js +198 -0
  35. package/dist/cjs/resources/search.js.map +1 -0
  36. package/dist/cjs/resources/stream.d.ts +45 -0
  37. package/dist/cjs/resources/stream.d.ts.map +1 -0
  38. package/dist/cjs/resources/stream.js +129 -0
  39. package/dist/cjs/resources/stream.js.map +1 -0
  40. package/dist/cjs/resources/trending.d.ts +11 -0
  41. package/dist/cjs/resources/trending.d.ts.map +1 -0
  42. package/dist/cjs/resources/trending.js +21 -0
  43. package/dist/cjs/resources/trending.js.map +1 -0
  44. package/dist/cjs/resources/tweets.d.ts +90 -0
  45. package/dist/cjs/resources/tweets.d.ts.map +1 -0
  46. package/dist/cjs/resources/tweets.js +202 -0
  47. package/dist/cjs/resources/tweets.js.map +1 -0
  48. package/dist/cjs/resources/users.d.ts +96 -0
  49. package/dist/cjs/resources/users.d.ts.map +1 -0
  50. package/dist/cjs/resources/users.js +238 -0
  51. package/dist/cjs/resources/users.js.map +1 -0
  52. package/dist/cjs/types.d.ts +442 -0
  53. package/dist/cjs/types.d.ts.map +1 -0
  54. package/dist/cjs/types.js +4 -0
  55. package/dist/cjs/types.js.map +1 -0
  56. package/dist/esm/client.d.ts +65 -0
  57. package/dist/esm/client.d.ts.map +1 -0
  58. package/dist/esm/client.js +80 -0
  59. package/dist/esm/client.js.map +1 -0
  60. package/dist/esm/errors.d.ts +46 -0
  61. package/dist/esm/errors.d.ts.map +1 -0
  62. package/dist/esm/errors.js +71 -0
  63. package/dist/esm/errors.js.map +1 -0
  64. package/dist/esm/http.d.ts +28 -0
  65. package/dist/esm/http.d.ts.map +1 -0
  66. package/dist/esm/http.js +246 -0
  67. package/dist/esm/http.js.map +1 -0
  68. package/dist/esm/index.d.ts +13 -0
  69. package/dist/esm/index.d.ts.map +1 -0
  70. package/dist/esm/index.js +16 -0
  71. package/dist/esm/index.js.map +1 -0
  72. package/dist/esm/resources/account.d.ts +28 -0
  73. package/dist/esm/resources/account.d.ts.map +1 -0
  74. package/dist/esm/resources/account.js +59 -0
  75. package/dist/esm/resources/account.js.map +1 -0
  76. package/dist/esm/resources/communities.d.ts +29 -0
  77. package/dist/esm/resources/communities.d.ts.map +1 -0
  78. package/dist/esm/resources/communities.js +52 -0
  79. package/dist/esm/resources/communities.js.map +1 -0
  80. package/dist/esm/resources/lists.d.ts +24 -0
  81. package/dist/esm/resources/lists.d.ts.map +1 -0
  82. package/dist/esm/resources/lists.js +61 -0
  83. package/dist/esm/resources/lists.js.map +1 -0
  84. package/dist/esm/resources/search.d.ts +60 -0
  85. package/dist/esm/resources/search.d.ts.map +1 -0
  86. package/dist/esm/resources/search.js +193 -0
  87. package/dist/esm/resources/search.js.map +1 -0
  88. package/dist/esm/resources/stream.d.ts +45 -0
  89. package/dist/esm/resources/stream.d.ts.map +1 -0
  90. package/dist/esm/resources/stream.js +124 -0
  91. package/dist/esm/resources/stream.js.map +1 -0
  92. package/dist/esm/resources/trending.d.ts +11 -0
  93. package/dist/esm/resources/trending.d.ts.map +1 -0
  94. package/dist/esm/resources/trending.js +17 -0
  95. package/dist/esm/resources/trending.js.map +1 -0
  96. package/dist/esm/resources/tweets.d.ts +90 -0
  97. package/dist/esm/resources/tweets.d.ts.map +1 -0
  98. package/dist/esm/resources/tweets.js +197 -0
  99. package/dist/esm/resources/tweets.js.map +1 -0
  100. package/dist/esm/resources/users.d.ts +96 -0
  101. package/dist/esm/resources/users.d.ts.map +1 -0
  102. package/dist/esm/resources/users.js +233 -0
  103. package/dist/esm/resources/users.js.map +1 -0
  104. package/dist/esm/types.d.ts +442 -0
  105. package/dist/esm/types.d.ts.map +1 -0
  106. package/dist/esm/types.js +3 -0
  107. package/dist/esm/types.js.map +1 -0
  108. package/package.json +43 -4
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024 XCROP
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,416 @@
1
- # Temporary Holding Version
1
+ # @xcrop/sdk
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ Official JavaScript/TypeScript SDK for the [XCROP API](https://xcrop.io), the X/Twitter data intelligence platform, covering 47 endpoints (profiles, tweets, search, lists, communities, account monitoring, and the Write API).
4
+
5
+ - Full TypeScript support with detailed types for all endpoints
6
+ - Auto-retry on rate limits (429) with exponential backoff
7
+ - Auto-retry on server errors (5xx), max 3 attempts
8
+ - Auto-pagination via async iterators
9
+ - SSE streaming support for search and real-time feeds
10
+ - ESM and CommonJS dual output
11
+ - Zero dependencies (uses native `fetch`)
12
+
13
+ ## Requirements
14
+
15
+ - Node.js 18+ (native `fetch` required)
16
+
17
+ ## Installation
18
+
19
+ ```bash
20
+ npm install @xcrop/sdk
21
+ ```
22
+
23
+ ## Quick Start
24
+
25
+ ```typescript
26
+ import { XCrop } from '@xcrop/sdk';
27
+
28
+ const client = new XCrop({ apiKey: 'xc_live_...' });
29
+
30
+ // Get a user profile
31
+ const { data: user } = await client.users.get('elonmusk');
32
+ console.log(user.name, user.followers_count);
33
+
34
+ // Get user tweets
35
+ const { data: tweets } = await client.users.tweets('elonmusk', { count: 50 });
36
+ ```
37
+
38
+ ## Configuration
39
+
40
+ ```typescript
41
+ const client = new XCrop({
42
+ apiKey: 'xc_live_...', // Required
43
+ baseUrl: 'https://...', // Default: https://xcrop.io/api/v2
44
+ timeout: 30000, // Default: 30s
45
+ maxRetries: 3, // Default: 3 (for 429/5xx)
46
+ });
47
+ ```
48
+
49
+ ## Users
50
+
51
+ ```typescript
52
+ // Profile
53
+ const { data: user } = await client.users.get('elonmusk');
54
+
55
+ // Tweets, mentions, replies, media
56
+ const { data: tweets } = await client.users.tweets('elonmusk', { count: 20 });
57
+ const { data: mentions } = await client.users.mentions('elonmusk');
58
+ const { data: replies } = await client.users.replies('elonmusk');
59
+ const { data: media } = await client.users.media('elonmusk');
60
+
61
+ // Followers & following
62
+ const { data: followers } = await client.users.followers('elonmusk', { count: 100 });
63
+ const { data: following } = await client.users.following('elonmusk');
64
+ const { data: verified } = await client.users.verifiedFollowers('elonmusk');
65
+
66
+ // Raw follower / following IDs (bulk, no profile metadata, up to 5000/call)
67
+ const { data: ids } = await client.users.followersIds('elonmusk', { count: 5000 });
68
+ const { data: followingIds } = await client.users.followingIds('elonmusk', { count: 5000 });
69
+
70
+ // Batch lookup (max 100), by username or by numeric id
71
+ const { data: users } = await client.users.batch(['elonmusk', 'jack', 'VitalikButerin']);
72
+ const { data: byId, meta } = await client.users.batchByIds(['44196397', '12']);
73
+ console.log(meta.not_found); // ids X did not return
74
+
75
+ // Any user route also takes a numeric id: `id:<digits>` or `user_id`
76
+ await client.users.get('id:44196397');
77
+ await client.users.tweets('ignored', { user_id: '44196397' });
78
+
79
+ // Time window on mentions (unix seconds or ISO date)
80
+ await client.users.mentions('elonmusk', { since: '2026-11-01', until: '2026-11-10' });
81
+
82
+ // Also return suspended/deactivated accounts (not billed). Those rows look like
83
+ // { id, unavailable: true, unavailable_reason, ...every other field null }
84
+ const { data: all } = await client.users.following('nasa', { include_unavailable: true });
85
+
86
+ // Check follow relationship
87
+ const { data: rel } = await client.users.checkFollow('elonmusk', 'jack');
88
+ console.log(rel.source_follows_target, rel.target_follows_source);
89
+
90
+ // Eligibility checks for airdrop/giveaway gating
91
+ const { data: qa } = await client.users.checkQualifiedAccount('elonmusk', {
92
+ min_followers: 1000,
93
+ min_age_days: 30,
94
+ });
95
+ const { data: qn } = await client.users.checkQualifiedName('elonmusk', {
96
+ contains: 'crypto',
97
+ position: 'anywhere', // 'anywhere' | 'left' | 'right'
98
+ });
99
+ ```
100
+
101
+ User objects now include `location`, `website`, `banner_image`, `likes_count`,
102
+ `media_count`, `protected`, `can_dm`, `pinned_tweet_ids`, `automated`,
103
+ `automated_by` and `affiliation` (all nullable: `null` means X did not send it).
104
+ Community member and moderator rows add `community_role`.
105
+
106
+ ## Tweets
107
+
108
+ ```typescript
109
+ // Single tweet
110
+ const { data: tweet } = await client.tweets.get('1234567890');
111
+
112
+ // Conversation thread
113
+ const { data: thread } = await client.tweets.conversation('1234567890', { count: 50 });
114
+
115
+ // Quote tweets
116
+ const { data: quotes } = await client.tweets.quotes('1234567890');
117
+
118
+ // Batch lookup (max 100)
119
+ const { data: tweets } = await client.tweets.batch(['123', '456', '789']);
120
+
121
+ // Who reposted a tweet (billed per user returned)
122
+ const { data: retweeters } = await client.tweets.retweeters('1234567890', { count: 100 });
123
+
124
+ // Conversation: sort 'latest' (default) | 'relevance' | 'likes', plus a time window
125
+ const convo = await client.tweets.conversation('1234567890', { sort: 'likes', since: '2026-11-01' });
126
+ console.log(convo.meta.sort, convo.meta.thread_context); // tweets above a mid-thread tweet
127
+
128
+ // Time window on quotes and list tweets
129
+ await client.tweets.quotes('1234567890', { since: 1730419200 });
130
+ await client.lists.tweets('1234567890', { until: '2026-11-10' });
131
+ ```
132
+
133
+ Tweets now carry `url`, `lang`, `source`, `in_reply_to`, `quoted_tweet`,
134
+ `retweeted_tweet`, `is_long_post`, `entities`, `possibly_sensitive`, `edit`,
135
+ `has_community_notes`, `place`, `card`, `metrics.quotes` and richer `author`
136
+ fields (`followers`, `verified`, `verified_type`, `profile_image`). `text` is
137
+ the full text of long posts.
138
+
139
+ ## Communities
140
+
141
+ X Communities data. `count` is a minimum on members and moderators: X serves
142
+ whole pages, so a response can hold more rows than requested.
143
+
144
+ ```typescript
145
+ const { data: community } = await client.communities.get('1708766018985501165');
146
+ const { data: tweets } = await client.communities.tweets('1708766018985501165', { count: 20 });
147
+ const { data: members } = await client.communities.members('1708766018985501165', { sort: 'name' });
148
+ const { data: mods } = await client.communities.moderators('1708766018985501165', { sort: 'default' });
149
+ ```
150
+
151
+ ## Search
152
+
153
+ ```typescript
154
+ // Search tweets
155
+ const { data: results } = await client.search.tweets({
156
+ query: 'bitcoin',
157
+ count: 50,
158
+ sort: 'latest', // 'latest' | 'popular' | 'engagement'
159
+ lang: 'en',
160
+ min_likes: 10,
161
+ exclude_replies: true,
162
+ since: '2024-01-01',
163
+ until: '2024-12-31',
164
+ });
165
+
166
+ // Search users
167
+ const { data: users } = await client.search.users({ query: 'crypto', count: 20 });
168
+ ```
169
+
170
+ ## Auto-Pagination
171
+
172
+ Use the `paginate` helper to automatically iterate through all pages:
173
+
174
+ ```typescript
175
+ // Iterate all tweets
176
+ for await (const tweet of client.paginate.userTweets('elonmusk', { count: 100 })) {
177
+ console.log(tweet.text);
178
+ }
179
+
180
+ // Also works with: client.users.tweets.paginate()
181
+ for await (const tweet of client.users.tweets.paginate('elonmusk', { count: 200 })) {
182
+ console.log(tweet.id);
183
+ }
184
+
185
+ // All paginated endpoints:
186
+ client.paginate.userTweets(username, params)
187
+ client.paginate.userMentions(username, params)
188
+ client.paginate.userFollowers(username, params)
189
+ client.paginate.userFollowing(username, params)
190
+ client.paginate.userReplies(username, params)
191
+ client.paginate.userMedia(username, params)
192
+ client.paginate.userVerifiedFollowers(username, params)
193
+ client.paginate.tweetConversation(tweetId, params)
194
+ client.paginate.tweetQuotes(tweetId, params)
195
+ client.paginate.listTweets(listId, params)
196
+ client.paginate.listMembers(listId, params)
197
+ client.paginate.listSubscribers(listId, params)
198
+ client.paginate.communityTweets(communityId, params)
199
+ client.paginate.communityMembers(communityId, params)
200
+ ```
201
+
202
+ ## Streaming
203
+
204
+ ### Search Stream (SSE)
205
+
206
+ ```typescript
207
+ const stream = client.search.stream({ query: 'crypto', count: 500 });
208
+
209
+ stream.on('tweet', (tweet) => {
210
+ console.log(tweet.text);
211
+ });
212
+
213
+ stream.on('done', (meta) => {
214
+ console.log('Stream complete', meta);
215
+ });
216
+
217
+ stream.on('error', (err) => {
218
+ console.error('Stream error', err);
219
+ });
220
+
221
+ // Close early
222
+ stream.close();
223
+ ```
224
+
225
+ ### Real-time Stream
226
+
227
+ ```typescript
228
+ const stream = client.stream.connect();
229
+
230
+ stream.on('tweet', (tweet) => {
231
+ console.log('New tweet:', tweet.text);
232
+ });
233
+
234
+ stream.on('error', (err) => {
235
+ console.error(err);
236
+ });
237
+
238
+ // Close when done
239
+ stream.close();
240
+ ```
241
+
242
+ ## Write Operations
243
+
244
+ Write operations require a connected X account.
245
+
246
+ ### Connect Account
247
+
248
+ ```typescript
249
+ // Via credentials
250
+ await client.account.connect({
251
+ username: 'myuser',
252
+ password: 'mypass',
253
+ totp_secret: 'ABCDEF123456', // Optional 2FA
254
+ });
255
+
256
+ // Via cookies
257
+ await client.account.connect({
258
+ cookies: {
259
+ auth_token: '...',
260
+ ct0: '...',
261
+ },
262
+ });
263
+
264
+ // Check status
265
+ const { data: status } = await client.account.status();
266
+ console.log(status.connected, status.username);
267
+
268
+ // Disconnect
269
+ await client.account.disconnect();
270
+ ```
271
+
272
+ ### Create, Reply, Quote
273
+
274
+ ```typescript
275
+ // Create tweet
276
+ const { data: result } = await client.tweets.create({ text: 'Hello world!' });
277
+ console.log(result.tweet_id);
278
+
279
+ // Reply
280
+ await client.tweets.reply({ tweet_id: '1234567890', text: 'Great thread!' });
281
+
282
+ // Quote
283
+ await client.tweets.quote({ tweet_id: '1234567890', text: 'Interesting take' });
284
+
285
+ // Delete
286
+ await client.tweets.delete('1234567890');
287
+ ```
288
+
289
+ ### Like, Retweet, Follow
290
+
291
+ ```typescript
292
+ await client.tweets.like('1234567890');
293
+ await client.tweets.unlike('1234567890');
294
+
295
+ await client.tweets.retweet('1234567890');
296
+ await client.tweets.unretweet('1234567890');
297
+
298
+ await client.users.follow('elonmusk');
299
+ await client.users.unfollow('elonmusk');
300
+ ```
301
+
302
+ ## Interaction Checks
303
+
304
+ Check if a user interacted with a specific tweet (no connected account needed):
305
+
306
+ ```typescript
307
+ const { data: retweeted } = await client.tweets.checkRetweet('1234567890', 'username');
308
+ const { data: replied } = await client.tweets.checkReply('1234567890', 'username');
309
+ const { data: quoted } = await client.tweets.checkQuote('1234567890', 'username');
310
+
311
+ console.log(retweeted.found); // boolean
312
+ ```
313
+
314
+ ## Lists
315
+
316
+ ```typescript
317
+ const { data: tweets } = await client.lists.tweets('12345', { count: 50 });
318
+ const { data: members } = await client.lists.members('12345');
319
+ const { data: subs } = await client.lists.subscribers('12345');
320
+ ```
321
+
322
+ ## Trending
323
+
324
+ ```typescript
325
+ // Trending topics (defaults to Worldwide)
326
+ const { data: trends } = await client.trending.get();
327
+ const { data: usTrends } = await client.trending.get({ country: 'United States' });
328
+ // Each row has a 1-based `rank`; `volume` is always null (X no longer publishes counts)
329
+ ```
330
+
331
+ ## Account Monitoring
332
+
333
+ Track specific X accounts over time (profile snapshots, tweet activity) via
334
+ the `users` and `search` endpoints above: poll `client.users.get()` /
335
+ `client.users.tweets()` on a schedule, or use `client.stream.connect()` for
336
+ real-time updates.
337
+
338
+ ## Credits
339
+
340
+ ```typescript
341
+ // Free call: current credit balance
342
+ const { data: credits } = await client.account.credits();
343
+ console.log(credits.total_remaining, credits.plan_remaining, credits.topup_remaining);
344
+ ```
345
+
346
+ ## Error Handling
347
+
348
+ ```typescript
349
+ import { XCrop, AuthError, RateLimitError, NotFoundError, XCropError } from '@xcrop/sdk';
350
+
351
+ try {
352
+ await client.users.get('nonexistent_user_12345');
353
+ } catch (err) {
354
+ if (err instanceof NotFoundError) {
355
+ // err.code: NOT_FOUND | USER_SUSPENDED | USER_UNAVAILABLE
356
+ // err.reason: e.g. 'suspended', 'deactivated', 'not_found'
357
+ console.log(`User not found: ${err.code} ${err.reason ?? ''}`);
358
+ } else if (err instanceof AuthError) {
359
+ console.log('Invalid API key');
360
+ } else if (err instanceof RateLimitError) {
361
+ console.log(`Rate limited. Retry after ${err.retryAfter}s`);
362
+ console.log(`Remaining: ${err.remaining}/${err.limit}`);
363
+ } else if (err instanceof XCropError) {
364
+ console.log(`API error: ${err.status} ${err.code} - ${err.message}`);
365
+ }
366
+ }
367
+ ```
368
+
369
+ Error codes returned in `err.code` (the list can grow, keep a fallback branch):
370
+ `NOT_FOUND`, `USER_SUSPENDED`, `USER_UNAVAILABLE` (with `err.reason`),
371
+ `BAD_COMMUNITY_ID`, `BAD_TIME_WINDOW`, `BAD_USER_ID`, `BAD_SORT`, `BAD_CURSOR`
372
+ and `INTERNAL_ERROR` (500). Suspended and unavailable accounts arrive as a
373
+ `NotFoundError` (404) with the matching code.
374
+
375
+ ## Rate Limits
376
+
377
+ Per-minute request limits, by plan:
378
+
379
+ | Plan | Requests/min |
380
+ |------|---------------|
381
+ | Starter | 60 |
382
+ | Basic | 300 |
383
+ | Pro | 600 |
384
+ | Pay-as-You-Go | 300 |
385
+
386
+ Every plan (including the free Starter tier) can call all 47 endpoints. Plans
387
+ differ only by monthly credits, the rate limit above, and credit price. On a
388
+ 429 the SDK auto-retries with backoff (see `RateLimitError` above for the
389
+ raw `retryAfter`/`remaining`/`limit` fields).
390
+
391
+ ## Payment
392
+
393
+ Plans and credit top-ups are paid via cryptocurrency: USDT (BEP-20), USDC
394
+ (BEP-20), SOL, and POL. Card payments (Stripe) are coming soon. See
395
+ [xcrop.io/pricing](https://xcrop.io/pricing) for details.
396
+
397
+ ## Response Format
398
+
399
+ All methods return the raw API response envelope:
400
+
401
+ ```typescript
402
+ interface ApiResponse<T> {
403
+ data: T;
404
+ meta: {
405
+ latency_ms?: number;
406
+ cached?: boolean;
407
+ total?: number;
408
+ cursor?: string; // For pagination
409
+ has_next?: boolean; // More pages available
410
+ };
411
+ }
412
+ ```
413
+
414
+ ## License
415
+
416
+ MIT
@@ -0,0 +1,65 @@
1
+ import { UsersResource } from './resources/users.js';
2
+ import { TweetsResource } from './resources/tweets.js';
3
+ import { SearchResource } from './resources/search.js';
4
+ import { ListsResource } from './resources/lists.js';
5
+ import { TrendingResource } from './resources/trending.js';
6
+ import { CommunitiesResource } from './resources/communities.js';
7
+ import { AccountResource } from './resources/account.js';
8
+ import { StreamResource } from './resources/stream.js';
9
+ import type { XCropOptions, PaginationParams, CommunityTweetsParams, CommunityMembersParams, Tweet, User } from './types.js';
10
+ type UserTweetsFn = UsersResource['tweets'] & {
11
+ paginate(username: string, params?: PaginationParams): AsyncGenerator<Tweet, void, undefined>;
12
+ };
13
+ interface PaginateHelpers {
14
+ userTweets(username: string, params?: PaginationParams): AsyncGenerator<Tweet, void, undefined>;
15
+ userMentions(username: string, params?: PaginationParams): AsyncGenerator<Tweet, void, undefined>;
16
+ userFollowers(username: string, params?: PaginationParams): AsyncGenerator<User, void, undefined>;
17
+ userFollowing(username: string, params?: PaginationParams): AsyncGenerator<User, void, undefined>;
18
+ userReplies(username: string, params?: PaginationParams): AsyncGenerator<Tweet, void, undefined>;
19
+ userMedia(username: string, params?: PaginationParams): AsyncGenerator<Tweet, void, undefined>;
20
+ userVerifiedFollowers(username: string, params?: PaginationParams): AsyncGenerator<User, void, undefined>;
21
+ tweetConversation(tweetId: string, params?: PaginationParams): AsyncGenerator<Tweet, void, undefined>;
22
+ tweetQuotes(tweetId: string, params?: PaginationParams): AsyncGenerator<Tweet, void, undefined>;
23
+ listTweets(listId: string, params?: PaginationParams): AsyncGenerator<Tweet, void, undefined>;
24
+ listMembers(listId: string, params?: PaginationParams): AsyncGenerator<User, void, undefined>;
25
+ listSubscribers(listId: string, params?: PaginationParams): AsyncGenerator<User, void, undefined>;
26
+ communityTweets(communityId: string, params?: CommunityTweetsParams): AsyncGenerator<Tweet, void, undefined>;
27
+ communityMembers(communityId: string, params?: CommunityMembersParams): AsyncGenerator<User, void, undefined>;
28
+ }
29
+ /**
30
+ * XCROP SDK client for the X/Twitter data intelligence API.
31
+ *
32
+ * @example
33
+ * ```ts
34
+ * import { XCrop } from '@xcrop/sdk';
35
+ *
36
+ * const client = new XCrop({ apiKey: 'xc_live_...' });
37
+ * const user = await client.users.get('elonmusk');
38
+ * ```
39
+ */
40
+ export declare class XCrop {
41
+ private readonly http;
42
+ /** User profile, tweets, followers, and follow-check endpoints. */
43
+ readonly users: UsersResource & {
44
+ tweets: UserTweetsFn;
45
+ };
46
+ /** Tweet data, write operations, interactions, and checks. */
47
+ readonly tweets: TweetsResource;
48
+ /** Search tweets and users, with streaming support. */
49
+ readonly search: SearchResource;
50
+ /** Twitter list data. */
51
+ readonly lists: ListsResource;
52
+ /** Trending topics. */
53
+ readonly trending: TrendingResource;
54
+ /** X Communities data (details, tweets, members, moderators). */
55
+ readonly communities: CommunitiesResource;
56
+ /** X account connection management for write operations. */
57
+ readonly account: AccountResource;
58
+ /** Real-time SSE stream. */
59
+ readonly stream: StreamResource;
60
+ /** Pagination helper — auto-iterate through all pages. */
61
+ readonly paginate: PaginateHelpers;
62
+ constructor(options: XCropOptions);
63
+ }
64
+ export {};
65
+ //# sourceMappingURL=client.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAgB,MAAM,sBAAsB,CAAC;AACnE,OAAO,EAAE,cAAc,EAAiB,MAAM,uBAAuB,CAAC;AACtE,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,aAAa,EAAgB,MAAM,sBAAsB,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,KAAK,EACV,YAAY,EACZ,gBAAgB,EAChB,qBAAqB,EACrB,sBAAsB,EACtB,KAAK,EACL,IAAI,EACL,MAAM,YAAY,CAAC;AAEpB,KAAK,YAAY,GAAG,aAAa,CAAC,QAAQ,CAAC,GAAG;IAC5C,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,cAAc,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;CAC/F,CAAC;AAEF,UAAU,eAAe;IACvB,UAAU,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,cAAc,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAChG,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,cAAc,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAClG,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAClG,aAAa,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAClG,WAAW,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,cAAc,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IACjG,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,cAAc,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC/F,qBAAqB,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC1G,iBAAiB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,cAAc,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IACtG,WAAW,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,cAAc,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAChG,UAAU,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,cAAc,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC9F,WAAW,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC9F,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,gBAAgB,GAAG,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAClG,eAAe,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,qBAAqB,GAAG,cAAc,CAAC,KAAK,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;IAC7G,gBAAgB,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,sBAAsB,GAAG,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;CAC/G;AAED;;;;;;;;;;GAUG;AACH,qBAAa,KAAK;IAChB,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAa;IAElC,mEAAmE;IACnE,SAAgB,KAAK,EAAE,aAAa,GAAG;QAAE,MAAM,EAAE,YAAY,CAAA;KAAE,CAAC;IAChE,8DAA8D;IAC9D,SAAgB,MAAM,EAAE,cAAc,CAAC;IACvC,uDAAuD;IACvD,SAAgB,MAAM,EAAE,cAAc,CAAC;IACvC,yBAAyB;IACzB,SAAgB,KAAK,EAAE,aAAa,CAAC;IACrC,uBAAuB;IACvB,SAAgB,QAAQ,EAAE,gBAAgB,CAAC;IAC3C,iEAAiE;IACjE,SAAgB,WAAW,EAAE,mBAAmB,CAAC;IACjD,4DAA4D;IAC5D,SAAgB,OAAO,EAAE,eAAe,CAAC;IACzC,4BAA4B;IAC5B,SAAgB,MAAM,EAAE,cAAc,CAAC;IAEvC,0DAA0D;IAC1D,SAAgB,QAAQ,EAAE,eAAe,CAAC;gBAE9B,OAAO,EAAE,YAAY;CA0DlC"}
@@ -0,0 +1,84 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.XCrop = void 0;
4
+ const http_js_1 = require("./http.js");
5
+ const users_js_1 = require("./resources/users.js");
6
+ const tweets_js_1 = require("./resources/tweets.js");
7
+ const search_js_1 = require("./resources/search.js");
8
+ const lists_js_1 = require("./resources/lists.js");
9
+ const trending_js_1 = require("./resources/trending.js");
10
+ const communities_js_1 = require("./resources/communities.js");
11
+ const account_js_1 = require("./resources/account.js");
12
+ const stream_js_1 = require("./resources/stream.js");
13
+ /**
14
+ * XCROP SDK client for the X/Twitter data intelligence API.
15
+ *
16
+ * @example
17
+ * ```ts
18
+ * import { XCrop } from '@xcrop/sdk';
19
+ *
20
+ * const client = new XCrop({ apiKey: 'xc_live_...' });
21
+ * const user = await client.users.get('elonmusk');
22
+ * ```
23
+ */
24
+ class XCrop {
25
+ http;
26
+ /** User profile, tweets, followers, and follow-check endpoints. */
27
+ users;
28
+ /** Tweet data, write operations, interactions, and checks. */
29
+ tweets;
30
+ /** Search tweets and users, with streaming support. */
31
+ search;
32
+ /** Twitter list data. */
33
+ lists;
34
+ /** Trending topics. */
35
+ trending;
36
+ /** X Communities data (details, tweets, members, moderators). */
37
+ communities;
38
+ /** X account connection management for write operations. */
39
+ account;
40
+ /** Real-time SSE stream. */
41
+ stream;
42
+ /** Pagination helper — auto-iterate through all pages. */
43
+ paginate;
44
+ constructor(options) {
45
+ if (!options.apiKey) {
46
+ throw new Error('apiKey is required');
47
+ }
48
+ this.http = new http_js_1.HttpClient(options);
49
+ // Initialize resources
50
+ const usersBase = new users_js_1.UsersResource(this.http);
51
+ this.tweets = new tweets_js_1.TweetsResource(this.http);
52
+ this.search = new search_js_1.SearchResource(this.http);
53
+ this.lists = new lists_js_1.ListsResource(this.http);
54
+ this.trending = new trending_js_1.TrendingResource(this.http);
55
+ this.communities = new communities_js_1.CommunitiesResource(this.http);
56
+ this.account = new account_js_1.AccountResource(this.http);
57
+ this.stream = new stream_js_1.StreamResource(this.http);
58
+ // Build users.tweets with nested .paginate()
59
+ const boundTweets = usersBase.tweets.bind(usersBase);
60
+ const tweetsFn = Object.assign(boundTweets, {
61
+ paginate: (username, params) => (0, users_js_1.paginateUser)(boundTweets, username, params),
62
+ });
63
+ this.users = Object.assign(usersBase, { tweets: tweetsFn });
64
+ // Build top-level paginate helpers
65
+ this.paginate = {
66
+ userTweets: (username, params) => (0, users_js_1.paginateUser)(boundTweets, username, params),
67
+ userMentions: (username, params) => (0, users_js_1.paginateUser)(usersBase.mentions.bind(usersBase), username, params),
68
+ userFollowers: (username, params) => (0, users_js_1.paginateUser)(usersBase.followers.bind(usersBase), username, params),
69
+ userFollowing: (username, params) => (0, users_js_1.paginateUser)(usersBase.following.bind(usersBase), username, params),
70
+ userReplies: (username, params) => (0, users_js_1.paginateUser)(usersBase.replies.bind(usersBase), username, params),
71
+ userMedia: (username, params) => (0, users_js_1.paginateUser)(usersBase.media.bind(usersBase), username, params),
72
+ userVerifiedFollowers: (username, params) => (0, users_js_1.paginateUser)(usersBase.verifiedFollowers.bind(usersBase), username, params),
73
+ tweetConversation: (tweetId, params) => (0, tweets_js_1.paginateTweet)(this.tweets.conversation.bind(this.tweets), tweetId, params),
74
+ tweetQuotes: (tweetId, params) => (0, tweets_js_1.paginateTweet)(this.tweets.quotes.bind(this.tweets), tweetId, params),
75
+ listTweets: (listId, params) => (0, lists_js_1.paginateList)(this.lists.tweets.bind(this.lists), listId, params),
76
+ listMembers: (listId, params) => (0, lists_js_1.paginateList)(this.lists.members.bind(this.lists), listId, params),
77
+ listSubscribers: (listId, params) => (0, lists_js_1.paginateList)(this.lists.subscribers.bind(this.lists), listId, params),
78
+ communityTweets: (communityId, params) => (0, lists_js_1.paginateList)(this.communities.tweets.bind(this.communities), communityId, params),
79
+ communityMembers: (communityId, params) => (0, lists_js_1.paginateList)(this.communities.members.bind(this.communities), communityId, params),
80
+ };
81
+ }
82
+ }
83
+ exports.XCrop = XCrop;
84
+ //# sourceMappingURL=client.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"client.js","sourceRoot":"","sources":["../../src/client.ts"],"names":[],"mappings":";;;AAAA,uCAAuC;AACvC,mDAAmE;AACnE,qDAAsE;AACtE,qDAAuD;AACvD,mDAAmE;AACnE,yDAA2D;AAC3D,+DAAiE;AACjE,uDAAyD;AACzD,qDAAuD;AA+BvD;;;;;;;;;;GAUG;AACH,MAAa,KAAK;IACC,IAAI,CAAa;IAElC,mEAAmE;IACnD,KAAK,CAA2C;IAChE,8DAA8D;IAC9C,MAAM,CAAiB;IACvC,uDAAuD;IACvC,MAAM,CAAiB;IACvC,yBAAyB;IACT,KAAK,CAAgB;IACrC,uBAAuB;IACP,QAAQ,CAAmB;IAC3C,iEAAiE;IACjD,WAAW,CAAsB;IACjD,4DAA4D;IAC5C,OAAO,CAAkB;IACzC,4BAA4B;IACZ,MAAM,CAAiB;IAEvC,0DAA0D;IAC1C,QAAQ,CAAkB;IAE1C,YAAY,OAAqB;QAC/B,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACpB,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACxC,CAAC;QAED,IAAI,CAAC,IAAI,GAAG,IAAI,oBAAU,CAAC,OAAO,CAAC,CAAC;QAEpC,uBAAuB;QACvB,MAAM,SAAS,GAAG,IAAI,wBAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/C,IAAI,CAAC,MAAM,GAAG,IAAI,0BAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,CAAC,MAAM,GAAG,IAAI,0BAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC5C,IAAI,CAAC,KAAK,GAAG,IAAI,wBAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC1C,IAAI,CAAC,QAAQ,GAAG,IAAI,8BAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAChD,IAAI,CAAC,WAAW,GAAG,IAAI,oCAAmB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtD,IAAI,CAAC,OAAO,GAAG,IAAI,4BAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC9C,IAAI,CAAC,MAAM,GAAG,IAAI,0BAAc,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAE5C,6CAA6C;QAC7C,MAAM,WAAW,GAAG,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;QACrD,MAAM,QAAQ,GAAG,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE;YAC1C,QAAQ,EAAE,CAAC,QAAgB,EAAE,MAAyB,EAAE,EAAE,CACxD,IAAA,uBAAY,EAAQ,WAAW,EAAE,QAAQ,EAAE,MAAM,CAAC;SACrD,CAAiB,CAAC;QAEnB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAA6C,CAAC;QAExG,mCAAmC;QACnC,IAAI,CAAC,QAAQ,GAAG;YACd,UAAU,EAAE,CAAC,QAAgB,EAAE,MAAyB,EAAE,EAAE,CAC1D,IAAA,uBAAY,EAAQ,WAAW,EAAE,QAAQ,EAAE,MAAM,CAAC;YACpD,YAAY,EAAE,CAAC,QAAgB,EAAE,MAAyB,EAAE,EAAE,CAC5D,IAAA,uBAAY,EAAQ,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC;YAC3E,aAAa,EAAE,CAAC,QAAgB,EAAE,MAAyB,EAAE,EAAE,CAC7D,IAAA,uBAAY,EAAO,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC;YAC3E,aAAa,EAAE,CAAC,QAAgB,EAAE,MAAyB,EAAE,EAAE,CAC7D,IAAA,uBAAY,EAAO,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC;YAC3E,WAAW,EAAE,CAAC,QAAgB,EAAE,MAAyB,EAAE,EAAE,CAC3D,IAAA,uBAAY,EAAQ,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC;YAC1E,SAAS,EAAE,CAAC,QAAgB,EAAE,MAAyB,EAAE,EAAE,CACzD,IAAA,uBAAY,EAAQ,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC;YACxE,qBAAqB,EAAE,CAAC,QAAgB,EAAE,MAAyB,EAAE,EAAE,CACrE,IAAA,uBAAY,EAAO,SAAS,CAAC,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,MAAM,CAAC;YACnF,iBAAiB,EAAE,CAAC,OAAe,EAAE,MAAyB,EAAE,EAAE,CAChE,IAAA,yBAAa,EAAQ,IAAI,CAAC,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC;YACnF,WAAW,EAAE,CAAC,OAAe,EAAE,MAAyB,EAAE,EAAE,CAC1D,IAAA,yBAAa,EAAQ,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC;YAC7E,UAAU,EAAE,CAAC,MAAc,EAAE,MAAyB,EAAE,EAAE,CACxD,IAAA,uBAAY,EAAQ,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC;YACzE,WAAW,EAAE,CAAC,MAAc,EAAE,MAAyB,EAAE,EAAE,CACzD,IAAA,uBAAY,EAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC;YACzE,eAAe,EAAE,CAAC,MAAc,EAAE,MAAyB,EAAE,EAAE,CAC7D,IAAA,uBAAY,EAAO,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC;YAC7E,eAAe,EAAE,CAAC,WAAmB,EAAE,MAA8B,EAAE,EAAE,CACvE,IAAA,uBAAY,EAAQ,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC;YAC1F,gBAAgB,EAAE,CAAC,WAAmB,EAAE,MAA+B,EAAE,EAAE,CACzE,IAAA,uBAAY,EAAO,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC;SAC3F,CAAC;IACJ,CAAC;CACF;AAjFD,sBAiFC"}
@@ -0,0 +1,46 @@
1
+ /**
2
+ * Base error class for all XCROP SDK errors.
3
+ */
4
+ export declare class XCropError extends Error {
5
+ readonly status: number;
6
+ readonly code: string;
7
+ readonly headers: Record<string, string>;
8
+ /**
9
+ * Extra detail the API adds to some errors (404s), e.g. `suspended`,
10
+ * `deactivated`, `not_found`. null when the response carried none.
11
+ */
12
+ readonly reason: string | null;
13
+ constructor(message: string, status: number, code: string, headers?: Record<string, string>, reason?: string | null);
14
+ }
15
+ /**
16
+ * Thrown when authentication fails (401).
17
+ */
18
+ export declare class AuthError extends XCropError {
19
+ constructor(message: string, headers?: Record<string, string>);
20
+ }
21
+ /**
22
+ * Thrown when rate limit is exceeded (429).
23
+ * Contains retry timing information.
24
+ */
25
+ export declare class RateLimitError extends XCropError {
26
+ readonly retryAfter: number | null;
27
+ readonly remaining: number;
28
+ readonly limit: number;
29
+ constructor(message: string, headers?: Record<string, string>);
30
+ }
31
+ /**
32
+ * Thrown when a resource is not found (404).
33
+ *
34
+ * `code` is the API's code: `NOT_FOUND` (default), `USER_SUSPENDED` or
35
+ * `USER_UNAVAILABLE` (with `reason`, e.g. `suspended` / `deactivated`).
36
+ */
37
+ export declare class NotFoundError extends XCropError {
38
+ constructor(message: string, headers?: Record<string, string>, code?: string, reason?: string | null);
39
+ }
40
+ /**
41
+ * Thrown when the request is forbidden (403).
42
+ */
43
+ export declare class ForbiddenError extends XCropError {
44
+ constructor(message: string, headers?: Record<string, string>);
45
+ }
46
+ //# sourceMappingURL=errors.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"errors.d.ts","sourceRoot":"","sources":["../../src/errors.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,qBAAa,UAAW,SAAQ,KAAK;IACnC,SAAgB,MAAM,EAAE,MAAM,CAAC;IAC/B,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChD;;;OAGG;IACH,SAAgB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;gBAGpC,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,IAAI,EAAE,MAAM,EACZ,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,EACpC,MAAM,GAAE,MAAM,GAAG,IAAW;CAU/B;AAED;;GAEG;AACH,qBAAa,SAAU,SAAQ,UAAU;gBAC3B,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM;CAIlE;AAED;;;GAGG;AACH,qBAAa,cAAe,SAAQ,UAAU;IAC5C,SAAgB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1C,SAAgB,SAAS,EAAE,MAAM,CAAC;IAClC,SAAgB,KAAK,EAAE,MAAM,CAAC;gBAG5B,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM;CAUvC;AAED;;;;;GAKG;AACH,qBAAa,aAAc,SAAQ,UAAU;gBAEzC,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM,EACpC,IAAI,GAAE,MAAoB,EAC1B,MAAM,GAAE,MAAM,GAAG,IAAW;CAK/B;AAED;;GAEG;AACH,qBAAa,cAAe,SAAQ,UAAU;gBAChC,OAAO,EAAE,MAAM,EAAE,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM;CAIlE"}