@youmind-openlab/rettiwt-api 1.0.0

package/src/browser/services/BrowserUserService.ts

@@ -0,0 +1,272 @@
+import { Extractors } from '../../collections/Extractors';
+import { RawAnalyticsGranularity, RawAnalyticsMetric } from '../../enums/raw/Analytics';
+import { ResourceType } from '../../enums/Resource';
+import { ProfileUpdateOptions } from '../../models/args/ProfileArgs';
+import { Analytics } from '../../models/data/Analytics';
+import { BookmarkFolder } from '../../models/data/BookmarkFolder';
+import { CursoredData } from '../../models/data/CursoredData';
+import { List } from '../../models/data/List';
+import { Notification } from '../../models/data/Notification';
+import { Tweet } from '../../models/data/Tweet';
+import { User } from '../../models/data/User';
+import { IProfileUpdateOptions } from '../../types/args/ProfileArgs';
+import { IUserAffiliatesResponse } from '../../types/raw/user/Affiliates';
+import { IUserAnalyticsResponse } from '../../types/raw/user/Analytics';
+import { IUserBookmarkFoldersResponse } from '../../types/raw/user/BookmarkFolders';
+import { IUserBookmarkFolderTweetsResponse } from '../../types/raw/user/BookmarkFolderTweets';
+import { IUserBookmarksResponse } from '../../types/raw/user/Bookmarks';
+import { IUserDetailsResponse } from '../../types/raw/user/Details';
+import { IUserDetailsBulkResponse } from '../../types/raw/user/DetailsBulk';
+import { IUserFollowResponse } from '../../types/raw/user/Follow';
+import { IUserFollowedResponse } from '../../types/raw/user/Followed';
+import { IUserFollowersResponse } from '../../types/raw/user/Followers';
+import { IUserFollowingResponse } from '../../types/raw/user/Following';
+import { IUserHighlightsResponse } from '../../types/raw/user/Highlights';
+import { IUserLikesResponse } from '../../types/raw/user/Likes';
+import { IUserListsResponse } from '../../types/raw/user/Lists';
+import { IUserMediaResponse } from '../../types/raw/user/Media';
+import { IUserNotificationsResponse } from '../../types/raw/user/Notifications';
+import { IUserProfileUpdateResponse } from '../../types/raw/user/ProfileUpdate';
+import { IUserRecommendedResponse } from '../../types/raw/user/Recommended';
+import { IUserSearchResponse } from '../../types/raw/user/Search';
+import { IUserSubscriptionsResponse } from '../../types/raw/user/Subscriptions';
+import { IUserTweetsResponse } from '../../types/raw/user/Tweets';
+import { IUserTweetsAndRepliesResponse } from '../../types/raw/user/TweetsAndReplies';
+import { IUserUnfollowResponse } from '../../types/raw/user/Unfollow';
+
+import { BrowserFetcherService } from './BrowserFetcherService';
+import { BrowserRettiwtConfig } from '../config/BrowserRettiwtConfig';
+
+/**
+ * Browser-compatible user service.
+ * Handles interacting with resources related to user account.
+ *
+ * @public
+ */
+export class BrowserUserService extends BrowserFetcherService {
+	/**
+	 * @param config - The browser config object for configuring the Rettiwt instance.
+	 */
+	public constructor(config: BrowserRettiwtConfig) {
+		super(config);
+	}
+
+	/**
+	 * Get the details of the currently logged in user.
+	 *
+	 * @returns The details of the logged in user.
+	 */
+	public async details(): Promise<User | undefined> {
+		const resource = ResourceType.USER_DETAILS_BY_ID;
+
+		const response = await this.request<IUserDetailsResponse>(resource, {
+			id: this.config.userId,
+		});
+
+		const data = Extractors[resource](response);
+
+		return data;
+	}
+
+	/**
+	 * Get the details of a user by username.
+	 *
+	 * @param id - The username of the target user.
+	 * @returns The details of the user.
+	 */
+	public async detailsByUserName(id: string): Promise<User | undefined> {
+		const resource = ResourceType.USER_DETAILS_BY_USERNAME;
+
+		const response = await this.request<IUserDetailsResponse>(resource, {
+			id: id,
+		});
+
+		const data = Extractors[resource](response);
+
+		return data;
+	}
+
+	/**
+	 * Get the details of a user by ID.
+	 *
+	 * @param id - The ID of the target user.
+	 * @returns The details of the user.
+	 */
+	public async detailsById(id: string): Promise<User | undefined> {
+		const resource = ResourceType.USER_DETAILS_BY_ID;
+
+		const response = await this.request<IUserDetailsResponse>(resource, {
+			id: id,
+		});
+
+		const data = Extractors[resource](response);
+
+		return data;
+	}
+
+	/**
+	 * Get the list of users following a user.
+	 *
+	 * @param id - The ID of the target user.
+	 * @param count - The number of followers to fetch, must be <= 100.
+	 * @param cursor - The cursor to the batch of followers to fetch.
+	 * @returns The list of users following the target user.
+	 */
+	public async followers(id: string, count?: number, cursor?: string): Promise<CursoredData<User>> {
+		const resource = ResourceType.USER_FOLLOWERS;
+
+		const response = await this.request<IUserFollowersResponse>(resource, {
+			id: id,
+			count: count,
+			cursor: cursor,
+		});
+
+		const data = Extractors[resource](response);
+
+		return data;
+	}
+
+	/**
+	 * Get the list of users followed by a user.
+	 *
+	 * @param id - The ID of the target user.
+	 * @param count - The number of following to fetch, must be <= 100.
+	 * @param cursor - The cursor to the batch of following to fetch.
+	 * @returns The list of users followed by the target user.
+	 */
+	public async following(id: string, count?: number, cursor?: string): Promise<CursoredData<User>> {
+		const resource = ResourceType.USER_FOLLOWING;
+
+		const response = await this.request<IUserFollowingResponse>(resource, {
+			id: id,
+			count: count,
+			cursor: cursor,
+		});
+
+		const data = Extractors[resource](response);
+
+		return data;
+	}
+
+	/**
+	 * Get the list of tweets liked by a 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.
+	 * @returns The list of tweets liked by the target user.
+	 */
+	public async likes(id: string, count?: number, cursor?: string): Promise<CursoredData<Tweet>> {
+		const resource = ResourceType.USER_LIKES;
+
+		const response = await this.request<IUserLikesResponse>(resource, {
+			id: id,
+			count: count,
+			cursor: cursor,
+		});
+
+		const data = Extractors[resource](response);
+
+		return data;
+	}
+
+	/**
+	 * Get the timeline of a user.
+	 *
+	 * @param id - The ID of the target user.
+	 * @param count - The number of tweets to fetch, must be <= 100.
+	 * @param cursor - The cursor to the batch of tweets to fetch.
+	 * @returns The timeline of the target user.
+	 */
+	public async timeline(id: string, count?: number, cursor?: string): Promise<CursoredData<Tweet>> {
+		const resource = ResourceType.USER_TIMELINE;
+
+		const response = await this.request<IUserTweetsResponse>(resource, {
+			id: id,
+			count: count,
+			cursor: cursor,
+		});
+
+		const data = Extractors[resource](response);
+
+		return data;
+	}
+
+	/**
+	 * Follow a user.
+	 *
+	 * @param id - The ID of the user to follow.
+	 * @returns Whether the follow was successful.
+	 */
+	public async follow(id: string): Promise<boolean> {
+		const resource = ResourceType.USER_FOLLOW;
+
+		const response = await this.request<IUserFollowResponse>(resource, {
+			id: id,
+		});
+
+		const data = Extractors[resource](response) ?? false;
+
+		return data;
+	}
+
+	/**
+	 * Unfollow a user.
+	 *
+	 * @param id - The ID of the user to unfollow.
+	 * @returns Whether the unfollow was successful.
+	 */
+	public async unfollow(id: string): Promise<boolean> {
+		const resource = ResourceType.USER_UNFOLLOW;
+
+		const response = await this.request<IUserUnfollowResponse>(resource, {
+			id: id,
+		});
+
+		const data = Extractors[resource](response) ?? false;
+
+		return data;
+	}
+
+	/**
+	 * Search for users.
+	 *
+	 * @param query - The search query.
+	 * @param count - The number of users to fetch.
+	 * @param cursor - The cursor for pagination.
+	 * @returns The list of users matching the query.
+	 */
+	public async search(userName: string, count?: number, cursor?: string): Promise<CursoredData<User>> {
+		const resource = ResourceType.USER_SEARCH;
+
+		const response = await this.request<IUserSearchResponse>(resource, {
+			id: userName,
+			count: count,
+			cursor: cursor,
+		});
+
+		const data = Extractors[resource](response);
+
+		return data;
+	}
+
+	/**
+	 * Get the bookmarks of the logged in user.
+	 *
+	 * @param count - The number of bookmarks to fetch, must be <= 100.
+	 * @param cursor - The cursor to the batch of bookmarks to fetch.
+	 * @returns The list of bookmarked tweets.
+	 */
+	public async bookmarks(count?: number, cursor?: string): Promise<CursoredData<Tweet>> {
+		const resource = ResourceType.USER_BOOKMARKS;
+
+		const response = await this.request<IUserBookmarksResponse>(resource, {
+			count: count,
+			cursor: cursor,
+		});
+
+		const data = Extractors[resource](response);
+
+		return data;
+	}
+}

