@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
@@ -0,0 +1,90 @@
1
+ import type { HttpClient } from '../http.js';
2
+ import type { Tweet, PaginationParams, PaginatedResponse, ApiResponse, CreateTweetParams, ReplyTweetParams, QuoteTweetParams, WriteResult, InteractionCheckResult, User, ConversationParams, TweetQuotesParams } from '../types.js';
3
+ export declare class TweetsResource {
4
+ private readonly http;
5
+ constructor(http: HttpClient);
6
+ /**
7
+ * Get a single tweet by ID.
8
+ */
9
+ get(tweetId: string): Promise<ApiResponse<Tweet>>;
10
+ /**
11
+ * Get the conversation thread for a tweet. `sort` is `latest` (default),
12
+ * `relevance` or `likes`. `meta.thread_context` holds the tweets above a
13
+ * mid-thread tweet (oldest first, not billed) and `meta.sort` the order used.
14
+ */
15
+ conversation(tweetId: string, params?: ConversationParams): Promise<PaginatedResponse<Tweet>>;
16
+ /**
17
+ * Get quote tweets of a tweet.
18
+ */
19
+ quotes(tweetId: string, params?: TweetQuotesParams): Promise<PaginatedResponse<Tweet>>;
20
+ /**
21
+ * Get the users who reposted a tweet. Billed per user returned.
22
+ */
23
+ retweeters(tweetId: string, params?: PaginationParams): Promise<PaginatedResponse<User>>;
24
+ /**
25
+ * Batch lookup multiple tweets by ID (max 100).
26
+ */
27
+ batch(tweetIds: string[]): Promise<ApiResponse<Tweet[]>>;
28
+ /**
29
+ * Create a new tweet. Requires a connected X account.
30
+ */
31
+ create(params: CreateTweetParams): Promise<ApiResponse<WriteResult>>;
32
+ /**
33
+ * Reply to a tweet. Requires a connected X account.
34
+ */
35
+ reply(params: ReplyTweetParams): Promise<ApiResponse<WriteResult>>;
36
+ /**
37
+ * Quote a tweet. Requires a connected X account.
38
+ */
39
+ quote(params: QuoteTweetParams): Promise<ApiResponse<WriteResult>>;
40
+ /**
41
+ * Delete a tweet. Requires a connected X account.
42
+ */
43
+ delete(tweetId: string): Promise<ApiResponse<{
44
+ success: boolean;
45
+ }>>;
46
+ /**
47
+ * Like a tweet. Requires a connected X account.
48
+ */
49
+ like(tweetId: string): Promise<ApiResponse<{
50
+ success: boolean;
51
+ }>>;
52
+ /**
53
+ * Unlike a tweet. Requires a connected X account.
54
+ */
55
+ unlike(tweetId: string): Promise<ApiResponse<{
56
+ success: boolean;
57
+ }>>;
58
+ /**
59
+ * Retweet a tweet. Requires a connected X account.
60
+ */
61
+ retweet(tweetId: string): Promise<ApiResponse<{
62
+ success: boolean;
63
+ }>>;
64
+ /**
65
+ * Unretweet a tweet. Requires a connected X account.
66
+ */
67
+ unretweet(tweetId: string): Promise<ApiResponse<{
68
+ success: boolean;
69
+ }>>;
70
+ /**
71
+ * Check if a user retweeted a tweet.
72
+ */
73
+ checkRetweet(tweetId: string, username: string): Promise<ApiResponse<InteractionCheckResult>>;
74
+ /**
75
+ * Check if a user replied to a tweet.
76
+ */
77
+ checkReply(tweetId: string, username: string): Promise<ApiResponse<InteractionCheckResult>>;
78
+ /**
79
+ * Check if a user quoted a tweet.
80
+ */
81
+ checkQuote(tweetId: string, username: string): Promise<ApiResponse<InteractionCheckResult>>;
82
+ }
83
+ type TweetPaginatedMethod<T> = (id: string, params: PaginationParams) => Promise<PaginatedResponse<T>>;
84
+ /**
85
+ * Async generator that auto-paginates a tweet-based paginated endpoint.
86
+ * @param maxPages Safety limit to prevent infinite loops (default 100).
87
+ */
88
+ export declare function paginateTweet<T>(method: TweetPaginatedMethod<T>, id: string, params?: PaginationParams, maxPages?: number): AsyncGenerator<T, void, undefined>;
89
+ export {};
90
+ //# sourceMappingURL=tweets.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tweets.d.ts","sourceRoot":"","sources":["../../../src/resources/tweets.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,KAAK,EACV,KAAK,EACL,gBAAgB,EAChB,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACjB,gBAAgB,EAChB,gBAAgB,EAChB,WAAW,EACX,sBAAsB,EACtB,IAAI,EACJ,kBAAkB,EAClB,iBAAiB,EAClB,MAAM,aAAa,CAAC;AAIrB,qBAAa,cAAc;IACb,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C;;OAEG;IACG,GAAG,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAOvD;;;;OAIG;IACG,YAAY,CAChB,OAAO,EAAE,MAAM,EACf,MAAM,GAAE,kBAAuB,GAC9B,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAcpC;;OAEG;IACG,MAAM,CACV,OAAO,EAAE,MAAM,EACf,MAAM,GAAE,iBAAsB,GAC7B,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAapC;;OAEG;IACG,UAAU,CACd,OAAO,EAAE,MAAM,EACf,MAAM,GAAE,gBAAqB,GAC5B,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAQnC;;OAEG;IACG,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC,KAAK,EAAE,CAAC,CAAC;IAU9D;;OAEG;IACG,MAAM,CAAC,MAAM,EAAE,iBAAiB,GAAG,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IAQ1E;;OAEG;IACG,KAAK,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IAQxE;;OAEG;IACG,KAAK,CAAC,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;IAQxE;;OAEG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IASzE;;OAEG;IACG,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAOvE;;OAEG;IACG,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAOzE;;OAEG;IACG,OAAO,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAO1E;;OAEG;IACG,SAAS,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAS5E;;OAEG;IACG,YAAY,CAChB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,WAAW,CAAC,sBAAsB,CAAC,CAAC;IAQ/C;;OAEG;IACG,UAAU,CACd,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,WAAW,CAAC,sBAAsB,CAAC,CAAC;IAQ/C;;OAEG;IACG,UAAU,CACd,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,GACf,OAAO,CAAC,WAAW,CAAC,sBAAsB,CAAC,CAAC;CAOhD;AAID,KAAK,oBAAoB,CAAC,CAAC,IAAI,CAC7B,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,gBAAgB,KACrB,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;AAEnC;;;GAGG;AACH,wBAAuB,aAAa,CAAC,CAAC,EACpC,MAAM,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAC/B,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,gBAAqB,EAC7B,QAAQ,GAAE,MAA0B,GACnC,cAAc,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,CAiBpC"}
@@ -0,0 +1,197 @@
1
+ const DEFAULT_MAX_PAGES = 100;
2
+ export class TweetsResource {
3
+ http;
4
+ constructor(http) {
5
+ this.http = http;
6
+ }
7
+ /**
8
+ * Get a single tweet by ID.
9
+ */
10
+ async get(tweetId) {
11
+ return this.http.request({
12
+ method: 'GET',
13
+ path: `/tweets/${encodeURIComponent(tweetId)}`,
14
+ });
15
+ }
16
+ /**
17
+ * Get the conversation thread for a tweet. `sort` is `latest` (default),
18
+ * `relevance` or `likes`. `meta.thread_context` holds the tweets above a
19
+ * mid-thread tweet (oldest first, not billed) and `meta.sort` the order used.
20
+ */
21
+ async conversation(tweetId, params = {}) {
22
+ return this.http.request({
23
+ method: 'GET',
24
+ path: `/tweets/${encodeURIComponent(tweetId)}/conversation`,
25
+ query: {
26
+ count: params.count,
27
+ cursor: params.cursor,
28
+ sort: params.sort,
29
+ since: params.since,
30
+ until: params.until,
31
+ },
32
+ });
33
+ }
34
+ /**
35
+ * Get quote tweets of a tweet.
36
+ */
37
+ async quotes(tweetId, params = {}) {
38
+ return this.http.request({
39
+ method: 'GET',
40
+ path: `/tweets/${encodeURIComponent(tweetId)}/quotes`,
41
+ query: {
42
+ count: params.count,
43
+ cursor: params.cursor,
44
+ since: params.since,
45
+ until: params.until,
46
+ },
47
+ });
48
+ }
49
+ /**
50
+ * Get the users who reposted a tweet. Billed per user returned.
51
+ */
52
+ async retweeters(tweetId, params = {}) {
53
+ return this.http.request({
54
+ method: 'GET',
55
+ path: `/tweets/${encodeURIComponent(tweetId)}/retweeters`,
56
+ query: { count: params.count, cursor: params.cursor },
57
+ });
58
+ }
59
+ /**
60
+ * Batch lookup multiple tweets by ID (max 100).
61
+ */
62
+ async batch(tweetIds) {
63
+ return this.http.request({
64
+ method: 'POST',
65
+ path: '/tweets/batch',
66
+ body: { tweet_ids: tweetIds },
67
+ });
68
+ }
69
+ // ─── Write Operations ────────────────────────────────────────
70
+ /**
71
+ * Create a new tweet. Requires a connected X account.
72
+ */
73
+ async create(params) {
74
+ return this.http.request({
75
+ method: 'POST',
76
+ path: '/tweets/create',
77
+ body: { text: params.text },
78
+ });
79
+ }
80
+ /**
81
+ * Reply to a tweet. Requires a connected X account.
82
+ */
83
+ async reply(params) {
84
+ return this.http.request({
85
+ method: 'POST',
86
+ path: '/tweets/reply',
87
+ body: { tweet_id: params.tweet_id, text: params.text },
88
+ });
89
+ }
90
+ /**
91
+ * Quote a tweet. Requires a connected X account.
92
+ */
93
+ async quote(params) {
94
+ return this.http.request({
95
+ method: 'POST',
96
+ path: '/tweets/quote',
97
+ body: { tweet_id: params.tweet_id, text: params.text },
98
+ });
99
+ }
100
+ /**
101
+ * Delete a tweet. Requires a connected X account.
102
+ */
103
+ async delete(tweetId) {
104
+ return this.http.request({
105
+ method: 'DELETE',
106
+ path: `/tweets/${encodeURIComponent(tweetId)}`,
107
+ });
108
+ }
109
+ // ─── Actions ──────────────────────────────────────────────────
110
+ /**
111
+ * Like a tweet. Requires a connected X account.
112
+ */
113
+ async like(tweetId) {
114
+ return this.http.request({
115
+ method: 'POST',
116
+ path: `/tweets/${encodeURIComponent(tweetId)}/like`,
117
+ });
118
+ }
119
+ /**
120
+ * Unlike a tweet. Requires a connected X account.
121
+ */
122
+ async unlike(tweetId) {
123
+ return this.http.request({
124
+ method: 'DELETE',
125
+ path: `/tweets/${encodeURIComponent(tweetId)}/like`,
126
+ });
127
+ }
128
+ /**
129
+ * Retweet a tweet. Requires a connected X account.
130
+ */
131
+ async retweet(tweetId) {
132
+ return this.http.request({
133
+ method: 'POST',
134
+ path: `/tweets/${encodeURIComponent(tweetId)}/retweet`,
135
+ });
136
+ }
137
+ /**
138
+ * Unretweet a tweet. Requires a connected X account.
139
+ */
140
+ async unretweet(tweetId) {
141
+ return this.http.request({
142
+ method: 'DELETE',
143
+ path: `/tweets/${encodeURIComponent(tweetId)}/retweet`,
144
+ });
145
+ }
146
+ // ─── Interaction Checks ───────────────────────────────────────
147
+ /**
148
+ * Check if a user retweeted a tweet.
149
+ */
150
+ async checkRetweet(tweetId, username) {
151
+ return this.http.request({
152
+ method: 'GET',
153
+ path: `/tweets/${encodeURIComponent(tweetId)}/check-retweet`,
154
+ query: { username },
155
+ });
156
+ }
157
+ /**
158
+ * Check if a user replied to a tweet.
159
+ */
160
+ async checkReply(tweetId, username) {
161
+ return this.http.request({
162
+ method: 'GET',
163
+ path: `/tweets/${encodeURIComponent(tweetId)}/check-reply`,
164
+ query: { username },
165
+ });
166
+ }
167
+ /**
168
+ * Check if a user quoted a tweet.
169
+ */
170
+ async checkQuote(tweetId, username) {
171
+ return this.http.request({
172
+ method: 'GET',
173
+ path: `/tweets/${encodeURIComponent(tweetId)}/check-quote`,
174
+ query: { username },
175
+ });
176
+ }
177
+ }
178
+ /**
179
+ * Async generator that auto-paginates a tweet-based paginated endpoint.
180
+ * @param maxPages Safety limit to prevent infinite loops (default 100).
181
+ */
182
+ export async function* paginateTweet(method, id, params = {}, maxPages = DEFAULT_MAX_PAGES) {
183
+ let cursor = params.cursor;
184
+ let hasNext = true;
185
+ let page = 0;
186
+ while (hasNext && page < maxPages) {
187
+ const response = await method(id, { ...params, cursor });
188
+ const items = response.data;
189
+ for (const item of items) {
190
+ yield item;
191
+ }
192
+ cursor = response.meta.cursor;
193
+ hasNext = !!response.meta.has_next && !!cursor;
194
+ page++;
195
+ }
196
+ }
197
+ //# sourceMappingURL=tweets.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tweets.js","sourceRoot":"","sources":["../../../src/resources/tweets.ts"],"names":[],"mappings":"AAgBA,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAE9B,MAAM,OAAO,cAAc;IACI;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD;;OAEG;IACH,KAAK,CAAC,GAAG,CAAC,OAAe;QACvB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAQ;YAC9B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,WAAW,kBAAkB,CAAC,OAAO,CAAC,EAAE;SAC/C,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,YAAY,CAChB,OAAe,EACf,SAA6B,EAAE;QAE/B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,WAAW,kBAAkB,CAAC,OAAO,CAAC,eAAe;YAC3D,KAAK,EAAE;gBACL,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,KAAK,EAAE,MAAM,CAAC,KAAK;aACpB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,OAAe,EACf,SAA4B,EAAE;QAE9B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,WAAW,kBAAkB,CAAC,OAAO,CAAC,SAAS;YACrD,KAAK,EAAE;gBACL,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,KAAK,EAAE,MAAM,CAAC,KAAK;aACpB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CACd,OAAe,EACf,SAA2B,EAAE;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,WAAW,kBAAkB,CAAC,OAAO,CAAC,aAAa;YACzD,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE;SACtD,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK,CAAC,QAAkB;QAC5B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAU;YAChC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,eAAe;YACrB,IAAI,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE;SAC9B,CAAC,CAAC;IACL,CAAC;IAED,gEAAgE;IAEhE;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,MAAyB;QACpC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAc;YACpC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,gBAAgB;YACtB,IAAI,EAAE,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE;SAC5B,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK,CAAC,MAAwB;QAClC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAc;YACpC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,eAAe;YACrB,IAAI,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE;SACvD,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK,CAAC,MAAwB;QAClC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAc;YACpC,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,eAAe;YACrB,IAAI,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE;SACvD,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,OAAe;QAC1B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAuB;YAC7C,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,WAAW,kBAAkB,CAAC,OAAO,CAAC,EAAE;SAC/C,CAAC,CAAC;IACL,CAAC;IAED,iEAAiE;IAEjE;;OAEG;IACH,KAAK,CAAC,IAAI,CAAC,OAAe;QACxB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAuB;YAC7C,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,WAAW,kBAAkB,CAAC,OAAO,CAAC,OAAO;SACpD,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,OAAe;QAC1B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAuB;YAC7C,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,WAAW,kBAAkB,CAAC,OAAO,CAAC,OAAO;SACpD,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CAAC,OAAe;QAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAuB;YAC7C,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,WAAW,kBAAkB,CAAC,OAAO,CAAC,UAAU;SACvD,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CAAC,OAAe;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAuB;YAC7C,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,WAAW,kBAAkB,CAAC,OAAO,CAAC,UAAU;SACvD,CAAC,CAAC;IACL,CAAC;IAED,iEAAiE;IAEjE;;OAEG;IACH,KAAK,CAAC,YAAY,CAChB,OAAe,EACf,QAAgB;QAEhB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAyB;YAC/C,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,WAAW,kBAAkB,CAAC,OAAO,CAAC,gBAAgB;YAC5D,KAAK,EAAE,EAAE,QAAQ,EAAE;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CACd,OAAe,EACf,QAAgB;QAEhB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAyB;YAC/C,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,WAAW,kBAAkB,CAAC,OAAO,CAAC,cAAc;YAC1D,KAAK,EAAE,EAAE,QAAQ,EAAE;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,UAAU,CACd,OAAe,EACf,QAAgB;QAEhB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAyB;YAC/C,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,WAAW,kBAAkB,CAAC,OAAO,CAAC,cAAc;YAC1D,KAAK,EAAE,EAAE,QAAQ,EAAE;SACpB,CAAC,CAAC;IACL,CAAC;CACF;AASD;;;GAGG;AACH,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,aAAa,CAClC,MAA+B,EAC/B,EAAU,EACV,SAA2B,EAAE,EAC7B,WAAmB,iBAAiB;IAEpC,IAAI,MAAM,GAAuB,MAAM,CAAC,MAAM,CAAC;IAC/C,IAAI,OAAO,GAAG,IAAI,CAAC;IACnB,IAAI,IAAI,GAAG,CAAC,CAAC;IAEb,OAAO,OAAO,IAAI,IAAI,GAAG,QAAQ,EAAE,CAAC;QAClC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,EAAE,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;QACzD,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC;QAE5B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,IAAI,CAAC;QACb,CAAC;QAED,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC;QAC9B,OAAO,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,MAAM,CAAC;QAC/C,IAAI,EAAE,CAAC;IACT,CAAC;AACH,CAAC"}
@@ -0,0 +1,96 @@
1
+ import type { HttpClient } from '../http.js';
2
+ import type { User, Tweet, PaginationParams, PaginatedResponse, ApiResponse, CheckFollowResult, QualifiedAccountParams, QualifiedAccountResult, QualifiedNameParams, QualifiedNameResult, FollowersIdsParams, FollowersIdsResponse, UserLookupParams, UserPaginationParams, UserListParams, UserMentionsParams } from '../types.js';
3
+ export declare class UsersResource {
4
+ private readonly http;
5
+ constructor(http: HttpClient);
6
+ /**
7
+ * Get a user profile by username. Pass `id:<digits>` as the username (or
8
+ * `{ user_id }`) to look a user up by numeric id.
9
+ */
10
+ get(username: string, params?: UserLookupParams): Promise<ApiResponse<User>>;
11
+ /**
12
+ * Get a user's tweets.
13
+ */
14
+ tweets(username: string, params?: UserPaginationParams): Promise<PaginatedResponse<Tweet>>;
15
+ /**
16
+ * Get a user's mentions.
17
+ */
18
+ mentions(username: string, params?: UserMentionsParams): Promise<PaginatedResponse<Tweet>>;
19
+ /**
20
+ * Get a user's followers. With `include_unavailable: true`, suspended or
21
+ * deactivated accounts also come back as rows `{ id, unavailable: true,
22
+ * unavailable_reason, ...every other field null }` (not billed). Same
23
+ * option on `following()` and `verifiedFollowers()`.
24
+ */
25
+ followers(username: string, params?: UserListParams): Promise<PaginatedResponse<User>>;
26
+ /**
27
+ * Get users that a user is following.
28
+ */
29
+ following(username: string, params?: UserListParams): Promise<PaginatedResponse<User>>;
30
+ /**
31
+ * Get a user's replies.
32
+ */
33
+ replies(username: string, params?: UserPaginationParams): Promise<PaginatedResponse<Tweet>>;
34
+ /**
35
+ * Get a user's media tweets.
36
+ */
37
+ media(username: string, params?: UserPaginationParams): Promise<PaginatedResponse<Tweet>>;
38
+ /**
39
+ * Get a user's verified (blue) followers.
40
+ */
41
+ verifiedFollowers(username: string, params?: UserListParams): Promise<PaginatedResponse<User>>;
42
+ /**
43
+ * Get up to 5000 raw follower IDs (no profile metadata). Cheaper and
44
+ * faster than `followers()` for large-scale ID harvesting.
45
+ */
46
+ followersIds(username: string, params?: FollowersIdsParams): Promise<FollowersIdsResponse>;
47
+ /**
48
+ * Get up to 5000 raw IDs of the accounts a user follows (no profile
49
+ * metadata). Mirror of `followersIds()`.
50
+ */
51
+ followingIds(username: string, params?: FollowersIdsParams): Promise<FollowersIdsResponse>;
52
+ /**
53
+ * Batch lookup multiple users by username (max 100).
54
+ */
55
+ batch(usernames: string[]): Promise<ApiResponse<User[]>>;
56
+ /**
57
+ * Batch lookup multiple users by numeric id (max 100). Ids are sent as
58
+ * strings; numbers above 2^53 lose precision in JavaScript, so pass those as
59
+ * strings. Ids X does not return are listed in `meta.not_found`.
60
+ */
61
+ batchByIds(ids: Array<string | number>): Promise<ApiResponse<User[]>>;
62
+ /**
63
+ * Check whether `source` follows `target` (and vice versa).
64
+ */
65
+ checkFollow(source: string, target: string): Promise<ApiResponse<CheckFollowResult>>;
66
+ /**
67
+ * Check if an account is eligible by minimum followers / account age.
68
+ * For airdrop/giveaway gating.
69
+ */
70
+ checkQualifiedAccount(username: string, params?: QualifiedAccountParams): Promise<ApiResponse<QualifiedAccountResult>>;
71
+ /**
72
+ * Check if a user's display name contains required text. For
73
+ * airdrop/giveaway gating.
74
+ */
75
+ checkQualifiedName(username: string, params: QualifiedNameParams): Promise<ApiResponse<QualifiedNameResult>>;
76
+ /**
77
+ * Follow a user. Requires a connected X account.
78
+ */
79
+ follow(username: string): Promise<ApiResponse<{
80
+ success: boolean;
81
+ }>>;
82
+ /**
83
+ * Unfollow a user. Requires a connected X account.
84
+ */
85
+ unfollow(username: string): Promise<ApiResponse<{
86
+ success: boolean;
87
+ }>>;
88
+ }
89
+ type PaginatedMethod<T> = (username: string, params: PaginationParams) => Promise<PaginatedResponse<T>>;
90
+ /**
91
+ * Async generator that auto-paginates a user-based paginated endpoint.
92
+ * @param maxPages Safety limit to prevent infinite loops (default 100).
93
+ */
94
+ export declare function paginateUser<T>(method: PaginatedMethod<T>, username: string, params?: PaginationParams, maxPages?: number): AsyncGenerator<T, void, undefined>;
95
+ export {};
96
+ //# sourceMappingURL=users.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"users.d.ts","sourceRoot":"","sources":["../../../src/resources/users.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,KAAK,EACV,IAAI,EACJ,KAAK,EACL,gBAAgB,EAChB,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EACjB,sBAAsB,EACtB,sBAAsB,EACtB,mBAAmB,EACnB,mBAAmB,EACnB,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,oBAAoB,EACpB,cAAc,EACd,kBAAkB,EACnB,MAAM,aAAa,CAAC;AAYrB,qBAAa,aAAa;IACZ,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C;;;OAGG;IACG,GAAG,CACP,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,gBAAqB,GAC5B,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAQ7B;;OAEG;IACG,MAAM,CACV,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,oBAAyB,GAChC,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAQpC;;OAEG;IACG,QAAQ,CACZ,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,kBAAuB,GAC9B,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAcpC;;;;;OAKG;IACG,SAAS,CACb,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,cAAmB,GAC1B,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAanC;;OAEG;IACG,SAAS,CACb,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,cAAmB,GAC1B,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAanC;;OAEG;IACG,OAAO,CACX,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,oBAAyB,GAChC,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAQpC;;OAEG;IACG,KAAK,CACT,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,oBAAyB,GAChC,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAQpC;;OAEG;IACG,iBAAiB,CACrB,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,cAAmB,GAC1B,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAanC;;;OAGG;IACG,YAAY,CAChB,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,kBAAuB,GAC9B,OAAO,CAAC,oBAAoB,CAAC;IAQhC;;;OAGG;IACG,YAAY,CAChB,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,kBAAuB,GAC9B,OAAO,CAAC,oBAAoB,CAAC;IAQhC;;OAEG;IACG,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;IAQ9D;;;;OAIG;IACG,UAAU,CAAC,GAAG,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;IAQ3E;;OAEG;IACG,WAAW,CACf,MAAM,EAAE,MAAM,EACd,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,WAAW,CAAC,iBAAiB,CAAC,CAAC;IAQ1C;;;OAGG;IACG,qBAAqB,CACzB,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,sBAA2B,GAClC,OAAO,CAAC,WAAW,CAAC,sBAAsB,CAAC,CAAC;IAQ/C;;;OAGG;IACG,kBAAkB,CACtB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,mBAAmB,GAC1B,OAAO,CAAC,WAAW,CAAC,mBAAmB,CAAC,CAAC;IAQ5C;;OAEG;IACG,MAAM,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;IAO1E;;OAEG;IACG,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAC,CAAC;CAM7E;AAID,KAAK,eAAe,CAAC,CAAC,IAAI,CACxB,QAAQ,EAAE,MAAM,EAChB,MAAM,EAAE,gBAAgB,KACrB,OAAO,CAAC,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC;AAEnC;;;GAGG;AACH,wBAAuB,YAAY,CAAC,CAAC,EACnC,MAAM,EAAE,eAAe,CAAC,CAAC,CAAC,EAC1B,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,gBAAqB,EAC7B,QAAQ,GAAE,MAA0B,GACnC,cAAc,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,CAAC,CAiBpC"}
@@ -0,0 +1,233 @@
1
+ const DEFAULT_MAX_PAGES = 100;
2
+ /**
3
+ * Path segment for a user route: the username, or `id:<user_id>` when only a numeric id was given (an empty segment
4
+ * would hit `/users/` and never reach the user route).
5
+ */
6
+ function userSeg(username, userId) {
7
+ return username ? username : userId != null && String(userId) !== '' ? `id:${userId}` : username;
8
+ }
9
+ export class UsersResource {
10
+ http;
11
+ constructor(http) {
12
+ this.http = http;
13
+ }
14
+ /**
15
+ * Get a user profile by username. Pass `id:<digits>` as the username (or
16
+ * `{ user_id }`) to look a user up by numeric id.
17
+ */
18
+ async get(username, params = {}) {
19
+ return this.http.request({
20
+ method: 'GET',
21
+ path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}`,
22
+ query: { user_id: params.user_id },
23
+ });
24
+ }
25
+ /**
26
+ * Get a user's tweets.
27
+ */
28
+ async tweets(username, params = {}) {
29
+ return this.http.request({
30
+ method: 'GET',
31
+ path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}/tweets`,
32
+ query: { count: params.count, cursor: params.cursor, user_id: params.user_id },
33
+ });
34
+ }
35
+ /**
36
+ * Get a user's mentions.
37
+ */
38
+ async mentions(username, params = {}) {
39
+ return this.http.request({
40
+ method: 'GET',
41
+ path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}/mentions`,
42
+ query: {
43
+ count: params.count,
44
+ cursor: params.cursor,
45
+ user_id: params.user_id,
46
+ since: params.since,
47
+ until: params.until,
48
+ },
49
+ });
50
+ }
51
+ /**
52
+ * Get a user's followers. With `include_unavailable: true`, suspended or
53
+ * deactivated accounts also come back as rows `{ id, unavailable: true,
54
+ * unavailable_reason, ...every other field null }` (not billed). Same
55
+ * option on `following()` and `verifiedFollowers()`.
56
+ */
57
+ async followers(username, params = {}) {
58
+ return this.http.request({
59
+ method: 'GET',
60
+ path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}/followers`,
61
+ query: {
62
+ count: params.count,
63
+ cursor: params.cursor,
64
+ user_id: params.user_id,
65
+ include_unavailable: params.include_unavailable,
66
+ },
67
+ });
68
+ }
69
+ /**
70
+ * Get users that a user is following.
71
+ */
72
+ async following(username, params = {}) {
73
+ return this.http.request({
74
+ method: 'GET',
75
+ path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}/following`,
76
+ query: {
77
+ count: params.count,
78
+ cursor: params.cursor,
79
+ user_id: params.user_id,
80
+ include_unavailable: params.include_unavailable,
81
+ },
82
+ });
83
+ }
84
+ /**
85
+ * Get a user's replies.
86
+ */
87
+ async replies(username, params = {}) {
88
+ return this.http.request({
89
+ method: 'GET',
90
+ path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}/replies`,
91
+ query: { count: params.count, cursor: params.cursor, user_id: params.user_id },
92
+ });
93
+ }
94
+ /**
95
+ * Get a user's media tweets.
96
+ */
97
+ async media(username, params = {}) {
98
+ return this.http.request({
99
+ method: 'GET',
100
+ path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}/media`,
101
+ query: { count: params.count, cursor: params.cursor, user_id: params.user_id },
102
+ });
103
+ }
104
+ /**
105
+ * Get a user's verified (blue) followers.
106
+ */
107
+ async verifiedFollowers(username, params = {}) {
108
+ return this.http.request({
109
+ method: 'GET',
110
+ path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}/verified-followers`,
111
+ query: {
112
+ count: params.count,
113
+ cursor: params.cursor,
114
+ user_id: params.user_id,
115
+ include_unavailable: params.include_unavailable,
116
+ },
117
+ });
118
+ }
119
+ /**
120
+ * Get up to 5000 raw follower IDs (no profile metadata). Cheaper and
121
+ * faster than `followers()` for large-scale ID harvesting.
122
+ */
123
+ async followersIds(username, params = {}) {
124
+ return this.http.request({
125
+ method: 'GET',
126
+ path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}/followers-ids`,
127
+ query: { count: params.count, cursor: params.cursor, user_id: params.user_id },
128
+ });
129
+ }
130
+ /**
131
+ * Get up to 5000 raw IDs of the accounts a user follows (no profile
132
+ * metadata). Mirror of `followersIds()`.
133
+ */
134
+ async followingIds(username, params = {}) {
135
+ return this.http.request({
136
+ method: 'GET',
137
+ path: `/users/${encodeURIComponent(userSeg(username, params.user_id))}/following-ids`,
138
+ query: { count: params.count, cursor: params.cursor, user_id: params.user_id },
139
+ });
140
+ }
141
+ /**
142
+ * Batch lookup multiple users by username (max 100).
143
+ */
144
+ async batch(usernames) {
145
+ return this.http.request({
146
+ method: 'POST',
147
+ path: '/users/batch',
148
+ body: { usernames },
149
+ });
150
+ }
151
+ /**
152
+ * Batch lookup multiple users by numeric id (max 100). Ids are sent as
153
+ * strings; numbers above 2^53 lose precision in JavaScript, so pass those as
154
+ * strings. Ids X does not return are listed in `meta.not_found`.
155
+ */
156
+ async batchByIds(ids) {
157
+ return this.http.request({
158
+ method: 'POST',
159
+ path: '/users/batch',
160
+ body: { ids: ids.map((id) => String(id)) },
161
+ });
162
+ }
163
+ /**
164
+ * Check whether `source` follows `target` (and vice versa).
165
+ */
166
+ async checkFollow(source, target) {
167
+ return this.http.request({
168
+ method: 'GET',
169
+ path: '/users/check-follow',
170
+ query: { source, target },
171
+ });
172
+ }
173
+ /**
174
+ * Check if an account is eligible by minimum followers / account age.
175
+ * For airdrop/giveaway gating.
176
+ */
177
+ async checkQualifiedAccount(username, params = {}) {
178
+ return this.http.request({
179
+ method: 'GET',
180
+ path: `/users/${encodeURIComponent(username)}/check-qualified-account`,
181
+ query: { min_followers: params.min_followers, min_age_days: params.min_age_days },
182
+ });
183
+ }
184
+ /**
185
+ * Check if a user's display name contains required text. For
186
+ * airdrop/giveaway gating.
187
+ */
188
+ async checkQualifiedName(username, params) {
189
+ return this.http.request({
190
+ method: 'GET',
191
+ path: `/users/${encodeURIComponent(username)}/check-qualified-name`,
192
+ query: { contains: params.contains, position: params.position },
193
+ });
194
+ }
195
+ /**
196
+ * Follow a user. Requires a connected X account.
197
+ */
198
+ async follow(username) {
199
+ return this.http.request({
200
+ method: 'POST',
201
+ path: `/users/${encodeURIComponent(username)}/follow`,
202
+ });
203
+ }
204
+ /**
205
+ * Unfollow a user. Requires a connected X account.
206
+ */
207
+ async unfollow(username) {
208
+ return this.http.request({
209
+ method: 'DELETE',
210
+ path: `/users/${encodeURIComponent(username)}/follow`,
211
+ });
212
+ }
213
+ }
214
+ /**
215
+ * Async generator that auto-paginates a user-based paginated endpoint.
216
+ * @param maxPages Safety limit to prevent infinite loops (default 100).
217
+ */
218
+ export async function* paginateUser(method, username, params = {}, maxPages = DEFAULT_MAX_PAGES) {
219
+ let cursor = params.cursor;
220
+ let hasNext = true;
221
+ let page = 0;
222
+ while (hasNext && page < maxPages) {
223
+ const response = await method(username, { ...params, cursor });
224
+ const items = response.data;
225
+ for (const item of items) {
226
+ yield item;
227
+ }
228
+ cursor = response.meta.cursor;
229
+ hasNext = !!response.meta.has_next && !!cursor;
230
+ page++;
231
+ }
232
+ }
233
+ //# sourceMappingURL=users.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"users.js","sourceRoot":"","sources":["../../../src/resources/users.ts"],"names":[],"mappings":"AAoBA,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAE9B;;;GAGG;AACH,SAAS,OAAO,CAAC,QAAgB,EAAE,MAAwB;IACzD,OAAO,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,IAAI,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,MAAM,MAAM,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;AACnG,CAAC;AAED,MAAM,OAAO,aAAa;IACK;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD;;;OAGG;IACH,KAAK,CAAC,GAAG,CACP,QAAgB,EAChB,SAA2B,EAAE;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAO;YAC7B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE;YACvE,KAAK,EAAE,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;SACnC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,QAAgB,EAChB,SAA+B,EAAE;QAEjC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS;YAC9E,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;SAC/E,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CACZ,QAAgB,EAChB,SAA6B,EAAE;QAE/B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,WAAW;YAChF,KAAK,EAAE;gBACL,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,KAAK,EAAE,MAAM,CAAC,KAAK;aACpB;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CACb,QAAgB,EAChB,SAAyB,EAAE;QAE3B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY;YACjF,KAAK,EAAE;gBACL,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,mBAAmB,EAAE,MAAM,CAAC,mBAAmB;aAChD;SACF,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,SAAS,CACb,QAAgB,EAChB,SAAyB,EAAE;QAE3B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,YAAY;YACjF,KAAK,EAAE;gBACL,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,mBAAmB,EAAE,MAAM,CAAC,mBAAmB;aAChD;SACF,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,OAAO,CACX,QAAgB,EAChB,SAA+B,EAAE;QAEjC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,UAAU;YAC/E,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;SAC/E,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK,CACT,QAAgB,EAChB,SAA+B,EAAE;QAEjC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,QAAQ;YAC7E,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;SAC/E,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,iBAAiB,CACrB,QAAgB,EAChB,SAAyB,EAAE;QAE3B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,qBAAqB;YAC1F,KAAK,EAAE;gBACL,KAAK,EAAE,MAAM,CAAC,KAAK;gBACnB,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,mBAAmB,EAAE,MAAM,CAAC,mBAAmB;aAChD;SACF,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAChB,QAAgB,EAChB,SAA6B,EAAE;QAE/B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAW;YACjC,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,gBAAgB;YACrF,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;SAC/E,CAA6C,CAAC;IACjD,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,YAAY,CAChB,QAAgB,EAChB,SAA6B,EAAE;QAE/B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAW;YACjC,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,gBAAgB;YACrF,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE;SAC/E,CAA6C,CAAC;IACjD,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,KAAK,CAAC,SAAmB;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAS;YAC/B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,cAAc;YACpB,IAAI,EAAE,EAAE,SAAS,EAAE;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU,CAAC,GAA2B;QAC1C,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAS;YAC/B,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,cAAc;YACpB,IAAI,EAAE,EAAE,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,EAAE;SAC3C,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CACf,MAAc,EACd,MAAc;QAEd,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAoB;YAC1C,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,qBAAqB;YAC3B,KAAK,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE;SAC1B,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,qBAAqB,CACzB,QAAgB,EAChB,SAAiC,EAAE;QAEnC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAyB;YAC/C,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,QAAQ,CAAC,0BAA0B;YACtE,KAAK,EAAE,EAAE,aAAa,EAAE,MAAM,CAAC,aAAa,EAAE,YAAY,EAAE,MAAM,CAAC,YAAY,EAAE;SAClF,CAAC,CAAC;IACL,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,kBAAkB,CACtB,QAAgB,EAChB,MAA2B;QAE3B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAsB;YAC5C,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,QAAQ,CAAC,uBAAuB;YACnE,KAAK,EAAE,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE;SAChE,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CAAC,QAAgB;QAC3B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAuB;YAC7C,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,UAAU,kBAAkB,CAAC,QAAQ,CAAC,SAAS;SACtD,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,QAAQ,CAAC,QAAgB;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAuB;YAC7C,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,UAAU,kBAAkB,CAAC,QAAQ,CAAC,SAAS;SACtD,CAAC,CAAC;IACL,CAAC;CACF;AASD;;;GAGG;AACH,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,YAAY,CACjC,MAA0B,EAC1B,QAAgB,EAChB,SAA2B,EAAE,EAC7B,WAAmB,iBAAiB;IAEpC,IAAI,MAAM,GAAuB,MAAM,CAAC,MAAM,CAAC;IAC/C,IAAI,OAAO,GAAG,IAAI,CAAC;IACnB,IAAI,IAAI,GAAG,CAAC,CAAC;IAEb,OAAO,OAAO,IAAI,IAAI,GAAG,QAAQ,EAAE,CAAC;QAClC,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,QAAQ,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;QAC/D,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC;QAE5B,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,IAAI,CAAC;QACb,CAAC;QAED,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC;QAC9B,OAAO,GAAG,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC,MAAM,CAAC;QAC/C,IAAI,EAAE,CAAC;IACT,CAAC;AACH,CAAC"}