@youmind-openlab/rettiwt-api 1.0.3 → 1.0.4

package/src/commands/User.ts

@@ -1,3 +1,7 @@
+import { readFileSync } from 'fs';
+import { createInterface } from 'readline/promises';
+import { Writable } from 'stream';
+
 import { Command, createCommand } from 'commander';
 
 import { RawAnalyticsGranularity, RawAnalyticsMetric } from '../enums/raw/Analytics';
@@ -353,9 +357,144 @@ function createUserCommand(rettiwt: Rettiwt): Command {
 			}
 		});
 
+	// Change Password
+	user.command('change-password')
+		.description('Change your account password')
+		.option('--show-new-key', 'Include rotated apiKey in the output')
+		.action(async (options?: UserPasswordChangeOptions) => {
+			try {
+				const initialApiKey = rettiwt.apiKey;
+				const currentPassword = await promptHidden('Current password: ');
+				const newPassword = await promptHidden('New password: ');
+				const confirmPassword = await promptHidden('Confirm new password: ');
+
+				if (newPassword !== confirmPassword) {
+					throw new Error('New password confirmation does not match');
+				}
+				if (newPassword === currentPassword) {
+					throw new Error('New password must be different from current password');
+				}
+
+				const result = await rettiwt.user.changePassword(currentPassword, newPassword);
+				const apiKeyUpdated = initialApiKey !== rettiwt.apiKey;
+				const response = {
+					success: result,
+					apiKeyUpdated: result ? apiKeyUpdated : false,
+					...(options?.showNewKey ? { apiKey: rettiwt.apiKey } : {}),
+				};
+
+				output(response);
+			} catch (error) {
+				output(error);
+			}
+		});
+
+	// Change Username
+	user.command('change-username')
+		.description('Change your username')
+		.argument('<username>', 'The new username (with or without @)')
+		.action(async (username: string) => {
+			try {
+				const result = await rettiwt.user.changeUsername(username);
+				output(result);
+			} catch (error) {
+				output(error);
+			}
+		});
+
+	// Update Profile Banner
+	user.command('update-profile-banner')
+		.description('Update your profile banner from an image file path')
+		.argument('<path>', 'The path to the banner image file')
+		.action(async (path: string) => {
+			try {
+				const result = await rettiwt.user.updateProfileBanner(fileToBase64(path));
+				output(result);
+			} catch (error) {
+				output(error);
+			}
+		});
+
+	// Update Profile Image
+	user.command('update-profile-image')
+		.description('Update your profile image from an image file path')
+		.argument('<path>', 'The path to the profile image file')
+		.action(async (path: string) => {
+			try {
+				const result = await rettiwt.user.updateProfileImage(fileToBase64(path));
+				output(result);
+			} catch (error) {
+				output(error);
+			}
+		});
+
 	return user;
 }
 
+/**
+ * Reads a file and returns its base64 representation.
+ *
+ * @param path - The path to the file.
+ * @returns The base64 representation of the file contents.
+ */
+function fileToBase64(path: string): string {
+	if (path.trim().length === 0) {
+		throw new Error('File path cannot be empty');
+	}
+
+	try {
+		return readFileSync(path).toString('base64');
+	} catch (error) {
+		if (error instanceof Error) {
+			throw new Error(`Could not read file at '${path}': ${error.message}`);
+		}
+
+		throw new Error(`Could not read file at '${path}'`);
+	}
+}
+
+/**
+ * Prompts user for hidden input without echoing typed characters.
+ *
+ * @param query - The prompt text.
+ * @returns The provided value.
+ */
+async function promptHidden(query: string): Promise<string> {
+	if (!process.stdin.isTTY || !process.stdout.isTTY) {
+		throw new Error('Password prompt requires an interactive terminal');
+	}
+
+	let queryShown = false;
+
+	const mutedOutput = new Writable({
+		write(chunk: Buffer | string, encoding: BufferEncoding, callback: (error?: Error | null) => void): void {
+			const text = chunk.toString();
+
+			if (!queryShown) {
+				process.stdout.write(text);
+				queryShown = text.includes(query);
+			}
+
+			callback();
+		},
+	});
+
+	const input = createInterface({
+		input: process.stdin,
+		output: mutedOutput,
+		terminal: true,
+	});
+
+	try {
+		const value = await input.question(query);
+		process.stdout.write('\n');
+
+		return value;
+	} finally {
+		input.close();
+	}
+}
+
 /**
  * The options for fetching user analytics.
  */
@@ -377,4 +516,11 @@ type UserProfileUpdateOptions = {
 	description?: string;
 };
 
+/**
+ * The options for changing account password.
+ */
+type UserPasswordChangeOptions = {
+	showNewKey?: boolean;
+};
+
 export default createUserCommand;

package/src/enums/Resource.ts