package/src/cli.ts

@@ -0,0 +1,48 @@
+#! /usr/bin/env node
+
+import { createCommand } from 'commander';
+
+import dm from './commands/DirectMessage';
+import list from './commands/List';
+import tweet from './commands/Tweet';
+import user from './commands/User';
+import { Rettiwt } from './Rettiwt';
+
+// Creating a new commandline program
+const Program = createCommand('rettiwt')
+	.description('A CLI tool for accessing the Twitter API for free!')
+	.passThroughOptions()
+	.enablePositionalOptions();
+
+// Adding options
+Program.option('-k, --key <string>', 'The API key to use for authentication')
+	.option('-l, --log', 'Enable logging to console')
+	.option('-p, --proxy <string>', 'The URL to the proxy to use')
+	.option('-t, --timeout <number>', 'The timout (in milli-seconds) to use for requests')
+	.option(
+		'-r, --retries <number>',
+		'The maximum number of retries to use, a value of 5 combined with a delay of 1000 is recommended',
+	)
+	.option('-d, --delay <number>', 'The delay in milliseconds to use in-between successive requests');
+
+// Parsing the program to get supplied options
+Program.parse();
+
+// Initializing Rettiwt instance using the given options
+const RettiwtInstance = new Rettiwt({
+	apiKey: process.env.API_KEY ?? (Program.opts().key as string),
+	logging: Program.opts().log ? true : false,
+	proxyUrl: Program.opts().proxy as URL,
+	timeout: Program.opts().timeout ? Number(Program.opts().timeout) : undefined,
+	maxRetries: Program.opts().retries as number,
+	delay: Program.opts().delay as number,
+});
+
+// Adding sub-commands
+Program.addCommand(dm(RettiwtInstance));
+Program.addCommand(list(RettiwtInstance));
+Program.addCommand(tweet(RettiwtInstance));
+Program.addCommand(user(RettiwtInstance));
+
+// Finalizing the CLI
+Program.parse();

