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

package/src/commands/User.ts

@@ -13,6 +13,21 @@ function createUserCommand(rettiwt: Rettiwt): Command {
 	// Creating the 'user' command
 	const user = createCommand('user').description('Access resources releated to users');
 
+	// Affiliates
+	user.command('affiliates')
+		.description('Fetch the list of users who affiliated to the given user')
+		.argument('<id>', 'The id of the user')
+		.argument('[count]', 'The number of affiliates to fetch')
+		.argument('[cursor]', 'The cursor to the batch of affiliates to fetch')
+		.action(async (id: string, count?: string, cursor?: string) => {
+			try {
+				const users = await rettiwt.user.affiliates(id, count ? parseInt(count) : undefined, cursor);
+				output(users);
+			} catch (error) {
+				output(error);
+			}
+		});
+
 	user.command('bookmarks')
 		.description('Fetch your list of bookmarks')
 		.argument('[count]', 'The number of bookmarks to fetch')

package/src/enums/Api.ts

@@ -5,57 +5,6 @@
  */
 export enum EApiErrors {
 	COULD_NOT_AUTHENTICATE = 'Failed to authenticate',
-	RESOURCE_NOT_FOUND = 'Requested resource not found',
-	MISSING_PARAMETER = 'Missing named parameter',
-	USER_NOT_FOUND = 'Requested user not found',
-	USER_SUSPENDED = 'Requested user has been suspended',
-	ACCOUNT_SUSPENDED = 'Account has been suspended',
-	RATE_LIMIT_EXCEEDED = 'Rate limit exceeded',
-	INTERNAL_ERROR = 'Internal server error',
-	TIME_ERROR = 'Mismatched data/time with server',
-	ALREADY_FAVORITED = 'Tweet already favorited',
-	STATUS_NOT_FOUND = 'Requested tweeet not found',
-	NOT_AUTHORIZED = 'Not authorized to view tweet',
-	DAILY_STATUS_LIMIT_EXCEEDED = 'Exceeded daily tweet update limit',
-	TWEET_LENGTH_EXCEEDED = 'Exceeded tweet text maximum length',
-	DUPLICATE_STATUS = 'Tweet already posted',
 	BAD_AUTHENTICATION = 'Invalid authentication data',
 	RESOURCE_NOT_ALLOWED = 'Not authorized to access requested resource',
-	AUTOMATED_REQUEST_ERROR = 'Automated request detected',
-	ACCOUNT_LOCKED = 'Account has been locked',
-	ALREADY_RETWEETED = 'Tweet already retweeted',
-	TWEET_NOT_FOUND = 'Requested tweet not found',
-	TWEET_VIOLATED_RULES = 'Requestd tweet has been removed for rules violation',
-	DISABLED_TWEET_ACTIONS = 'Reqeusted action disabled on the tweet',
-}
-
-/**
- * The different error codes.
- *
- * @public
- */
-export enum EErrorCodes {
-	COULD_NOT_AUTHENTICATE = 32,
-	RESOURCE_NOT_FOUND = 34,
-	MISSING_PARAMETER = 38,
-	USER_NOT_FOUND = 50,
-	USER_SUSPENDED = 63,
-	ACCOUNT_SUSPENDED = 64,
-	RATE_LIMIT_EXCEEDED = 88,
-	INTERNAL_ERROR = 131,
-	TIME_ERROR = 135,
-	ALREADY_FAVORITED = 139,
-	STATUS_NOT_FOUND = 144,
-	NOT_AUTHORIZED = 179,
-	DAILY_STATUS_LIMIT_EXCEEDED = 185,
-	TWEET_LENGTH_EXCEEDED = 186,
-	DUPLICATE_STATUS = 187,
-	BAD_AUTHENTICATION = 215,
-	RESOURCE_NOT_ALLOWED = 220,
-	AUTOMATED_REQUEST_ERROR = 226,
-	ACCOUNT_LOCKED = 326,
-	ALREADY_RETWEETED = 327,
-	TWEET_NOT_FOUND = 421,
-	TWEET_VIOLATED_RULES = 422,
-	DISABLED_TWEET_ACTIONS = 425,
 }

package/src/enums/Resource.ts

@@ -31,6 +31,7 @@ export enum EResourceType {
 	TWEET_UNSCHEDULE = 'TWEET_UNSCHEDULE',
 
 	// USER
+	USER_AFFILIATES = 'USER_AFFILIATES',
 	USER_BOOKMARKS = 'USER_BOOKMARKS',
 	USER_DETAILS_BY_USERNAME = 'USER_DETAILS_BY_USERNAME',
 	USER_DETAILS_BY_ID = 'USER_DETAILS_BY_ID',

package/src/index.ts

@@ -9,7 +9,6 @@ export * from './enums/raw/Tweet';
 export * from './enums/Api';
 export * from './enums/Authentication';
 export * from './enums/Data';
-export * from './enums/Http';
 export * from './enums/Logging';
 export * from './enums/Media';
 export * from './enums/Notification';
@@ -23,10 +22,7 @@ export * from './models/data/List';
 export * from './models/data/Notification';
 export * from './models/data/Tweet';
 export * from './models/data/User';
-export * from './models/errors/ApiError';
-export * from './models/errors/HttpError';
-export * from './models/errors/RettiwtError';
-export * from './models/errors/TimeoutError';
+export * from './models/errors/TwitterError';
 
 // REQUESTS
 export * from './requests/List';
@@ -49,9 +45,11 @@ export * from './types/data/List';
 export * from './types/data/Notification';
 export * from './types/data/Tweet';
 export * from './types/data/User';
+export * from './types/errors/TwitterError';
 export * from './types/params/Variables';
 export { IAnalytics as IRawAnalytics } from './types/raw/base/Analytic';
 export { ICursor as IRawCursor } from './types/raw/base/Cursor';
+export { IErrorData as IRawErrorData, IErrorDetails as IRawErrorDetails } from './types/raw/base/Error';
 export { ILimitedVisibilityTweet as IRawLimitedVisibilityTweet } from './types/raw/base/LimitedVisibilityTweet';
 export { IList as IRawList } from './types/raw/base/List';
 export { IMedia as IRawMedia } from './types/raw/base/Media';
@@ -62,7 +60,6 @@ export { IUser as IRawUser } from './types/raw/base/User';
 export { IDataResult as IRawDataResult } from './types/raw/composite/DataResult';
 export { ITimelineTweet as IRawTimelineTweet } from './types/raw/composite/TimelineTweet';
 export { ITimelineUser as IRawTimelineUser } from './types/raw/composite/TimelineUser';
-export { IError as IRawError } from './types/raw/generic/Error';
 export { IResponse as IRawResponse } from './types/raw/generic/Response';
 export { IListDetailsResponse as IRawListDetailsResponse } from './types/raw/list/Details';
 export { IListMembersResponse as IRawListMembersResponse } from './types/raw/list/Members';
@@ -71,6 +68,7 @@ export { IMediaFinalizeUploadResponse as IRawMediaFinalizeUploadResponse } from
 export { IMediaInitializeUploadResponse as IRawMediaInitializeUploadResponse } from './types/raw/media/InitalizeUpload';
 export { IMediaLiveVideoStreamResponse as IRawMediaLiveVideoStreamResponse } from './types/raw/media/LiveVideoStream';
 export { ITweetDetailsResponse as IRawTweetDetailsResponse } from './types/raw/tweet/Details';
+export { ITweetDetailsBulkResponse as IRawTweetDetailsBulkResponse } from './types/raw/tweet/DetailsBulk';
 export { ITweetLikeResponse as IRawTweetLikeResponse } from './types/raw/tweet/Like';
 export { ITweetLikersResponse as IRawTweetLikersResponse } from './types/raw/tweet/Likers';
 export { ITweetPostResponse as IRawTweetPostResponse } from './types/raw/tweet/Post';
@@ -87,6 +85,7 @@ export { IUserAffiliatesResponse as IRawUserAffiliatesResponse } from './types/r
 export { IUserAnalyticsResponse as IRawUserAnalyticsResponse } from './types/raw/user/Analytics';
 export { IUserBookmarksResponse as IRawUserBookmarksResponse } from './types/raw/user/Bookmarks';
 export { IUserDetailsResponse as IRawUserDetailsResponse } from './types/raw/user/Details';
+export { IUserDetailsBulkResponse as IRawUserDetailsBulkResponse } from './types/raw/user/DetailsBulk';
 export { IUserFollowResponse as IRawUserFollowResponse } from './types/raw/user/Follow';
 export { IUserFollowedResponse as IRawUserFollowedResponse } from './types/raw/user/Followed';
 export { IUserFollowersResponse as IRawUserFollowersResponse } from './types/raw/user/Followers';

package/src/models/data/List.ts

@@ -7,6 +7,9 @@ import { IList as IRawList } from '../../types/raw/base/List';
  * @public
  */
 export class List implements IList {
+	/** The raw list details. */
+	private readonly _raw: IRawList;
+
 	public createdAt: string;
 	public createdBy: string;
 	public description?: string;
@@ -19,6 +22,7 @@ export class List implements IList {
 	 * @param list - The raw list details.
 	 */
 	public constructor(list: IRawList) {
+		this._raw = { ...list };
 		this.id = list.id_str;
 		this.name = list.name;
 		this.createdAt = new Date(list.created_at).toISOString();
@@ -28,6 +32,11 @@ export class List implements IList {
 		this.createdBy = list.user_results.result.id;
 	}
 
+	/** Get the raw list details. */
+	public get raw(): IRawList {
+		return { ...this._raw };
+	}
+
 	/**
 	 * @returns A serializable JSON representation of `this` object.
 	 */

package/src/models/data/Notification.ts

@@ -11,6 +11,9 @@ import { IUserNotificationsResponse } from '../../types/raw/user/Notifications';
  * @public
  */
 export class Notification implements INotification {
+	/** The raw notification details. */
+	private readonly _raw: IRawNotification;
+
 	public from: string[];
 	public id: string;
 	public message: string;
@@ -22,6 +25,8 @@ export class Notification implements INotification {
 	 * @param notification - The raw notification details.
 	 */
 	public constructor(notification: IRawNotification) {
+		this._raw = { ...notification };
+
 		// Getting the original notification type
 		const notificationType: string | undefined = findKeyByValue(ERawNotificationType, notification.icon.id);
 
@@ -39,6 +44,11 @@ export class Notification implements INotification {
 			: ENotificationType.UNDEFINED;
 	}
 
+	/** Get the raw notification details. */
+	public get raw(): IRawNotification {
+		return { ...this._raw };
+	}
+
 	/**
 	 * Extracts and deserializes the list of notifications from the given raw response data.
 	 *

package/src/models/data/Tweet.ts

@@ -19,6 +19,9 @@ import { User } from './User';
  * @public
  */
 export class Tweet implements ITweet {
+	/** The raw tweet details. */
+	private readonly _raw: IRawTweet;
+
 	public bookmarkCount: number;
 	public conversationId: string;
 	public createdAt: string;
@@ -42,6 +45,7 @@ export class Tweet implements ITweet {
 	 * @param tweet - The raw tweet details.
 	 */
 	public constructor(tweet: IRawTweet) {
+		this._raw = { ...tweet };
 		this.id = tweet.rest_id;
 		this.conversationId = tweet.legacy.conversation_id_str;
 		this.createdAt = new Date(tweet.legacy.created_at).toISOString();
@@ -62,6 +66,11 @@ export class Tweet implements ITweet {
 		this.url = `https://x.com/${this.tweetBy.userName}/status/${this.id}`;
 	}
 
+	/** Get the raw tweet details. */
+	public get raw(): IRawTweet {
+		return { ...this._raw };
+	}
+
 	/**
 	 * Extract and deserialize the original quoted tweet from the given raw tweet.
 	 *

package/src/models/data/User.ts

@@ -11,6 +11,9 @@ import { ITimelineUser as IRawTimelineUser } from '../../types/raw/composite/Tim
  * @public
  */
 export class User implements IUser {
+	/** The raw user details. */
+	private readonly _raw: IRawUser;
+
 	public createdAt: string;
 	public description?: string;
 	public followersCount: number;
@@ -30,6 +33,7 @@ export class User implements IUser {
 	 * @param user - The raw user details.
 	 */
 	public constructor(user: IRawUser) {
+		this._raw = { ...user };
 		this.id = user.rest_id;
 		this.userName = user.legacy.screen_name;
 		this.fullName = user.legacy.name;
@@ -46,6 +50,11 @@ export class User implements IUser {
 		this.profileImage = user.legacy.profile_image_url_https;
 	}
 
+	/** Get the raw user details. */
+	public get raw(): IRawUser {
+		return { ...this._raw };
+	}
+
 	/**
 	 * Extracts and deserializes multiple target users from the given raw response data.
 	 *

package/src/models/errors/TwitterError.ts

@@ -0,0 +1,65 @@
+import { AxiosError } from 'axios';
+
+import { ITwitterError, ITwitterErrorDetails } from '../../types/errors/TwitterError';
+import { IErrorData as IRawErrorData, IErrorDetails as IRawErrorDetails } from '../../types/raw/base/Error';
+
+/**
+ * The error thrown by Twitter API.
+ *
+ * @public
+ */
+export class TwitterError extends Error implements ITwitterError {
+	public details: ITwitterErrorDetails[];
+	public message: string;
+	public name: string;
+	public status: number;
+
+	/**
+	 * @param error - The error response received from Twitter.
+	 */
+	public constructor(error: AxiosError<IRawErrorData | IRawErrorDetails>) {
+		super(error.message);
+		this.details = (
+			(error.response?.data as IRawErrorData).errors
+				? (error.response?.data as IRawErrorData).errors.map((item) => new TwitterErrorDetails(item))
+				: [new TwitterErrorDetails(error.response?.data as IRawErrorDetails)]
+		).map((item) => item.toJSON());
+		this.message = error.message;
+		this.name = 'TWITTER_ERROR';
+		this.status = error.status ?? 500;
+	}
+}
+
+/**
+ * The error details.
+ *
+ * @public
+ */
+export class TwitterErrorDetails implements ITwitterErrorDetails {
+	public code: number;
+	public message: string;
+	public name?: string;
+	public type?: string;
+
+	/**
+	 * @param details - The details of the error.
+	 */
+	public constructor(details: IRawErrorDetails) {
+		this.code = details.code;
+		this.message = details.message;
+		this.name = details.name;
+		this.type = details.kind;
+	}
+
+	/**
+	 * @returns The JSON representation of `this` object.
+	 */
+	public toJSON(): ITwitterErrorDetails {
+		return {
+			code: this.code,
+			message: this.message,
+			name: this.message,
+			type: this.type,
+		};
+	}
+}

package/src/requests/List.ts

@@ -37,7 +37,7 @@ export class ListRequests {
 	public static members(id: string, count?: number, cursor?: string): AxiosRequestConfig {
 		return {
 			method: 'get',
-			url: 'https://x.com/i/api/graphql/dsJhIe3M0vCopjSfU6SlQw/ListMembers',
+			url: 'https://x.com/i/api/graphql/T7VZsrWpCoi4jWxFdwyNcg/ListMembers',
 			params: {
 				/* eslint-disable @typescript-eslint/naming-convention */
 				variables: JSON.stringify({
@@ -46,14 +46,20 @@ export class ListRequests {
 					cursor: cursor,
 				}),
 				features: JSON.stringify({
+					rweb_video_screen_enabled: false,
+					profile_label_improvements_pcf_label_in_post_enabled: true,
 					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,
+					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: false,
+					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,
@@ -61,13 +67,15 @@ export class ListRequests {
 					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,
-					rweb_video_timestamps_enabled: true,
 					longform_notetweets_rich_text_read_enabled: true,
 					longform_notetweets_inline_media_enabled: true,
+					responsive_web_grok_image_annotation_enabled: true,
 					responsive_web_enhance_cards_enabled: false,
 				}),
 				/* eslint-enable @typescript-eslint/naming-convention */
@@ -83,7 +91,7 @@ export class ListRequests {
 	public static tweets(id: string, count?: number, cursor?: string): AxiosRequestConfig {
 		return {
 			method: 'get',
-			url: 'https://x.com/i/api/graphql/naCjgapXCSCsbZ7qnnItQA/ListLatestTweetsTimeline',
+			url: 'https://x.com/i/api/graphql/BkauSnPUDQTeeJsxq17opA/ListLatestTweetsTimeline',
 			params: {
 				/* eslint-disable @typescript-eslint/naming-convention */
 				variables: JSON.stringify({
@@ -92,25 +100,36 @@ export class ListRequests {
 					cursor: cursor,
 				}),
 				features: JSON.stringify({
-					rweb_lists_timeline_redesign_enabled: true,
-					responsive_web_graphql_exclude_directive_enabled: true,
+					rweb_video_screen_enabled: false,
+					profile_label_improvements_pcf_label_in_post_enabled: true,
+					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,
-					tweetypie_unmention_optimization_enabled: true,
+					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: false,
+					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: false,
+					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_media_download_video_enabled: false,
+					responsive_web_grok_image_annotation_enabled: true,
 					responsive_web_enhance_cards_enabled: false,
 				}),
 				/* eslint-enable @typescript-eslint/naming-convention */