rettiwt-api 5.0.0-alpha.4 → 5.0.0

package/src/models/args/FetchArgs.ts

@@ -1,4 +1,4 @@
-import { EResourceType } from '../../enums/Resource';
+import { ETweetRepliesSortType } from '../../enums/Tweet';
 import { IFetchArgs, ITweetFilter } from '../../types/args/FetchArgs';
 
 /**
@@ -12,17 +12,18 @@ export class FetchArgs implements IFetchArgs {
 	public filter?: TweetFilter;
 	public id?: string;
 	public ids?: string[];
+	public sortBy?: ETweetRepliesSortType;
 
 	/**
-	 * @param resource - The resource to be fetched.
 	 * @param args - Additional user-defined arguments for fetching the resource.
 	 */
-	public constructor(resource: EResourceType, args: IFetchArgs) {
+	public constructor(args: IFetchArgs) {
 		this.id = args.id;
 		this.ids = args.ids;
 		this.count = args.count;
 		this.cursor = args.cursor;
 		this.filter = args.filter ? new TweetFilter(args.filter) : undefined;
+		this.sortBy = args.sortBy;
 	}
 }
 

package/src/models/args/PostArgs.ts

@@ -1,4 +1,3 @@
-import { EResourceType } from '../../enums/Resource';
 import { INewTweet, INewTweetMedia, IPostArgs, IUploadArgs } from '../../types/args/PostArgs';
 
 /**
@@ -15,10 +14,10 @@ export class PostArgs implements IPostArgs {
 	 * @param resource - The resource to be posted.
 	 * @param args - Additional user-defined arguments for posting the resource.
 	 */
-	public constructor(resource: EResourceType, args: IPostArgs) {
+	public constructor(args: IPostArgs) {
 		this.id = args.id;
 		this.tweet = args.tweet ? new NewTweet(args.tweet) : undefined;
-		this.upload = args.upload ? new UploadArgs(resource, args.upload) : undefined;
+		this.upload = args.upload ? new UploadArgs(args.upload) : undefined;
 	}
 }
 
@@ -78,7 +77,7 @@ export class UploadArgs implements IUploadArgs {
 	 * @param step - The upload step.
 	 * @param args - The upload arguments for uploading the media file.
 	 */
-	public constructor(step: EResourceType, args: IUploadArgs) {
+	public constructor(args: IUploadArgs) {
 		this.size = args.size;
 		this.media = args.media;
 		this.id = args.id;

package/src/models/auth/AuthCookie.ts

@@ -5,7 +5,7 @@ import { IAuthCookie } from '../../types/auth/AuthCookie';
 /**
  * The cookie containing the tokens that are used to authenticate against Twitter.
  *
- * @public
+ * @internal
  */
 export class AuthCookie implements IAuthCookie {
 	/* eslint-disable @typescript-eslint/naming-convention */

package/src/models/auth/AuthCredential.ts

@@ -15,7 +15,7 @@ import { AuthCookie } from './AuthCookie';
  * - authToken, csrfToken, cookie =\> User authentication.
  * - authToken, guestToken, cookie =\> Guest authentication while logging in.
  *
- * @public
+ * @internal
  */
 export class AuthCredential implements IAuthCredential {
 	public authToken?: string;

package/src/models/data/List.ts

@@ -32,7 +32,7 @@ export class List implements IList {
 		this.createdBy = list.user_results.result.id;
 	}
 
-	/** Get the raw list details. */
+	/** The raw list details. */
 	public get raw(): IRawList {
 		return { ...this._raw };
 	}

package/src/models/data/Notification.ts

@@ -44,7 +44,7 @@ export class Notification implements INotification {
 			: ENotificationType.UNDEFINED;
 	}
 
-	/** Get the raw notification details. */
+	/** The raw notification details. */
 	public get raw(): IRawNotification {
 		return { ...this._raw };
 	}

package/src/models/data/Tweet.ts

@@ -66,7 +66,7 @@ export class Tweet implements ITweet {
 		this.url = `https://x.com/${this.tweetBy.userName}/status/${this.id}`;
 	}
 
-	/** Get the raw tweet details. */
+	/** The raw tweet details. */
 	public get raw(): IRawTweet {
 		return { ...this._raw };
 	}

package/src/models/data/User.ts

@@ -50,7 +50,7 @@ export class User implements IUser {
 		this.profileImage = user.legacy.profile_image_url_https;
 	}
 
-	/** Get the raw user details. */
+	/** The raw user details. */
 	public get raw(): IRawUser {
 		return { ...this._raw };
 	}

package/src/requests/Tweet.ts

@@ -1,6 +1,6 @@
 import { AxiosRequestConfig } from 'axios';
 
-import { ERawTweetSearchResultType } from '../enums/raw/Tweet';
+import { ERawTweetRepliesSortType, ERawTweetSearchResultType } from '../enums/raw/Tweet';
 import { TweetFilter } from '../models/args/FetchArgs';
 import { NewTweet } from '../models/args/PostArgs';
 import { MediaVariable, ReplyVariable } from '../models/params/Variables';
@@ -266,7 +266,7 @@ export class TweetRequests {
 	 * @param id - The id of the tweet whose replies are to be fetched.
 	 * @param cursor - The cursor to the batch of replies to fetch.
 	 */
-	public static replies(id: string, cursor?: string): AxiosRequestConfig {
+	public static replies(id: string, cursor?: string, sortBy?: ERawTweetRepliesSortType): AxiosRequestConfig {
 		return {
 			method: 'get',
 			url: 'https://x.com/i/api/graphql/_8aYOgEDz35BrBcBal1-_w/TweetDetail',
@@ -276,14 +276,13 @@ export class TweetRequests {
 					focalTweetId: id,
 					cursor: cursor,
 					referrer: 'tweet',
-					controller_data: cursor,
 					with_rux_injections: false,
-					includePromotedContent: false,
+					rankingMode: sortBy ?? ERawTweetRepliesSortType.RELEVACE,
+					includePromotedContent: true,
 					withCommunity: true,
 					withQuickPromoteEligibilityTweetFields: true,
 					withBirdwatchNotes: true,
 					withVoice: true,
-					withV2Timeline: true,
 				}),
 				features: JSON.stringify({
 					rweb_video_screen_enabled: false,

package/src/services/internal/AuthService.ts

@@ -7,7 +7,7 @@ import { RettiwtConfig } from '../../models/RettiwtConfig';
 /**
  * The services that handles authentication.
  *
- * @public
+ * @internal
  */
 export class AuthService {
 	/** The config object. */

package/src/services/internal/TidService.ts

@@ -19,7 +19,6 @@ import { LogService } from './LogService';
 export class TidService implements ITidProvider {
 	private readonly _cdnUrl: string;
 	private readonly _config: RettiwtConfig;
-	private readonly _requestHeaders: NonNullable<unknown>;
 	private _dynamicArgs?: ITidDynamicArgs;
 
 	/**
@@ -28,20 +27,6 @@ export class TidService implements ITidProvider {
 	public constructor(config: RettiwtConfig) {
 		this._cdnUrl = 'https://abs.twimg.com/responsive-web/client-web';
 		this._config = config;
-		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 */
-		};
 	}
 
 	/**
@@ -69,7 +54,7 @@ export class TidService implements ITidProvider {
 	 */
 	private async getHomepageHtml(): Promise<string> {
 		const response = await axios.get<string>('https://x.com', {
-			headers: this._requestHeaders,
+			headers: this._config.headers,
 			httpAgent: this._config.httpsAgent,
 			httpsAgent: this._config.httpsAgent,
 		});
@@ -117,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;
@@ -132,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

@@ -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'