@youmind-openlab/rettiwt-api 1.0.0

package/src/requests/DirectMessage.ts

@@ -0,0 +1,233 @@
+import qs from 'querystring';
+
+import { AxiosRequestConfig } from 'axios';
+
+/**
+ * Common parameter sets for DM requests
+ */
+const BaseDMParams = {
+	/* eslint-disable @typescript-eslint/naming-convention */
+
+	nsfw_filtering_enabled: false,
+	filter_low_quality: true,
+	include_quality: 'all',
+	dm_secret_conversations_enabled: false,
+	krs_registration_enabled: false,
+	cards_platform: 'Web-12',
+	include_cards: 1,
+	include_ext_alt_text: true,
+	include_ext_limited_action_results: true,
+	include_quote_count: true,
+	include_reply_count: 1,
+	tweet_mode: 'extended',
+	include_ext_views: true,
+	include_groups: true,
+	include_inbox_timelines: true,
+	include_ext_media_color: true,
+	supports_reactions: true,
+	supports_edit: true,
+	include_ext_edit_control: true,
+	include_ext_business_affiliations_label: true,
+	ext: 'mediaColor%2CaltText%2CbusinessAffiliationsLabel%2CmediaStats%2ChighlightedLabel%2CparodyCommentaryFanLabel%2CvoiceInfo%2CbirdwatchPivot%2CsuperFollowMetadata%2CunmentionInfo%2CeditControl%2Carticle',
+
+	/* eslint-enable @typescript-eslint/naming-convention */
+};
+
+const DMUserIncludeParams = {
+	/* eslint-disable @typescript-eslint/naming-convention */
+
+	include_profile_interstitial_type: 1,
+	include_blocking: 1,
+	include_blocked_by: 1,
+	include_followed_by: 1,
+	include_want_retweets: 1,
+	include_mute_edge: 1,
+	include_can_dm: 1,
+	include_can_media_tag: 1,
+	include_ext_is_blue_verified: 1,
+	include_ext_verified_type: 1,
+	include_ext_profile_image_shape: 1,
+	skip_status: 1,
+
+	/* eslint-enable @typescript-eslint/naming-convention */
+};
+
+/**
+ * Collection of requests related to direct messages.
+ *
+ * @public
+ */
+export class DMRequests {
+	/**
+	 * Get a specific DM conversation
+	 * @param conversationId - The conversation ID (e.g., "394028042-1712730991884689408")
+	 * @param maxId - Maximum ID for pagination (optional)
+	 */
+	public static conversation(conversationId: string, maxId?: string): AxiosRequestConfig {
+		const context = maxId ? 'FETCH_DM_CONVERSATION_HISTORY' : 'FETCH_DM_CONVERSATION';
+
+		return {
+			method: 'get',
+			url: `https://x.com/i/api/1.1/dm/conversation/${conversationId}.json`,
+			params: {
+				...BaseDMParams,
+				...DMUserIncludeParams,
+				/* eslint-disable @typescript-eslint/naming-convention */
+				max_id: maxId,
+				context: context,
+				dm_users: false,
+				include_conversation_info: true,
+				/* eslint-enable @typescript-eslint/naming-convention */
+			},
+			paramsSerializer: { encode: encodeURIComponent },
+		};
+	}
+
+	/**
+	 * Delete a DM conversation
+	 * @param conversationId - The ID of the conversation to delete
+	 */
+	public static deleteConversation(conversationId: string): AxiosRequestConfig {
+		return {
+			method: 'post',
+			url: `https://x.com/i/api/1.1/dm/${conversationId}/delete.json`,
+			data: qs.stringify({
+				/* eslint-disable @typescript-eslint/naming-convention */
+				dm_secret_conversations_enabled: false,
+				krs_registration_enabled: false,
+				cards_platform: 'Web-12',
+				include_cards: 1,
+				include_ext_alt_text: true,
+				include_ext_limited_action_results: true,
+				include_quote_count: true,
+				include_reply_count: 1,
+				tweet_mode: 'extended',
+				include_ext_views: true,
+				dm_users: false,
+				include_groups: true,
+				include_inbox_timelines: true,
+				include_ext_media_color: true,
+				supports_reactions: true,
+				supports_edit: true,
+				include_conversation_info: true,
+			}),
+		};
+	}
+
+	/**
+	 * Get the initial state of the DM inbox
+	 */
+	public static inboxInitial(): AxiosRequestConfig {
+		return {
+			method: 'get',
+			url: 'https://x.com/i/api/1.1/dm/inbox_initial_state.json',
+			params: {
+				...BaseDMParams,
+				...DMUserIncludeParams,
+				/* eslint-disable @typescript-eslint/naming-convention */
+				dm_users: true,
+				include_ext_parody_commentary_fan_label: true,
+				ext: 'mediaColor%2CaltText%2CmediaStats%2ChighlightedLabel%2CparodyCommentaryFanLabel%2CvoiceInfo%2CbirdwatchPivot%2CsuperFollowMetadata%2CunmentionInfo%2CeditControl%2Carticle',
+			},
+			paramsSerializer: { encode: encodeURIComponent },
+		};
+	}
+
+	/**
+	 * Get inbox timeline (pagination of conversations)
+	 * @param maxId - Maximum ID for pagination
+	 */
+	public static inboxTimeline(maxId?: string): AxiosRequestConfig {
+		return {
+			method: 'get',
+			url: 'https://x.com/i/api/1.1/dm/inbox_timeline/trusted.json',
+			params: {
+				...BaseDMParams,
+				...DMUserIncludeParams,
+				/* eslint-disable @typescript-eslint/naming-convention */
+				max_id: maxId,
+				dm_users: false,
+			},
+			paramsSerializer: { encode: encodeURIComponent },
+		};
+	}
+
+	/**
+	 * Create a new DM or get DM creation interface
+	 */
+	// public static new(): AxiosRequestConfig {
+	// 	return {
+	// 		method: 'get',
+	// 		url: 'https://x.com/i/api/1.1/dm/new2.json',
+	// 		params: {
+	// 			/* eslint-disable @typescript-eslint/naming-convention */
+	// 			ext: 'mediaColor%2CaltText%2CmediaStats%2ChighlightedLabel%2CparodyCommentaryFanLabel%2CvoiceInfo%2CbirdwatchPivot%2CsuperFollowMetadata%2CunmentionInfo%2CeditControl%2Carticle',
+	// 			include_ext_alt_text: true,
+	// 			include_ext_limited_action_results: true,
+	// 			include_reply_count: 1,
+	// 			tweet_mode: 'extended',
+	// 			include_ext_views: true,
+	// 			include_groups: true,
+	// 			include_inbox_timelines: true,
+	// 			include_ext_media_color: true,
+	// 			supports_reactions: true,
+	// 			supports_edit: true,
+	// 		},
+	// 		paramsSerializer: { encode: encodeURIComponent },
+	// 	};
+	// }
+
+	/**
+	 * Check DM permissions for specific recipients
+	 * @param recipientIds - Array of recipient user IDs
+	 */
+	// public static permissions(recipientIds: string[]): AxiosRequestConfig {
+	// 	return {
+	// 		method: 'get',
+	// 		url: 'https://x.com/i/api/1.1/dm/permissions.json',
+	// 		params: {
+	// 			/* eslint-disable @typescript-eslint/naming-convention */
+	// 			recipient_ids: recipientIds.join(','),
+	// 			dm_users: true,
+	// 		},
+	// 		paramsSerializer: { encode: encodeURIComponent },
+	// 	};
+	// }
+
+	/**
+	 * Update the last seen event ID for a conversation
+	 * @param lastSeenEventId - The ID of the last seen event
+	 * @param trustedLastSeenEventId - The trusted last seen event ID (usually same as lastSeenEventId)
+	 */
+	// public static updateLastSeenEventId(lastSeenEventId: string, trustedLastSeenEventId?: string): AxiosRequestConfig {
+	// 	return {
+	// 		method: 'post',
+	// 		url: 'https://x.com/i/api/1.1/dm/update_last_seen_event_id.json',
+	// 		data: qs.stringify({
+	// 			/* eslint-disable @typescript-eslint/naming-convention */
+	// 			last_seen_event_id: lastSeenEventId,
+	// 			trusted_last_seen_event_id: trustedLastSeenEventId ?? lastSeenEventId,
+	// 		}),
+	// 	};
+	// }
+
+	/**
+	 * Get user updates for DMs (polling for new messages)
+	 * @param cursor - Cursor for pagination
+	 * @param activeConversationId - ID of the currently active conversation
+	 */
+	// public static userUpdates(cursor?: string, activeConversationId?: string): AxiosRequestConfig {
+	// 	return {
+	// 		method: 'get',
+	// 		url: 'https://x.com/i/api/1.1/dm/user_updates.json',
+	// 		params: {
+	// 			...DM_BASE_PARAMS,
+	// 			/* eslint-disable @typescript-eslint/naming-convention */
+	// 			cursor: cursor,
+	// 			active_conversation_id: activeConversationId,
+	// 			dm_users: false,
+	// 		},
+	// 		paramsSerializer: { encode: encodeURIComponent },
+	// 	};
+	// }
+}

