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

package/src/models/data/User.ts

@@ -1,55 +1,29 @@
-import { IUser as IRawUser, ITimelineUser, IUser } from 'rettiwt-core';
-
 import { ELogActions } from '../../enums/Logging';
 import { findByFilter } from '../../helper/JsonUtils';
 import { LogService } from '../../services/internal/LogService';
+import { IUser } from '../../types/data/User';
+import { IUser as IRawUser } from '../../types/raw/base/User';
+import { ITimelineUser as IRawTimelineUser } from '../../types/raw/composite/TimelineUser';
 
 /**
  * The details of a single user.
  *
  * @public
  */
-export class User {
-	/** The creation date of user's account. */
+export class User implements IUser {
 	public createdAt: string;
-
-	/** The user's description. */
 	public description?: string;
-
-	/** The number of followers of the user. */
 	public followersCount: number;
-
-	/** The number of following of the user. */
 	public followingsCount: number;
-
-	/** The full name of the user. */
 	public fullName: string;
-
-	/** The rest id of the user. */
 	public id: string;
-
-	/** Whether the account is verified or not. */
 	public isVerified: boolean;
-
-	/** The number of tweets liked by the user. */
 	public likeCount: number;
-
-	/** The location of user as provided by user. */
 	public location?: string;
-
-	/** The rest id of the tweet pinned in the user's profile. */
 	public pinnedTweet?: string;
-
-	/** The url of the profile banner image. */
 	public profileBanner?: string;
-
-	/** The url of the profile image. */
 	public profileImage: string;
-
-	/** The number of tweets made by the user. */
 	public statusesCount: number;
-
-	/** The username/screenname of the user. */
 	public userName: string;
 
 	/**
@@ -59,7 +33,7 @@ export class User {
 		this.id = user.rest_id;
 		this.userName = user.legacy.screen_name;
 		this.fullName = user.legacy.name;
-		this.createdAt = user.legacy.created_at;
+		this.createdAt = new Date(user.legacy.created_at).toISOString();
 		this.description = user.legacy.description.length ? user.legacy.description : undefined;
 		this.isVerified = user.is_blue_verified;
 		this.likeCount = user.legacy.favourites_count;
@@ -73,27 +47,26 @@ export class User {
 	}
 
 	/**
-	 * Extracts and deserializes the list of users from the given raw response data.
+	 * Extracts and deserializes multiple target users from the given raw response data.
 	 *
 	 * @param response - The raw response data.
+	 * @param ids - The ids of the target users.
 	 *
-	 * @returns The deserialized list of users.
-	 *
-	 * @internal
+	 * @returns The target deserialized users.
 	 */
-	public static list(response: NonNullable<unknown>): User[] {
-		const users: User[] = [];
+	public static multiple(response: NonNullable<unknown>, ids: string[]): User[] {
+		let users: User[] = [];
 
 		// Extracting the matching data
-		const extract = findByFilter<ITimelineUser>(response, '__typename', 'TimelineUser');
+		const extract = findByFilter<IRawUser>(response, '__typename', 'User');
 
 		// Deserializing valid data
 		for (const item of extract) {
-			if (item.user_results?.result?.legacy) {
+			if (item.legacy && item.legacy.created_at) {
 				// Logging
-				LogService.log(ELogActions.DESERIALIZE, { id: item.user_results.result.rest_id });
+				LogService.log(ELogActions.DESERIALIZE, { id: item.rest_id });
 
-				users.push(new User(item.user_results.result));
+				users.push(new User(item));
 			} else {
 				// Logging
 				LogService.log(ELogActions.WARNING, {
@@ -103,6 +76,11 @@ export class User {
 			}
 		}
 
+		// Filtering only required user, if required
+		if (ids && ids.length) {
+			users = users.filter((user) => ids.includes(user.id));
+		}
+
 		return users;
 	}
 
@@ -112,14 +90,12 @@ export class User {
 	 * @param response - The raw response data.
 	 *
 	 * @returns The target deserialized user.
-	 *
-	 * @internal
 	 */
 	public static single(response: NonNullable<unknown>): User | undefined {
 		const users: User[] = [];
 
 		// Extracting the matching data
-		const extract = findByFilter<IUser>(response, '__typename', 'User');
+		const extract = findByFilter<IRawUser>(response, '__typename', 'User');
 
 		// Deserializing valid data
 		for (const item of extract) {
@@ -139,4 +115,58 @@ export class User {
 
 		return users.length ? users[0] : undefined;
 	}
+
+	/**
+	 * Extracts and deserializes the timeline of users from the given raw response data.
+	 *
+	 * @param response - The raw response data.
+	 *
+	 * @returns The deserialized timeline of users.
+	 */
+	public static timeline(response: NonNullable<unknown>): User[] {
+		const users: User[] = [];
+
+		// Extracting the matching data
+		const extract = findByFilter<IRawTimelineUser>(response, '__typename', 'TimelineUser');
+
+		// Deserializing valid data
+		for (const item of extract) {
+			if (item.user_results?.result?.legacy) {
+				// Logging
+				LogService.log(ELogActions.DESERIALIZE, { id: item.user_results.result.rest_id });
+
+				users.push(new User(item.user_results.result));
+			} else {
+				// Logging
+				LogService.log(ELogActions.WARNING, {
+					action: ELogActions.DESERIALIZE,
+					message: `User not found, skipping`,
+				});
+			}
+		}
+
+		return users;
+	}
+
+	/**
+	 * @returns A serializable JSON representation of `this` object.
+	 */
+	public toJSON(): IUser {
+		return {
+			createdAt: this.createdAt,
+			description: this.description,
+			followersCount: this.followersCount,
+			followingsCount: this.followingsCount,
+			fullName: this.fullName,
+			id: this.id,
+			isVerified: this.isVerified,
+			likeCount: this.likeCount,
+			location: this.location,
+			pinnedTweet: this.pinnedTweet,
+			profileBanner: this.profileBanner,
+			profileImage: this.profileImage,
+			statusesCount: this.statusesCount,
+			userName: this.userName,
+		};
+	}
 }

package/src/models/errors/RettiwtError.ts

@@ -1,9 +1,10 @@
 /**
  * Represents an error that arises inside the package.
- *
- * @internal
  */
 export class RettiwtError extends Error {
+	/**
+	 * @param message - The error message.
+	 */
 	public constructor(message?: string) {
 		super(message);
 

package/src/models/params/Variables.ts

@@ -0,0 +1,62 @@
+import { IMediaEntityVariable, IMediaVariable, IReplyVariable } from '../../types/params/Variables';
+import { NewTweetMedia } from '../args/PostArgs';
+
+/**
+ * Media to be sent as payload.
+ *
+ * @internal
+ */
+export class MediaVariable implements IMediaVariable {
+	/* eslint-disable @typescript-eslint/naming-convention */
+	public media_entities: MediaEntityVariable[];
+	public possibly_sensitive: boolean;
+	/* eslint-enable @typescript-eslint/naming-convention */
+
+	/**
+	 * @param media - The list of NewTweetMedia objects specifying the media items to be sent in the Tweet.
+	 */
+	public constructor(media: NewTweetMedia[]) {
+		this.media_entities = media.map((item) => new MediaEntityVariable(item));
+		this.possibly_sensitive = false;
+	}
+}
+
+/**
+ * Each media item in the media payload.
+ *
+ * @internal
+ */
+export class MediaEntityVariable implements IMediaEntityVariable {
+	/* eslint-disable @typescript-eslint/naming-convention */
+	public media_id: string;
+	public tagged_users: string[];
+	/* eslint-enable @typescript-eslint/naming-convention */
+
+	/**
+	 * @param media - The NewTweetMedia object specifying the details of the media item to be included in the payload.
+	 */
+	public constructor(media: NewTweetMedia) {
+		this.media_id = media.id;
+		this.tagged_users = media.tags ?? [];
+	}
+}
+
+/**
+ * Reply specific details to be sent in payload.
+ *
+ * @internal
+ */
+export class ReplyVariable implements IReplyVariable {
+	/* eslint-disable @typescript-eslint/naming-convention */
+	public exclude_reply_user_ids: string[];
+	public in_reply_to_tweet_id: string;
+	/* eslint-enable @typescript-eslint/naming-convention */
+
+	/**
+	 * @param replyTo - The id of the Tweet to which this Tweet is a reply.
+	 */
+	public constructor(replyTo: string) {
+		this.in_reply_to_tweet_id = replyTo;
+		this.exclude_reply_user_ids = [];
+	}
+}

package/src/requests/List.ts

@@ -0,0 +1,121 @@
+import { AxiosRequestConfig } from 'axios';
+
+/**
+ * Collection of requests related to lists.
+ *
+ * @public
+ */
+export class ListRequests {
+	/**
+	 * @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/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.
+	 */
+	public static members(id: string, count?: number, cursor?: string): AxiosRequestConfig {
+		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.
+	 */
+	public static tweets(id: string, count?: number, cursor?: string): AxiosRequestConfig {
+		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 },
+		};
+	}
+}

package/src/requests/Media.ts

@@ -0,0 +1,67 @@
+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.
+	 */
+	public static appendUpload(id: string, media: string | ArrayBuffer): AxiosRequestConfig {
+		const data = new FormData();
+		data.append('media', typeof media == 'string' ? fs.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.
+	 */
+	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 */
+			},
+		};
+	}
+}