@@ -33,6 +33,7 @@ export enum ResourceType {
 	TWEET_LIKE = 'TWEET_LIKE',
 	TWEET_LIKERS = 'TWEET_LIKERS',
 	TWEET_POST = 'TWEET_POST',
+	TWEET_POST_NOTE = 'TWEET_POST_NOTE',
 	TWEET_REPLIES = 'TWEET_REPLIES',
 	TWEET_RETWEET = 'TWEET_RETWEET',
 	TWEET_RETWEETERS = 'TWEET_RETWEETERS',
@@ -70,4 +71,8 @@ export enum ResourceType {
 	USER_TIMELINE_AND_REPLIES = 'USER_TIMELINE_AND_REPLIES',
 	USER_UNFOLLOW = 'USER_UNFOLLOW',
 	USER_PROFILE_UPDATE = 'USER_PROFILE_UPDATE',
+	USER_PROFILE_IMAGE_UPDATE = 'USER_PROFILE_IMAGE_UPDATE',
+	USER_PROFILE_BANNER_UPDATE = 'USER_PROFILE_BANNER_UPDATE',
+	USER_USERNAME_CHANGE = 'USER_USERNAME_CHANGE',
+	USER_PASSWORD_CHANGE = 'USER_PASSWORD_CHANGE',
 }

package/src/index.ts

@@ -128,6 +128,8 @@ export { IUserTweetsResponse as IRawUserTweetsResponse } from './types/raw/user/
 export { IUserTweetsAndRepliesResponse as IRawUserTweetsAndRepliesResponse } from './types/raw/user/TweetsAndReplies';
 export { IUserUnfollowResponse as IRawUserUnfollowResponse } from './types/raw/user/Unfollow';
 export { IUserProfileUpdateResponse as IRawUserProfileUpdateResponse } from './types/raw/user/ProfileUpdate';
+export { IUserSettingsResponse as IRawUserSettingsResponse } from './types/raw/user/Settings';
+export { IUserChangePasswordResponse as IRawUserChangePasswordResponse } from './types/raw/user/ChangePassword';
 export * from './types/ErrorHandler';
 export * from './types/RettiwtConfig';
 export { IConversationTimelineResponse as IRawConversationTimelineResponse } from './types/raw/dm/Conversation';

package/src/models/args/PostArgs.ts

@@ -1,4 +1,4 @@
-import { INewTweet, INewTweetMedia, IPostArgs, IUploadArgs } from '../../types/args/PostArgs';
+import { IChangePasswordArgs, INewTweet, INewTweetMedia, IPostArgs, IUploadArgs } from '../../types/args/PostArgs';
 
 import { ProfileUpdateOptions } from './ProfileArgs';
 
@@ -8,12 +8,16 @@ import { ProfileUpdateOptions } from './ProfileArgs';
  * @public
  */
 export class PostArgs implements IPostArgs {
+	public changePassword?: ChangePasswordArgs;
 	public conversationId?: string;
 	public id?: string;
+	public profileBanner?: string;
+	public profileImage?: string;
 	public profileOptions?: ProfileUpdateOptions;
 	public tweet?: NewTweet;
 	public upload?: UploadArgs;
 	public userId?: string;
+	public username?: string;
 
 	/**
 	 * @param resource - The resource to be posted.
@@ -24,8 +28,28 @@ export class PostArgs implements IPostArgs {
 		this.tweet = args.tweet ? new NewTweet(args.tweet) : undefined;
 		this.upload = args.upload ? new UploadArgs(args.upload) : undefined;
 		this.userId = args.userId;
+		this.username = PostArgs._validateNonEmptyString(args.username, 'Username');
 		this.conversationId = args.conversationId;
 		this.profileOptions = args.profileOptions ? new ProfileUpdateOptions(args.profileOptions) : undefined;
+		this.profileImage = PostArgs._validateNonEmptyString(args.profileImage, 'Profile image');
+		this.profileBanner = PostArgs._validateNonEmptyString(args.profileBanner, 'Profile banner');
+		this.changePassword = args.changePassword ? new ChangePasswordArgs(args.changePassword) : undefined;
+	}
+
+	private static _validateNonEmptyString(value: unknown, fieldName: string): string | undefined {
+		if (value === undefined) {
+			return undefined;
+		}
+
+		if (typeof value !== 'string') {
+			throw new Error(`${fieldName} must be a string`);
+		}
+
+		if (value.trim().length === 0) {
+			throw new Error(`${fieldName} cannot be empty`);
+		}
+
+		return value;
 	}
 }
 
@@ -91,3 +115,27 @@ export class UploadArgs implements IUploadArgs {
 		this.id = args.id;
 	}
 }
+
+/**
+ * Validated password change arguments.
+ *
+ * @public
+ */
+export class ChangePasswordArgs implements IChangePasswordArgs {
+	public currentPassword: string;
+	public newPassword: string;
+
+	public constructor(args: IChangePasswordArgs) {
+		if (!args.currentPassword || args.currentPassword.trim().length === 0) {
+			throw new Error('Current password cannot be empty');
+		}
+		if (!args.newPassword || args.newPassword.trim().length === 0) {
+			throw new Error('New password cannot be empty');
+		}
+		if (args.newPassword.length < 8) {
+			throw new Error('New password must be at least 8 characters long');
+		}
+		this.currentPassword = args.currentPassword;
+		this.newPassword = args.newPassword;
+	}
+}

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

@@ -326,6 +326,43 @@ export class UserRequests {
 		};
 	}
 
+	/**
+	 * Returns the request to change the user's password.
+	 *
+	 * @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 */
+			}),
+		};
+	}
+
+	/**
+	 * Returns the request to change the user's username (screen_name).
+	 *
+	 * @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.
 	 */
