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

package/src/commands/Tweet.ts

@@ -1,5 +1,5 @@
 import { Command, createCommand } from 'commander';
-import { ESearchResultType, TweetFilter } from 'rettiwt-core';
+import { TweetFilter } from 'rettiwt-core';
 
 import { output } from '../helper/CliUtils';
 import { Rettiwt } from '../Rettiwt';
@@ -192,7 +192,6 @@ function createTweetCommand(rettiwt: Rettiwt): Command {
 						new TweetSearchOptions(options).toTweetFilter(),
 						count ? parseInt(count) : undefined,
 						cursor,
-						options?.top ? ESearchResultType.TOP : ESearchResultType.LATEST,
 					);
 					output(tweets);
 				}
@@ -352,6 +351,7 @@ class TweetSearchOptions {
 			links: !this.excludeLinks,
 			replies: !this.excludeReplies,
 			startDate: this.start ? new Date(this.start) : undefined,
+			top: this.top,
 			endDate: this.end ? new Date(this.end) : undefined,
 		});
 	}

package/src/commands/User.ts

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

package/src/enums/Resource.ts

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

package/src/index.ts

@@ -5,7 +5,6 @@ export * from './Rettiwt';
 export * from './enums/Api';
 export * from './enums/Http';
 export * from './enums/Resource';
-export { ESearchResultType } from 'rettiwt-core';
 
 // ARG MODELS
 export * from './models/args/FetchArgs';