package/src/collections/Extractors.ts

@@ -0,0 +1,155 @@
+import { BaseType } from '../enums/Data';
+import { Analytics } from '../models/data/Analytics';
+import { BookmarkFolder } from '../models/data/BookmarkFolder';
+import { Conversation } from '../models/data/Conversation';
+import { CursoredData } from '../models/data/CursoredData';
+import { Inbox } from '../models/data/Inbox';
+import { List } from '../models/data/List';
+import { Notification } from '../models/data/Notification';
+import { Tweet } from '../models/data/Tweet';
+import { User } from '../models/data/User';
+import { IConversationTimelineResponse } from '../types/raw/dm/Conversation';
+import { IInboxInitialResponse } from '../types/raw/dm/InboxInitial';
+import { IInboxTimelineResponse } from '../types/raw/dm/InboxTimeline';
+import { IListMemberAddResponse } from '../types/raw/list/AddMember';
+import { IListDetailsResponse } from '../types/raw/list/Details';
+import { IListMembersResponse } from '../types/raw/list/Members';
+import { IListMemberRemoveResponse } from '../types/raw/list/RemoveMember';
+import { IListTweetsResponse } from '../types/raw/list/Tweets';
+import { IMediaInitializeUploadResponse } from '../types/raw/media/InitalizeUpload';
+import { ITweetBookmarkResponse } from '../types/raw/tweet/Bookmark';
+import { ITweetDetailsResponse } from '../types/raw/tweet/Details';
+import { ITweetDetailsBulkResponse } from '../types/raw/tweet/DetailsBulk';
+import { ITweetLikeResponse } from '../types/raw/tweet/Like';
+import { ITweetLikersResponse } from '../types/raw/tweet/Likers';
+import { ITweetPostResponse } from '../types/raw/tweet/Post';
+import { ITweetRepliesResponse } from '../types/raw/tweet/Replies';
+import { ITweetRetweetResponse } from '../types/raw/tweet/Retweet';
+import { ITweetRetweetersResponse } from '../types/raw/tweet/Retweeters';
+import { ITweetScheduleResponse } from '../types/raw/tweet/Schedule';
+import { ITweetSearchResponse } from '../types/raw/tweet/Search';
+import { ITweetUnbookmarkResponse } from '../types/raw/tweet/Unbookmark';
+import { ITweetUnlikeResponse } from '../types/raw/tweet/Unlike';
+import { ITweetUnpostResponse } from '../types/raw/tweet/Unpost';
+import { ITweetUnretweetResponse } from '../types/raw/tweet/Unretweet';
+import { ITweetUnscheduleResponse } from '../types/raw/tweet/Unschedule';
+import { IUserAffiliatesResponse } from '../types/raw/user/Affiliates';
+import { IUserAnalyticsResponse } from '../types/raw/user/Analytics';
+import { IUserBookmarkFoldersResponse } from '../types/raw/user/BookmarkFolders';
+import { IUserBookmarkFolderTweetsResponse } from '../types/raw/user/BookmarkFolderTweets';
+import { IUserBookmarksResponse } from '../types/raw/user/Bookmarks';
+import { IUserDetailsResponse } from '../types/raw/user/Details';
+import { IUserDetailsBulkResponse } from '../types/raw/user/DetailsBulk';
+import { IUserFollowResponse } from '../types/raw/user/Follow';
+import { IUserFollowedResponse } from '../types/raw/user/Followed';
+import { IUserFollowersResponse } from '../types/raw/user/Followers';
+import { IUserFollowingResponse } from '../types/raw/user/Following';
+import { IUserHighlightsResponse } from '../types/raw/user/Highlights';
+import { IUserLikesResponse } from '../types/raw/user/Likes';
+import { IUserListsResponse } from '../types/raw/user/Lists';
+import { IUserMediaResponse } from '../types/raw/user/Media';
+import { IUserNotificationsResponse } from '../types/raw/user/Notifications';
+import { IUserProfileUpdateResponse } from '../types/raw/user/ProfileUpdate';
+import { IUserRecommendedResponse } from '../types/raw/user/Recommended';
+import { IUserSearchResponse } from '../types/raw/user/Search';
+import { IUserSubscriptionsResponse } from '../types/raw/user/Subscriptions';
+import { IUserTweetsResponse } from '../types/raw/user/Tweets';
+import { IUserTweetsAndRepliesResponse } from '../types/raw/user/TweetsAndReplies';
+import { IUserUnfollowResponse } from '../types/raw/user/Unfollow';
+
+/**
+ * Collection of data extractors for each resource.
+ *
+ * @internal
+ */
+export const Extractors = {
+	/* eslint-disable @typescript-eslint/naming-convention */
+
+	LIST_DETAILS: (response: IListDetailsResponse, id: string): List | undefined => List.single(response, id),
+	LIST_MEMBERS: (response: IListMembersResponse): CursoredData<User> =>
+		new CursoredData<User>(response, BaseType.USER),
+	LIST_MEMBER_ADD: (response: IListMemberAddResponse): number | undefined =>
+		response.data?.list?.member_count ?? undefined,
+	LIST_MEMBER_REMOVE: (response: IListMemberRemoveResponse): number | undefined =>
+		response.data?.list?.member_count ?? undefined,
+	LIST_TWEETS: (response: IListTweetsResponse): CursoredData<Tweet> =>
+		new CursoredData<Tweet>(response, BaseType.TWEET),
+
+	MEDIA_UPLOAD_APPEND: (): void => undefined,
+	MEDIA_UPLOAD_FINALIZE: (): void => undefined,
+	MEDIA_UPLOAD_INITIALIZE: (response: IMediaInitializeUploadResponse): string =>
+		response.media_id_string ?? undefined,
+
+	DM_CONVERSATION: (response: IConversationTimelineResponse): Conversation | undefined =>
+		Conversation.fromConversationTimeline(response),
+	DM_INBOX_INITIAL_STATE: (response: IInboxInitialResponse): Inbox => new Inbox(response),
+	DM_INBOX_TIMELINE: (response: IInboxTimelineResponse): Inbox => new Inbox(response),
+
+	TWEET_BOOKMARK: (response: ITweetBookmarkResponse): boolean => response?.data?.tweet_bookmark_put === 'Done',
+	TWEET_DETAILS: (response: ITweetDetailsResponse, id: string): Tweet | undefined => Tweet.single(response, id),
+	TWEET_DETAILS_ALT: (response: ITweetRepliesResponse, id: string): Tweet | undefined => Tweet.single(response, id),
+	TWEET_DETAILS_BULK: (response: ITweetDetailsBulkResponse, ids: string[]): Tweet[] => Tweet.multiple(response, ids),
+	TWEET_LIKE: (response: ITweetLikeResponse): boolean => (response?.data?.favorite_tweet ? true : false),
+	TWEET_LIKERS: (response: ITweetLikersResponse): CursoredData<User> =>
+		new CursoredData<User>(response, BaseType.USER),
+	TWEET_POST: (response: ITweetPostResponse): string =>
+		response?.data?.create_tweet?.tweet_results?.result?.rest_id ?? undefined,
+	TWEET_REPLIES: (response: ITweetDetailsResponse): CursoredData<Tweet> =>
+		new CursoredData<Tweet>(response, BaseType.TWEET),
+	TWEET_RETWEET: (response: ITweetRetweetResponse): boolean => (response?.data?.create_retweet ? true : false),
+	TWEET_RETWEETERS: (response: ITweetRetweetersResponse): CursoredData<User> =>
+		new CursoredData<User>(response, BaseType.USER),
+	TWEET_SCHEDULE: (response: ITweetScheduleResponse): string => response?.data?.tweet?.rest_id ?? undefined,
+	TWEET_SEARCH: (response: ITweetSearchResponse): CursoredData<Tweet> =>
+		new CursoredData<Tweet>(response, BaseType.TWEET),
+	TWEET_UNBOOKMARK: (response: ITweetUnbookmarkResponse): boolean => response?.data?.tweet_bookmark_delete === 'Done',
+	TWEET_UNLIKE: (response: ITweetUnlikeResponse): boolean => (response?.data?.unfavorite_tweet ? true : false),
+	TWEET_UNPOST: (response: ITweetUnpostResponse): boolean => (response?.data?.delete_tweet ? true : false),
+	TWEET_UNRETWEET: (response: ITweetUnretweetResponse): boolean =>
+		response?.data?.unretweet?.source_tweet_results?.result ? true : false,
+	TWEET_UNSCHEDULE: (response: ITweetUnscheduleResponse): boolean => response?.data?.scheduledtweet_delete == 'Done',
+
+	USER_AFFILIATES: (response: IUserAffiliatesResponse): CursoredData<User> =>
+		new CursoredData<User>(response, BaseType.USER),
+	USER_ANALYTICS: (response: IUserAnalyticsResponse): Analytics =>
+		new Analytics(response.data.viewer_v2.user_results.result),
+	USER_BOOKMARKS: (response: IUserBookmarksResponse): CursoredData<Tweet> =>
+		new CursoredData<Tweet>(response, BaseType.TWEET),
+	USER_BOOKMARK_FOLDERS: (response: IUserBookmarkFoldersResponse): CursoredData<BookmarkFolder> =>
+		new CursoredData<BookmarkFolder>(response, BaseType.BOOKMARK_FOLDER),
+	USER_BOOKMARK_FOLDER_TWEETS: (response: IUserBookmarkFolderTweetsResponse): CursoredData<Tweet> =>
+		new CursoredData<Tweet>(response, BaseType.TWEET),
+	USER_DETAILS_BY_USERNAME: (response: IUserDetailsResponse): User | undefined => User.single(response),
+	USER_DETAILS_BY_ID: (response: IUserDetailsResponse): User | undefined => User.single(response),
+	USER_DETAILS_BY_IDS_BULK: (response: IUserDetailsBulkResponse, ids: string[]): User[] =>
+		User.multiple(response, ids),
+	USER_FEED_FOLLOWED: (response: IUserFollowedResponse): CursoredData<Tweet> =>
+		new CursoredData<Tweet>(response, BaseType.TWEET),
+	USER_FEED_RECOMMENDED: (response: IUserRecommendedResponse): CursoredData<Tweet> =>
+		new CursoredData<Tweet>(response, BaseType.TWEET),
+	USER_FOLLOW: (response: IUserFollowResponse): boolean => (response?.id ? true : false),
+	USER_FOLLOWING: (response: IUserFollowingResponse): CursoredData<User> =>
+		new CursoredData<User>(response, BaseType.USER),
+	USER_FOLLOWERS: (response: IUserFollowersResponse): CursoredData<User> =>
+		new CursoredData<User>(response, BaseType.USER),
+	USER_HIGHLIGHTS: (response: IUserHighlightsResponse): CursoredData<Tweet> =>
+		new CursoredData<Tweet>(response, BaseType.TWEET),
+	USER_LISTS: (response: IUserListsResponse): CursoredData<List> => new CursoredData<List>(response, BaseType.LIST),
+	USER_LIKES: (response: IUserLikesResponse): CursoredData<Tweet> =>
+		new CursoredData<Tweet>(response, BaseType.TWEET),
+	USER_MEDIA: (response: IUserMediaResponse): CursoredData<Tweet> =>
+		new CursoredData<Tweet>(response, BaseType.TWEET),
+	USER_NOTIFICATIONS: (response: IUserNotificationsResponse): CursoredData<Notification> =>
+		new CursoredData<Notification>(response, BaseType.NOTIFICATION),
+	USER_SEARCH: (response: IUserSearchResponse): CursoredData<User> => new CursoredData<User>(response, BaseType.USER),
+	USER_SUBSCRIPTIONS: (response: IUserSubscriptionsResponse): CursoredData<User> =>
+		new CursoredData<User>(response, BaseType.USER),
+	USER_TIMELINE: (response: IUserTweetsResponse): CursoredData<Tweet> =>
+		new CursoredData<Tweet>(response, BaseType.TWEET),
+	USER_TIMELINE_AND_REPLIES: (response: IUserTweetsAndRepliesResponse): CursoredData<Tweet> =>
+		new CursoredData<Tweet>(response, BaseType.TWEET),
+	USER_UNFOLLOW: (response: IUserUnfollowResponse): boolean => (response?.id ? true : false),
+	USER_PROFILE_UPDATE: (response: IUserProfileUpdateResponse): boolean => (response?.name ? true : false),
+
+	/* eslint-enable @typescript-eslint/naming-convention */
+};

