rettiwt-api 4.2.0-alpha.1 → 4.2.0-alpha.2

package/src/models/data/Tweet.ts

@@ -1,5 +1,6 @@
 import {
 	EMediaType,
+	ILimitedVisibilityTweet,
 	IExtendedMedia as IRawExtendedMedia,
 	ITweet as IRawTweet,
 	IEntities as IRawTweetEntities,
@@ -77,7 +78,7 @@ export class Tweet {
 		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 = tweet.quoted_status_result ? new Tweet(tweet.quoted_status_result.result) : undefined;
+		this.quoted = this.getQuotedTweet(tweet);
 		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.lang = tweet.legacy.lang;
@@ -87,9 +88,51 @@ 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 = tweet.legacy.retweeted_status_result?.result?.rest_id
-			? new Tweet(tweet.legacy.retweeted_status_result.result)
-			: undefined;
+		this.retweetedTweet = this.getRetweetedTweet(tweet);
+	}
+
+	/**
+	 * Extract and deserialize the original quoted tweet from the given raw tweet.
+	 *
+	 * @param tweet - The raw tweet.
+	 *
+	 * @returns - The deserialized original quoted tweet.
+	 */
+	private getQuotedTweet(tweet: IRawTweet): 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'
+		) {
+			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) {
+			return new Tweet(tweet.quoted_status_result.result as ITweet);
+		}
+		// Else, skip
+		else {
+			return undefined;
+		}
+	}
+
+	/**
+	 * Extract and deserialize the original retweeted tweet from the given raw tweet.
+	 *
+	 * @param tweet - The raw 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);
+		}
+		// Else, skip
+		else {
+			return undefined;
+		}
 	}
 
 	/**
@@ -112,7 +155,6 @@ export class Tweet {
 			if (item.tweet_results?.result?.legacy) {
 				// Logging
 				LogService.log(ELogActions.DESERIALIZE, { id: item.tweet_results.result.rest_id });
-
 				tweets.push(new Tweet(item.tweet_results.result));
 			} else {
 				// Logging
@@ -210,6 +252,9 @@ export class TweetEntities {
  * @public
  */
 export class TweetMedia {
+	/** The thumbnail URL for the video content of the tweet. */
+	public thumbnailUrl?: string;
+
 	/** The type of media. */
 	public type: EMediaType;
 
@@ -232,6 +277,8 @@ export class TweetMedia {
 		}
 		// If the media is a video
 		else {
+			this.thumbnailUrl = media.media_url_https;
+
 			/** The highest bitrate of all variants. */
 			let highestRate: number = 0;
 

package/src/services/public/FetcherService.ts

@@ -26,19 +26,19 @@ import { AuthService } from './AuthService';
  */
 export class FetcherService {
 	/** The api key to use for authenticating against Twitter API as user. */
-	private readonly apiKey?: string;
+	private readonly _apiKey?: string;
 
 	/** The service used to handle HTTP and API errors */
-	private readonly errorHandler: IErrorHandler;
+	private readonly _errorHandler: IErrorHandler;
 
 	/** The guest key to use for authenticating against Twitter API as guest. */
-	private readonly guestKey?: string;
+	private readonly _guestKey?: string;
 
 	/** The URL To the proxy server to use for all others. */
-	private readonly proxyUrl?: URL;
+	private readonly _proxyUrl?: URL;
 
 	/** The max wait time for a response. */
-	private readonly timeout: number;
+	private readonly _timeout: number;
 
 	/** The URL to the proxy server to use only for authentication. */
 	protected readonly authProxyUrl?: URL;
@@ -51,13 +51,13 @@ export class FetcherService {
 	 */
 	public constructor(config?: IRettiwtConfig) {
 		LogService.enabled = config?.logging ?? false;
-		this.apiKey = config?.apiKey;
-		this.guestKey = config?.guestKey;
+		this._apiKey = config?.apiKey;
+		this._guestKey = config?.guestKey;
 		this.userId = config?.apiKey ? AuthService.getUserId(config.apiKey) : undefined;
 		this.authProxyUrl = config?.authProxyUrl ?? config?.proxyUrl;
-		this.proxyUrl = config?.proxyUrl;
-		this.timeout = config?.timeout ?? 0;
-		this.errorHandler = config?.errorHandler ?? new ErrorService();
+		this._proxyUrl = config?.proxyUrl;
+		this._timeout = config?.timeout ?? 0;
+		this._errorHandler = config?.errorHandler ?? new ErrorService();
 	}
 
 	/**
@@ -83,16 +83,16 @@ export class FetcherService {
 	 * @returns The generated AuthCredential
 	 */
 	private async getCredential(): Promise<AuthCredential> {
-		if (this.apiKey) {
+		if (this._apiKey) {
 			// Logging
 			LogService.log(ELogActions.GET, { target: 'USER_CREDENTIAL' });
 
-			return new AuthCredential(AuthService.decodeCookie(this.apiKey).split(';'));
-		} else if (this.guestKey) {
+			return new AuthCredential(AuthService.decodeCookie(this._apiKey).split(';'));
+		} else if (this._guestKey) {
 			// Logging
 			LogService.log(ELogActions.GET, { target: 'GUEST_CREDENTIAL' });
 
-			return new AuthCredential(undefined, this.guestKey);
+			return new AuthCredential(undefined, this._guestKey);
 		} else {
 			// Logging
 			LogService.log(ELogActions.GET, { target: 'NEW_GUEST_CREDENTIAL' });
@@ -183,7 +183,7 @@ export class FetcherService {
 		args = this.validateArgs(resource, args)!;
 
 		// Getting HTTPS agent
-		const httpsAgent: Agent = this.getHttpsAgent(this.proxyUrl);
+		const httpsAgent: Agent = this.getHttpsAgent(this._proxyUrl);
 
 		// Getting credentials from key
 		const cred: AuthCredential = await this.getCredential();
@@ -195,7 +195,7 @@ export class FetcherService {
 		config.headers = { ...config.headers, ...cred.toHeader() };
 		config.httpAgent = httpsAgent;
 		config.httpsAgent = httpsAgent;
-		config.timeout = this.timeout;
+		config.timeout = this._timeout;
 
 		// Sending the request
 		try {
@@ -203,7 +203,7 @@ export class FetcherService {
 			return (await axios<T>(config)).data;
 		} catch (error) {
 			// If error, delegate handling to error handler
-			this.errorHandler.handle(error);
+			this._errorHandler.handle(error);
 			throw error;
 		}
 	}

package/src/services/public/ListService.ts

@@ -0,0 +1,112 @@
+import { IListMembersResponse, IListTweetsResponse } from 'rettiwt-core';
+
+import { extractors } from '../../collections/Extractors';
+import { EResourceType } from '../../enums/Resource';
+import { CursoredData } from '../../models/data/CursoredData';
+import { Tweet } from '../../models/data/Tweet';
+import { User } from '../../models/data/User';
+import { IRettiwtConfig } from '../../types/RettiwtConfig';
+
+import { FetcherService } from './FetcherService';
+
+export class ListService extends FetcherService {
+	/**
+	 * @param config - The config object for configuring the Rettiwt instance.
+	 *
+	 * @internal
+	 */
+	public constructor(config?: IRettiwtConfig) {
+		super(config);
+	}
+
+	/**
+	 * Get the list of members of a tweet list.
+	 *
+	 * @param id - The id of target list.
+	 * @param count - The number of members to fetch, must be \<= 100.
+	 * @param cursor - The cursor to the batch of members to fetch.
+	 *
+	 * @returns The list tweets in the given list.
+	 *
+	 * @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 first 100 members of the Twitter list with id '1234567890'
+	 * rettiwt.list.members('1234567890')
+	 * .then(res => {
+	 * 	console.log(res);
+	 * })
+	 * .catch(err => {
+	 * 	console.log(err);
+	 * });
+	 * ```
+	 *
+	 * @remarks Due a bug in Twitter API, the count is ignored when no cursor is provided and defaults to 100.
+	 */
+	public async members(id: string, count?: number, cursor?: string): Promise<CursoredData<User>> {
+		const resource: EResourceType = EResourceType.LIST_MEMBERS;
+
+		// Fetching the raw list of members
+		const response = await this.request<IListMembersResponse>(resource, {
+			id: id,
+			count: count,
+			cursor: cursor,
+		});
+
+		// Deserializing response
+		const data = extractors[resource](response);
+
+		return data;
+	}
+
+	/**
+	 * Get the list of tweets from a tweet list.
+	 *
+	 * @param id - The id of target list.
+	 * @param count - The number of tweets to fetch, must be \<= 100.
+	 * @param cursor - The cursor to the batch of tweets to fetch.
+	 *
+	 * @returns The list tweets in the given list.
+	 *
+	 * @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 tweets of the Twitter list with id '1234567890'
+	 * rettiwt.list.tweets('1234567890')
+	 * .then(res => {
+	 * 	console.log(res);
+	 * })
+	 * .catch(err => {
+	 * 	console.log(err);
+	 * });
+	 * ```
+	 *
+	 * @remarks Due a bug in Twitter API, the count is ignored when no cursor is provided and defaults to 100.
+	 */
+	public async tweets(id: string, count?: number, cursor?: string): Promise<CursoredData<Tweet>> {
+		const resource = EResourceType.LIST_TWEETS;
+
+		// Fetching raw list tweets
+		const response = await this.request<IListTweetsResponse>(resource, {
+			id: id,
+			count: count,
+			cursor: cursor,
+		});
+
+		// Deserializing response
+		const data = extractors[resource](response);
+
+		// Sorting the tweets by date, from recent to oldest
+		data.list.sort((a, b) => new Date(b.createdAt).valueOf() - new Date(a.createdAt).valueOf());
+
+		return data;
+	}
+}