rettiwt-api 5.1.0-alpha.0 → 6.0.0

package/src/collections/Groups.ts

@@ -1,14 +1,14 @@
-import { EResourceType } from '../enums/Resource';
+import { ResourceType } from '../enums/Resource';
 
 /**
  * Collection of resources that allow guest authentication.
  *
  * @internal
  */
-export const allowGuestAuthentication = [
-	EResourceType.TWEET_DETAILS,
-	EResourceType.USER_DETAILS_BY_USERNAME,
-	EResourceType.USER_TIMELINE,
+export const AllowGuestAuthenticationGroup = [
+	ResourceType.TWEET_DETAILS,
+	ResourceType.USER_DETAILS_BY_USERNAME,
+	ResourceType.USER_TIMELINE,
 ];
 
 /**
@@ -16,32 +16,32 @@ export const allowGuestAuthentication = [
  *
  * @internal
  */
-export const fetchResources = [
-	EResourceType.LIST_MEMBERS,
-	EResourceType.LIST_TWEETS,
-	EResourceType.TWEET_DETAILS,
-	EResourceType.TWEET_DETAILS_ALT,
-	EResourceType.TWEET_DETAILS_BULK,
-	EResourceType.TWEET_LIKERS,
-	EResourceType.TWEET_REPLIES,
-	EResourceType.TWEET_RETWEETERS,
-	EResourceType.TWEET_SEARCH,
-	EResourceType.USER_AFFILIATES,
-	EResourceType.USER_BOOKMARKS,
-	EResourceType.USER_DETAILS_BY_USERNAME,
-	EResourceType.USER_DETAILS_BY_ID,
-	EResourceType.USER_DETAILS_BY_IDS_BULK,
-	EResourceType.USER_FEED_FOLLOWED,
-	EResourceType.USER_FEED_RECOMMENDED,
-	EResourceType.USER_FOLLOWING,
-	EResourceType.USER_FOLLOWERS,
-	EResourceType.USER_HIGHLIGHTS,
-	EResourceType.USER_LIKES,
-	EResourceType.USER_MEDIA,
-	EResourceType.USER_NOTIFICATIONS,
-	EResourceType.USER_SUBSCRIPTIONS,
-	EResourceType.USER_TIMELINE,
-	EResourceType.USER_TIMELINE_AND_REPLIES,
+export const FetchResourcesGroup = [
+	ResourceType.LIST_MEMBERS,
+	ResourceType.LIST_TWEETS,
+	ResourceType.TWEET_DETAILS,
+	ResourceType.TWEET_DETAILS_ALT,
+	ResourceType.TWEET_DETAILS_BULK,
+	ResourceType.TWEET_LIKERS,
+	ResourceType.TWEET_REPLIES,
+	ResourceType.TWEET_RETWEETERS,
+	ResourceType.TWEET_SEARCH,
+	ResourceType.USER_AFFILIATES,
+	ResourceType.USER_BOOKMARKS,
+	ResourceType.USER_DETAILS_BY_USERNAME,
+	ResourceType.USER_DETAILS_BY_ID,
+	ResourceType.USER_DETAILS_BY_IDS_BULK,
+	ResourceType.USER_FEED_FOLLOWED,
+	ResourceType.USER_FEED_RECOMMENDED,
+	ResourceType.USER_FOLLOWING,
+	ResourceType.USER_FOLLOWERS,
+	ResourceType.USER_HIGHLIGHTS,
+	ResourceType.USER_LIKES,
+	ResourceType.USER_MEDIA,
+	ResourceType.USER_NOTIFICATIONS,
+	ResourceType.USER_SUBSCRIPTIONS,
+	ResourceType.USER_TIMELINE,
+	ResourceType.USER_TIMELINE_AND_REPLIES,
 ];
 
 /**
@@ -49,18 +49,18 @@ export const fetchResources = [
  *
  * @internal
  */
-export const postResources = [
-	EResourceType.MEDIA_UPLOAD_APPEND,
-	EResourceType.MEDIA_UPLOAD_FINALIZE,
-	EResourceType.MEDIA_UPLOAD_INITIALIZE,
-	EResourceType.TWEET_LIKE,
-	EResourceType.TWEET_POST,
-	EResourceType.TWEET_RETWEET,
-	EResourceType.TWEET_SCHEDULE,
-	EResourceType.TWEET_UNLIKE,
-	EResourceType.TWEET_UNPOST,
-	EResourceType.TWEET_UNRETWEET,
-	EResourceType.TWEET_UNSCHEDULE,
-	EResourceType.USER_FOLLOW,
-	EResourceType.USER_UNFOLLOW,
+export const PostResourcesGroup = [
+	ResourceType.MEDIA_UPLOAD_APPEND,
+	ResourceType.MEDIA_UPLOAD_FINALIZE,
+	ResourceType.MEDIA_UPLOAD_INITIALIZE,
+	ResourceType.TWEET_LIKE,
+	ResourceType.TWEET_POST,
+	ResourceType.TWEET_RETWEET,
+	ResourceType.TWEET_SCHEDULE,
+	ResourceType.TWEET_UNLIKE,
+	ResourceType.TWEET_UNPOST,
+	ResourceType.TWEET_UNRETWEET,
+	ResourceType.TWEET_UNSCHEDULE,
+	ResourceType.USER_FOLLOW,
+	ResourceType.USER_UNFOLLOW,
 ];

package/src/collections/Requests.ts

@@ -1,6 +1,6 @@
 import { AxiosRequestConfig } from 'axios';
 
-import { EResourceType } from '../enums/Resource';
+import { ResourceType } from '../enums/Resource';
 import { ListRequests } from '../requests/List';
 import { MediaRequests } from '../requests/Media';
 import { TweetRequests } from '../requests/Tweet';
@@ -8,14 +8,14 @@ import { UserRequests } from '../requests/User';
 import { IFetchArgs } from '../types/args/FetchArgs';
 import { IPostArgs } from '../types/args/PostArgs';
 
-import { rawTweetRepliesSortType } from './Tweet';
+import { TweetRepliesSortTypeMap } from './Tweet';
 
 /**
  * Collection of requests to various resources.
  *
  * @internal
  */
-export const requests: { [key in keyof typeof EResourceType]: (args: IFetchArgs | IPostArgs) => AxiosRequestConfig } = {
+export const Requests: { [key in keyof typeof ResourceType]: (args: IFetchArgs | IPostArgs) => AxiosRequestConfig } = {
 	/* eslint-disable @typescript-eslint/naming-convention */
 
 	LIST_MEMBERS: (args: IFetchArgs) => ListRequests.members(args.id!, args.count, args.cursor),
@@ -32,7 +32,7 @@ export const requests: { [key in keyof typeof EResourceType]: (args: IFetchArgs
 	TWEET_LIKERS: (args: IFetchArgs) => TweetRequests.likers(args.id!, args.count, args.cursor),
 	TWEET_POST: (args: IPostArgs) => TweetRequests.post(args.tweet!),
 	TWEET_REPLIES: (args: IFetchArgs) =>
-		TweetRequests.replies(args.id!, args.cursor, args.sortBy ? rawTweetRepliesSortType[args.sortBy] : undefined),
+		TweetRequests.replies(args.id!, args.cursor, args.sortBy ? TweetRepliesSortTypeMap[args.sortBy] : undefined),
 	TWEET_RETWEET: (args: IPostArgs) => TweetRequests.retweet(args.id!),
 	TWEET_RETWEETERS: (args: IFetchArgs) => TweetRequests.retweeters(args.id!, args.count, args.cursor),
 	TWEET_SCHEDULE: (args: IPostArgs) => TweetRequests.schedule(args.tweet!),

package/src/collections/Tweet.ts

@@ -1,17 +1,17 @@
-import { ERawTweetRepliesSortType } from '../enums/raw/Tweet';
-import { ETweetRepliesSortType } from '../enums/Tweet';
+import { RawTweetRepliesSortType } from '../enums/raw/Tweet';
+import { TweetRepliesSortType } from '../enums/Tweet';
 
 /**
  * Collection of mapping from parsed reply sort type to raw reply sort type.
  *
  * @internal
  */
-export const rawTweetRepliesSortType: { [key in keyof typeof ETweetRepliesSortType]: ERawTweetRepliesSortType } = {
+export const TweetRepliesSortTypeMap: { [key in keyof typeof TweetRepliesSortType]: RawTweetRepliesSortType } = {
 	/* eslint-disable @typescript-eslint/naming-convention */
 
-	LATEST: ERawTweetRepliesSortType.LATEST,
-	LIKES: ERawTweetRepliesSortType.LIKES,
-	RELEVANCE: ERawTweetRepliesSortType.RELEVACE,
+	LATEST: RawTweetRepliesSortType.LATEST,
+	LIKES: RawTweetRepliesSortType.LIKES,
+	RELEVANCE: RawTweetRepliesSortType.RELEVACE,
 
 	/* eslint-enable @typescript-eslint/naming-convention */
 };

package/src/commands/Tweet.ts

@@ -1,5 +1,6 @@
 import { Command, createCommand } from 'commander';
 
+import { TweetRepliesSortType } from '../enums/Tweet';
 import { output } from '../helper/CliUtils';
 import { TweetFilter } from '../models/args/FetchArgs';
 import { Rettiwt } from '../Rettiwt';
@@ -63,8 +64,8 @@ function createTweetCommand(rettiwt: Rettiwt): Command {
 		.argument('[cursor]', 'The cursor to the batch of likers to fetch')
 		.action(async (id: string, count?: string, cursor?: string) => {
 			try {
-				const tweets = await rettiwt.tweet.likers(id, count ? parseInt(count) : undefined, cursor);
-				output(tweets);
+				const users = await rettiwt.tweet.likers(id, count ? parseInt(count) : undefined, cursor);
+				output(users);
 			} catch (error) {
 				output(error);
 			}
@@ -95,6 +96,34 @@ function createTweetCommand(rettiwt: Rettiwt): Command {
 			}
 		});
 
+	// Replies
+	tweet
+		.command('replies')
+		.description(
+			'Fetch the list of replies to a tweet, with the first batch containing the whole thread, if the tweet is/part of a thread',
+		)
+		.argument('<id>', 'The id of the tweet')
+		.argument('[cursor]', 'The cursor to the batch of replies to fetch')
+		.option('-s, --sort-by <string>', 'Sort the tweets by likes, latest or relevance, default is latest')
+		.action(async (id: string, cursor?: string, options?: { sortBy: string }) => {
+			try {
+				// Determining the sort type
+				let sortType: TweetRepliesSortType | undefined = undefined;
+				if (options?.sortBy === 'likes') {
+					sortType = TweetRepliesSortType.LIKES;
+				} else if (options?.sortBy === 'latest') {
+					sortType = TweetRepliesSortType.LATEST;
+				} else if (options?.sortBy === 'relevance') {
+					sortType = TweetRepliesSortType.RELEVANCE;
+				}
+
+				const tweets = await rettiwt.tweet.replies(id, cursor, sortType);
+				output(tweets);
+			} catch (error) {
+				output(error);
+			}
+		});
+
 	// Retweet
 	tweet
 		.command('retweet')
@@ -118,8 +147,8 @@ function createTweetCommand(rettiwt: Rettiwt): Command {
 		.argument('[cursor]', 'The cursor to the batch of retweeters to fetch')
 		.action(async (id: string, count?: string, cursor?: string) => {
 			try {
-				const tweets = await rettiwt.tweet.retweeters(id, count ? parseInt(count) : undefined, cursor);
-				output(tweets);
+				const users = await rettiwt.tweet.retweeters(id, count ? parseInt(count) : undefined, cursor);
+				output(users);
 			} catch (error) {
 				output(error);
 			}

package/src/enums/Api.ts

@@ -3,7 +3,7 @@
  *
  * @public
  */
-export enum EApiErrors {
+export enum ApiErrors {
 	COULD_NOT_AUTHENTICATE = 'Failed to authenticate',
 	BAD_AUTHENTICATION = 'Invalid authentication data',
 	RESOURCE_NOT_ALLOWED = 'Not authorized to access requested resource',

package/src/enums/Authentication.ts

@@ -3,7 +3,7 @@
  *
  * @public
  */
-export enum EAuthenticationType {
+export enum AuthenticationType {
 	GUEST = 'GUEST',
 	USER = 'USER',
 	LOGIN = 'LOGIN',

package/src/enums/Data.ts

@@ -3,7 +3,7 @@
  *
  * @internal
  */
-export enum EBaseType {
+export enum BaseType {
 	NOTIFICATION = 'NOTIFICATION',
 	TWEET = 'TWEET',
 	USER = 'USER',

package/src/enums/Logging.ts

@@ -3,7 +3,7 @@
  *
  * @internal
  */
-export enum ELogActions {
+export enum LogActions {
 	AUTHORIZATION = 'AUTHORIZATION',
 	DESERIALIZE = 'DESERIALIZE',
 	EXTRACT = 'EXTRACT',

package/src/enums/Media.ts

@@ -3,7 +3,7 @@
  *
  * @public
  */
-export enum EMediaType {
+export enum MediaType {
 	PHOTO = 'PHOTO',
 	VIDEO = 'VIDEO',
 	GIF = 'GIF',

package/src/enums/Notification.ts

@@ -3,7 +3,7 @@
  *
  * @public
  */
-export enum ENotificationType {
+export enum NotificationType {
 	RECOMMENDATION = 'RECOMMENDATION',
 	INFORMATION = 'INFORMATION',
 	LIVE = 'LIVE',

package/src/enums/Resource.ts

@@ -3,7 +3,7 @@
  *
  * @public
  */
-export enum EResourceType {
+export enum ResourceType {
 	// LIST
 	LIST_MEMBERS = 'LIST_MEMBERS',
 	LIST_TWEETS = 'LIST_TWEETS',

package/src/enums/Tweet.ts

@@ -1,7 +1,7 @@
 /**
  * The different types of sorting options when fetching replies to tweets.
  */
-export enum ETweetRepliesSortType {
+export enum TweetRepliesSortType {
 	LIKES = 'LIKES',
 	LATEST = 'LATEST',
 	RELEVANCE = 'RELEVANCE',

package/src/enums/raw/Analytics.ts

@@ -3,7 +3,7 @@
  *
  * @public
  */
-export enum ERawAnalyticsGranularity {
+export enum RawAnalyticsGranularity {
 	DAILY = 'Daily',
 	WEEKLY = 'Weekly',
 	MONTHLY = 'Monthly',
@@ -14,7 +14,7 @@ export enum ERawAnalyticsGranularity {
  *
  * @public
  */
-export enum ERawAnalyticsMetric {
+export enum RawAnalyticsMetric {
 	ENGAGEMENTS = 'Engagements',
 	IMPRESSIONS = 'Impressions',
 	PROFILE_VISITS = 'ProfileVisits',

package/src/enums/raw/Media.ts

@@ -3,7 +3,7 @@
  *
  * @public
  */
-export enum ERawMediaType {
+export enum RawMediaType {
 	PHOTO = 'photo',
 	VIDEO = 'video',
 	GIF = 'animated_gif',

package/src/enums/raw/Notification.ts

@@ -3,7 +3,7 @@
  *
  * @public
  */
-export enum ERawNotificationType {
+export enum RawNotificationType {
 	RECOMMENDATION = 'recommendation_icon',
 	INFORMATION = 'bird_icon',
 	LIVE = 'live_icon',

package/src/enums/raw/Tweet.ts

@@ -3,7 +3,7 @@
  *
  * @public
  */
-export enum ERawTweetSearchResultType {
+export enum RawTweetSearchResultType {
 	LATEST = 'Latest',
 	TOP = 'Top',
 }
@@ -13,7 +13,7 @@ export enum ERawTweetSearchResultType {
  *
  * @public
  */
-export enum ERawTweetRepliesSortType {
+export enum RawTweetRepliesSortType {
 	RELEVACE = 'Relevance',
 	LATEST = 'Recency',
 	LIKES = 'Likes',

package/src/models/RettiwtConfig.ts

@@ -12,7 +12,7 @@ import { IRettiwtConfig } from '../types/RettiwtConfig';
  *
  * @public
  */
-const defaultHeaders = {
+const DefaultHeaders = {
 	/* eslint-disable @typescript-eslint/naming-convention */
 
 	Authority: 'x.com',
@@ -43,6 +43,7 @@ export class RettiwtConfig implements IRettiwtConfig {
 	public readonly delay?: number | (() => number | Promise<number>);
 	public readonly errorHandler?: IErrorHandler;
 	public readonly logging?: boolean;
+	public readonly maxRetries: number;
 	public readonly tidProvider?: ITidProvider;
 	public readonly timeout?: number;
 
@@ -53,14 +54,15 @@ export class RettiwtConfig implements IRettiwtConfig {
 		this._apiKey = config?.apiKey;
 		this._httpsAgent = config?.proxyUrl ? new HttpsProxyAgent(config?.proxyUrl) : new Agent();
 		this._userId = config?.apiKey ? AuthService.getUserId(config?.apiKey) : undefined;
-		this.delay = config?.delay;
+		this.delay = config?.delay ?? 1000;
+		this.maxRetries = config?.maxRetries ?? 5;
 		this.errorHandler = config?.errorHandler;
 		this.logging = config?.logging;
 		this.tidProvider = config?.tidProvider;
 		this.timeout = config?.timeout;
 		this.apiKey = config?.apiKey;
 		this._headers = {
-			...defaultHeaders,
+			...DefaultHeaders,
 			...config?.headers,
 		};
 	}
@@ -90,7 +92,7 @@ export class RettiwtConfig implements IRettiwtConfig {
 
 	public set headers(headers: { [key: string]: string } | undefined) {
 		this._headers = {
-			...defaultHeaders,
+			...DefaultHeaders,
 			...headers,
 		};
 	}
@@ -100,4 +102,4 @@ export class RettiwtConfig implements IRettiwtConfig {
 	}
 }
 
-export { defaultHeaders as DefaultRettiwtHeaders };
+export { DefaultHeaders as DefaultRettiwtHeaders };

package/src/models/args/FetchArgs.ts

@@ -1,4 +1,4 @@
-import { ETweetRepliesSortType } from '../../enums/Tweet';
+import { TweetRepliesSortType } from '../../enums/Tweet';
 import { IFetchArgs, ITweetFilter } from '../../types/args/FetchArgs';
 
 /**
@@ -12,7 +12,7 @@ export class FetchArgs implements IFetchArgs {
 	public filter?: TweetFilter;
 	public id?: string;
 	public ids?: string[];
-	public sortBy?: ETweetRepliesSortType;
+	public sortBy?: TweetRepliesSortType;
 
 	/**
 	 * @param args - Additional user-defined arguments for fetching the resource.
@@ -93,7 +93,7 @@ export class TweetFilter implements ITweetFilter {
 	 * @param date - The date object to convert.
 	 * @returns The Twitter string representation of the date.
 	 */
-	private static dateToTwitterString(date: Date): string {
+	private static _dateToTwitterString(date: Date): string {
 		// Converting localized date to UTC date
 		const utc = new Date(
 			Date.UTC(
@@ -135,8 +135,8 @@ export class TweetFilter implements ITweetFilter {
 				this.minLikes ? `min_faves:${this.minLikes}` : '',
 				this.minRetweets ? `min_retweets:${this.minRetweets}` : '',
 				this.language ? `lang:${this.language}` : '',
-				this.startDate ? `since:${TweetFilter.dateToTwitterString(this.startDate)}` : '',
-				this.endDate ? `until:${TweetFilter.dateToTwitterString(this.endDate)}` : '',
+				this.startDate ? `since:${TweetFilter._dateToTwitterString(this.startDate)}` : '',
+				this.endDate ? `until:${TweetFilter._dateToTwitterString(this.endDate)}` : '',
 				this.sinceId ? `since_id:${this.sinceId}` : '',
 				this.maxId ? `max_id:${this.maxId}` : '',
 				this.quoted ? `quoted_tweet_id:${this.quoted}` : '',

package/src/models/auth/AuthCredential.ts

@@ -2,7 +2,7 @@ import { AxiosHeaders, AxiosRequestHeaders } from 'axios';
 
 import { Cookie } from 'cookiejar';
 
-import { EAuthenticationType } from '../../enums/Authentication';
+import { AuthenticationType } from '../../enums/Authentication';
 import { IAuthCredential } from '../../types/auth/AuthCredential';
 
 import { AuthCookie } from './AuthCookie';
@@ -19,7 +19,7 @@ import { AuthCookie } from './AuthCookie';
  */
 export class AuthCredential implements IAuthCredential {
 	public authToken?: string;
-	public authenticationType?: EAuthenticationType;
+	public authenticationType?: AuthenticationType;
 	public cookies?: string;
 	public csrfToken?: string;
 	public guestToken?: string;
@@ -34,7 +34,7 @@ export class AuthCredential implements IAuthCredential {
 		// If guest credentials given
 		if (!cookies && guestToken) {
 			this.guestToken = guestToken;
-			this.authenticationType = EAuthenticationType.GUEST;
+			this.authenticationType = AuthenticationType.GUEST;
 		}
 		// If login credentials given
 		else if (cookies && guestToken) {
@@ -43,7 +43,7 @@ export class AuthCredential implements IAuthCredential {
 
 			this.cookies = parsedCookie.toString();
 			this.guestToken = guestToken;
-			this.authenticationType = EAuthenticationType.LOGIN;
+			this.authenticationType = AuthenticationType.LOGIN;
 		}
 		// If user credentials given
 		else if (cookies && !guestToken) {
@@ -52,7 +52,7 @@ export class AuthCredential implements IAuthCredential {
 
 			this.cookies = parsedCookie.toString();
 			this.csrfToken = parsedCookie.ct0;
-			this.authenticationType = EAuthenticationType.USER;
+			this.authenticationType = AuthenticationType.USER;
 		}
 	}
 

package/src/models/data/CursoredData.ts

@@ -1,4 +1,4 @@
-import { EBaseType } from '../../enums/Data';
+import { BaseType } from '../../enums/Data';
 
 import { findByFilter } from '../../helper/JsonUtils';
 
@@ -24,18 +24,18 @@ export class CursoredData<T extends Notification | Tweet | User> implements ICur
 	 * @param response - The raw response.
 	 * @param type - The base type of the data included in the batch.
 	 */
-	public constructor(response: NonNullable<unknown>, type: EBaseType) {
+	public constructor(response: NonNullable<unknown>, type: BaseType) {
 		// Initializing defaults
 		this.list = [];
 		this.next = '';
 
-		if (type == EBaseType.TWEET) {
+		if (type == BaseType.TWEET) {
 			this.list = Tweet.timeline(response) as T[];
 			this.next = findByFilter<IRawCursor>(response, 'cursorType', 'Bottom')[0]?.value ?? '';
-		} else if (type == EBaseType.USER) {
+		} else if (type == BaseType.USER) {
 			this.list = User.timeline(response) as T[];
 			this.next = findByFilter<IRawCursor>(response, 'cursorType', 'Bottom')[0]?.value ?? '';
-		} else if (type == EBaseType.NOTIFICATION) {
+		} else if (type == BaseType.NOTIFICATION) {
 			this.list = Notification.list(response) as T[];
 			this.next = findByFilter<IRawCursor>(response, 'cursorType', 'Top')[0]?.value ?? '';
 		}

package/src/models/data/Notification.ts

@@ -1,5 +1,5 @@
-import { ENotificationType } from '../../enums/Notification';
-import { ERawNotificationType } from '../../enums/raw/Notification';
+import { NotificationType } from '../../enums/Notification';
+import { RawNotificationType } from '../../enums/raw/Notification';
 import { findKeyByValue } from '../../helper/JsonUtils';
 import { INotification } from '../../types/data/Notification';
 import { INotification as IRawNotification } from '../../types/raw/base/Notification';
@@ -19,7 +19,7 @@ export class Notification implements INotification {
 	public message: string;
 	public receivedAt: string;
 	public target: string[];
-	public type?: ENotificationType;
+	public type?: NotificationType;
 
 	/**
 	 * @param notification - The raw notification details.
@@ -28,7 +28,7 @@ export class Notification implements INotification {
 		this._raw = { ...notification };
 
 		// Getting the original notification type
-		const notificationType: string | undefined = findKeyByValue(ERawNotificationType, notification.icon.id);
+		const notificationType: string | undefined = findKeyByValue(RawNotificationType, notification.icon.id);
 
 		this.from = notification.template?.aggregateUserActionsV1?.fromUsers
 			? notification.template.aggregateUserActionsV1.fromUsers.map((item) => item.user.id)
@@ -40,8 +40,8 @@ export class Notification implements INotification {
 			? notification.template.aggregateUserActionsV1.targetObjects.map((item) => item.tweet.id)
 			: [];
 		this.type = notificationType
-			? ENotificationType[notificationType as keyof typeof ENotificationType]
-			: ENotificationType.UNDEFINED;
+			? NotificationType[notificationType as keyof typeof NotificationType]
+			: NotificationType.UNDEFINED;
 	}
 
 	/** The raw notification details. */