rettiwt-api 5.0.0-alpha.0 → 5.0.0-alpha.2

package/dist/requests/List.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListRequests = void 0;
+/**
+ * Collection of requests related to lists.
+ *
+ * @public
+ */
+class ListRequests {
+    /**
+     * @param id - The id of the list whose details are to be fetched.
+     */
+    static details(id) {
+        return {
+            method: 'get',
+            url: 'https://x.com/i/api/graphql/gO1_eYPohKYHwCG2m-1ZnQ/ListByRestId',
+            params: {
+                /* eslint-disable @typescript-eslint/naming-convention */
+                variables: JSON.stringify({ listId: id }),
+                features: JSON.stringify({
+                    rweb_lists_timeline_redesign_enabled: true,
+                    responsive_web_graphql_exclude_directive_enabled: true,
+                    verified_phone_label_enabled: true,
+                    responsive_web_graphql_skip_user_profile_image_extensions_enabled: false,
+                    responsive_web_graphql_timeline_navigation_enabled: true,
+                }),
+                /* eslint-enable @typescript-eslint/naming-convention */
+            },
+            paramsSerializer: { encode: encodeURIComponent },
+        };
+    }
+    /**
+     * @param id - The id of the list whose members are to be fetched.
+     * @param count - The number of members to fetch. Must be \<= 100.
+     * @param cursor - The cursor to the batch of members to fetch.
+     */
+    static members(id, count, cursor) {
+        return {
+            method: 'get',
+            url: 'https://x.com/i/api/graphql/dsJhIe3M0vCopjSfU6SlQw/ListMembers',
+            params: {
+                /* eslint-disable @typescript-eslint/naming-convention */
+                variables: JSON.stringify({
+                    listId: id,
+                    count: count,
+                    cursor: cursor,
+                }),
+                features: JSON.stringify({
+                    rweb_tipjar_consumption_enabled: true,
+                    responsive_web_graphql_exclude_directive_enabled: true,
+                    verified_phone_label_enabled: true,
+                    creator_subscriptions_tweet_preview_api_enabled: true,
+                    responsive_web_graphql_timeline_navigation_enabled: true,
+                    responsive_web_graphql_skip_user_profile_image_extensions_enabled: false,
+                    communities_web_enable_tweet_community_results_fetch: true,
+                    c9s_tweet_anatomy_moderator_badge_enabled: true,
+                    articles_preview_enabled: true,
+                    responsive_web_edit_tweet_api_enabled: true,
+                    graphql_is_translatable_rweb_tweet_is_translatable_enabled: true,
+                    view_counts_everywhere_api_enabled: true,
+                    longform_notetweets_consumption_enabled: true,
+                    responsive_web_twitter_article_tweet_consumption_enabled: true,
+                    tweet_awards_web_tipping_enabled: false,
+                    creator_subscriptions_quote_tweet_preview_enabled: false,
+                    freedom_of_speech_not_reach_fetch_enabled: true,
+                    standardized_nudges_misinfo: true,
+                    tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled: true,
+                    rweb_video_timestamps_enabled: true,
+                    longform_notetweets_rich_text_read_enabled: true,
+                    longform_notetweets_inline_media_enabled: true,
+                    responsive_web_enhance_cards_enabled: false,
+                }),
+                /* eslint-enable @typescript-eslint/naming-convention */
+            },
+        };
+    }
+    /**
+     * @param id - The id of the list whose tweets are to be fetched.
+     * @param count - The number of tweets to fetch. Must be \<= 100.
+     * @param cursor - The cursor to the batch of tweets to fetch.
+     */
+    static tweets(id, count, cursor) {
+        return {
+            method: 'get',
+            url: 'https://x.com/i/api/graphql/naCjgapXCSCsbZ7qnnItQA/ListLatestTweetsTimeline',
+            params: {
+                /* eslint-disable @typescript-eslint/naming-convention */
+                variables: JSON.stringify({
+                    listId: id,
+                    count: count,
+                    cursor: cursor,
+                }),
+                features: JSON.stringify({
+                    rweb_lists_timeline_redesign_enabled: true,
+                    responsive_web_graphql_exclude_directive_enabled: true,
+                    verified_phone_label_enabled: true,
+                    creator_subscriptions_tweet_preview_api_enabled: true,
+                    responsive_web_graphql_timeline_navigation_enabled: true,
+                    responsive_web_graphql_skip_user_profile_image_extensions_enabled: false,
+                    tweetypie_unmention_optimization_enabled: true,
+                    responsive_web_edit_tweet_api_enabled: true,
+                    graphql_is_translatable_rweb_tweet_is_translatable_enabled: true,
+                    view_counts_everywhere_api_enabled: true,
+                    longform_notetweets_consumption_enabled: true,
+                    responsive_web_twitter_article_tweet_consumption_enabled: false,
+                    tweet_awards_web_tipping_enabled: false,
+                    freedom_of_speech_not_reach_fetch_enabled: true,
+                    standardized_nudges_misinfo: true,
+                    tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled: true,
+                    longform_notetweets_rich_text_read_enabled: true,
+                    longform_notetweets_inline_media_enabled: true,
+                    responsive_web_media_download_video_enabled: false,
+                    responsive_web_enhance_cards_enabled: false,
+                }),
+                /* eslint-enable @typescript-eslint/naming-convention */
+            },
+            paramsSerializer: { encode: encodeURIComponent },
+        };
+    }
+}
+exports.ListRequests = ListRequests;
+//# sourceMappingURL=List.js.map

