@xcrop/sdk 0.0.0-stage → 1.0.1

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 +361 -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 +38 -0
  8. package/dist/cjs/errors.d.ts.map +1 -0
  9. package/dist/cjs/errors.js +70 -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 +24 -0
  21. package/dist/cjs/resources/account.d.ts.map +1 -0
  22. package/dist/cjs/resources/account.js +54 -0
  23. package/dist/cjs/resources/account.js.map +1 -0
  24. package/dist/cjs/resources/communities.d.ts +26 -0
  25. package/dist/cjs/resources/communities.d.ts.map +1 -0
  26. package/dist/cjs/resources/communities.js +47 -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 +61 -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 +84 -0
  45. package/dist/cjs/resources/tweets.d.ts.map +1 -0
  46. package/dist/cjs/resources/tweets.js +179 -0
  47. package/dist/cjs/resources/tweets.js.map +1 -0
  48. package/dist/cjs/resources/users.d.ts +81 -0
  49. package/dist/cjs/resources/users.d.ts.map +1 -0
  50. package/dist/cjs/resources/users.js +182 -0
  51. package/dist/cjs/resources/users.js.map +1 -0
  52. package/dist/cjs/types.d.ts +256 -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 +38 -0
  61. package/dist/esm/errors.d.ts.map +1 -0
  62. package/dist/esm/errors.js +62 -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 +24 -0
  73. package/dist/esm/resources/account.d.ts.map +1 -0
  74. package/dist/esm/resources/account.js +50 -0
  75. package/dist/esm/resources/account.js.map +1 -0
  76. package/dist/esm/resources/communities.d.ts +26 -0
  77. package/dist/esm/resources/communities.d.ts.map +1 -0
  78. package/dist/esm/resources/communities.js +43 -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 +56 -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 +84 -0
  97. package/dist/esm/resources/tweets.d.ts.map +1 -0
  98. package/dist/esm/resources/tweets.js +174 -0
  99. package/dist/esm/resources/tweets.js.map +1 -0
  100. package/dist/esm/resources/users.d.ts +81 -0
  101. package/dist/esm/resources/users.d.ts.map +1 -0
  102. package/dist/esm/resources/users.js +177 -0
  103. package/dist/esm/resources/users.js.map +1 -0
  104. package/dist/esm/types.d.ts +256 -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,179 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.TweetsResource = void 0;
