rettiwt-api 4.2.0-alpha.2 → 4.2.0

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

@@ -102,13 +102,13 @@ export class Tweet {
 		// 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);
 		}
 		// If normal tweet
-		else if (tweet.quoted_status_result && Object.entries(tweet.quoted_status_result).length) {
+		else if ((tweet.quoted_status_result?.result as ITweet)?.rest_id) {
 			return new Tweet(tweet.quoted_status_result.result as ITweet);
 		}
 		// Else, skip
@@ -125,9 +125,17 @@ export class Tweet {
 	 * @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);
+		// 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);
+		}
+		// 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);
 		}
 		// Else, skip
 		else {
@@ -152,11 +160,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));
+			}
+			// 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));
+			}
+			// If invalid/unrecognized tweet
+			else {
 				// Logging
 				LogService.log(ELogActions.WARNING, {
 					action: ELogActions.DESERIALIZE,

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