package/dist/requests/List.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"List.js","sourceRoot":"","sources":["../../src/requests/List.ts"],"names":[],"mappings":";;;AAEA;;;;GAIG;AACH,MAAa,YAAY;IACxB;;OAEG;IACI,MAAM,CAAC,OAAO,CAAC,EAAU;QAC/B,OAAO;YACN,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,iEAAiE;YACtE,MAAM,EAAE;gBACP,yDAAyD;gBACzD,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;gBACzC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC;oBACxB,oCAAoC,EAAE,IAAI;oBAC1C,gDAAgD,EAAE,IAAI;oBACtD,4BAA4B,EAAE,IAAI;oBAClC,iEAAiE,EAAE,KAAK;oBACxE,kDAAkD,EAAE,IAAI;iBACxD,CAAC;gBACF,wDAAwD;aACxD;YACD,gBAAgB,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE;SAChD,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,OAAO,CAAC,EAAU,EAAE,KAAc,EAAE,MAAe;QAChE,OAAO;YACN,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,gEAAgE;YACrE,MAAM,EAAE;gBACP,yDAAyD;gBACzD,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC;oBACzB,MAAM,EAAE,EAAE;oBACV,KAAK,EAAE,KAAK;oBACZ,MAAM,EAAE,MAAM;iBACd,CAAC;gBACF,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC;oBACxB,+BAA+B,EAAE,IAAI;oBACrC,gDAAgD,EAAE,IAAI;oBACtD,4BAA4B,EAAE,IAAI;oBAClC,+CAA+C,EAAE,IAAI;oBACrD,kDAAkD,EAAE,IAAI;oBACxD,iEAAiE,EAAE,KAAK;oBACxE,oDAAoD,EAAE,IAAI;oBAC1D,yCAAyC,EAAE,IAAI;oBAC/C,wBAAwB,EAAE,IAAI;oBAC9B,qCAAqC,EAAE,IAAI;oBAC3C,0DAA0D,EAAE,IAAI;oBAChE,kCAAkC,EAAE,IAAI;oBACxC,uCAAuC,EAAE,IAAI;oBAC7C,wDAAwD,EAAE,IAAI;oBAC9D,gCAAgC,EAAE,KAAK;oBACvC,iDAAiD,EAAE,KAAK;oBACxD,yCAAyC,EAAE,IAAI;oBAC/C,2BAA2B,EAAE,IAAI;oBACjC,uEAAuE,EAAE,IAAI;oBAC7E,6BAA6B,EAAE,IAAI;oBACnC,0CAA0C,EAAE,IAAI;oBAChD,wCAAwC,EAAE,IAAI;oBAC9C,oCAAoC,EAAE,KAAK;iBAC3C,CAAC;gBACF,wDAAwD;aACxD;SACD,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,MAAM,CAAC,EAAU,EAAE,KAAc,EAAE,MAAe;QAC/D,OAAO;YACN,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,6EAA6E;YAClF,MAAM,EAAE;gBACP,yDAAyD;gBACzD,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC;oBACzB,MAAM,EAAE,EAAE;oBACV,KAAK,EAAE,KAAK;oBACZ,MAAM,EAAE,MAAM;iBACd,CAAC;gBACF,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC;oBACxB,oCAAoC,EAAE,IAAI;oBAC1C,gDAAgD,EAAE,IAAI;oBACtD,4BAA4B,EAAE,IAAI;oBAClC,+CAA+C,EAAE,IAAI;oBACrD,kDAAkD,EAAE,IAAI;oBACxD,iEAAiE,EAAE,KAAK;oBACxE,wCAAwC,EAAE,IAAI;oBAC9C,qCAAqC,EAAE,IAAI;oBAC3C,0DAA0D,EAAE,IAAI;oBAChE,kCAAkC,EAAE,IAAI;oBACxC,uCAAuC,EAAE,IAAI;oBAC7C,wDAAwD,EAAE,KAAK;oBAC/D,gCAAgC,EAAE,KAAK;oBACvC,yCAAyC,EAAE,IAAI;oBAC/C,2BAA2B,EAAE,IAAI;oBACjC,uEAAuE,EAAE,IAAI;oBAC7E,0CAA0C,EAAE,IAAI;oBAChD,wCAAwC,EAAE,IAAI;oBAC9C,2CAA2C,EAAE,KAAK;oBAClD,oCAAoC,EAAE,KAAK;iBAC3C,CAAC;gBACF,wDAAwD;aACxD;YACD,gBAAgB,EAAE,EAAE,MAAM,EAAE,kBAAkB,EAAE;SAChD,CAAC;IACH,CAAC;CACD;AAjHD,oCAiHC"}

