rettiwt-api 5.0.0-alpha.3 → 5.0.0

package/src/services/internal/AuthService.ts

@@ -1,24 +1,23 @@
-import { Agent } from 'https';
-
 import axios from 'axios';
 
 import { EApiErrors } from '../../enums/Api';
 import { AuthCredential } from '../../models/auth/AuthCredential';
+import { RettiwtConfig } from '../../models/RettiwtConfig';
 
 /**
  * The services that handles authentication.
  *
- * @public
+ * @internal
  */
 export class AuthService {
-	/** The HTTPS Agent to use for requests to Twitter API. */
-	private readonly _httpsAgent: Agent;
+	/** The config object. */
+	private readonly _config: RettiwtConfig;
 
 	/**
-	 * @param httpsAgent - The HTTPS agent to use. If none is provided, default is used.
+	 * @param config - The config for Rettiwt.
 	 */
-	public constructor(httpsAgent?: Agent) {
-		this._httpsAgent = httpsAgent ?? new Agent();
+	public constructor(config: RettiwtConfig) {
+		this._config = config;
 	}
 
 	/**
@@ -107,7 +106,7 @@ export class AuthService {
 				/* eslint-enable @typescript-eslint/naming-convention */
 			}>('https://api.twitter.com/1.1/guest/activate.json', undefined, {
 				headers: cred.toHeader(),
-				httpsAgent: this._httpsAgent,
+				httpsAgent: this._config.httpsAgent,
 			})
 			.then((res) => {
 				cred.guestToken = res.data.guest_token;

package/src/services/internal/ErrorService.ts

@@ -1,12 +1,8 @@
-import { AxiosError, AxiosResponse, isAxiosError } from 'axios';
+import { AxiosError, isAxiosError } from 'axios';
 
-import { EApiErrors, EErrorCodes } from '../../enums/Api';
-import { EHttpStatus } from '../../enums/Http';
-import { findKeyByValue } from '../../helper/JsonUtils';
-import { ApiError } from '../../models/errors/ApiError';
-import { HttpError } from '../../models/errors/HttpError';
-import { TimeoutError } from '../../models/errors/TimeoutError';
+import { TwitterError } from '../../models/errors/TwitterError';
 import { IErrorHandler } from '../../types/ErrorHandler';
+import { IErrorData as IRawErrorData, IErrorDetails as IRawErrorDetails } from '../../types/raw/base/Error';
 
 /**
  * The base service that handles any errors.
@@ -15,129 +11,19 @@ import { IErrorHandler } from '../../types/ErrorHandler';
  */
 export class ErrorService implements IErrorHandler {
 	/**
-	 * Error message used when the specific error type is not defined in the required enums.
-	 */
-	protected static readonly DEFAULT_ERROR_MESSAGE = 'Unknown error';
-
-	/**
-	 * Creates an API error instance based on the provided error code.
-	 *
-	 * @param errorCode - The error code.
-	 *
-	 * @returns An API error instance.
-	 */
-	protected createApiError(errorCode: number): ApiError {
-		return new ApiError(errorCode, this.getApiErrorMessage(errorCode));
-	}
-
-	/**
-	 * Creates an HTTP error instance based on the provided HTTP status.
-	 *
-	 * @param httpStatus - The HTTP status code.
-	 *
-	 * @returns An HTTP error instance.
-	 */
-	protected createHttpError(httpStatus: number): HttpError {
-		return new HttpError(httpStatus, this.getHttpErrorMessage(httpStatus));
-	}
-
-	/**
-	 * Retrieves the API error message based on the provided error code.
+	 * Handles errors thrown by Twitter.
 	 *
-	 * @param errorCode - The error code.
-	 *
-	 * @returns The API error message.
+	 * @param error - The error response received from Twitter.
 	 */
-	protected getApiErrorMessage(errorCode: number): string {
-		const errorCodeKey = findKeyByValue(EErrorCodes, errorCode.toString());
-
-		return !!errorCodeKey && errorCodeKey in EApiErrors
-			? EApiErrors[errorCodeKey as keyof typeof EApiErrors]
-			: ErrorService.DEFAULT_ERROR_MESSAGE;
+	private handleAxiosError(error: AxiosError<IRawErrorData | IRawErrorDetails>): void {
+		throw new TwitterError(error);
 	}
 
 	/**
-	 * Retrieves the response data from the given error.
-	 *
-	 * @param error - The error object.
-	 *
-	 * @returns The response data.
-	 *
-	 * @throws The original error if it is not an HTTP error with a response.
+	 * Handle unknown error.
 	 */
-	protected getAxiosResponse(error: AxiosError): AxiosResponse {
-		if (error.response) {
-			return error.response;
-		}
-
-		throw error;
-	}
-
-	/**
-	 * Retrieves the API error code from the Axios response data.
-	 *
-	 * @param response - The response object received.
-	 *
-	 * @returns The error code, or undefined if not found.
-	 */
-	protected getErrorCode(response: AxiosResponse): number | undefined {
-		const errors = (response.data as { errors: { code: number }[] }).errors;
-
-		return !!errors && errors.length ? errors[0].code : undefined;
-	}
-
-	/**
-	 * Retrieves the HTTP error message based on the provided HTTP status.
-	 *
-	 * @param httpStatus - The HTTP status code.
-	 *
-	 * @returns The HTTP error message.
-	 */
-	protected getHttpErrorMessage(httpStatus: number): string {
-		return Object.values(EHttpStatus).includes(httpStatus)
-			? EHttpStatus[httpStatus]
-			: ErrorService.DEFAULT_ERROR_MESSAGE;
-	}
-
-	/**
-	 * Handles API error in a response.
-	 *
-	 * @param response - The response object received.
-	 *
-	 * @throws An error with the corresponding API error message if any API-related error has occurred.
-	 */
-	protected handleApiError(response: AxiosResponse): void {
-		const errorCode = this.getErrorCode(response);
-
-		if (errorCode === undefined) {
-			return;
-		}
-
-		throw this.createApiError(errorCode);
-	}
-
-	/**
-	 * Handles HTTP error in a response.
-	 *
-	 * @param response - The response object received.
-	 *
-	 * @throws An error with the corresponding HTTP status text if any HTTP-related error has occurred.
-	 */
-	protected handleHttpError(response: AxiosResponse): void {
-		throw this.createHttpError(response.status);
-	}
-
-	/**
-	 * Handles exceeded timeout, configured in RettiwtConfig.
-	 *
-	 * @param error - The error object.
-	 *
-	 * @throws An error if the configured request timeout has been exceeded.
-	 */
-	protected handleTimeoutError(error: AxiosError): void {
-		if (error.code === 'ECONNABORTED') {
-			throw new TimeoutError(error.message);
-		}
+	private handleUnknownError(): void {
+		throw new Error('Unknown error');
 	}
 
 	/**
@@ -146,14 +32,10 @@ export class ErrorService implements IErrorHandler {
 	 * @param error - The error caught while making HTTP request to Twitter API.
 	 */
 	public handle(error: unknown): void {
-		if (!isAxiosError(error)) {
-			throw error;
+		if (isAxiosError(error)) {
+			this.handleAxiosError(error as AxiosError<IRawErrorData | IRawErrorDetails>);
+		} else {
+			this.handleUnknownError();
 		}
-
-		this.handleTimeoutError(error);
-
-		const axiosResponse = this.getAxiosResponse(error);
-		this.handleApiError(axiosResponse);
-		this.handleHttpError(axiosResponse);
 	}
 }

package/src/services/internal/TidService.ts

@@ -1,5 +1,3 @@
-import { Agent } from 'http';
-
 import axios from 'axios';
 import * as htmlParser from 'node-html-parser';
 
@@ -7,6 +5,7 @@ import { ELogActions } from '../../enums/Logging';
 
 import { calculateClientTransactionIdHeader } from '../../helper/TidUtils';
 
+import { RettiwtConfig } from '../../models/RettiwtConfig';
 import { ITidDynamicArgs } from '../../types/auth/TidDynamicArgs';
 import { ITidProvider } from '../../types/auth/TidProvider';
 
@@ -19,30 +18,15 @@ import { LogService } from './LogService';
  */
 export class TidService implements ITidProvider {
 	private readonly _cdnUrl: string;
-	private readonly _httpsAgent: Agent;
-	private readonly _requestHeaders: NonNullable<unknown>;
+	private readonly _config: RettiwtConfig;
 	private _dynamicArgs?: ITidDynamicArgs;
 
 	/**
-	 * @param httpsAgent - The HTTPS agent to use. If none is provided, default is used.
+	 * @param config - The config for Rettiwt.
 	 */
-	public constructor(httpsAgent?: Agent) {
+	public constructor(config: RettiwtConfig) {
 		this._cdnUrl = 'https://abs.twimg.com/responsive-web/client-web';
-		this._httpsAgent = httpsAgent ?? new Agent();
-		this._requestHeaders = {
-			/* eslint-disable @typescript-eslint/naming-convention */
-
-			Authority: 'x.com',
-			'Accept-Language': 'en-US,en;q=0.9',
-			'Cache-Control': 'no-cache',
-			Referer: 'https://x.com',
-			'User-Agent':
-				'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/127.0.0.0 Safari/537.36',
-			'X-Twitter-Active-User': 'yes',
-			'X-Twitter-Client-Language': 'en',
-
-			/* eslint-enable @typescript-eslint/naming-convention */
-		};
+		this._config = config;
 	}
 
 	/**
@@ -70,9 +54,9 @@ export class TidService implements ITidProvider {
 	 */
 	private async getHomepageHtml(): Promise<string> {
 		const response = await axios.get<string>('https://x.com', {
-			headers: this._requestHeaders,
-			httpAgent: this._httpsAgent,
-			httpsAgent: this._httpsAgent,
+			headers: this._config.headers,
+			httpAgent: this._config.httpsAgent,
+			httpsAgent: this._config.httpsAgent,
 		});
 
 		return response.data;
@@ -88,8 +72,8 @@ export class TidService implements ITidProvider {
 
 		const onDemandFileHash = ondemandFileMatch ? ondemandFileMatch[1] : '';
 		const response = await axios.get<string>(`${this._cdnUrl}/ondemand.s.${onDemandFileHash}a.js`, {
-			httpAgent: this._httpsAgent,
-			httpsAgent: this._httpsAgent,
+			httpAgent: this._config.httpsAgent,
+			httpsAgent: this._config.httpsAgent,
 		});
 		const match = response.data.matchAll(/(\(\w\[(\d{1,2})],\s*16\))+?/gm);
 
@@ -118,8 +102,12 @@ export class TidService implements ITidProvider {
 	 */
 	public async generate(method: string, path: string): Promise<string | undefined> {
 		try {
+			// Refreshing dynamic args
+			await this.refreshDynamicArgs();
+
+			// If dynamic args weren't obtained, skip with error
 			if (!this._dynamicArgs) {
-				this._dynamicArgs = await this.getDynamicArgs();
+				throw new Error('Dynamic args failed to generate');
 			}
 
 			const { verificationKey, frames, indices } = this._dynamicArgs;
@@ -133,7 +121,12 @@ export class TidService implements ITidProvider {
 				indices: indices,
 				extraByte: 3,
 			});
-		} catch {
+		} catch (err) {
+			LogService.log(ELogActions.WARNING, {
+				message: 'Failed to generated transaction token. Request may or may not work',
+				error: err,
+			});
+
 			return;
 		}
 	}

package/src/services/public/FetcherService.ts

@@ -53,9 +53,9 @@ export class FetcherService {
 		this.config = config;
 		this._delay = config.delay;
 		this._errorHandler = config.errorHandler ?? new ErrorService();
-		this._tidProvider = config.tidProvider ?? new TidService(config.httpsAgent);
+		this._tidProvider = config.tidProvider ?? new TidService(config);
 		this._timeout = config.timeout ?? 0;
-		this._auth = new AuthService(config.httpsAgent);
+		this._auth = new AuthService(config);
 	}
 
 	/**
@@ -137,12 +137,12 @@ export class FetcherService {
 			// Logging
 			LogService.log(ELogActions.VALIDATE, { target: 'FETCH_ARGS' });
 
-			return new FetchArgs(resource, args);
+			return new FetchArgs(args);
 		} else if (postResources.includes(resource)) {
 			// Logging
 			LogService.log(ELogActions.VALIDATE, { target: 'POST_ARGS' });
 
-			return new PostArgs(resource, args);
+			return new PostArgs(args);
 		}
 	}
 
@@ -180,8 +180,9 @@ export class FetcherService {
 	 * @returns The raw data response received.
 	 *
 	 * @example
-	 * Fetching the raw details of a user with username 'user1'
-	 * ```
+	 *
+	 * #### Fetching the raw details of a single user, using their username
+	 * ```ts
 	 * import { FetcherService, EResourceType } from 'rettiwt-api';
 	 *
 	 * // Creating a new FetcherService instance using the given 'API_KEY'
@@ -194,7 +195,7 @@ export class FetcherService {
 	 * })
 	 * .catch(err => {
 	 * 	console.log(err);
-	 * })
+	 * });
 	 * ```
 	 */
 	public async request<T = unknown>(resource: EResourceType, args: IFetchArgs | IPostArgs): Promise<T> {

package/src/services/public/ListService.ts

@@ -22,14 +22,15 @@ export class ListService extends FetcherService {
 	/**
 	 * Get the list of members of a tweet list.
 	 *
-	 * @param id - The id of target 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
-	 * ```
+	 *
+	 * ```ts
 	 * import { Rettiwt } from 'rettiwt-api';
 	 *
 	 * // Creating a new Rettiwt instance using the given 'API_KEY'
@@ -66,14 +67,15 @@ export class ListService extends FetcherService {
 	/**
 	 * Get the list of tweets from a tweet list.
 	 *
-	 * @param id - The id of target 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
-	 * ```
+	 *
+	 * ```ts
 	 * import { Rettiwt } from 'rettiwt-api';
 	 *
 	 * // Creating a new Rettiwt instance using the given 'API_KEY'