package/src/collections/Groups.ts

@@ -0,0 +1,81 @@
+import { ResourceType } from '../enums/Resource';
+
+/**
+ * Collection of resources that allow guest authentication.
+ *
+ * @internal
+ */
+export const AllowGuestAuthenticationGroup = [
+	ResourceType.TWEET_DETAILS,
+	ResourceType.USER_DETAILS_BY_USERNAME,
+	ResourceType.USER_TIMELINE,
+];
+
+/**
+ * Collection of resources that can be fetched.
+ *
+ * @internal
+ */
+export const FetchResourcesGroup = [
+	ResourceType.LIST_DETAILS,
+	ResourceType.LIST_MEMBERS,
+	ResourceType.LIST_TWEETS,
+	ResourceType.DM_CONVERSATION,
+	ResourceType.DM_INBOX_INITIAL_STATE,
+	ResourceType.DM_INBOX_TIMELINE,
+	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_ANALYTICS,
+	ResourceType.USER_BOOKMARKS,
+	ResourceType.USER_BOOKMARK_FOLDERS,
+	ResourceType.USER_BOOKMARK_FOLDER_TWEETS,
+	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_LISTS,
+	ResourceType.USER_MEDIA,
+	ResourceType.USER_NOTIFICATIONS,
+	ResourceType.USER_SEARCH,
+	ResourceType.USER_SUBSCRIPTIONS,
+	ResourceType.USER_TIMELINE,
+	ResourceType.USER_TIMELINE_AND_REPLIES,
+];
+
+/**
+ * Collection of resources that can be posted.
+ *
+ * @internal
+ */
+export const PostResourcesGroup = [
+	ResourceType.LIST_MEMBER_ADD,
+	ResourceType.LIST_MEMBER_REMOVE,
+	ResourceType.MEDIA_UPLOAD_APPEND,
+	ResourceType.MEDIA_UPLOAD_FINALIZE,
+	ResourceType.MEDIA_UPLOAD_INITIALIZE,
+	ResourceType.DM_DELETE_CONVERSATION,
+	ResourceType.TWEET_BOOKMARK,
+	ResourceType.TWEET_LIKE,
+	ResourceType.TWEET_POST,
+	ResourceType.TWEET_RETWEET,
+	ResourceType.TWEET_SCHEDULE,
+	ResourceType.TWEET_UNBOOKMARK,
+	ResourceType.TWEET_UNLIKE,
+	ResourceType.TWEET_UNPOST,
+	ResourceType.TWEET_UNRETWEET,
+	ResourceType.TWEET_UNSCHEDULE,
+	ResourceType.USER_FOLLOW,
+	ResourceType.USER_UNFOLLOW,
+	ResourceType.USER_PROFILE_UPDATE,
+];