4
+ exports.paginateTweet = paginateTweet;
5
+ const DEFAULT_MAX_PAGES = 100;
6
+ class TweetsResource {
7
+ http;
8
+ constructor(http) {
9
+ this.http = http;
10
+ }
11
+ /**
12
+ * Get a single tweet by ID.
13
+ */
14
+ async get(tweetId) {
15
+ return this.http.request({
16
+ method: 'GET',
17
+ path: `/tweets/${encodeURIComponent(tweetId)}`,
18
+ });
19
+ }
20
+ /**
21
+ * Get the conversation thread for a tweet.
22
+ */
23
+ async conversation(tweetId, params = {}) {
24
+ return this.http.request({
25
+ method: 'GET',
26
+ path: `/tweets/${encodeURIComponent(tweetId)}/conversation`,
27
+ query: { count: params.count, cursor: params.cursor },
28
+ });
29
+ }
30
+ /**
31
+ * Get quote tweets of a tweet.
32
+ */
33
+ async quotes(tweetId, params = {}) {
34
+ return this.http.request({
35
+ method: 'GET',
36
+ path: `/tweets/${encodeURIComponent(tweetId)}/quotes`,
37
+ query: { count: params.count, cursor: params.cursor },
38
+ });
39
+ }
40
+ /**
41
+ * Batch lookup multiple tweets by ID (max 100).
42
+ */
43
+ async batch(tweetIds) {
44
+ return this.http.request({
45
+ method: 'POST',
46
+ path: '/tweets/batch',
47
+ body: { tweet_ids: tweetIds },
48
+ });
49
+ }
50
+ // ─── Write Operations ────────────────────────────────────────
51
+ /**
52
+ * Create a new tweet. Requires a connected X account.
53
+ */
54
+ async create(params) {
55
+ return this.http.request({
56
+ method: 'POST',
57
+ path: '/tweets/create',
58
+ body: { text: params.text },
59
+ });
60
+ }
61
+ /**
62
+ * Reply to a tweet. Requires a connected X account.
63
+ */
64
+ async reply(params) {
65
+ return this.http.request({
66
+ method: 'POST',
67
+ path: '/tweets/reply',
68
+ body: { tweet_id: params.tweet_id, text: params.text },
69
+ });
70
+ }
71
+ /**
72
+ * Quote a tweet. Requires a connected X account.
73
+ */
74
+ async quote(params) {
75
+ return this.http.request({
76
+ method: 'POST',
77
+ path: '/tweets/quote',
78
+ body: { tweet_id: params.tweet_id, text: params.text },
79
+ });
80
+ }
81
+ /**
82
+ * Delete a tweet. Requires a connected X account.
83
+ */
84
+ async delete(tweetId) {
85
+ return this.http.request({
86
+ method: 'DELETE',
87
+ path: `/tweets/${encodeURIComponent(tweetId)}`,
88
+ });
89
+ }
90
+ // ─── Actions ──────────────────────────────────────────────────
91
+ /**
92
+ * Like a tweet. Requires a connected X account.
93
+ */
94
+ async like(tweetId) {
95
+ return this.http.request({
96
+ method: 'POST',
97
+ path: `/tweets/${encodeURIComponent(tweetId)}/like`,
98
+ });
99
+ }
100
+ /**
101
+ * Unlike a tweet. Requires a connected X account.
102
+ */
103
+ async unlike(tweetId) {
104
+ return this.http.request({
105
+ method: 'DELETE',
106
+ path: `/tweets/${encodeURIComponent(tweetId)}/like`,
107
+ });
108
+ }
109
+ /**
110
+ * Retweet a tweet. Requires a connected X account.
111
+ */
112
+ async retweet(tweetId) {
113
+ return this.http.request({
114
+ method: 'POST',
115
+ path: `/tweets/${encodeURIComponent(tweetId)}/retweet`,
116
+ });
117
+ }
118
+ /**
119
+ * Unretweet a tweet. Requires a connected X account.
120
+ */
121
+ async unretweet(tweetId) {
122
+ return this.http.request({
123
+ method: 'DELETE',
124
+ path: `/tweets/${encodeURIComponent(tweetId)}/retweet`,
125
+ });
126
+ }
127
+ // ─── Interaction Checks ───────────────────────────────────────
128
+ /**
129
+ * Check if a user retweeted a tweet.
130
+ */
131
+ async checkRetweet(tweetId, username) {
132
+ return this.http.request({
133
+ method: 'GET',
134
+ path: `/tweets/${encodeURIComponent(tweetId)}/check-retweet`,
135
+ query: { username },
136
+ });
137
+ }
138
+ /**
139
+ * Check if a user replied to a tweet.
140
+ */
141
+ async checkReply(tweetId, username) {
142
+ return this.http.request({
143
+ method: 'GET',
144
+ path: `/tweets/${encodeURIComponent(tweetId)}/check-reply`,
145
+ query: { username },
146
+ });
147
+ }
148
+ /**
149
+ * Check if a user quoted a tweet.
150
+ */
151
+ async checkQuote(tweetId, username) {
152
+ return this.http.request({
153
+ method: 'GET',
154
+ path: `/tweets/${encodeURIComponent(tweetId)}/check-quote`,
155
+ query: { username },
156
+ });
157
+ }
158
+ }
159
+ exports.TweetsResource = TweetsResource;
160
+ /**
161
+ * Async generator that auto-paginates a tweet-based paginated endpoint.
162
+ * @param maxPages Safety limit to prevent infinite loops (default 100).
163
+ */
164
+ async function* paginateTweet(method, id, params = {}, maxPages = DEFAULT_MAX_PAGES) {
165
+ let cursor = params.cursor;
166
+ let hasNext = true;
167
+ let page = 0;
168
+ while (hasNext && page < maxPages) {
169
+ const response = await method(id, { ...params, cursor });
170
+ const items = response.data;
171
+ for (const item of items) {
172
+ yield item;
173
+ }
174
+ cursor = response.meta.cursor;
175
+ hasNext = !!response.meta.has_next && !!cursor;
176
+ page++;
177
+ }
178
+ }
179
+ //# sourceMappingURL=tweets.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tweets.js","sourceRoot":"","sources":["../../../src/resources/tweets.ts"],"names":[],"mappings":";;;AAkNA,sCAsBC;AA3ND,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAE9B,MAAa,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;;OAEG;IACH,KAAK,CAAC,YAAY,CAChB,OAAe,EACf,SAA2B,EAAE;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,WAAW,kBAAkB,CAAC,OAAO,CAAC,eAAe;YAC3D,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,MAAM,CACV,OAAe,EACf,SAA2B,EAAE;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,WAAW,kBAAkB,CAAC,OAAO,CAAC,SAAS;YACrD,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;AAtLD,wCAsLC;AASD;;;GAGG;AACI,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,81 @@
1
+ import type { HttpClient } from '../http.js';
2
+ import type { User, Tweet, PaginationParams, PaginatedResponse, ApiResponse, CheckFollowResult, QualifiedAccountParams, QualifiedAccountResult, QualifiedNameParams, QualifiedNameResult, FollowersIdsParams, FollowersIdsResponse } from '../types.js';
3
+ export declare class UsersResource {
4
+ private readonly http;
5
+ constructor(http: HttpClient);
6
+ /**
7
+ * Get a user profile by username.
8
+ */
9
+ get(username: string): Promise<ApiResponse<User>>;
10
+ /**
11
+ * Get a user's tweets.
12
+ */
13
+ tweets(username: string, params?: PaginationParams): Promise<PaginatedResponse<Tweet>>;
14
+ /**
15
+ * Get a user's mentions.
16
+ */
17
+ mentions(username: string, params?: PaginationParams): Promise<PaginatedResponse<Tweet>>;
18
+ /**
19
+ * Get a user's followers.
20
+ */
21
+ followers(username: string, params?: PaginationParams): Promise<PaginatedResponse<User>>;
22
+ /**
23
+ * Get users that a user is following.
24
+ */
25
+ following(username: string, params?: PaginationParams): Promise<PaginatedResponse<User>>;
26
+ /**
27
+ * Get a user's replies.
28
+ */
29
+ replies(username: string, params?: PaginationParams): Promise<PaginatedResponse<Tweet>>;
30
+ /**
31
+ * Get a user's media tweets.
32
+ */
33
+ media(username: string, params?: PaginationParams): Promise<PaginatedResponse<Tweet>>;
34
+ /**
35
+ * Get a user's verified (blue) followers.
36
+ */
37
+ verifiedFollowers(username: string, params?: PaginationParams): Promise<PaginatedResponse<User>>;
38
+ /**
39
+ * Get up to 5000 raw follower IDs (no profile metadata). Cheaper and
40
+ * faster than `followers()` for large-scale ID harvesting.
41
+ */
42
+ followersIds(username: string, params?: FollowersIdsParams): Promise<FollowersIdsResponse>;
43
+ /**
44
+ * Batch lookup multiple users by username (max 100).
45
+ */
46
+ batch(usernames: string[]): Promise<ApiResponse<User[]>>;
47
+ /**
48
+ * Check whether `source` follows `target` (and vice versa).
49
+ */
50
+ checkFollow(source: string, target: string): Promise<ApiResponse<CheckFollowResult>>;
51
+ /**
52
+ * Check if an account is eligible by minimum followers / account age.
53
+ * For airdrop/giveaway gating.
54
+ */
55
+ checkQualifiedAccount(username: string, params?: QualifiedAccountParams): Promise<ApiResponse<QualifiedAccountResult>>;
56
+ /**
57
+ * Check if a user's display name contains required text. For
58
+ * airdrop/giveaway gating.
59
+ */
60
+ checkQualifiedName(username: string, params: QualifiedNameParams): Promise<ApiResponse<QualifiedNameResult>>;
61
+ /**
62
+ * Follow a user. Requires a connected X account.
63
+ */
64
+ follow(username: string): Promise<ApiResponse<{
65
+ success: boolean;
66
+ }>>;
67
+ /**
68
+ * Unfollow a user. Requires a connected X account.
69
+ */
70
+ unfollow(username: string): Promise<ApiResponse<{
71
+ success: boolean;
72
+ }>>;
73
+ }
74
+ type PaginatedMethod<T> = (username: string, params: PaginationParams) => Promise<PaginatedResponse<T>>;
75
+ /**
76
+ * Async generator that auto-paginates a user-based paginated endpoint.
77
+ * @param maxPages Safety limit to prevent infinite loops (default 100).
78
+ */
79
+ export declare function paginateUser<T>(method: PaginatedMethod<T>, username: string, params?: PaginationParams, maxPages?: number): AsyncGenerator<T, void, undefined>;
80
+ export {};
81
+ //# 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,EACrB,MAAM,aAAa,CAAC;AAIrB,qBAAa,aAAa;IACZ,OAAO,CAAC,QAAQ,CAAC,IAAI;gBAAJ,IAAI,EAAE,UAAU;IAE7C;;OAEG;IACG,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC;IAOvD;;OAEG;IACG,MAAM,CACV,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,gBAAqB,GAC5B,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAQpC;;OAEG;IACG,QAAQ,CACZ,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,gBAAqB,GAC5B,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAQpC;;OAEG;IACG,SAAS,CACb,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,gBAAqB,GAC5B,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAQnC;;OAEG;IACG,SAAS,CACb,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,gBAAqB,GAC5B,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAQnC;;OAEG;IACG,OAAO,CACX,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,gBAAqB,GAC5B,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAQpC;;OAEG;IACG,KAAK,CACT,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,gBAAqB,GAC5B,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAQpC;;OAEG;IACG,iBAAiB,CACrB,QAAQ,EAAE,MAAM,EAChB,MAAM,GAAE,gBAAqB,GAC5B,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;IAQnC;;;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;;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,182 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.UsersResource = void 0;
4
+ exports.paginateUser = paginateUser;
5
+ const DEFAULT_MAX_PAGES = 100;
6
+ class UsersResource {
7
+ http;
8
+ constructor(http) {
9
+ this.http = http;
10
+ }
11
+ /**
12
+ * Get a user profile by username.
13
+ */
14
+ async get(username) {
15
+ return this.http.request({
16
+ method: 'GET',
17
+ path: `/users/${encodeURIComponent(username)}`,
18
+ });
19
+ }
20
+ /**
21
+ * Get a user's tweets.
22
+ */
23
+ async tweets(username, params = {}) {
24
+ return this.http.request({
25
+ method: 'GET',
26
+ path: `/users/${encodeURIComponent(username)}/tweets`,
27
+ query: { count: params.count, cursor: params.cursor },
28
+ });
29
+ }
30
+ /**
31
+ * Get a user's mentions.
32
+ */
33
+ async mentions(username, params = {}) {
34
+ return this.http.request({
35
+ method: 'GET',
36
+ path: `/users/${encodeURIComponent(username)}/mentions`,
37
+ query: { count: params.count, cursor: params.cursor },
38
+ });
39
+ }
40
+ /**
41
+ * Get a user's followers.
42
+ */
43
+ async followers(username, params = {}) {
44
+ return this.http.request({
45
+ method: 'GET',
46
+ path: `/users/${encodeURIComponent(username)}/followers`,
47
+ query: { count: params.count, cursor: params.cursor },
48
+ });
49
+ }
50
+ /**
51
+ * Get users that a user is following.
52
+ */
53
+ async following(username, params = {}) {
54
+ return this.http.request({
55
+ method: 'GET',
56
+ path: `/users/${encodeURIComponent(username)}/following`,
57
+ query: { count: params.count, cursor: params.cursor },
58
+ });
59
+ }
60
+ /**
61
+ * Get a user's replies.
62
+ */
63
+ async replies(username, params = {}) {
64
+ return this.http.request({
65
+ method: 'GET',
66
+ path: `/users/${encodeURIComponent(username)}/replies`,
67
+ query: { count: params.count, cursor: params.cursor },
68
+ });
69
+ }
70
+ /**
71
+ * Get a user's media tweets.
72
+ */
73
+ async media(username, params = {}) {
74
+ return this.http.request({
75
+ method: 'GET',
76
+ path: `/users/${encodeURIComponent(username)}/media`,
77
+ query: { count: params.count, cursor: params.cursor },
78
+ });
79
+ }
80
+ /**
81
+ * Get a user's verified (blue) followers.
82
+ */
83
+ async verifiedFollowers(username, params = {}) {
84
+ return this.http.request({
85
+ method: 'GET',
86
+ path: `/users/${encodeURIComponent(username)}/verified-followers`,
87
+ query: { count: params.count, cursor: params.cursor },
88
+ });
89
+ }
90
+ /**
91
+ * Get up to 5000 raw follower IDs (no profile metadata). Cheaper and
92
+ * faster than `followers()` for large-scale ID harvesting.
93
+ */
94
+ async followersIds(username, params = {}) {
95
+ return this.http.request({
96
+ method: 'GET',
97
+ path: `/users/${encodeURIComponent(username)}/followers-ids`,
98
+ query: { count: params.count, cursor: params.cursor },
99
+ });
100
+ }
101
+ /**
102
+ * Batch lookup multiple users by username (max 100).
103
+ */
104
+ async batch(usernames) {
105
+ return this.http.request({
106
+ method: 'POST',
107
+ path: '/users/batch',
108
+ body: { usernames },
109
+ });
110
+ }
111
+ /**
112
+ * Check whether `source` follows `target` (and vice versa).
113
+ */
114
+ async checkFollow(source, target) {
115
+ return this.http.request({
116
+ method: 'GET',
117
+ path: '/users/check-follow',
118
+ query: { source, target },
119
+ });
120
+ }
121
+ /**
122
+ * Check if an account is eligible by minimum followers / account age.
123
+ * For airdrop/giveaway gating.
124
+ */
125
+ async checkQualifiedAccount(username, params = {}) {
126
+ return this.http.request({
127
+ method: 'GET',
128
+ path: `/users/${encodeURIComponent(username)}/check-qualified-account`,
129
+ query: { min_followers: params.min_followers, min_age_days: params.min_age_days },
130
+ });
131
+ }
132
+ /**
133
+ * Check if a user's display name contains required text. For
134
+ * airdrop/giveaway gating.
135
+ */
136
+ async checkQualifiedName(username, params) {
137
+ return this.http.request({
138
+ method: 'GET',
139
+ path: `/users/${encodeURIComponent(username)}/check-qualified-name`,
140
+ query: { contains: params.contains, position: params.position },
141
+ });
142
+ }
143
+ /**
144
+ * Follow a user. Requires a connected X account.
145
+ */
146
+ async follow(username) {
147
+ return this.http.request({
148
+ method: 'POST',
149
+ path: `/users/${encodeURIComponent(username)}/follow`,
150
+ });
151
+ }
152
+ /**
153
+ * Unfollow a user. Requires a connected X account.
154
+ */
155
+ async unfollow(username) {
156
+ return this.http.request({
157
+ method: 'DELETE',
158
+ path: `/users/${encodeURIComponent(username)}/follow`,
159
+ });
160
+ }
161
+ }
162
+ exports.UsersResource = UsersResource;
163
+ /**
164
+ * Async generator that auto-paginates a user-based paginated endpoint.
165
+ * @param maxPages Safety limit to prevent infinite loops (default 100).
166
+ */
167
+ async function* paginateUser(method, username, params = {}, maxPages = DEFAULT_MAX_PAGES) {
168
+ let cursor = params.cursor;
169
+ let hasNext = true;
170
+ let page = 0;
171
+ while (hasNext && page < maxPages) {
172
+ const response = await method(username, { ...params, cursor });
173
+ const items = response.data;
174
+ for (const item of items) {
175
+ yield item;
176
+ }
177
+ cursor = response.meta.cursor;
178
+ hasNext = !!response.meta.has_next && !!cursor;
179
+ page++;
180
+ }
181
+ }
182
+ //# sourceMappingURL=users.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"users.js","sourceRoot":"","sources":["../../../src/resources/users.ts"],"names":[],"mappings":";;;AAuOA,oCAsBC;AA7OD,MAAM,iBAAiB,GAAG,GAAG,CAAC;AAE9B,MAAa,aAAa;IACK;IAA7B,YAA6B,IAAgB;QAAhB,SAAI,GAAJ,IAAI,CAAY;IAAG,CAAC;IAEjD;;OAEG;IACH,KAAK,CAAC,GAAG,CAAC,QAAgB;QACxB,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAO;YAC7B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,QAAQ,CAAC,EAAE;SAC/C,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,MAAM,CACV,QAAgB,EAChB,SAA2B,EAAE;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,QAAQ,CAAC,SAAS;YACrD,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,QAAQ,CACZ,QAAgB,EAChB,SAA2B,EAAE;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,QAAQ,CAAC,WAAW;YACvD,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,SAAS,CACb,QAAgB,EAChB,SAA2B,EAAE;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,QAAQ,CAAC,YAAY;YACxD,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,SAAS,CACb,QAAgB,EAChB,SAA2B,EAAE;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,QAAQ,CAAC,YAAY;YACxD,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,OAAO,CACX,QAAgB,EAChB,SAA2B,EAAE;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,QAAQ,CAAC,UAAU;YACtD,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,CACT,QAAgB,EAChB,SAA2B,EAAE;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,QAAQ,CAAC,QAAQ;YACpD,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,iBAAiB,CACrB,QAAgB,EAChB,SAA2B,EAAE;QAE7B,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,UAAU,kBAAkB,CAAC,QAAQ,CAAC,qBAAqB;YACjE,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE;SACtD,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,QAAQ,CAAC,gBAAgB;YAC5D,KAAK,EAAE,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE;SACtD,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;;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;AAxMD,sCAwMC;AASD;;;GAGG;AACI,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"}