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

package/src/models/data/Notification.ts

@@ -1,61 +1,36 @@
-import {
-	ENotificationType as ENotificationTypeOriginal,
-	INotification,
-	IUserNotificationsResponse,
-} from 'rettiwt-core';
-
+import { ENotificationType } from '../../enums/Notification';
+import { ERawNotificationType } from '../../enums/raw/Notification';
 import { findKeyByValue } from '../../helper/JsonUtils';
-
-/**
- * The different types of notifications.
- *
- * @public
- */
-export enum ENotificationType {
-	RECOMMENDATION = 'RECOMMENDATION',
-	INFORMATION = 'INFORMATION',
-	LIVE = 'LIVE',
-	ALERT = 'ALERT',
-	UNDEFINED = 'UNDEFINED',
-}
+import { INotification } from '../../types/data/Notification';
+import { INotification as IRawNotification } from '../../types/raw/base/Notification';
+import { IUserNotificationsResponse } from '../../types/raw/user/Notifications';
 
 /**
  * The details of a single notification.
  *
  * @public
  */
-export class Notification {
-	/** The list of id of the users from whom the notification was received. */
+export class Notification implements INotification {
 	public from: string[];
-
-	/** The id of the notification. */
 	public id: string;
-
-	/** The text contents of the notification. */
 	public message: string;
-
-	/** The date/time at which the notification was received. */
-	public receivedAt: Date;
-
-	/** The list of id of the target tweet(s) of the notification. */
+	public receivedAt: string;
 	public target: string[];
-
-	/** The type of notification. */
 	public type?: ENotificationType;
 
 	/**
 	 * @param notification - The raw notification details.
 	 */
-	public constructor(notification: INotification) {
+	public constructor(notification: IRawNotification) {
 		// Getting the original notification type
-		const notificationType: string | undefined = findKeyByValue(ENotificationTypeOriginal, notification.icon.id);
+		const notificationType: string | undefined = findKeyByValue(ERawNotificationType, notification.icon.id);
 
 		this.from = notification.template?.aggregateUserActionsV1?.fromUsers
 			? notification.template.aggregateUserActionsV1.fromUsers.map((item) => item.user.id)
 			: [];
 		this.id = notification.id;
 		this.message = notification.message.text;
-		this.receivedAt = new Date(Number(notification.timestampMs));
+		this.receivedAt = new Date(Number(notification.timestampMs)).toISOString();
 		this.target = notification.template?.aggregateUserActionsV1?.targetObjects
 			? notification.template.aggregateUserActionsV1.targetObjects.map((item) => item.tweet.id)
 			: [];
@@ -70,8 +45,6 @@ export class Notification {
 	 * @param response - The raw response data.
 	 *
 	 * @returns The deserialized list of notifications.
-	 *
-	 * @internal
 	 */
 	public static list(response: NonNullable<unknown>): Notification[] {
 		const notifications: Notification[] = [];
@@ -82,10 +55,24 @@ export class Notification {
 			for (const [, value] of Object.entries(
 				(response as IUserNotificationsResponse).globalObjects.notifications,
 			)) {
-				notifications.push(new Notification(value as INotification));
+				notifications.push(new Notification(value as IRawNotification));
 			}
 		}
 
 		return notifications;
 	}
+
+	/**
+	 * @returns A serializable JSON representation of `this` object.
+	 */
+	public toJSON(): INotification {
+		return {
+			from: this.from,
+			id: this.id,
+			message: this.message,
+			receivedAt: this.receivedAt,
+			target: this.target,
+			type: this.type,
+		};
+	}
 }

package/src/models/data/Tweet.ts

@@ -1,18 +1,16 @@
-import {
-	EMediaType,
-	ILimitedVisibilityTweet,
-	IExtendedMedia as IRawExtendedMedia,
-	ITweet as IRawTweet,
-	IEntities as IRawTweetEntities,
-	ITimelineTweet,
-	ITweet,
-} from 'rettiwt-core';
-
 import { ELogActions } from '../../enums/Logging';
+import { EMediaType } from '../../enums/Media';
+import { ERawMediaType } from '../../enums/raw/Media';
 import { findByFilter } from '../../helper/JsonUtils';
 
 import { LogService } from '../../services/internal/LogService';
 
+import { ITweet, ITweetEntities, ITweetMedia } from '../../types/data/Tweet';
+import { ILimitedVisibilityTweet } from '../../types/raw/base/LimitedVisibilityTweet';
+import { IExtendedMedia as IRawExtendedMedia } from '../../types/raw/base/Media';
+import { ITweet as IRawTweet, IEntities as IRawTweetEntities } from '../../types/raw/base/Tweet';
+import { ITimelineTweet } from '../../types/raw/composite/TimelineTweet';
+
 import { User } from './User';
 
 /**
@@ -20,68 +18,39 @@ import { User } from './User';
  *
  * @public
  */
-export class Tweet {
-	/** The number of bookmarks of a tweet. */
+export class Tweet implements ITweet {
 	public bookmarkCount: number;
-
-	/** The date and time of creation of the tweet, in UTC string format. */
+	public conversationId: string;
 	public createdAt: string;
-
-	/** Additional tweet entities like urls, mentions, etc. */
 	public entities: TweetEntities;
-
-	/** The full text content of the tweet. */
 	public fullText: string;
-
-	/** The rest id of the tweet. */
 	public id: string;
-
-	/** The language in which the tweet is written. */
 	public lang: string;
-
-	/** The number of likes of the tweet. */
 	public likeCount: number;
-
-	/** The urls of the media contents of the tweet (if any). */
 	public media?: TweetMedia[];
-
-	/** The number of quotes of the tweet. */
 	public quoteCount: number;
-
-	/** The tweet which is quoted in the tweet. */
 	public quoted?: Tweet;
-
-	/** The number of replies to the tweet. */
 	public replyCount: number;
-
-	/** The rest id of the tweet to which the tweet is a reply. */
-	public replyTo?: Tweet;
-
-	/** The number of retweets of the tweet. */
+	public replyTo?: string;
 	public retweetCount: number;
-
-	/** The tweet which is retweeted in this tweet (if any). */
 	public retweetedTweet?: Tweet;
-
-	/** The details of the user who made the tweet. */
 	public tweetBy: User;
-
-	/** The number of views of a tweet. */
+	public url: string;
 	public viewCount: number;
 
 	/**
 	 * @param tweet - The raw tweet details.
-	 * @param response - The raw response
 	 */
-	public constructor(tweet: IRawTweet, response: NonNullable<unknown>) {
+	public constructor(tweet: IRawTweet) {
 		this.id = tweet.rest_id;
-		this.createdAt = tweet.legacy.created_at;
+		this.conversationId = tweet.legacy.conversation_id_str;
+		this.createdAt = new Date(tweet.legacy.created_at).toISOString();
 		this.tweetBy = new User(tweet.core.user_results.result);
 		this.entities = new TweetEntities(tweet.legacy.entities);
 		this.media = tweet.legacy.extended_entities?.media?.map((media) => new TweetMedia(media));
-		this.quoted = this.getQuotedTweet(tweet, response);
+		this.quoted = this.getQuotedTweet(tweet);
 		this.fullText = tweet.note_tweet ? tweet.note_tweet.note_tweet_results.result.text : tweet.legacy.full_text;
-		this.replyTo = this.getParentTweet(tweet, response);
+		this.replyTo = tweet.legacy.in_reply_to_status_id_str;
 		this.lang = tweet.legacy.lang;
 		this.quoteCount = tweet.legacy.quote_count;
 		this.replyCount = tweet.legacy.reply_count;
@@ -89,42 +58,29 @@ export class Tweet {
 		this.likeCount = tweet.legacy.favorite_count;
 		this.viewCount = tweet.views.count ? parseInt(tweet.views.count) : 0;
 		this.bookmarkCount = tweet.legacy.bookmark_count;
-		this.retweetedTweet = this.getRetweetedTweet(tweet, response);
-	}
-
-	private getParentTweet(tweet: IRawTweet, response: NonNullable<unknown>): Tweet | undefined {
-		// Getting parent tweet ID, if any
-		const parentTweetId: string = tweet.legacy?.in_reply_to_status_id_str ?? '';
-
-		// If no parent tweet
-		if (parentTweetId.length == 0) {
-			return;
-		}
-
-		// Getting the details of parent tweet
-		return Tweet.single(response, parentTweetId);
+		this.retweetedTweet = this.getRetweetedTweet(tweet);
+		this.url = `https://x.com/${this.tweetBy.userName}/status/${this.id}`;
 	}
 
 	/**
 	 * Extract and deserialize the original quoted tweet from the given raw tweet.
 	 *
 	 * @param tweet - The raw tweet.
-	 * @param response - The raw response
 	 *
 	 * @returns - The deserialized original quoted tweet.
 	 */
-	private getQuotedTweet(tweet: IRawTweet, response: NonNullable<unknown>): Tweet | undefined {
+	private getQuotedTweet(tweet: IRawTweet): Tweet | undefined {
 		// If tweet with limited visibility
 		if (
 			tweet.quoted_status_result &&
 			tweet.quoted_status_result?.result?.__typename == 'TweetWithVisibilityResults' &&
 			(tweet.quoted_status_result.result as ILimitedVisibilityTweet)?.tweet?.legacy
 		) {
-			return new Tweet((tweet.quoted_status_result.result as ILimitedVisibilityTweet).tweet, response);
+			return new Tweet((tweet.quoted_status_result.result as ILimitedVisibilityTweet).tweet);
 		}
 		// If normal tweet
-		else if ((tweet.quoted_status_result?.result as ITweet)?.rest_id) {
-			return new Tweet(tweet.quoted_status_result.result as ITweet, response);
+		else if ((tweet.quoted_status_result?.result as IRawTweet)?.rest_id) {
+			return new Tweet(tweet.quoted_status_result.result as IRawTweet);
 		}
 		// Else, skip
 		else {
@@ -136,22 +92,21 @@ export class Tweet {
 	 * Extract and deserialize the original retweeted tweet from the given raw tweet.
 	 *
 	 * @param tweet - The raw tweet.
-	 * @param response - The raw response
 	 *
 	 * @returns - The deserialized original retweeted tweet.
 	 */
-	private getRetweetedTweet(tweet: IRawTweet, response: NonNullable<unknown>): Tweet | undefined {
+	private getRetweetedTweet(tweet: IRawTweet): Tweet | undefined {
 		// If retweet with limited visibility
 		if (
 			tweet.legacy?.retweeted_status_result &&
 			tweet.legacy?.retweeted_status_result?.result?.__typename == 'TweetWithVisibilityResults' &&
 			(tweet.legacy?.retweeted_status_result?.result as ILimitedVisibilityTweet)?.tweet?.legacy
 		) {
-			return new Tweet((tweet.legacy.retweeted_status_result.result as ILimitedVisibilityTweet).tweet, response);
+			return new Tweet((tweet.legacy.retweeted_status_result.result as ILimitedVisibilityTweet).tweet);
 		}
 		// If normal tweet
-		else if ((tweet.legacy?.retweeted_status_result?.result as ITweet)?.rest_id) {
-			return new Tweet(tweet.legacy.retweeted_status_result.result as ITweet, response);
+		else if ((tweet.legacy?.retweeted_status_result?.result as IRawTweet)?.rest_id) {
+			return new Tweet(tweet.legacy.retweeted_status_result.result as IRawTweet);
 		}
 		// Else, skip
 		else {
@@ -160,39 +115,27 @@ export class Tweet {
 	}
 
 	/**
-	 * Extracts and deserializes the list of tweets from the given raw response data.
+	 * Extracts and deserializes multiple target tweets from the given raw response data.
 	 *
 	 * @param response - The raw response data.
+	 * @param ids - The ids of the target tweets.
 	 *
-	 * @returns The deserialized list of tweets.
-	 *
-	 * @internal
+	 * @returns The target deserialized tweets.
 	 */
-	public static list(response: NonNullable<unknown>): Tweet[] {
-		const tweets: Tweet[] = [];
+	public static multiple(response: NonNullable<unknown>, ids: string[]): Tweet[] {
+		let tweets: Tweet[] = [];
 
 		// Extracting the matching data
-		const extract = findByFilter<ITimelineTweet>(response, '__typename', 'TimelineTweet');
+		const extract = findByFilter<IRawTweet>(response, '__typename', 'Tweet');
 
 		// Deserializing valid data
 		for (const item of extract) {
-			// If tweet with limited visibility
-			if (
-				item.tweet_results?.result &&
-				item.tweet_results?.result?.__typename == 'TweetWithVisibilityResults' &&
-				(item.tweet_results?.result as ILimitedVisibilityTweet)?.tweet?.legacy
-			) {
-				tweets.push(new Tweet((item.tweet_results.result as ILimitedVisibilityTweet).tweet, response));
-			}
-			// If normal tweet
-			else if ((item.tweet_results?.result as ITweet)?.legacy) {
+			if (item.legacy) {
 				// Logging
-				LogService.log(ELogActions.DESERIALIZE, { id: (item.tweet_results.result as ITweet).rest_id });
+				LogService.log(ELogActions.DESERIALIZE, { id: item.rest_id });
 
-				tweets.push(new Tweet(item.tweet_results.result as ITweet, response));
-			}
-			// If invalid/unrecognized tweet
-			else {
+				tweets.push(new Tweet(item));
+			} else {
 				// Logging
 				LogService.log(ELogActions.WARNING, {
 					action: ELogActions.DESERIALIZE,
@@ -201,6 +144,11 @@ export class Tweet {
 			}
 		}
 
+		// Filtering only required tweets, if required
+		if (ids && ids.length) {
+			tweets = tweets.filter((tweet) => ids.includes(tweet.id));
+		}
+
 		return tweets;
 	}
 
@@ -211,14 +159,12 @@ export class Tweet {
 	 * @param id - The id of the target tweet.
 	 *
 	 * @returns The target deserialized tweet.
-	 *
-	 * @internal
 	 */
 	public static single(response: NonNullable<unknown>, id: string): Tweet | undefined {
 		const tweets: Tweet[] = [];
 
 		// Extracting the matching data
-		const extract = findByFilter<ITweet>(response, 'rest_id', id);
+		const extract = findByFilter<IRawTweet>(response, 'rest_id', id);
 
 		// Deserializing valid data
 		for (const item of extract) {
@@ -226,7 +172,7 @@ export class Tweet {
 				// Logging
 				LogService.log(ELogActions.DESERIALIZE, { id: item.rest_id });
 
-				tweets.push(new Tweet(item, response));
+				tweets.push(new Tweet(item));
 			} else {
 				// Logging
 				LogService.log(ELogActions.WARNING, {
@@ -238,6 +184,76 @@ export class Tweet {
 
 		return tweets.length ? tweets[0] : undefined;
 	}
+
+	/**
+	 * Extracts and deserializes the timeline of tweets from the given raw response data.
+	 *
+	 * @param response - The raw response data.
+	 * @param ids - The IDs of specific tweets that need to be extracted.
+	 *
+	 * @returns The deserialized timeline of tweets.
+	 */
+	public static timeline(response: NonNullable<unknown>): Tweet[] {
+		const tweets: Tweet[] = [];
+
+		// Extracting the matching data
+		const extract = findByFilter<ITimelineTweet>(response, '__typename', 'TimelineTweet');
+
+		// Deserializing valid data
+		for (const item of extract) {
+			// If tweet with limited visibility
+			if (
+				item.tweet_results?.result &&
+				item.tweet_results?.result?.__typename == 'TweetWithVisibilityResults' &&
+				(item.tweet_results?.result as ILimitedVisibilityTweet)?.tweet?.legacy
+			) {
+				tweets.push(new Tweet((item.tweet_results.result as ILimitedVisibilityTweet).tweet));
+			}
+			// If normal tweet
+			else if ((item.tweet_results?.result as IRawTweet)?.legacy) {
+				// Logging
+				LogService.log(ELogActions.DESERIALIZE, { id: (item.tweet_results.result as IRawTweet).rest_id });
+
+				tweets.push(new Tweet(item.tweet_results.result as IRawTweet));
+			}
+			// If invalid/unrecognized tweet
+			else {
+				// Logging
+				LogService.log(ELogActions.WARNING, {
+					action: ELogActions.DESERIALIZE,
+					message: `Tweet not found, skipping`,
+				});
+			}
+		}
+
+		return tweets;
+	}
+
+	/**
+	 * @returns A serializable JSON representation of `this` object.
+	 */
+	public toJSON(): ITweet {
+		return {
+			bookmarkCount: this.bookmarkCount,
+			conversationId: this.conversationId,
+			createdAt: this.createdAt,
+			entities: this.entities.toJSON(),
+			fullText: this.fullText,
+			id: this.id,
+			lang: this.lang,
+			likeCount: this.likeCount,
+			media: this.media?.map((item) => item.toJSON()),
+			quoteCount: this.quoteCount,
+			quoted: this.quoted?.toJSON(),
+			replyCount: this.replyCount,
+			replyTo: this.replyTo,
+			retweetCount: this.retweetCount,
+			retweetedTweet: this.retweetedTweet?.toJSON(),
+			tweetBy: this.tweetBy.toJSON(),
+			url: this.url,
+			viewCount: this.viewCount,
+		};
+	}
 }
 
 /**
@@ -280,6 +296,17 @@ export class TweetEntities {
 			}
 		}
 	}
+
+	/**
+	 * @returns A serializable JSON representation of `this` object.
+	 */
+	public toJSON(): ITweetEntities {
+		return {
+			hashtags: this.hashtags,
+			mentionedUsers: this.mentionedUsers,
+			urls: this.urls,
+		};
+	}
 }
 
 /**
@@ -295,28 +322,29 @@ export class TweetMedia {
 	public type: EMediaType;
 
 	/** The direct URL to the media. */
-	public url: string = '';
+	public url = '';
 
 	/**
 	 * @param media - The raw media details.
 	 */
 	public constructor(media: IRawExtendedMedia) {
-		this.type = media.type;
-
 		// If the media is a photo
-		if (media.type == EMediaType.PHOTO) {
+		if (media.type == ERawMediaType.PHOTO) {
+			this.type = EMediaType.PHOTO;
 			this.url = media.media_url_https;
 		}
 		// If the media is a gif
-		else if (media.type == EMediaType.GIF) {
+		else if (media.type == ERawMediaType.GIF) {
+			this.type = EMediaType.GIF;
 			this.url = media.video_info?.variants[0].url as string;
 		}
 		// If the media is a video
 		else {
+			this.type = EMediaType.VIDEO;
 			this.thumbnailUrl = media.media_url_https;
 
 			/** The highest bitrate of all variants. */
-			let highestRate: number = 0;
+			let highestRate = 0;
 
 			/**
 			 * Selecting the URL of the video variant with the highest bitrate.
@@ -329,4 +357,15 @@ export class TweetMedia {
 			});
 		}
 	}
+
+	/**
+	 * @returns A serializable JSON representation of `this` object.
+	 */
+	public toJSON(): ITweetMedia {
+		return {
+			thumbnailUrl: this.thumbnailUrl,
+			type: this.type,
+			url: this.url,
+		};
+	}
 }