package/dist/requests/Media.d.ts

@@ -0,0 +1,21 @@
+import { AxiosRequestConfig } from 'axios';
+/**
+ * Collection of requests related to media.
+ *
+ * @public
+ */
+export declare class MediaRequests {
+    /**
+     * @param id - The allocated id of the media item to be uploaded.
+     * @param media - The media item to upload.
+     */
+    static appendUpload(id: string, media: string | ArrayBuffer): AxiosRequestConfig;
+    /**
+     * @param id - The allocated id of the media item.
+     */
+    static finalizeUpload(id: string): AxiosRequestConfig;
+    /**
+     * @param size - The size (in bytes) of the media item to be uploaded.
+     */
+    static initializeUpload(size: number): AxiosRequestConfig;
+}

package/dist/requests/Media.js

@@ -0,0 +1,70 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MediaRequests = void 0;
+const fs_1 = __importDefault(require("fs"));
+const form_data_1 = __importDefault(require("form-data"));
+/**
+ * Collection of requests related to media.
+ *
+ * @public
+ */
+class MediaRequests {
+    /**
+     * @param id - The allocated id of the media item to be uploaded.
+     * @param media - The media item to upload.
+     */
+    static appendUpload(id, media) {
+        const data = new form_data_1.default();
+        data.append('media', typeof media == 'string' ? fs_1.default.createReadStream(media) : Buffer.from(media));
+        return {
+            method: 'post',
+            headers: { referer: 'https://x.com' },
+            url: 'https://upload.x.com/i/media/upload.json',
+            params: {
+                /* eslint-disable @typescript-eslint/naming-convention */
+                command: 'APPEND',
+                media_id: id,
+                segment_index: 0,
+                /* eslint-enable @typescript-eslint/naming-convention */
+            },
+            data: data,
+        };
+    }
+    /**
+     * @param id - The allocated id of the media item.
+     */
+    static finalizeUpload(id) {
+        return {
+            method: 'post',
+            headers: { referer: 'https://x.com' },
+            url: 'https://upload.x.com/i/media/upload.json',
+            params: {
+                /* eslint-disable @typescript-eslint/naming-convention */
+                command: 'FINALIZE',
+                media_id: id,
+                /* eslint-enable @typescript-eslint/naming-convention */
+            },
+        };
+    }
+    /**
+     * @param size - The size (in bytes) of the media item to be uploaded.
+     */
+    static initializeUpload(size) {
+        return {
+            method: 'post',
+            headers: { referer: 'https://x.com' },
+            url: 'https://upload.x.com/i/media/upload.json',
+            params: {
+                /* eslint-disable @typescript-eslint/naming-convention */
+                command: 'INIT',
+                total_bytes: size,
+                /* eslint-enable @typescript-eslint/naming-convention */
+            },
+        };
+    }
+}
+exports.MediaRequests = MediaRequests;
+//# sourceMappingURL=Media.js.map

