rettiwt-api 3.1.1 → 4.0.0

package/src/services/public/AuthService.ts

@@ -1,5 +1,6 @@
 import { Auth } from 'rettiwt-auth';
 
+import { EApiErrors } from '../../enums/Api';
 import { IRettiwtConfig } from '../../types/RettiwtConfig';
 
 import { FetcherService } from './FetcherService';
@@ -19,6 +20,55 @@ export class AuthService extends FetcherService {
 		super(config);
 	}
 
+	/**
+	 * Decodes the encoded cookie string.
+	 *
+	 * @param encodedCookies - The encoded cookie string to decode.
+	 * @returns The decoded cookie string.
+	 */
+	public static decodeCookie(encodedCookies: string): string {
+		// Decoding the encoded cookie string
+		const decodedCookies: string = Buffer.from(encodedCookies, 'base64').toString('ascii');
+
+		return decodedCookies;
+	}
+
+	/**
+	 * Encodes the given cookie string.
+	 *
+	 * @param cookieString - The cookie string to encode.
+	 * @returns The encoded cookie string.
+	 */
+	public static encodeCookie(cookieString: string): string {
+		// Encoding the cookie string to base64
+		const encodedCookies: string = Buffer.from(cookieString).toString('base64');
+
+		return encodedCookies;
+	}
+
+	/**
+	 * Gets the user's id from the given API key.
+	 *
+	 * @param apiKey - The API key.
+	 * @returns The user id associated with the API key.
+	 */
+	public static getUserId(apiKey: string): string {
+		// Getting the cookie string from the API key
+		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)(.*)(?=;))/);
+
+		// If user id was found
+		if (searchResults) {
+			return searchResults[0];
+		}
+		// If user id was not found
+		else {
+			throw new Error(EApiErrors.BAD_AUTHENTICATION);
+		}
+	}
+
 	/**
 	 * Login to twitter as guest.
 	 *
@@ -91,7 +141,7 @@ export class AuthService extends FetcherService {
 			).toHeader().cookie as string) ?? '';
 
 		// Converting the credentials to base64 string
-		apiKey = Buffer.from(apiKey).toString('base64');
+		apiKey = AuthService.encodeCookie(apiKey);
 
 		return apiKey;
 	}

package/src/services/public/FetcherService.ts

@@ -17,6 +17,8 @@ import { IRettiwtConfig } from '../../types/RettiwtConfig';
 import { ErrorService } from '../internal/ErrorService';
 import { LogService } from '../internal/LogService';
 
+import { AuthService } from './AuthService';
+
 /**
  * The base service that handles all HTTP requests.
  *
@@ -32,9 +34,6 @@ export class FetcherService {
 	/** The guest key to use for authenticating against Twitter API as guest. */
 	private readonly guestKey?: string;
 
-	/** Whether the instance is authenticated or not. */
-	private readonly isAuthenticated: boolean;
-
 	/** The URL To the proxy server to use for all others. */
 	private readonly proxyUrl?: URL;
 