package/src/collections/Requests.ts

@@ -0,0 +1,90 @@
+import { AxiosRequestConfig } from 'axios';
+
+import { ResourceType } from '../enums/Resource';
+import { DMRequests } from '../requests/DirectMessage';
+import { ListRequests } from '../requests/List';
+import { MediaRequests } from '../requests/Media';
+import { TweetRequests } from '../requests/Tweet';
+import { UserRequests } from '../requests/User';
+import { IFetchArgs } from '../types/args/FetchArgs';
+import { IPostArgs } from '../types/args/PostArgs';
+
+import { TweetRepliesSortTypeMap } from './Tweet';
+
+/**
+ * Collection of requests to various resources.
+ *
+ * @internal
+ */
+export const Requests: { [key in keyof typeof ResourceType]: (args: IFetchArgs | IPostArgs) => AxiosRequestConfig } = {
+	/* eslint-disable @typescript-eslint/naming-convention */
+
+	LIST_DETAILS: (args: IFetchArgs) => ListRequests.details(args.id!),
+	LIST_MEMBERS: (args: IFetchArgs) => ListRequests.members(args.id!, args.count, args.cursor),
+	LIST_MEMBER_ADD: (args: IPostArgs) => ListRequests.addMember(args.id!, args.userId!),
+	LIST_MEMBER_REMOVE: (args: IPostArgs) => ListRequests.removeMember(args.id!, args.userId!),
+	LIST_TWEETS: (args: IFetchArgs) => ListRequests.tweets(args.id!, args.count, args.cursor),
+
+	MEDIA_UPLOAD_APPEND: (args: IPostArgs) => MediaRequests.appendUpload(args.upload!.id!, args.upload!.media!),
+	MEDIA_UPLOAD_FINALIZE: (args: IPostArgs) => MediaRequests.finalizeUpload(args.upload!.id!),
+	MEDIA_UPLOAD_INITIALIZE: (args: IPostArgs) => MediaRequests.initializeUpload(args.upload!.size!),
+
+	DM_CONVERSATION: (args: IFetchArgs) => DMRequests.conversation(args.conversationId!, args.maxId),
+	DM_INBOX_INITIAL_STATE: () => DMRequests.inboxInitial(),
+	DM_INBOX_TIMELINE: (args: IFetchArgs) => DMRequests.inboxTimeline(args.maxId),
+	DM_DELETE_CONVERSATION: (args: IPostArgs) => DMRequests.deleteConversation(args.conversationId!),
+
+	TWEET_BOOKMARK: (args: IPostArgs) => TweetRequests.bookmark(args.id!),
+	TWEET_DETAILS: (args: IFetchArgs) => TweetRequests.details(args.id!),
+	TWEET_DETAILS_ALT: (args: IFetchArgs) => TweetRequests.replies(args.id!),
+	TWEET_DETAILS_BULK: (args: IFetchArgs) => TweetRequests.bulkDetails(args.ids!),
+	TWEET_LIKE: (args: IPostArgs) => TweetRequests.like(args.id!),
+	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 ? 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!),
+	TWEET_SEARCH: (args: IFetchArgs) => TweetRequests.search(args.filter!, args.count, args.cursor),
+	TWEET_UNBOOKMARK: (args: IPostArgs) => TweetRequests.unbookmark(args.id!),
+	TWEET_UNLIKE: (args: IPostArgs) => TweetRequests.unlike(args.id!),
+	TWEET_UNPOST: (args: IPostArgs) => TweetRequests.unpost(args.id!),
+	TWEET_UNRETWEET: (args: IPostArgs) => TweetRequests.unretweet(args.id!),
+	TWEET_UNSCHEDULE: (args: IPostArgs) => TweetRequests.unschedule(args.id!),
+
+	USER_AFFILIATES: (args: IFetchArgs) => UserRequests.affiliates(args.id!, args.count, args.cursor),
+	USER_ANALYTICS: (args: IFetchArgs) =>
+		UserRequests.analytics(
+			args.fromTime!,
+			args.toTime!,
+			args.granularity!,
+			args.metrics!,
+			args.showVerifiedFollowers!,
+		),
+	USER_BOOKMARKS: (args: IFetchArgs) => UserRequests.bookmarks(args.count, args.cursor),
+	USER_BOOKMARK_FOLDERS: (args: IFetchArgs) => UserRequests.bookmarkFolders(args.cursor),
+	USER_BOOKMARK_FOLDER_TWEETS: (args: IFetchArgs) =>
+		UserRequests.bookmarkFolderTweets(args.id!, args.count, args.cursor),
+	USER_DETAILS_BY_USERNAME: (args: IFetchArgs) => UserRequests.detailsByUsername(args.id!),
+	USER_DETAILS_BY_ID: (args: IFetchArgs) => UserRequests.detailsById(args.id!),
+	USER_DETAILS_BY_IDS_BULK: (args: IFetchArgs) => UserRequests.bulkDetailsByIds(args.ids!),
+	USER_FEED_FOLLOWED: (args: IFetchArgs) => UserRequests.followed(args.count, args.cursor),
+	USER_FEED_RECOMMENDED: (args: IFetchArgs) => UserRequests.recommended(args.count, args.cursor),
+	USER_FOLLOW: (args: IPostArgs) => UserRequests.follow(args.id!),
+	USER_FOLLOWING: (args: IFetchArgs) => UserRequests.following(args.id!, args.count, args.cursor),
+	USER_FOLLOWERS: (args: IFetchArgs) => UserRequests.followers(args.id!, args.count, args.cursor),
+	USER_HIGHLIGHTS: (args: IFetchArgs) => UserRequests.highlights(args.id!, args.count, args.cursor),
+	USER_LIKES: (args: IFetchArgs) => UserRequests.likes(args.id!, args.count, args.cursor),
+	USER_LISTS: (args: IFetchArgs) => UserRequests.lists(args.id!, args.count, args.cursor),
+	USER_MEDIA: (args: IFetchArgs) => UserRequests.media(args.id!, args.count, args.cursor),
+	USER_NOTIFICATIONS: (args: IFetchArgs) => UserRequests.notifications(args.count, args.cursor),
+	USER_SEARCH: (args: IFetchArgs) => UserRequests.search(args.id!, args.count, args.cursor),
+	USER_SUBSCRIPTIONS: (args: IFetchArgs) => UserRequests.subscriptions(args.id!, args.count, args.cursor),
+	USER_TIMELINE: (args: IFetchArgs) => UserRequests.tweets(args.id!, args.count, args.cursor),
+	USER_TIMELINE_AND_REPLIES: (args: IFetchArgs) => UserRequests.tweetsAndReplies(args.id!, args.count, args.cursor),
+	USER_UNFOLLOW: (args: IPostArgs) => UserRequests.unfollow(args.id!),
+	USER_PROFILE_UPDATE: (args: IPostArgs) => UserRequests.updateProfile(args.profileOptions!),
+
+	/* eslint-enable @typescript-eslint/naming-convention */
+};

package/src/collections/Tweet.ts

@@ -0,0 +1,17 @@
+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 TweetRepliesSortTypeMap: { [key in keyof typeof TweetRepliesSortType]: RawTweetRepliesSortType } = {
+	/* eslint-disable @typescript-eslint/naming-convention */
+
+	LATEST: RawTweetRepliesSortType.LATEST,
+	LIKES: RawTweetRepliesSortType.LIKES,
+	RELEVANCE: RawTweetRepliesSortType.RELEVACE,
+
+	/* eslint-enable @typescript-eslint/naming-convention */
+};