rettiwt-api 6.3.0-alpha.1 → 7.0.1

package/src/models/data/UserAbout.ts

@@ -0,0 +1,161 @@
+import { LogActions } from '../../enums/Logging';
+import { LogService } from '../../services/internal/LogService';
+import {
+	IUserAbout,
+	IUserAboutProfile,
+	IUserAboutUsernameChanges,
+	IUserAboutVerificationInfo,
+} from '../../types/data/UserAbout';
+import { IUserAboutResponse, IUserAboutResult } from '../../types/raw/user/About';
+
+/* eslint-disable @typescript-eslint/naming-convention */
+type IRawUsernameChanges = {
+	count?: string;
+	last_changed_at_msec?: string;
+};
+/* eslint-enable @typescript-eslint/naming-convention */
+
+/**
+ * The about profile details of a single user.
+ *
+ * @public
+ */
+export class UserAbout implements IUserAbout {
+	/** The raw about profile details. */
+	private readonly _raw: IUserAboutResult;
+
+	public aboutProfile?: IUserAboutProfile;
+	public createdAt: string;
+	public fullName: string;
+	public id: string;
+	public isProtected?: boolean;
+	public isVerified: boolean;
+	public profileImage: string;
+	public profileImageShape?: string;
+	public userName: string;
+	public verificationInfo?: IUserAboutVerificationInfo;
+
+	/**
+	 * @param user - The raw about profile details.
+	 */
+	public constructor(user: IUserAboutResult) {
+		this._raw = { ...user };
+
+		this.id = user.rest_id ?? user.id ?? '';
+		this.userName = user.core?.screen_name ?? '';
+		this.fullName = user.core?.name ?? '';
+		this.createdAt = new Date(user.core?.created_at ?? 0).toISOString();
+		this.profileImage = user.avatar?.image_url ?? '';
+		this.profileImageShape = user.profile_image_shape;
+		this.isVerified = user.is_blue_verified ?? false;
+		this.isProtected = user.privacy?.protected;
+		this.aboutProfile = UserAbout._buildAboutProfile(user);
+		this.verificationInfo = UserAbout._buildVerificationInfo(user);
+	}
+
+	/** The raw about profile details. */
+	public get raw(): IUserAboutResult {
+		return { ...this._raw };
+	}
+
+	private static _buildAboutProfile(user: IUserAboutResult): IUserAboutProfile | undefined {
+		const profile = user.about_profile;
+
+		if (!profile) {
+			return undefined;
+		}
+
+		const usernameChanges = UserAbout._buildUsernameChanges(profile.username_changes);
+
+		return {
+			createdCountryAccurate: profile.created_country_accurate,
+			accountBasedIn: profile.account_based_in,
+			locationAccurate: profile.location_accurate,
+			learnMoreUrl: profile.learn_more_url,
+			source: profile.source,
+			usernameChanges: usernameChanges,
+		};
+	}
+
+	private static _buildUsernameChanges(changes?: IRawUsernameChanges): IUserAboutUsernameChanges | undefined {
+		if (!changes) {
+			return undefined;
+		}
+
+		return {
+			count: UserAbout._toNumber(changes.count),
+			lastChangedAt: UserAbout._toIsoFromMsec(changes.last_changed_at_msec),
+		};
+	}
+
+	private static _buildVerificationInfo(user: IUserAboutResult): IUserAboutVerificationInfo | undefined {
+		const info = user.verification_info;
+
+		if (!info) {
+			return undefined;
+		}
+
+		return {
+			isIdentityVerified: info.is_identity_verified,
+			verifiedSince: UserAbout._toIsoFromMsec(info.reason?.verified_since_msec),
+		};
+	}
+
+	private static _toIsoFromMsec(value?: string | number): string | undefined {
+		const parsed = UserAbout._toNumber(value);
+
+		return parsed === undefined ? undefined : new Date(parsed).toISOString();
+	}
+
+	private static _toNumber(value?: string | number): number | undefined {
+		if (value === undefined || value === null) {
+			return undefined;
+		}
+
+		const parsed = typeof value === 'number' ? value : Number(value);
+
+		return Number.isFinite(parsed) ? parsed : undefined;
+	}
+
+	/**
+	 * Extracts and deserializes a single target user about profile from the given raw response data.
+	 *
+	 * @param response - The raw response data.
+	 *
+	 * @returns The target deserialized user about profile.
+	 */
+	public static single(response: NonNullable<unknown>): UserAbout | undefined {
+		const result = (response as IUserAboutResponse)?.data?.user_result_by_screen_name?.result;
+
+		if (!result || result.__typename !== 'User') {
+			LogService.log(LogActions.WARNING, {
+				action: LogActions.DESERIALIZE,
+				message: `User not found, skipping`,
+			});
+			return undefined;
+		}
+
+		// Logging
+		LogService.log(LogActions.DESERIALIZE, { id: result.rest_id ?? result.id });
+
+		return new UserAbout(result);
+	}
+
+	/**
+	 * @returns A serializable JSON representation of `this` object.
+	 */
+	public toJSON(): IUserAbout {
+		return {
+			id: this.id,
+			userName: this.userName,
+			fullName: this.fullName,
+			createdAt: this.createdAt,
+			profileImage: this.profileImage,
+			profileImageShape: this.profileImageShape,
+			isVerified: this.isVerified,
+			isProtected: this.isProtected,
+			aboutProfile: this.aboutProfile,
+			verificationInfo: this.verificationInfo,
+		};
+	}
+}