@@ -44,6 +43,9 @@ export class FetcherService {
 	/** The URL to the proxy server to use only for authentication. */
 	protected readonly authProxyUrl?: URL;
 
+	/** The id of the authenticated user (if any). */
+	protected readonly userId?: string;
+
 	/**
 	 * @param config - The config object for configuring the Rettiwt instance.
 	 */
@@ -51,7 +53,7 @@ export class FetcherService {
 		LogService.enabled = config?.logging ?? false;
 		this.apiKey = config?.apiKey;
 		this.guestKey = config?.guestKey;
-		this.isAuthenticated = config?.apiKey ? true : false;
+		this.userId = config?.apiKey ? AuthService.getUserId(config.apiKey) : undefined;
 		this.authProxyUrl = config?.authProxyUrl ?? config?.proxyUrl;
 		this.proxyUrl = config?.proxyUrl;
 		this.timeout = config?.timeout ?? 0;
@@ -67,10 +69,10 @@ export class FetcherService {
 	 */
 	private checkAuthorization(resource: EResourceType): void {
 		// Logging
-		LogService.log(ELogActions.AUTHORIZATION, { authenticated: this.isAuthenticated });
+		LogService.log(ELogActions.AUTHORIZATION, { authenticated: this.userId != undefined });
 
 		// Checking authorization status
-		if (!allowGuestAuthentication.includes(resource) && this.isAuthenticated == false) {
+		if (!allowGuestAuthentication.includes(resource) && this.userId == undefined) {
 			throw new Error(EApiErrors.RESOURCE_NOT_ALLOWED);
 		}
 	}
@@ -85,8 +87,7 @@ export class FetcherService {
 			// Logging
 			LogService.log(ELogActions.GET, { target: 'USER_CREDENTIAL' });
 
-			const cookies = Buffer.from(this.apiKey, 'base64').toString('ascii').split(';');
-			return new AuthCredential(cookies);
+			return new AuthCredential(AuthService.decodeCookie(this.apiKey).split(';'));
 		} else if (this.guestKey) {
 			// Logging
 			LogService.log(ELogActions.GET, { target: 'GUEST_CREDENTIAL' });

package/src/services/public/TweetService.ts

@@ -5,14 +5,16 @@ import {
 	IListTweetsResponse,
 	ITweetDetailsResponse,
 	ITweetLikeResponse,
-	ITweetLikersResponse,
 	ITweetPostResponse,
+	ITweetRepliesResponse,
 	ITweetRetweetersResponse,
 	ITweetRetweetResponse,
+	ITweetScheduleResponse,
 	ITweetSearchResponse,
 	ITweetUnlikeResponse,
 	ITweetUnpostResponse,
 	ITweetUnretweetResponse,
+	ITweetUnscheduleResponse,
 	TweetFilter,
 } from 'rettiwt-core';
 
@@ -68,15 +70,32 @@ export class TweetService extends FetcherService {
 	 * ```
 	 */
 	public async details(id: string): Promise<Tweet | undefined> {
-		const resource = EResourceType.TWEET_DETAILS;
+		let resource: EResourceType;
 
-		// Fetching raw tweet details
-		const response = await this.request<ITweetDetailsResponse>(resource, { id: id });
+		// If user is authenticated
+		if (this.userId != undefined) {
+			resource = EResourceType.TWEET_DETAILS_ALT;
 
-		// Deserializing response
-		const data = extractors[resource](response, id);
+			// Fetching raw tweet details
+			const response = await this.request<ITweetRepliesResponse>(resource, { id: id });
 
-		return data;
+			// Deserializing response
+			const data = extractors[resource](response, id);
+
+			return data;
+		}
+		// If user is not authenticated
+		else {
+			resource = EResourceType.TWEET_DETAILS;
+
+			// Fetching raw tweet details
+			const response = await this.request<ITweetDetailsResponse>(resource, { id: id });
+
+			// Deserializing response
+			const data = extractors[resource](response, id);
+
+			return data;
+		}
 	}
 
 	/**
@@ -117,58 +136,6 @@ export class TweetService extends FetcherService {
 		return data;
 	}
 
-	/**
-	 * @deprecated
-	 * The method will be removed in the next release following the removal of the ability to see tweet likers by Twitter.
-	 * Currently, the method does not work.
-	 *
-	 * Get the list of users who liked a tweet.
-	 *
-	 * @param id - The id of the target tweet.
-	 * @param count - The number of likers to fetch, must be \<= 100.
-	 * @param cursor - The cursor to the batch of likers to fetch.
-	 *
-	 * @returns The list of users who liked the given tweet.
-	 *
-	 * @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 likers of the Tweet with id '1234567890'
-	 * rettiwt.tweet.likers('1234567890')
-	 * .then(res => {
-	 * 	console.log(res);
-	 * })
-	 * .catch(err => {
-	 * 	console.log(err);
-	 * });
-	 * ```
-	 */
-	public async likers(id: string, count?: number, cursor?: string): Promise<CursoredData<User>> {
-		// Deprecation warning
-		console.log(`
-			This method has been deprecated following the removal of the ability to see tweet liksers by Twitter.
-			Currently, the method does not work.
-		`);
-
-		const resource = EResourceType.TWEET_LIKERS;
-
-		// Fetching raw likers
-		const response = await this.request<ITweetLikersResponse>(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.
 	 *
@@ -221,7 +188,7 @@ export class TweetService extends FetcherService {
 	 *
 	 * @param options - The options describing the tweet to be posted. Check {@link TweetArgs} for available options.
 	 *
-	 * @returns Whether posting was successful or not.
+	 * @returns The id of the posted tweet.
 	 *
 	 * @example
 	 * Posting a simple text
@@ -385,6 +352,46 @@ export class TweetService extends FetcherService {
 		return data;
 	}
 
+	/**
+	 * Schedule a tweet.
+	 *
+	 * @param options - The options describing the tweet to be posted. Check {@link TweetArgs} for available options.
+	 *
+	 * @returns The id of the schedule.
+	 *
+	 * @example
+	 * Scheduling a simple text
+	 * ```
+	 * import { Rettiwt } from 'rettiwt-api';
+	 *
+	 * // Creating a new Rettiwt instance using the given 'API_KEY'
+	 * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+	 *
+	 * // Scheduling a tweet to posted at 19th of August, 2024, at 11:59:00 AM, in local time
+	 * rettiwt.tweet.schedule({ text: 'Hello World!', scheduleFor: new Date('2024-08-19 23:59:00') })
+	 * .then(res => {
+	 * 	console.log(res);
+	 * })
+	 * .catch(err => {
+	 * 	console.log(err);
+	 * });
+	 * ```
+	 *
+	 * @remarks
+	 * Scheduling a tweet is similar to {@link post}ing, except that an extra parameter called `scheduleFor` is used.
+	 */
+	public async schedule(options: TweetArgs): Promise<string | undefined> {
+		const resource = EResourceType.TWEET_SCHEDULE;
+
+		// Scheduling the tweet
+		const response = await this.request<ITweetScheduleResponse>(resource, { tweet: options });
+
+		// Deserializing response
+		const data = extractors[resource](response);
+
+		return data;
+	}
+
 	/**
 	 * Search for tweets using a filter.
 	 *
@@ -604,6 +611,42 @@ export class TweetService extends FetcherService {
 		return data;
 	}
 
+	/**
+	 * Unschedule a tweet.
+	 *
+	 * @param id - The id of the scheduled tweet.
+	 *
+	 * @returns Whether unscheduling was successful or not.
+	 *
+	 * @example
+	 * ```
+	 * import { Rettiwt } from 'rettiwt-api';
+	 *
+	 * // Creating a new Rettiwt instance using the given 'API_KEY'
+	 * const rettiwt = new Rettiwt({ apiKey: API_KEY });
+	 *
+	 * // Unscheduling the Tweet with id '1234567890'
+	 * rettiwt.tweet.unschedule('1234567890')
+	 * .then(res => {
+	 * 	console.log(res);
+	 * })
+	 * .catch(err => {
+	 * 	console.log(err);
+	 * });
+	 * ```
+	 */
+	public async unschedule(id: string): Promise<boolean> {
+		const resource = EResourceType.TWEET_UNSCHEDULE;
+
+		// Unscheduling the tweet
+		const response = await this.request<ITweetUnscheduleResponse>(resource, { id: id });
+
+		// Deserializing the response
+		const data = extractors[resource](response) ?? false;
+
+		return data;
+	}
+
 	/**
 	 * Upload a media file to Twitter.
 	 *

package/src/services/public/UserService.ts

@@ -309,9 +309,8 @@ export class UserService extends FetcherService {
 	}
 
 	/**
-	 * Get the list of tweets liked by a user.
+	 * Get the list of tweets liked by the logged in user.
 	 *
-	 * @param id - The id of the target user.
 	 * @param count - The number of likes to fetch, must be \<= 100.
 	 * @param cursor - The cursor to the batch of likes to fetch.
 	 *
@@ -324,8 +323,8 @@ export class UserService extends FetcherService {
 	 * // 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 User with id '1234567890'
-	 * rettiwt.user.likes('1234567890')
+	 * // Fetching the most recent 100 liked Tweets of the logged in User
+	 * rettiwt.user.likes()
 	 * .then(res => {
 	 * 	console.log(res);
 	 * })
@@ -334,12 +333,12 @@ export class UserService extends FetcherService {
 	 * });
 	 * ```
 	 */
-	public async likes(id: string, count?: number, cursor?: string): Promise<CursoredData<Tweet>> {
+	public async likes(count?: number, cursor?: string): Promise<CursoredData<Tweet>> {
 		const resource = EResourceType.USER_LIKES;
 
 		// Fetching raw list of likes
 		const response = await this.request<IUserLikesResponse>(resource, {
-			id: id,
+			id: this.userId,
 			count: count,
 			cursor: cursor,
 		});