@@ -1224,4 +1261,30 @@ export class UserRequests {
 			}),
 		};
 	}
+
+	/**
+	 * Returns the request to update the user's profile banner.
+	 *
+	 * @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 }),
+		};
+	}
+
+	/**
+	 * Returns the request to update the user's profile image.
+	 *
+	 * @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/public/FetcherService.ts

@@ -1,4 +1,4 @@
-import axios, { AxiosError, isAxiosError } from 'axios';
+import axios, { AxiosError, AxiosResponse, isAxiosError } from 'axios';
 import { Cookie } from 'cookiejar';
 import { JSDOM } from 'jsdom';
 import { ClientTransaction } from 'x-client-transaction-id';
@@ -254,11 +254,11 @@ export class FetcherService {
 	 * Makes an HTTP request according to the given parameters.
 	 *
 	 * @param resource - The requested resource.
-	 * @param config - The request configuration.
+	 * @param args - The args to be used for the request.
 	 *
 	 * @typeParam T - The type of the returned response data.
 	 *
-	 * @returns The raw data response received.
+	 * @returns The raw HTTP response received.
 	 *
 	 * @example
 	 *
@@ -279,7 +279,10 @@ export class FetcherService {
 	 * });
 	 * ```
 	 */
-	public async request<T = unknown>(resource: ResourceType, args: IFetchArgs | IPostArgs): Promise<T> {
+	protected async requestWithResponse<T = unknown>(
+		resource: ResourceType,
+		args: IFetchArgs | IPostArgs,
+	): Promise<AxiosResponse<T>> {
 		/** The current retry number. */
 		let retry = 0;
 
@@ -325,7 +328,8 @@ export class FetcherService {
 				await this._wait();
 
 				// Getting the response body
-				const responseData = (await axios<T>(config)).data;
+				const response = await axios<T>(config);
+				const responseData = response.data;
 
 				// Check for Twitter API errors in response body
 				// Type guard to check if response contains errors
@@ -348,8 +352,8 @@ export class FetcherService {
 					throw new TwitterError(axiosError);
 				}
 
-				// Returning the reponse body
-				return responseData;
+				// Returning the response
+				return response;
 			} catch (err) {
 				// If it's an error 404, retry
 				if (isAxiosError(err) && err.status === 404) {
@@ -369,4 +373,20 @@ export class FetcherService {
 		/** If request not successful even after retries, throw the error */
 		throw error;
 	}
+
+	/**
+	 * Makes an HTTP request according to the given parameters.
+	 *
+	 * @param resource - The requested resource.
+	 * @param args - The args to be used for the request.
+	 *
+	 * @typeParam T - The type of the returned response data.
+	 *
+	 * @returns The raw data response received.
+	 */
+	public async request<T = unknown>(resource: ResourceType, args: IFetchArgs | IPostArgs): Promise<T> {
+		const response = await this.requestWithResponse<T>(resource, args);
+
+		return response.data;
+	}
 }

package/src/services/public/TweetService.ts

@@ -17,7 +17,7 @@ import { ITweetDetailsResponse } from '../../types/raw/tweet/Details';
 import { ITweetDetailsBulkResponse } from '../../types/raw/tweet/DetailsBulk';
 import { ITweetLikeResponse } from '../../types/raw/tweet/Like';
 import { ITweetLikersResponse } from '../../types/raw/tweet/Likers';
-import { ITweetPostResponse } from '../../types/raw/tweet/Post';
+import { ITweetPostNoteResponse, ITweetPostResponse } from '../../types/raw/tweet/Post';
 import { ITweetRepliesResponse } from '../../types/raw/tweet/Replies';
 import { ITweetRetweetResponse } from '../../types/raw/tweet/Retweet';
 import { ITweetRetweetersResponse } from '../../types/raw/tweet/Retweeters';
@@ -342,15 +342,18 @@ export class TweetService extends FetcherService {
 	 * ```
 	 */
 	public async post(options: INewTweet): Promise<string | undefined> {
-		const resource = ResourceType.TWEET_POST;
+		// Use CreateNoteTweet endpoint for long-form tweets (X Premium, >280 chars)
+		if ((options.text?.length ?? 0) > 280) {
+			const response = await this.request<ITweetPostNoteResponse>(ResourceType.TWEET_POST_NOTE, {
+				tweet: options,
+			});
 
-		// Posting the tweet
-		const response = await this.request<ITweetPostResponse>(resource, { tweet: options });
+			return Extractors[ResourceType.TWEET_POST_NOTE](response);
+		}
 
-		// Deserializing response
-		const data = Extractors[resource](response);
+		const response = await this.request<ITweetPostResponse>(ResourceType.TWEET_POST, { tweet: options });
 
-		return data;
+		return Extractors[ResourceType.TWEET_POST](response);
 	}
 
 	/**