package/dist/requests/Media.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Media.js","sourceRoot":"","sources":["../../src/requests/Media.ts"],"names":[],"mappings":";;;;;;AAAA,4CAAoB;AAGpB,0DAAiC;AAEjC;;;;GAIG;AACH,MAAa,aAAa;IACzB;;;OAGG;IACI,MAAM,CAAC,YAAY,CAAC,EAAU,EAAE,KAA2B;QACjE,MAAM,IAAI,GAAG,IAAI,mBAAQ,EAAE,CAAC;QAC5B,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,KAAK,IAAI,QAAQ,CAAC,CAAC,CAAC,YAAE,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;QACjG,OAAO;YACN,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE;YACrC,GAAG,EAAE,0CAA0C;YAC/C,MAAM,EAAE;gBACP,yDAAyD;gBACzD,OAAO,EAAE,QAAQ;gBACjB,QAAQ,EAAE,EAAE;gBACZ,aAAa,EAAE,CAAC;gBAChB,wDAAwD;aACxD;YACD,IAAI,EAAE,IAAI;SACV,CAAC;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,cAAc,CAAC,EAAU;QACtC,OAAO;YACN,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE;YACrC,GAAG,EAAE,0CAA0C;YAC/C,MAAM,EAAE;gBACP,yDAAyD;gBACzD,OAAO,EAAE,UAAU;gBACnB,QAAQ,EAAE,EAAE;gBACZ,wDAAwD;aACxD;SACD,CAAC;IACH,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,gBAAgB,CAAC,IAAY;QAC1C,OAAO;YACN,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,EAAE,OAAO,EAAE,eAAe,EAAE;YACrC,GAAG,EAAE,0CAA0C;YAC/C,MAAM,EAAE;gBACP,yDAAyD;gBACzD,OAAO,EAAE,MAAM;gBACf,WAAW,EAAE,IAAI;gBACjB,wDAAwD;aACxD;SACD,CAAC;IACH,CAAC;CACD;AAxDD,sCAwDC"}

package/dist/requests/Tweet.d.ts

@@ -0,0 +1,75 @@
+import { AxiosRequestConfig } from 'axios';
+import { ITweetFilter } from '../types/args/FetchArgs';
+import { INewTweet } from '../types/args/PostArgs';
+/**
+ * Collection of requests related to tweets.
+ *
+ * @public
+ */
+export declare class TweetRequests {
+    /**
+     * @param ids - The IDs of the tweets whose details are to be fetched.
+     */
+    static bulkDetails(ids: string[]): AxiosRequestConfig;
+    /**
+     * @param id - The id of the tweet whose details are to be fetched.
+     */
+    static details(id: string): AxiosRequestConfig;
+    /**
+     * @param id - The id of the tweet to be liked.
+     */
+    static like(id: string): AxiosRequestConfig;
+    /**
+     * @param id - The id of the tweet whose likers are to be fetched.
+     * @param count - The number of likers to fetch. Only works as a lower limit when used with a cursor.
+     * @param cursor - The cursor to the batch of likers to fetch.
+     */
+    static likers(id: string, count?: number, cursor?: string): AxiosRequestConfig;
+    /**
+     * @param args - The configuration object for the tweet to be posted.
+     */
+    static post(args: INewTweet): AxiosRequestConfig;
+    /**
+     * @param id - The id of the tweet whose replies are to be fetched.
+     * @param cursor - The cursor to the batch of replies to fetch.
+     */
+    static replies(id: string, cursor?: string): AxiosRequestConfig;
+    /**
+     * @param id - The id of the tweet which is to be retweeted.
+     */
+    static retweet(id: string): AxiosRequestConfig;
+    /**
+     * @param id - The id of the tweet whose retweeters are to be fetched.
+     * @param count - The number of retweeters to fetch. Only works as a lower limit when used with a cursor.
+     * @param cursor - The cursor to the batch of retweeters to fetch.
+     */
+    static retweeters(id: string, count?: number, cursor?: string): AxiosRequestConfig;
+    /**
+     * @param args - The configuration object for the tweet to be posted.
+     *
+     * @remarks - Only `text` and `media.id` parameters are supported.
+     */
+    static schedule(args: INewTweet): AxiosRequestConfig;
+    /**
+     * @param filter - The filter to use for searching tweets.
+     * @param count - The number of tweets to fetch. Only works as a lower limit when used with a cursor.
+     * @param cursor - The cursor to the batch of tweets to fetch.
+     */
+    static search(filter: ITweetFilter, count?: number, cursor?: string): AxiosRequestConfig;
+    /**
+     * @param id - The id of the tweet to be unliked.
+     */
+    static unlike(id: string): AxiosRequestConfig;
+    /**
+     * @param id - The id of the tweet to be unposted.
+     */
+    static unpost(id: string): AxiosRequestConfig;
+    /**
+     * @param id - The id of the source tweet (which was retweeted), to be unretweeted.
+     */
+    static unretweet(id: string): AxiosRequestConfig;
+    /**
+     * @param id - The id of the scheduled tweet to be unscheduled.
+     */
+    static unschedule(id: string): AxiosRequestConfig;
+}