package/src/requests/List.ts

@@ -0,0 +1,205 @@
+import { AxiosRequestConfig } from 'axios';
+
+/**
+ * Collection of requests related to lists.
+ *
+ * @public
+ */
+export class ListRequests {
+	/**
+	 * @param listId - The ID of the target list.
+	 * @param userId - The ID of the user to be added as a member.
+	 */
+	public static addMember(listId: string, userId: string): AxiosRequestConfig {
+		return {
+			method: 'post',
+			url: 'https://x.com/i/api/graphql/EadD8ivrhZhYQr2pDmCpjA/ListAddMember',
+			data: {
+				/* eslint-disable @typescript-eslint/naming-convention */
+
+				variables: {
+					listId: listId,
+					userId: userId,
+				},
+				features: {
+					profile_label_improvements_pcf_label_in_post_enabled: true,
+					responsive_web_profile_redirect_enabled: false,
+					rweb_tipjar_consumption_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 */
+			},
+		};
+	}
+
+	/**
+	 * @param id - The id of the list whose details are to be fetched.
+	 */
+	public static details(id: string): AxiosRequestConfig {
+		return {
+			method: 'get',
+			url: 'https://x.com/i/api/graphql/Tzkkg-NaBi_y1aAUUb6_eQ/ListByRestId',
+			params: {
+				/* eslint-disable @typescript-eslint/naming-convention */
+				variables: JSON.stringify({ listId: id }),
+				features: JSON.stringify({
+					profile_label_improvements_pcf_label_in_post_enabled: true,
+					responsive_web_profile_redirect_enabled: false,
+					rweb_tipjar_consumption_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.
+	 */
+	public static members(id: string, count?: number, cursor?: string): AxiosRequestConfig {
+		return {
+			method: 'get',
+			url: 'https://x.com/i/api/graphql/Bnhcen0kdsMAU1tW7U79qQ/ListMembers',
+			params: {
+				/* eslint-disable @typescript-eslint/naming-convention */
+				variables: JSON.stringify({
+					listId: id,
+					count: count,
+					cursor: cursor,
+				}),
+				features: JSON.stringify({
+					rweb_video_screen_enabled: false,
+					profile_label_improvements_pcf_label_in_post_enabled: true,
+					responsive_web_profile_redirect_enabled: false,
+					rweb_tipjar_consumption_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,
+					premium_content_api_read_enabled: false,
+					communities_web_enable_tweet_community_results_fetch: true,
+					c9s_tweet_anatomy_moderator_badge_enabled: true,
+					responsive_web_grok_analyze_button_fetch_trends_enabled: false,
+					responsive_web_grok_analyze_post_followups_enabled: true,
+					responsive_web_jetfuel_frame: true,
+					responsive_web_grok_share_attachment_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,
+					responsive_web_grok_show_grok_translated_post: false,
+					responsive_web_grok_analysis_button_from_backend: true,
+					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,
+					longform_notetweets_rich_text_read_enabled: true,
+					longform_notetweets_inline_media_enabled: true,
+					responsive_web_grok_image_annotation_enabled: true,
+					responsive_web_grok_imagine_annotation_enabled: true,
+					responsive_web_grok_community_note_auto_translation_is_enabled: false,
+					responsive_web_enhance_cards_enabled: false,
+				}),
+				/* eslint-enable @typescript-eslint/naming-convention */
+			},
+		};
+	}
+
+	/**
+	 * @param listId - The ID of the target list.
+	 * @param userId - The ID of the user to remove as a member.
+	 */
+	public static removeMember(listId: string, userId: string): AxiosRequestConfig {
+		return {
+			method: 'post',
+			url: 'https://x.com/i/api/graphql/B5tMzrMYuFHJex_4EXFTSw/ListRemoveMember',
+			data: {
+				/* eslint-disable @typescript-eslint/naming-convention */
+
+				variables: {
+					listId: listId,
+					userId: userId,
+				},
+				features: {
+					profile_label_improvements_pcf_label_in_post_enabled: true,
+					responsive_web_profile_redirect_enabled: false,
+					rweb_tipjar_consumption_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 */
+			},
+		};
+	}
+
+	/**
+	 * @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.
+	 */
+	public static tweets(id: string, count?: number, cursor?: string): AxiosRequestConfig {
+		return {
+			method: 'get',
+			url: 'https://x.com/i/api/graphql/fqNUs_6rqLf89u_2waWuqg/ListLatestTweetsTimeline',
+			params: {
+				/* eslint-disable @typescript-eslint/naming-convention */
+				variables: JSON.stringify({
+					listId: id,
+					count: count,
+					cursor: cursor,
+				}),
+				features: JSON.stringify({
+					rweb_video_screen_enabled: false,
+					profile_label_improvements_pcf_label_in_post_enabled: true,
+					responsive_web_profile_redirect_enabled: false,
+					rweb_tipjar_consumption_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,
+					premium_content_api_read_enabled: false,
+					communities_web_enable_tweet_community_results_fetch: true,
+					c9s_tweet_anatomy_moderator_badge_enabled: true,
+					responsive_web_grok_analyze_button_fetch_trends_enabled: false,
+					responsive_web_grok_analyze_post_followups_enabled: true,
+					responsive_web_jetfuel_frame: true,
+					responsive_web_grok_share_attachment_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,
+					responsive_web_grok_show_grok_translated_post: false,
+					responsive_web_grok_analysis_button_from_backend: true,
+					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,
+					longform_notetweets_rich_text_read_enabled: true,
+					longform_notetweets_inline_media_enabled: true,
+					responsive_web_grok_image_annotation_enabled: true,
+					responsive_web_grok_imagine_annotation_enabled: true,
+					responsive_web_grok_community_note_auto_translation_is_enabled: false,
+					responsive_web_enhance_cards_enabled: false,
+				}),
+				/* eslint-enable @typescript-eslint/naming-convention */
+			},
+			paramsSerializer: { encode: encodeURIComponent },
+		};
+	}
+}

package/src/requests/Media.ts

@@ -0,0 +1,77 @@
+import fs from 'fs';
+
+import { AxiosRequestConfig } from 'axios';
+import FormData from 'form-data';
+
+/**
+ * Collection of requests related to media.
+ *
+ * @public
+ */
+export class MediaRequests {
+	/**
+	 * @param id - The allocated id of the media item to be uploaded.
+	 * @param media - The media item to upload. Can be a file path (Node.js), ArrayBuffer, or Blob (browser).
+	 */
+	public static appendUpload(id: string, media: string | ArrayBuffer | Blob): AxiosRequestConfig {
+		const data = new FormData();
+		// Support different media types:
+		// - string: file path (Node.js only, uses fs.createReadStream)
+		// - Blob/File: browser native blob (pass directly)
+		// - ArrayBuffer: convert to Buffer (Node.js) or pass as-is (browser)
+		if (typeof media === 'string') {
+			data.append('media', fs.createReadStream(media));
+		} else if (media instanceof Blob) {
+			data.append('media', media);
+		} else {
+			data.append('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.
+	 */
+	public static finalizeUpload(id: string): AxiosRequestConfig {
+		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.
+	 */
+	public static initializeUpload(size: number): AxiosRequestConfig {
+		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 */
+			},
+		};
+	}
+}