@@ -63,7 +62,7 @@ export {
 	IUserHighlightsResponse,
 	IUserLikesResponse,
 	IUserMediaResponse,
-	IUserNotifications as IUserNotificationsResponse,
+	IUserNotificationsResponse,
 	IUserRecommendedResponse,
 	IUserSubscriptionsResponse,
 	IUserTweetsAndRepliesResponse,

package/src/models/args/FetchArgs.ts

@@ -56,6 +56,7 @@ export class FetchArgs {
 			EResourceType.LIST_TWEETS,
 			EResourceType.TWEET_RETWEETERS,
 			EResourceType.TWEET_SEARCH,
+			EResourceType.USER_BOOKMARKS,
 			EResourceType.USER_FOLLOWERS,
 			EResourceType.USER_FOLLOWING,
 			EResourceType.USER_HIGHLIGHTS,
@@ -73,6 +74,7 @@ export class FetchArgs {
 			EResourceType.LIST_TWEETS,
 			EResourceType.TWEET_RETWEETERS,
 			EResourceType.TWEET_SEARCH,
+			EResourceType.USER_BOOKMARKS,
 			EResourceType.USER_FOLLOWERS,
 			EResourceType.USER_FOLLOWING,
 			EResourceType.USER_HIGHLIGHTS,
@@ -89,6 +91,7 @@ export class FetchArgs {
 			EResourceType.LIST_MEMBERS,
 			EResourceType.LIST_TWEETS,
 			EResourceType.TWEET_RETWEETERS,
+			EResourceType.USER_BOOKMARKS,
 			EResourceType.USER_FOLLOWERS,
 			EResourceType.USER_FOLLOWING,
 			EResourceType.USER_HIGHLIGHTS,
@@ -126,6 +129,7 @@ export class FetchArgs {
 			EResourceType.LIST_TWEETS,
 			EResourceType.TWEET_RETWEETERS,
 			EResourceType.TWEET_SEARCH,
+			EResourceType.USER_BOOKMARKS,
 			EResourceType.USER_FEED_FOLLOWED,
 			EResourceType.USER_FEED_RECOMMENDED,
 			EResourceType.USER_FOLLOWING,
@@ -145,6 +149,7 @@ export class FetchArgs {
 			EResourceType.LIST_TWEETS,
 			EResourceType.TWEET_RETWEETERS,
 			EResourceType.TWEET_SEARCH,
+			EResourceType.USER_BOOKMARKS,
 			EResourceType.USER_FEED_FOLLOWED,
 			EResourceType.USER_FEED_RECOMMENDED,
 			EResourceType.USER_FOLLOWING,
@@ -173,6 +178,7 @@ export class FetchArgs {
 			EResourceType.TWEET_DETAILS,
 			EResourceType.TWEET_DETAILS_ALT,
 			EResourceType.TWEET_RETWEETERS,
+			EResourceType.USER_BOOKMARKS,
 			EResourceType.USER_DETAILS_BY_USERNAME,
 			EResourceType.USER_DETAILS_BY_ID,
 			EResourceType.USER_FEED_FOLLOWED,
@@ -201,6 +207,7 @@ export class FetchArgs {
 	 */
 	@IsEmpty({
 		groups: [
+			EResourceType.USER_BOOKMARKS,
 			EResourceType.USER_FEED_FOLLOWED,
 			EResourceType.USER_FEED_RECOMMENDED,
 			EResourceType.USER_NOTIFICATIONS,
@@ -281,6 +288,7 @@ export class FetchArgs {
 			EResourceType.TWEET_DETAILS,
 			EResourceType.TWEET_DETAILS_ALT,
 			EResourceType.TWEET_RETWEETERS,
+			EResourceType.USER_BOOKMARKS,
 			EResourceType.USER_DETAILS_BY_USERNAME,
 			EResourceType.USER_DETAILS_BY_ID,
 			EResourceType.USER_FEED_FOLLOWED,
@@ -461,6 +469,15 @@ export class TweetFilter extends TweetFilterCore {
 	@IsString({ each: true })
 	public toUsers?: string[];
 
+	/**
+	 * Whether to fetch top or not.
+	 *
+	 * @defaultValue true
+	 */
+	@IsOptional()
+	@IsBoolean()
+	public top?: boolean;
+
 	/**
 	 * @param filter - The filter to use for searching tweets.
 	 */

package/src/models/data/Notification.ts

@@ -1,7 +1,7 @@
 import {
 	ENotificationType as ENotificationTypeOriginal,
 	INotification,
-	IUserNotifications as IUserNotificationsResponse,
+	IUserNotificationsResponse,
 } from 'rettiwt-core';
 
 import { findKeyByValue } from '../../helper/JsonUtils';

package/src/models/data/Tweet.ts

@@ -55,7 +55,7 @@ export class Tweet {
 	public replyCount: number;
 
 	/** The rest id of the tweet to which the tweet is a reply. */
-	public replyTo?: string;
+	public replyTo?: Tweet;
 
 	/** The number of retweets of the tweet. */
 	public retweetCount: number;
@@ -71,16 +71,17 @@ export class Tweet {
 
 	/**
 	 * @param tweet - The raw tweet details.
+	 * @param response - The raw response
 	 */
-	public constructor(tweet: IRawTweet) {
+	public constructor(tweet: IRawTweet, response: NonNullable<unknown>) {
 		this.id = tweet.rest_id;
 		this.createdAt = tweet.legacy.created_at;
 		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);
+		this.quoted = this.getQuotedTweet(tweet, response);
 		this.fullText = tweet.note_tweet ? tweet.note_tweet.note_tweet_results.result.text : tweet.legacy.full_text;
-		this.replyTo = tweet.legacy.in_reply_to_status_id_str;
+		this.replyTo = this.getParentTweet(tweet, response);
 		this.lang = tweet.legacy.lang;
 		this.quoteCount = tweet.legacy.quote_count;
 		this.replyCount = tweet.legacy.reply_count;
@@ -88,28 +89,42 @@ 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);
+		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);
 	}
 
 	/**
 	 * 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): Tweet | undefined {
+	private getQuotedTweet(tweet: IRawTweet, response: NonNullable<unknown>): Tweet | undefined {
 		// If tweet with limited visibility
 		if (
 			tweet.quoted_status_result &&
-			Object.entries(tweet.quoted_status_result).length &&
-			tweet.quoted_status_result.result.__typename == 'TweetWithVisibilityResults'
+			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);
+			return new Tweet((tweet.quoted_status_result.result as ILimitedVisibilityTweet).tweet, response);
 		}
 		// If normal tweet
-		else if (tweet.quoted_status_result && Object.entries(tweet.quoted_status_result).length) {
-			return new Tweet(tweet.quoted_status_result.result as ITweet);
+		else if ((tweet.quoted_status_result?.result as ITweet)?.rest_id) {
+			return new Tweet(tweet.quoted_status_result.result as ITweet, response);
 		}
 		// Else, skip
 		else {
@@ -121,13 +136,22 @@ 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): Tweet | undefined {
-		// If valid retweeted tweet
-		if (tweet.legacy.retweeted_status_result?.result?.rest_id) {
-			return new Tweet(tweet.legacy.retweeted_status_result.result);
+	private getRetweetedTweet(tweet: IRawTweet, response: NonNullable<unknown>): 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);
+		}
+		// 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, skip
 		else {
@@ -152,11 +176,23 @@ export class Tweet {
 
 		// Deserializing valid data
 		for (const item of extract) {
-			if (item.tweet_results?.result?.legacy) {
+			// 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) {
 				// Logging
-				LogService.log(ELogActions.DESERIALIZE, { id: item.tweet_results.result.rest_id });
-				tweets.push(new Tweet(item.tweet_results.result));
-			} else {
+				LogService.log(ELogActions.DESERIALIZE, { id: (item.tweet_results.result as ITweet).rest_id });
+
+				tweets.push(new Tweet(item.tweet_results.result as ITweet, response));
+			}
+			// If invalid/unrecognized tweet
+			else {
 				// Logging
 				LogService.log(ELogActions.WARNING, {
 					action: ELogActions.DESERIALIZE,
@@ -190,7 +226,7 @@ export class Tweet {
 				// Logging
 				LogService.log(ELogActions.DESERIALIZE, { id: item.rest_id });
 
-				tweets.push(new Tweet(item));
+				tweets.push(new Tweet(item, response));
 			} else {
 				// Logging
 				LogService.log(ELogActions.WARNING, {

package/src/models/data/User.ts

@@ -123,7 +123,7 @@ export class User {
 
 		// Deserializing valid data
 		for (const item of extract) {
-			if (item.legacy) {
+			if (item.legacy && item.legacy.created_at) {
 				// Logging
 				LogService.log(ELogActions.DESERIALIZE, { id: item.rest_id });
 

package/src/services/public/AuthService.ts

@@ -57,7 +57,9 @@ export class AuthService extends FetcherService {
 		const cookieString: string = AuthService.decodeCookie(apiKey);
 
 		// Searching for the user id in the cookie string
-		const searchResults: string[] | null = cookieString.match(/((?<=twid="u=)(.*)(?="))|((?<=twid=u%3D)(.*)(?=;))/);
+		const searchResults: string[] | null = cookieString.match(
+			/((?<=twid="u=)(\d+)(?="))|((?<=twid=u%3D)(\d+)(?=;))/,
+		);
 
 		// If user id was found
 		if (searchResults) {

package/src/services/public/UserService.ts

@@ -1,4 +1,5 @@
 import {
+	IUserBookmarksResponse,
 	IUserDetailsResponse,
 	IUserFollowedResponse,
 	IUserFollowersResponse,
@@ -7,7 +8,7 @@ import {
 	IUserHighlightsResponse,
 	IUserLikesResponse,
 	IUserMediaResponse,
-	IUserNotifications as IUserNotificationsResponse,
+	IUserNotificationsResponse,
 	IUserRecommendedResponse,
 	IUserSubscriptionsResponse,
 	IUserTweetsAndRepliesResponse,
@@ -40,6 +41,46 @@ export class UserService extends FetcherService {
 		super(config);
 	}
 
+	/**
+	 * Get the list of bookmarks of the logged in user.
+	 *
+	 * @param count - The number of bookmakrs to fetch, must be \<= 100.
+	 * @param cursor - The cursor to the batch of bookmarks to fetch.
+	 *
+	 * @returns The list of tweets bookmarked by the target user.
+	 *
+	 * @example
+	 * ```
+	 * import { Rettiwt } from 'rettiwt-api';
+	 *
+	 * // Creating a new Rettiwt instance using the given 'API_KEY'
+	 * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+	 *
+	 * // Fetching the most recent 100 liked Tweets of the logged in User
+	 * rettiwt.user.bookmarks()
+	 * .then(res => {
+	 * 	console.log(res);
+	 * })
+	 * .catch(err => {
+	 * 	console.log(err);
+	 * });
+	 * ```
+	 */
+	public async bookmarks(count?: number, cursor?: string): Promise<CursoredData<Tweet>> {
+		const resource = EResourceType.USER_BOOKMARKS;
+
+		// Fetching raw list of likes
+		const response = await this.request<IUserBookmarksResponse>(resource, {
+			count: count,
+			cursor: cursor,
+		});
+
+		// Deserializing response
+		const data = extractors[resource](response);
+
+		return data;
+	}
+
 	/**
 	 * Get the details of a user.
 	 *

package/.yarnrc.yml

@@ -1 +0,0 @@
-nodeLinker: node-modules