package/src/requests/Space.ts

@@ -0,0 +1,76 @@
+import { AxiosRequestConfig } from 'axios';
+
+/**
+ * Collection of requests related to spaces.
+ *
+ * @public
+ */
+export class SpaceRequests {
+	/**
+	 * @param id - The id of the space whose details are to be fetched.
+	 * @param withReplays - Whether to include replay information.
+	 * @param withListeners - Whether to include listeners information.
+	 * @param isMetatagsQuery - Whether the request is a metatags query.
+	 */
+	public static details(
+		id: string,
+		withReplays?: boolean,
+		withListeners?: boolean,
+		isMetatagsQuery?: boolean,
+	): AxiosRequestConfig {
+		return {
+			method: 'get',
+			url: 'https://x.com/i/api/graphql/rR7CQrr8kxb6fatlUaB61Q/AudioSpaceById',
+			params: {
+				/* eslint-disable @typescript-eslint/naming-convention */
+				variables: JSON.stringify({
+					id: id,
+					isMetatagsQuery: isMetatagsQuery ?? false,
+					withReplays: withReplays ?? true,
+					withListeners: withListeners ?? false,
+				}),
+				features: JSON.stringify({
+					spaces_2022_h2_spaces_communities: true,
+					spaces_2022_h2_clipping: true,
+					creator_subscriptions_tweet_preview_api_enabled: true,
+					profile_label_improvements_pcf_label_in_post_enabled: true,
+					responsive_web_profile_redirect_enabled: false,
+					rweb_tipjar_consumption_enabled: false,
+					verified_phone_label_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,
+					responsive_web_grok_annotations_enabled: false,
+					articles_preview_enabled: true,
+					responsive_web_graphql_skip_user_profile_image_extensions_enabled: false,
+					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,
+					post_ctas_fetch_enabled: 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_graphql_timeline_navigation_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/Tweet.ts

@@ -287,6 +287,65 @@ export class TweetRequests {
 		};
 	}
 
+	/**
+	 * @param args - The configuration object for the long-form tweet to be posted (X Premium only).
+	 */
+	public static postNote(args: INewTweet): AxiosRequestConfig {
+		// Parsing the args
+		const parsedArgs = new NewTweet(args);
+
+		return {
+			method: 'post',
+			url: 'https://x.com/i/api/graphql/_eeuQKX1-VyRP_ROM-GN7g/CreateNoteTweet',
+			data: {
+				/* eslint-disable @typescript-eslint/naming-convention */
+				variables: {
+					tweet_text: parsedArgs.text,
+					media: parsedArgs.media ? new MediaVariable(parsedArgs.media) : undefined,
+					semantic_annotation_ids: [],
+					disallowed_reply_options: null,
+				},
+				features: {
+					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,
+					responsive_web_grok_annotations_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,
+					content_disclosure_indicator_enabled: true,
+					content_disclosure_ai_generated_indicator_enabled: true,
+					responsive_web_grok_show_grok_translated_post: true,
+					responsive_web_grok_analysis_button_from_backend: true,
+					post_ctas_fetch_enabled: true,
+					longform_notetweets_rich_text_read_enabled: true,
+					longform_notetweets_inline_media_enabled: false,
+					profile_label_improvements_pcf_label_in_post_enabled: true,
+					responsive_web_profile_redirect_enabled: false,
+					rweb_tipjar_consumption_enabled: false,
+					verified_phone_label_enabled: false,
+					articles_preview_enabled: true,
+					responsive_web_grok_community_note_auto_translation_is_enabled: false,
+					responsive_web_graphql_skip_user_profile_image_extensions_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,
+					responsive_web_grok_image_annotation_enabled: true,
+					responsive_web_grok_imagine_annotation_enabled: true,
+					responsive_web_graphql_timeline_navigation_enabled: true,
+					responsive_web_enhance_cards_enabled: false,
+				},
+			},
+		};
+	}
+
 	/**
 	 * @param id - The id of the tweet whose replies are to be fetched.
 	 * @param cursor - The cursor to the batch of replies to fetch.

package/src/requests/User.ts

@@ -11,6 +11,20 @@ import { IProfileUpdateOptions } from '../types/args/ProfileArgs';
  * @public
  */
 export class UserRequests {
+	/**
+	 * @param userName - The username of the user whose about profile is to be fetched.
+	 */
+	public static aboutByUsername(userName: string): AxiosRequestConfig {
+		return {
+			method: 'get',
+			url: 'https://x.com/i/api/graphql/zs_jFPFT78rBpXv9Z3U2YQ/AboutAccountQuery',
+			params: {
+				variables: JSON.stringify({ screenName: userName }),
+			},
+			paramsSerializer: { encode: encodeURIComponent },
+		};
+	}
+
 	/**
 	 * @param id - The id of the user whose affiliates are to be fetched.
 	 * @param count - The number of affiliates to fetch. Only works as a lower limit when used with a cursor.
@@ -311,6 +325,39 @@ export class UserRequests {
 		};
 	}
 
+	/**
+	 * @param currentPassword - The current password.
+	 * @param newPassword - The new password.
+	 */
+	public static changePassword(currentPassword: string, newPassword: string): AxiosRequestConfig {
+		return {
+			method: 'post',
+			url: 'https://x.com/i/api/i/account/change_password.json',
+			data: qs.stringify({
+				/* eslint-disable @typescript-eslint/naming-convention */
+				current_password: currentPassword,
+				password: newPassword,
+				password_confirmation: newPassword,
+				/* eslint-enable @typescript-eslint/naming-convention */
+			}),
+		};
+	}
+
+	/**
+	 * @param newUsername - The new username to set.
+	 */
+	public static changeUsername(newUsername: string): AxiosRequestConfig {
+		return {
+			method: 'post',
+			url: 'https://x.com/i/api/1.1/account/settings.json',
+			data: qs.stringify({
+				/* eslint-disable @typescript-eslint/naming-convention */
+				screen_name: newUsername,
+				/* eslint-enable @typescript-eslint/naming-convention */
+			}),
+		};
+	}
+
 	/**
 	 * @param id - The id of the user whose details are to be fetched.
 	 */
@@ -1209,4 +1256,26 @@ export class UserRequests {
 			}),
 		};
 	}
+
+	/**
+	 * @param bannerBase64 - The base64-encoded banner image data.
+	 */
+	public static updateProfileBanner(bannerBase64: string): AxiosRequestConfig {
+		return {
+			method: 'post',
+			url: 'https://x.com/i/api/1.1/account/update_profile_banner.json',
+			data: qs.stringify({ banner: bannerBase64 }),
+		};
+	}
+
+	/**
+	 * @param imageBase64 - The base64-encoded image data.
+	 */
+	public static updateProfileImage(imageBase64: string): AxiosRequestConfig {
+		return {
+			method: 'post',
+			url: 'https://x.com/i/api/1.1/account/update_profile_image.json',
+			data: qs.stringify({ image: imageBase64 }),
+		};
+	}
 }

package/src/services/internal/AuthService.ts

@@ -1,4 +1,6 @@
-import axios from 'axios';
+import axios, { AxiosResponse } from 'axios';
+
+import { Cookie } from 'cookiejar';
 
 import { ApiErrors } from '../../enums/Api';
 import { AuthCredential } from '../../models/auth/AuthCredential';
@@ -20,6 +22,21 @@ export class AuthService {
 		this._config = config;
 	}
 
+	/**
+	 * Splits the cookie header into a list of key=value pairs.
+	 *
+	 * @param cookieHeader - The value of the cookie header.
+	 *
+	 * @returns The list of key=value pairs in the cookies.
+	 */
+	private static _splitCookieHeader(cookieHeader: string | string[]): string[] {
+		if (Array.isArray(cookieHeader)) {
+			return cookieHeader;
+		}
+
+		return cookieHeader.split(/,(?=\s*[^;,]+=)/g);
+	}
+
 	/**
 	 * Decodes the encoded cookie string.
 	 *
@@ -46,6 +63,91 @@ export class AuthService {
 		return encodedCookies;
 	}
 
+	/**
+	 * Gets a new API key from an HTTP response.
+	 *
+	 * @param response - The HTTP response received.
+	 * @param config - The current Rettiwt config.
+	 *
+	 * @returns The new API key.
+	 */
+	public static getApiKeyFromReponse(response: AxiosResponse, config?: RettiwtConfig): string | undefined {
+		// If new cookies not returned or user not authenticated, terminate
+		if (response.headers['set-cookie'] === undefined || config?.apiKey === undefined) {
+			return;
+		}
+
+		/** The collection of required cookie names. */
+		const requiredCookieNames = new Set(['auth_token', 'ct0', 'kdt', 'twid']);
+
+		/** The current cookie string. */
+		const currentCookieString = AuthService.decodeCookie(config.apiKey);
+
+		/** The cookie key=value pairs from the response. */
+		const cookies = AuthService._splitCookieHeader(response.headers['set-cookie']);
+
+		/** The map from cookie key to value. */
+		const cookiesMap = new Map<string, string>();
+
+		for (const cookieEntry of currentCookieString.split(';')) {
+			const trimmedEntry = cookieEntry.trim();
+			const separatorIndex = trimmedEntry.indexOf('=');
+
+			if (!trimmedEntry || separatorIndex < 1) {
+				continue;
+			}
+
+			const key = trimmedEntry.slice(0, separatorIndex).trim();
+			const value = trimmedEntry.slice(separatorIndex + 1).trim();
+			if (!key || !value || !requiredCookieNames.has(key)) {
+				continue;
+			}
+
+			cookiesMap.set(key, value);
+		}
+
+		let hasUpdate = false;
+		for (const cookie of cookies) {
+			const cookieValuePair = cookie.split(';', 1)[0]?.trim();
+			const separatorIndex = cookieValuePair?.indexOf('=') ?? -1;
+
+			if (!cookieValuePair || separatorIndex < 1) {
+				continue;
+			}
+
+			const key = cookieValuePair.slice(0, separatorIndex).trim();
+			const value = cookieValuePair.slice(separatorIndex + 1).trim();
+			if (!key || !value || !requiredCookieNames.has(key)) {
+				continue;
+			}
+
+			cookiesMap.set(key, value);
+			hasUpdate = true;
+		}
+
+		if (!hasUpdate || !cookiesMap.has('twid')) {
+			return;
+		}
+
+		let mergedCookieString = '';
+		for (const [key, value] of cookiesMap.entries()) {
+			mergedCookieString += `${key}=${value};`;
+		}
+
+		if (!mergedCookieString) {
+			return;
+		}
+
+		try {
+			// Encoding the new cookies into an API key
+			const newApiKey = AuthService.encodeCookie(mergedCookieString);
+
+			return newApiKey;
+		} catch {
+			return;
+		}
+	}
+
 	/**
 	 * Gets the user's id from the given API key.
 	 *
@@ -71,6 +173,50 @@ export class AuthService {
 		}
 	}
 
+	/**
+	 * Fetches a fresh CSRF from Twitter by making a lightweight
+	 * authenticated request, then rotates the apiKey with the updated cookie.
+	 *
+	 * @param config - The current Rettiwt config.
+	 */
+	public static async refreshCsrfToken(config: RettiwtConfig): Promise<void> {
+		// If unauthenticated, skip
+		if (config.apiKey === undefined) {
+			return;
+		}
+
+		try {
+			const cred = new AuthCredential(
+				AuthService.decodeCookie(config.apiKey)
+					.split(';')
+					.map((item) => new Cookie(item)),
+			);
+
+			const refreshResponse = await axios.get('https://x.com/i/api/1.1/account/verify_credentials.json', {
+				headers: {
+					...cred.toHeader(),
+					authorization:
+						'Bearer AAAAAAAAAAAAAAAAAAAAANRILgAAAAAAnNwIzUejRCOuH5E6I8xnZz4puTs%3D1Zv7ttfk8LF81IUq16cHjhLTvJu4FA33AGWWjCpTnA',
+				},
+				httpAgent: config.httpAgent,
+				httpsAgent: config.httpsAgent,
+				proxy: config.axiosProxyConfig,
+				validateStatus: () => true,
+			});
+
+			// Getting the new API key
+			const newApiKey = AuthService.getApiKeyFromReponse(refreshResponse, config);
+
+			// If new API key is generated, update current API key
+			if (newApiKey !== undefined) {
+				config.apiKey = newApiKey;
+			}
+		} catch {
+			// If ct0 refresh fails, leave apiKey as-is
+			return;
+		}
+	}
+
 	/**
 	 * Login to twitter as guest.
 	 *
@@ -106,7 +252,9 @@ export class AuthService {
 				/* eslint-enable @typescript-eslint/naming-convention */
 			}>('https://api.twitter.com/1.1/guest/activate.json', undefined, {
 				headers: cred.toHeader(),
+				httpAgent: this._config.httpAgent,
 				httpsAgent: this._config.httpsAgent,
+				proxy: this._config.axiosProxyConfig,
 			})
 			.then((res) => {
 				cred.guestToken = res.data.guest_token;

package/src/services/public/DirectMessageService.ts

@@ -64,7 +64,7 @@ export class DirectMessageService extends FetcherService {
 		});
 
 		// Deserializing response
-		const data = Extractors[resource](response);
+		const data = Extractors[resource](response.data);
 
 		return data;
 	}
@@ -139,7 +139,7 @@ export class DirectMessageService extends FetcherService {
 			});
 
 			// Deserializing response
-			const data = Extractors[resource](response);
+			const data = Extractors[resource](response.data);
 
 			return data;
 		}
@@ -151,7 +151,7 @@ export class DirectMessageService extends FetcherService {
 			const response = await this.request<IInboxInitialResponse>(resource, {});
 
 			// Deserializing response
-			const data = Extractors[resource](response);
+			const data = Extractors[resource](response.data);
 
 			return data;
 		}