rettiwt-api 4.2.0-alpha.1 → 4.2.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;
+	}
+}

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