rettiwt-api 1.1.2 → 1.1.7

package/src/services/data/UserService.ts

@@ -1,17 +1,23 @@
 // SERVICES
-import { FetcherService } from '../FetcherService';
-import { AuthService } from '../AuthService';
+import { FetcherService } from '../util/FetcherService';
+import { AuthService } from '../auth/AuthService';
+
+// MODELS
+import { User } from '../../models/data/User';
+import { UserListArgs } from '../../models/args/UserListArgs';
+import { Tweet } from '../../models/data/Tweet';
 
 // TYPES
-import { User } from '../../types/data/User';
-import { Tweet } from '../../types/data/Tweet';
-import { CursoredData } from '../../types/data/Service';
+import { CursoredData } from '../../models/data/CursoredData';
 import { Result as TweetData } from '../../types/raw/tweet/Tweet';
 import RawUser, { Result as UserData } from '../../types/raw/user/User';
+import RawUserTweets from '../../types/raw/user/Tweets';
 import RawUserFollowers from '../../types/raw/user/Followers';
 import RawUserFollowing from '../../types/raw/user/Following';
 import RawUserLikes from '../../types/raw/user/Likes';
-import * as Errors from '../../types/data/Errors';
+
+// ENUMS
+import { AuthenticationErrors } from '../../enums/Errors';
 
 // URLS
 import * as UserUrls from '../helper/urls/Users';
@@ -19,15 +25,10 @@ import * as UserUrls from '../helper/urls/Users';
 // EXTRACTORS
 import * as UserExtractors from '../helper/extractors/Users';
 
-// DESERIALIZERS
-import * as UserDeserializers from '../helper/deserializers/Users';
-import * as TweetDeserializers from '../helper/deserializers/Tweets';
-
 /**
  * Handles fetching of data related to user account
  */
 export class UserService extends FetcherService {
-    // MEMBER METHODS
     /**
      * @param auth The AuthService instance to use for authentication.
      */
@@ -36,13 +37,38 @@ export class UserService extends FetcherService {
     }
 
     /**
-     * @param screenName The screen name of the target user.
+     * @param id The id/username of the target user.
+     * 
      * @returns The details of the given user.
+     * 
+     * @throws {@link Errors.DataErrors.UserNotFound} error, if no user with the given username was found.
+     * 
+     * @remarks
+     * 
+     * No cookies are required to use this method.
      */
-    async getUserDetails(screenName: string): Promise<User> {
-        // Fetching the raw data
-        let res: RawUser = await this.request<RawUser>(UserUrls.userDetailsUrl(screenName), false).then(res => res.data);
-        
+    async getUserDetails(id: string): Promise<User> {
+        let res: RawUser;
+
+        // If id is not a numeric string => username is supplied
+        if (isNaN(Number(id))) {
+            // Fetching the raw data
+            res = await this.request<RawUser>(UserUrls.userDetailsUrl(id), false).then(res => res.data);
+        }
+        // If id is a numeric string => id is supplied
+        else {
+            // Getting data from cache
+            let cachedData = await this.readData(id);
+
+            // If data exists in cache
+            if (cachedData) {
+                return cachedData;
+            }
+
+            // Fetching the raw data
+            res = await this.request<RawUser>(UserUrls.userDetailsByIdUrl(id), false).then(res => res.data);
+        }
+
         // Extracting data
         let data = UserExtractors.extractUserDetails(res);
 
@@ -50,60 +76,71 @@ export class UserService extends FetcherService {
         this.cacheData(data);
 
         // Parsing data
-        let user = UserDeserializers.toUser(data.required[0]);
-            
+        let user = new User(data.required[0]);
+
         return user;
     }
 
     /**
-     * @param restId The screen name of the target user.
-     * @returns The details of the user with given rest id.
+     * @param userId The rest id of the target user.
+     * @param count The number of tweets to fetch, must be >= 40 (when no cursor is provided) and <=100.
+     * @param cursor The cursor to next batch. If blank, first batch is fetched.
+     * 
+     * @returns The list of tweets nade by the target user.
+     * 
+     * @throws {@link Errors.ValidationErrors.InvalidCount} error, if invalid count has been provided.
+     * @throws {@link Errors.DataErrors.UserNotFound} error, if invalid count has been provided.
+     * 
+     * @remarks
+     * 
+     * No cookies are required to use this method.
      */
-    async getUserDetailsById(restId: string): Promise<User> {
-        // Getting data from cache
-        let cachedData = await this.readData(restId);
+    async getUserTweets(userId: string, count?: number, cursor?: string): Promise<CursoredData<Tweet>> {
+        // Objectifying parameters
+        let args: UserListArgs = new UserListArgs(count, cursor);
 
-        // If data exists in cache
-        if(cachedData) {
-            return cachedData;
-        }
-        
-        // Fetchin the raw data
-        let res = await this.request<RawUser>(UserUrls.userDetailsByIdUrl(restId), false).then(res => res.data);
+        // Fetching the raw data
+        let res = await this.request<RawUserTweets>(UserUrls.userTweetsUrl(userId, args.count, args.cursor), false).then(res => res.data);
 
         // Extracting data
-        let data = UserExtractors.extractUserDetails(res);
+        let data = UserExtractors.extractUserTweets(res);
 
         // Caching data
         this.cacheData(data);
 
         // Parsing data
-        let user = UserDeserializers.toUser(data.required[0]);
-            
-        return user;
+        let tweets = data.required.map((item: TweetData) => new Tweet(item));
+
+        return new CursoredData<Tweet>(tweets, data.cursor);
     }
 
     /**
      * @param userId The rest id of the target user.
-     * @param count The number of following to fetch.
+     * @param count The number of following to fetch, must be >= 40 (when no cursor is provided) and <=100.
      * @param cursor The cursor to next batch. If blank, first batch is fetched.
+     * 
      * @returns The list of users followed by the target user.
-     * @remarks count must be >= 40 (when no cursor is provided) and <=100.
+     * 
+     * @throws {@link Errors.AuthenticationErrors.NotAuthenticated} error, if no cookies have been provided.
+     * @throws {@link Errors.ValidationErrors.InvalidCount} error, if invalid count has been provided.
+     * @throws {@link Errors.DataErrors.UserNotFound} error, if invalid count has been provided.
+     * 
+     * @remarks
+     * 
+     * Cookies are required to use this method!
      */
-    async getUserFollowing(userId: string, count: number, cursor: string): Promise<CursoredData<User>> {
+    async getUserFollowing(userId: string, count?: number, cursor?: string): Promise<CursoredData<User>> {
         // If user is not authenticated, abort
-        if(!this.isAuthenticated) {
-            throw new Error(Errors.AuthenticationErrors.NotAuthenticated);
+        if (!this.isAuthenticated) {
+            throw new Error(AuthenticationErrors.NotAuthenticated);
         }
 
-        // If invalid count provided
-        if (count < 40 && !cursor) {
-            throw new Error(Errors.ValidationErrors.InvalidCount);
-        }
+        // Objectifying parameters
+        let args: UserListArgs = new UserListArgs(count, cursor);
 
         // Fetchin the raw data
-        let res = await this.request<RawUserFollowing>(UserUrls.userFollowingUrl(userId, count, cursor)).then(res => res.data);
-        
+        let res = await this.request<RawUserFollowing>(UserUrls.userFollowingUrl(userId, args.count, args.cursor)).then(res => res.data);
+
         // Extracting data
         let data = UserExtractors.extractUserFollow(res);
 
@@ -111,35 +148,38 @@ export class UserService extends FetcherService {
         this.cacheData(data);
 
         // Parsing data
-        let users = data.required.map((item: UserData) => UserDeserializers.toUser(item));
+        let users = data.required.map((item: UserData) => new User(item));
 
-        return {
-            list: users,
-            next: { value: data.cursor }
-        };
+        return new CursoredData<User>(users, data.cursor);
     }
 
     /**
      * @param userId The rest id of the target user.
-     * @param count The number of followers to fetch.
+     * @param count The number of followers to fetch, must be >= 40 (when no cursor is provided) and <=100.
      * @param cursor The cursor to next batch. If blank, first batch is fetched.
+     * 
      * @returns The list of users following the target user.
-     * @remarks count must be >= 40 (when no cursor is provided) and <=100.
+     * 
+     * @throws {@link Errors.AuthenticationErrors.NotAuthenticated} error, if no cookies have been provided.
+     * @throws {@link Errors.ValidationErrors.InvalidCount} error, if invalid count has been provided.
+     * @throws {@link Errors.DataErrors.UserNotFound} error, if invalid count has been provided.
+     * 
+     * @remarks
+     * 
+     * Cookies are required to use this method!
      */
-    async getUserFollowers(userId: string, count: number, cursor: string): Promise<CursoredData<User>> {
+    async getUserFollowers(userId: string, count?: number, cursor?: string): Promise<CursoredData<User>> {
         // If user is not authenticated, abort
         if (!this.isAuthenticated) {
-            throw new Error(Errors.AuthenticationErrors.NotAuthenticated);
+            throw new Error(AuthenticationErrors.NotAuthenticated);
         }
 
-        // If invalid count provided
-        if (count < 40 && !cursor) {
-            throw new Error(Errors.ValidationErrors.InvalidCount);
-        }
+        // Objectifying parameters
+        let args: UserListArgs = new UserListArgs(count, cursor);
 
         // Fetching the raw data
-        let res = await this.request<RawUserFollowers>(UserUrls.userFollowersUrl(userId, count, cursor)).then(res => res.data);
-        
+        let res = await this.request<RawUserFollowers>(UserUrls.userFollowersUrl(userId, args.count, args.cursor)).then(res => res.data);
+
         // Extracting data
         let data = UserExtractors.extractUserFollow(res);
 
@@ -147,35 +187,36 @@ export class UserService extends FetcherService {
         this.cacheData(data);
 
         // Parsing data
-        let users = data.required.map((item: UserData) => UserDeserializers.toUser(item));
+        let users = data.required.map((item: UserData) => new User(item));
 
-        return {
-            list: users,
-            next: { value: data.cursor }
-        };
+        return new CursoredData<User>(users, data.cursor);
     }
 
     /**
      * @param userId The rest id of the target user.
      * @param count The number of likes to fetch.
-     * @param cursor The cursor to next batch. If blank, first batch is fetched.
+     * @param cursor The cursor to next batch. If blank, first batch is fetched, must be >= 40 (when no cursor is provided) and <=100.
+     * 
      * @returns The list of tweets liked by the target user.
-     * @remarks count must be >= 40 (when no cursor is provided) and <= 100.
+     * 
+     * @throws {@link AuthenticationErrors.NotAuthenticated} error, if no cookies have been provided.
+     * 
+     * @remarks
+     * 
+     * Cookies are required to use this method!
      */
-    async getUserLikes(userId: string, count: number, cursor: string): Promise<CursoredData<Tweet>> {
+    async getUserLikes(userId: string, count?: number, cursor?: string): Promise<CursoredData<Tweet>> {
         // If user is not authenticated, abort
         if (!this.isAuthenticated) {
-            throw new Error(Errors.AuthenticationErrors.NotAuthenticated);
+            throw new Error(AuthenticationErrors.NotAuthenticated);
         }
 
-        // If invalid count provided
-        if (count < 40 && !cursor) {
-            throw new Error(Errors.ValidationErrors.InvalidCount);
-        }
+        // Objectifying parameters
+        let args: UserListArgs = new UserListArgs(count, cursor);
 
         // Fetching the raw data
-        let res = await this.request<RawUserLikes>(UserUrls.userLikesUrl(userId, count, cursor)).then(res => res.data);
-        
+        let res = await this.request<RawUserLikes>(UserUrls.userLikesUrl(userId, args.count, args.cursor)).then(res => res.data);
+
         // Extracting data
         let data = UserExtractors.extractUserLikes(res);
 
@@ -183,11 +224,8 @@ export class UserService extends FetcherService {
         this.cacheData(data);
 
         // Parsing data
-        let tweets = data.required.map((item: TweetData) => TweetDeserializers.toTweet(item));
+        let tweets = data.required.map((item: TweetData) => new Tweet(item));
 
-        return {
-            list: tweets,
-            next: { value: data.cursor }
-        };
+        return new CursoredData<Tweet>(tweets, data.cursor);
     }
 };

package/src/services/helper/Headers.ts

@@ -1,5 +1,5 @@
 // TYPES
-import { GuestCredentials, AuthCredentials } from '../../types/Authentication';
+import { IGuestCredentials, IAuthCredentials } from '../../types/Authentication';
 
 /**
  * @param authToken The authentication token received from Twitter
@@ -7,7 +7,7 @@ import { GuestCredentials, AuthCredentials } from '../../types/Authentication';
  * @param cookie The cookie associated with the logged in account
  * @returns The header required for making authorized HTTP requests
  */
-export function authorizedHeader(authCred: AuthCredentials): any {
+export function authorizedHeader(authCred: IAuthCredentials): any {
     return [
         `sec-ch-ua: "Not_A Brand";v="99", "Microsoft Edge";v="109", "Chromium";v="109"`,
         `x-twitter-client-language: en`,
@@ -28,7 +28,7 @@ export function authorizedHeader(authCred: AuthCredentials): any {
  * @param guestCred The guest credentials to use
  * @returns The header requred for making guest HTTP requests
  */
-export function guestHeader(guestCred: GuestCredentials): any {
+export function guestHeader(guestCred: IGuestCredentials): any {
     return [
         'Accept: */*',
         `authorization: ${guestCred.authToken}`,
@@ -42,7 +42,7 @@ export function guestHeader(guestCred: GuestCredentials): any {
  * @param cookie The cookie to be used
  * @returns The header for making HTTP request for logging in
  */
-export function loginHeader(guestCred: GuestCredentials, cookie: string): any {
+export function loginHeader(guestCred: IGuestCredentials, cookie: string): any {
     return [ 
         `sec-ch-ua: "Not_A Brand";v="99", "Microsoft Edge";v="109", "Chromium";v="109"`, 
         `x-twitter-client-language: en`, 

package/src/services/helper/Parser.ts

@@ -1,5 +1,5 @@
 // TYPES
-import { TweetFilter } from '../../types/data/Tweet';
+import { ITweetFilter } from '../../types/Args';
 
 /**
  * @returns Whether the given json object is empty or not
@@ -92,7 +92,7 @@ export function normalizeText(text: string): string {
  * @param filter The tweet filter to use for getting filtered tweets
  * @returns The same tweet filter, in a URL query format string
  */
-export function toQueryString(filter: TweetFilter): string {
+export function toQueryString(filter: ITweetFilter): string {
     // Concatenating the input filter arguments to a URL query formatted string
     return [
         filter.words ? filter.words.join(' ') : '',

package/src/services/helper/extractors/Tweets.ts

@@ -1,6 +1,6 @@
 // TYPES
-import { DataExtract } from '../../../types/Resolvers';
-import { DataErrors } from '../../../types/data/Errors';
+import { IDataExtract } from '../../../types/Resolvers';
+import { DataErrors } from '../../../enums/Errors';
 import RawTweet from '../../../types/raw/tweet/Tweet';
 import RawTweets from '../../../types/raw/tweet/Tweets';
 import RawRetweeters from '../../../types/raw/tweet/Retweeters';
@@ -13,7 +13,7 @@ import * as Parsers from '../Parser';
  * @returns The raw tweets data formatted and sorted into required and additional data
  * @param res The raw response received from TwitterAPI
  */
-export function extractTweets(res: RawTweets): DataExtract {
+export function extractTweets(res: RawTweets): IDataExtract {
     let required: any[] = [];                                               // To store the reqruied raw data
     let cursor: string = '';                                                // To store the cursor to next batch
     let users: any[] = [];                                                  // To store additional user data
@@ -63,7 +63,7 @@ export function extractTweets(res: RawTweets): DataExtract {
  * @param res The raw response received from TwitterAPI
  * @param tweetId The rest id of the tweet to fetch
  */
-export function extractTweet(res: RawTweet, tweetId: string): DataExtract {
+export function extractTweet(res: RawTweet, tweetId: string): IDataExtract {
     let required: any[] = [];                                               // To store the reqruied raw data
     let cursor: string = '';                                                // To store the cursor to next batch
     let users: any[] = [];                                                  // To store additional user data
@@ -112,7 +112,7 @@ export function extractTweet(res: RawTweet, tweetId: string): DataExtract {
  * @returns The raw tweet likers data formatted and sorted into required and additional data
  * @param res The raw response received from TwitterAPI
  */
-export function extractTweetLikers(res: RawLikers): DataExtract {
+export function extractTweetLikers(res: RawLikers): IDataExtract {
     let required: any[] = [];                                               // To store the reqruied raw data
     let cursor: string = '';                                                // To store the cursor to next batch
     let users: any[] = [];                                                  // To store additional user data
@@ -152,7 +152,7 @@ export function extractTweetLikers(res: RawLikers): DataExtract {
  * @returns The raw tweet retweeters data formatted and sorted into required and additional data
  * @param res The raw response received from TwitterAPI
  */
-export function extractTweetRetweeters(res: RawRetweeters): DataExtract {
+export function extractTweetRetweeters(res: RawRetweeters): IDataExtract {
     let required: any[] = [];                                               // To store the reqruied raw data
     let cursor: string = '';                                                // To store the cursor to next batch
     let users: any[] = [];                                                  // To store additional user data
@@ -193,7 +193,7 @@ export function extractTweetRetweeters(res: RawRetweeters): DataExtract {
  * @param res The raw response received from TwitterAPI
  * @param tweetId The id of the tweet whose replies must be extracted
  */
-export function extractTweetReplies(res: RawTweet, tweetId: string): DataExtract {
+export function extractTweetReplies(res: RawTweet, tweetId: string): IDataExtract {
     let required: any[] = [];                                               // To store the reqruied raw data
     let cursor: string = '';                                                // To store the cursor to next batch
     let users: any[] = [];                                                  // To store additional user data

package/src/services/helper/extractors/Users.ts

@@ -1,7 +1,8 @@
 // TYPES
-import { DataExtract } from '../../../types/Resolvers'
-import { DataErrors } from '../../../types/data/Errors';
+import { IDataExtract } from '../../../types/Resolvers'
+import { DataErrors } from '../../../enums/Errors';
 import RawUser from '../../../types/raw/user/User';
+import RawUserTweets from '../../../types/raw/user/Tweets';
 import RawUserFollowers from '../../../types/raw/user/Followers';
 import RawUserFollowing from '../../../types/raw/user/Following';
 import RawUserLikes from '../../../types/raw/user/Likes';
@@ -13,7 +14,7 @@ import * as Parsers from '../Parser';
  * @returns The raw user account data formatted and sorted into required and additional data
  * @param res The raw response received from Twitter
  */
-export function extractUserDetails(res: RawUser): DataExtract {
+export function extractUserDetails(res: RawUser): IDataExtract {
     let required: any[] = [];                                               // To store the reqruied raw data
     let cursor: string = '';                                                // To store the cursor to next batch
     let users: any[] = [];                                                  // To store additional user data
@@ -37,11 +38,65 @@ export function extractUserDetails(res: RawUser): DataExtract {
     };
 }
 
+/**
+ * @returns The raw user tweet data formatted and sorted into required and additional data
+ * @param res The raw response received from Twitter
+ */
+export function extractUserTweets(res: RawUserTweets): IDataExtract {
+    let required: any[] = [];                                               // To store the reqruied raw data
+    let cursor: string = '';                                                // To store the cursor to next batch
+    let users: any[] = [];                                                  // To store additional user data
+    let tweets: any[] = [];                                                 // To store additional tweet data
+
+    // If user does not exist
+    if (Parsers.isJSONEmpty(res.data.user)) {
+        throw new Error(DataErrors.UserNotFound);
+    }
+
+    // Extracting the raw list
+    res.data.user.result.timeline_v2.timeline.instructions.forEach(item => {
+        if (item.type === 'TimelineAddEntries') {
+            // If no tweets found
+            if (item.entries?.length == 2) {
+                // Returning the data
+                return {
+                    required: required,
+                    cursor: cursor,
+                    users: users,
+                    tweets: tweets
+                };
+            }
+
+            // Destructuring data
+            item.entries.forEach(entry => {
+                // If entry is of type tweet and tweet exists
+                if (entry.entryId.indexOf('tweet') != -1 && entry.content.itemContent?.tweet_results.result.__typename === 'Tweet') {
+                    required.push(entry.content.itemContent.tweet_results.result);
+                    users.push(entry.content.itemContent.tweet_results.result.core.user_results.result);
+                    tweets.push(entry.content.itemContent.tweet_results.result);
+                }
+                // If entry is of type cursor
+                else if (entry.entryId.indexOf('cursor-bottom') != -1) {
+                    cursor = entry.content.value ?? '';
+                }
+            });
+        }
+    });
+
+    // Returning the data
+    return {
+        required: required,
+        cursor: cursor,
+        users: users,
+        tweets: tweets
+    };
+}
+
 /**
  * @returns The raw user following/followers data formatted and sorted into required and additional data
  * @param res The raw response received from TwitterAPI
  */
-export function extractUserFollow(res: RawUserFollowers | RawUserFollowing): DataExtract {
+export function extractUserFollow(res: RawUserFollowers | RawUserFollowing): IDataExtract {
     let required: any[] = [];                                               // To store the reqruied raw data
     let cursor: string = '';                                                // To store the cursor to next batch
     let users: any[] = [];                                                  // To store additional user data
@@ -94,7 +149,7 @@ export function extractUserFollow(res: RawUserFollowers | RawUserFollowing): Dat
  * @returns The raw user likes data formatted and sorted into required and additional data
  * @param res The raw response received from TwitterAPI
  */
-export function extractUserLikes(res: RawUserLikes): DataExtract {
+export function extractUserLikes(res: RawUserLikes): IDataExtract {
     let required: any[] = [];                                               // To store the reqruied raw data
     let cursor: string = '';                                                // To store the cursor to next batch
     let users: any[] = [];                                                  // To store additional user data

package/src/services/helper/urls/Users.ts

@@ -3,7 +3,7 @@
  * @param screenName The screen name of the target user
  */
 export function userDetailsUrl(screenName: string): string {
-    return `https://api.twitter.com/graphql/hVhfo_TquFTmgL7gYwf91Q/UserByScreenName?variables=%7B%22screen_name%22%3A%22${screenName}%22%2C%22withSafetyModeUserFields%22%3Atrue%2C%22withSuperFollowsUserFields%22%3Atrue%7D&features=%7B%22responsive_web_twitter_blue_verified_badge_is_enabled%22%3Atrue%2C%22verified_phone_label_enabled%22%3Atrue%2C%22responsive_web_graphql_timeline_navigation_enabled%22%3Atrue%7D`
+	return `https://api.twitter.com/graphql/hVhfo_TquFTmgL7gYwf91Q/UserByScreenName?variables=%7B%22screen_name%22%3A%22${screenName}%22%2C%22withSafetyModeUserFields%22%3Atrue%2C%22withSuperFollowsUserFields%22%3Atrue%7D&features=%7B%22responsive_web_twitter_blue_verified_badge_is_enabled%22%3Atrue%2C%22verified_phone_label_enabled%22%3Atrue%2C%22responsive_web_graphql_timeline_navigation_enabled%22%3Atrue%7D`;
 }
 
 /**
@@ -11,23 +11,35 @@ export function userDetailsUrl(screenName: string): string {
  * @param restid The restId of the target user
  */
 export function userDetailsByIdUrl(restId: string): string {
-    return `https://api.twitter.com/graphql/mi_IjXgFyr41N9zkszPz9w/UserByRestId?variables=%7B%22userId%22%3A%22${restId}%22%2C%22withSafetyModeUserFields%22%3Atrue%2C%22withSuperFollowsUserFields%22%3Atrue%7D&features=%7B%22responsive_web_twitter_blue_verified_badge_is_enabled%22%3Atrue%2C%22verified_phone_label_enabled%22%3Atrue%2C%22responsive_web_graphql_timeline_navigation_enabled%22%3Atrue%7D`;
+	return `https://api.twitter.com/graphql/mi_IjXgFyr41N9zkszPz9w/UserByRestId?variables=%7B%22userId%22%3A%22${restId}%22%2C%22withSafetyModeUserFields%22%3Atrue%2C%22withSuperFollowsUserFields%22%3Atrue%7D&features=%7B%22responsive_web_twitter_blue_verified_badge_is_enabled%22%3Atrue%2C%22verified_phone_label_enabled%22%3Atrue%2C%22responsive_web_graphql_timeline_navigation_enabled%22%3Atrue%7D`;
 }
 
 /**
- * @returns The url for fetching the list of users followed bu target user.
+ * @returns The url for fetching the list of tweet made by target user.
+ * @param userId The rest id of the target user
+ * @param count The batch size of the list of tweets, should be >= 40 and <=100
+ * @param cursor The cursor to next batch
+ */
+export function userTweetsUrl(userId: string, count: number, cursor: string): string {
+	return `https://api.twitter.com/graphql/xxLjoOBBPpYBHbBTI-hevQ/UserTweetsAndReplies?variables=%7B%22userId%22%3A%22${userId}%22%2C%22count%22%3A${count}%2C%22cursor%22%3A%22${cursor}%22%2C%22includePromotedContent%22%3Atrue%2C%22withCommunity%22%3Atrue%2C%22withSuperFollowsUserFields%22%3Atrue%2C%22withDownvotePerspective%22%3Afalse%2C%22withReactionsMetadata%22%3Afalse%2C%22withReactionsPerspective%22%3Afalse%2C%22withSuperFollowsTweetFields%22%3Atrue%2C%22withVoice%22%3Atrue%2C%22withV2Timeline%22%3Atrue%7D&features=%7B%22responsive_web_twitter_blue_verified_badge_is_enabled%22%3Atrue%2C%22verified_phone_label_enabled%22%3Atrue%2C%22responsive_web_graphql_timeline_navigation_enabled%22%3Atrue%2C%22view_counts_public_visibility_enabled%22%3Atrue%2C%22longform_notetweets_consumption_enabled%22%3Afalse%2C%22tweetypie_unmention_optimization_enabled%22%3Atrue%2C%22vibe_api_enabled%22%3Atrue%2C%22responsive_web_edit_tweet_api_enabled%22%3Atrue%2C%22graphql_is_translatable_rweb_tweet_is_translatable_enabled%22%3Atrue%2C%22view_counts_everywhere_api_enabled%22%3Atrue%2C%22standardized_nudges_misinfo%22%3Atrue%2C%22tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled%22%3Afalse%2C%22interactive_text_enabled%22%3Atrue%2C%22responsive_web_text_conversations_enabled%22%3Afalse%2C%22responsive_web_enhance_cards_enabled%22%3Afalse%7D`;
+}
+
+/**
+ * @returns The url for fetching the list of users followed by target user.
  * @param userId The rest id of the target user
  * @param count The batch size of the list of following, should be >= 40 and <=100
  * @param cursor The cursor to next batch
  */
 export function userFollowingUrl(userId: string, count: number, cursor: string): string {
-    /** 
-     * Twitter has a ver odd behaviour here.
-     * If no cursor is provided, the number of followings fetched is slightly more the given count.
-     * If a cursor if provided, the number of followings is sometimes less than the provided count.
-     * NO SOLUTION EXISTS AS OF NOW!
-     */
-    return `https://api.twitter.com/graphql/mSnjZc5CTm2Z5Lu_i4XsPQ/Following?variables=%7B%22userId%22%3A%22${userId}%22%2C%22count%22%3A${count}%2C%22cursor%22%3A%22${encodeURIComponent(cursor)}%22%2C%22includePromotedContent%22%3Afalse%2C%22withSuperFollowsUserFields%22%3Atrue%2C%22withDownvotePerspective%22%3Afalse%2C%22withReactionsMetadata%22%3Afalse%2C%22withReactionsPerspective%22%3Afalse%2C%22withSuperFollowsTweetFields%22%3Atrue%7D&features=%7B%22responsive_web_twitter_blue_verified_badge_is_enabled%22%3Atrue%2C%22verified_phone_label_enabled%22%3Atrue%2C%22responsive_web_graphql_timeline_navigation_enabled%22%3Atrue%2C%22view_counts_public_visibility_enabled%22%3Atrue%2C%22longform_notetweets_consumption_enabled%22%3Afalse%2C%22tweetypie_unmention_optimization_enabled%22%3Atrue%2C%22responsive_web_uc_gql_enabled%22%3Atrue%2C%22vibe_api_enabled%22%3Atrue%2C%22responsive_web_edit_tweet_api_enabled%22%3Atrue%2C%22graphql_is_translatable_rweb_tweet_is_translatable_enabled%22%3Atrue%2C%22view_counts_everywhere_api_enabled%22%3Atrue%2C%22standardized_nudges_misinfo%22%3Atrue%2C%22tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled%22%3Afalse%2C%22interactive_text_enabled%22%3Atrue%2C%22responsive_web_text_conversations_enabled%22%3Afalse%2C%22responsive_web_enhance_cards_enabled%22%3Afalse%7D`;
+	/**
+	 * Twitter has a ver odd behaviour here.
+	 * If no cursor is provided, the number of followings fetched is slightly more the given count.
+	 * If a cursor if provided, the number of followings is sometimes less than the provided count.
+	 * NO SOLUTION EXISTS AS OF NOW!
+	 */
+	return `https://api.twitter.com/graphql/mSnjZc5CTm2Z5Lu_i4XsPQ/Following?variables=%7B%22userId%22%3A%22${userId}%22%2C%22count%22%3A${count}%2C%22cursor%22%3A%22${encodeURIComponent(
+		cursor,
+	)}%22%2C%22includePromotedContent%22%3Afalse%2C%22withSuperFollowsUserFields%22%3Atrue%2C%22withDownvotePerspective%22%3Afalse%2C%22withReactionsMetadata%22%3Afalse%2C%22withReactionsPerspective%22%3Afalse%2C%22withSuperFollowsTweetFields%22%3Atrue%7D&features=%7B%22responsive_web_twitter_blue_verified_badge_is_enabled%22%3Atrue%2C%22verified_phone_label_enabled%22%3Atrue%2C%22responsive_web_graphql_timeline_navigation_enabled%22%3Atrue%2C%22view_counts_public_visibility_enabled%22%3Atrue%2C%22longform_notetweets_consumption_enabled%22%3Afalse%2C%22tweetypie_unmention_optimization_enabled%22%3Atrue%2C%22responsive_web_uc_gql_enabled%22%3Atrue%2C%22vibe_api_enabled%22%3Atrue%2C%22responsive_web_edit_tweet_api_enabled%22%3Atrue%2C%22graphql_is_translatable_rweb_tweet_is_translatable_enabled%22%3Atrue%2C%22view_counts_everywhere_api_enabled%22%3Atrue%2C%22standardized_nudges_misinfo%22%3Atrue%2C%22tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled%22%3Afalse%2C%22interactive_text_enabled%22%3Atrue%2C%22responsive_web_text_conversations_enabled%22%3Afalse%2C%22responsive_web_enhance_cards_enabled%22%3Afalse%7D`;
 }
 
 /**
@@ -37,18 +49,20 @@ export function userFollowingUrl(userId: string, count: number, cursor: string):
  * @param cursor The cusor to next batch
  */
 export function userFollowersUrl(userId: string, count: number, cursor: string): string {
-    /**
-     * Twitter has a very odd behaviour here.
-     * If no cursor is provided, the number of followers fetched is equal to count + 20.
-     * If a cursor is provided, the number of followers fetched is equal to count.
-     * The solution is to check accordingly, if a cursor if provided or not and manipulate the count
-     */
-    // If no cursor if provided
-    if (!cursor) {
-        count = count - 20;
-    }
+	/**
+	 * Twitter has a very odd behaviour here.
+	 * If no cursor is provided, the number of followers fetched is equal to count + 20.
+	 * If a cursor is provided, the number of followers fetched is equal to count.
+	 * The solution is to check accordingly, if a cursor if provided or not and manipulate the count
+	 */
+	// If no cursor if provided
+	if (!cursor) {
+		count = count - 20;
+	}
 
-    return `https://api.twitter.com/graphql/nwlAnaw7oKXcVLi91ehy7Q/Followers?variables=%7B%22userId%22%3A%22${userId}%22%2C%22count%22%3A${count}%2C%22cursor%22%3A%22${encodeURIComponent(cursor)}%22%2C%22includePromotedContent%22%3Afalse%2C%22withSuperFollowsUserFields%22%3Atrue%2C%22withDownvotePerspective%22%3Afalse%2C%22withReactionsMetadata%22%3Afalse%2C%22withReactionsPerspective%22%3Afalse%2C%22withSuperFollowsTweetFields%22%3Atrue%7D&features=%7B%22responsive_web_twitter_blue_verified_badge_is_enabled%22%3Atrue%2C%22verified_phone_label_enabled%22%3Atrue%2C%22responsive_web_graphql_timeline_navigation_enabled%22%3Atrue%2C%22view_counts_public_visibility_enabled%22%3Atrue%2C%22longform_notetweets_consumption_enabled%22%3Afalse%2C%22tweetypie_unmention_optimization_enabled%22%3Atrue%2C%22responsive_web_uc_gql_enabled%22%3Atrue%2C%22vibe_api_enabled%22%3Atrue%2C%22responsive_web_edit_tweet_api_enabled%22%3Atrue%2C%22graphql_is_translatable_rweb_tweet_is_translatable_enabled%22%3Atrue%2C%22view_counts_everywhere_api_enabled%22%3Atrue%2C%22standardized_nudges_misinfo%22%3Atrue%2C%22tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled%22%3Afalse%2C%22interactive_text_enabled%22%3Atrue%2C%22responsive_web_text_conversations_enabled%22%3Afalse%2C%22responsive_web_enhance_cards_enabled%22%3Afalse%7D`;
+	return `https://api.twitter.com/graphql/nwlAnaw7oKXcVLi91ehy7Q/Followers?variables=%7B%22userId%22%3A%22${userId}%22%2C%22count%22%3A${count}%2C%22cursor%22%3A%22${encodeURIComponent(
+		cursor,
+	)}%22%2C%22includePromotedContent%22%3Afalse%2C%22withSuperFollowsUserFields%22%3Atrue%2C%22withDownvotePerspective%22%3Afalse%2C%22withReactionsMetadata%22%3Afalse%2C%22withReactionsPerspective%22%3Afalse%2C%22withSuperFollowsTweetFields%22%3Atrue%7D&features=%7B%22responsive_web_twitter_blue_verified_badge_is_enabled%22%3Atrue%2C%22verified_phone_label_enabled%22%3Atrue%2C%22responsive_web_graphql_timeline_navigation_enabled%22%3Atrue%2C%22view_counts_public_visibility_enabled%22%3Atrue%2C%22longform_notetweets_consumption_enabled%22%3Afalse%2C%22tweetypie_unmention_optimization_enabled%22%3Atrue%2C%22responsive_web_uc_gql_enabled%22%3Atrue%2C%22vibe_api_enabled%22%3Atrue%2C%22responsive_web_edit_tweet_api_enabled%22%3Atrue%2C%22graphql_is_translatable_rweb_tweet_is_translatable_enabled%22%3Atrue%2C%22view_counts_everywhere_api_enabled%22%3Atrue%2C%22standardized_nudges_misinfo%22%3Atrue%2C%22tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled%22%3Afalse%2C%22interactive_text_enabled%22%3Atrue%2C%22responsive_web_text_conversations_enabled%22%3Afalse%2C%22responsive_web_enhance_cards_enabled%22%3Afalse%7D`;
 }
 
 /**
@@ -58,5 +72,7 @@ export function userFollowersUrl(userId: string, count: number, cursor: string):
  * @param cursor The cusor to next batch
  */
 export function userLikesUrl(userId: string, count: number, cursor: string): string {
-    return `https://api.twitter.com/graphql/gP4ZKghLd4tpILgS6VudAQ/Likes?variables=%7B%22userId%22%3A%22${userId}%22%2C%22count%22%3A${count}%2C%22cursor%22%3A%22${encodeURIComponent(cursor)}%22%2C%22includePromotedContent%22%3Afalse%2C%22withSuperFollowsUserFields%22%3Atrue%2C%22withDownvotePerspective%22%3Afalse%2C%22withReactionsMetadata%22%3Afalse%2C%22withReactionsPerspective%22%3Afalse%2C%22withSuperFollowsTweetFields%22%3Atrue%2C%22withClientEventToken%22%3Afalse%2C%22withBirdwatchNotes%22%3Afalse%2C%22withVoice%22%3Atrue%2C%22withV2Timeline%22%3Atrue%7D&features=%7B%22responsive_web_twitter_blue_verified_badge_is_enabled%22%3Atrue%2C%22verified_phone_label_enabled%22%3Atrue%2C%22responsive_web_graphql_timeline_navigation_enabled%22%3Atrue%2C%22view_counts_public_visibility_enabled%22%3Atrue%2C%22longform_notetweets_consumption_enabled%22%3Afalse%2C%22tweetypie_unmention_optimization_enabled%22%3Atrue%2C%22responsive_web_uc_gql_enabled%22%3Atrue%2C%22vibe_api_enabled%22%3Atrue%2C%22responsive_web_edit_tweet_api_enabled%22%3Atrue%2C%22graphql_is_translatable_rweb_tweet_is_translatable_enabled%22%3Atrue%2C%22view_counts_everywhere_api_enabled%22%3Atrue%2C%22standardized_nudges_misinfo%22%3Atrue%2C%22tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled%22%3Afalse%2C%22interactive_text_enabled%22%3Atrue%2C%22responsive_web_text_conversations_enabled%22%3Afalse%2C%22responsive_web_enhance_cards_enabled%22%3Afalse%7D`;
-}
+	return `https://api.twitter.com/graphql/gP4ZKghLd4tpILgS6VudAQ/Likes?variables=%7B%22userId%22%3A%22${userId}%22%2C%22count%22%3A${count}%2C%22cursor%22%3A%22${encodeURIComponent(
+		cursor,
+	)}%22%2C%22includePromotedContent%22%3Afalse%2C%22withSuperFollowsUserFields%22%3Atrue%2C%22withDownvotePerspective%22%3Afalse%2C%22withReactionsMetadata%22%3Afalse%2C%22withReactionsPerspective%22%3Afalse%2C%22withSuperFollowsTweetFields%22%3Atrue%2C%22withClientEventToken%22%3Afalse%2C%22withBirdwatchNotes%22%3Afalse%2C%22withVoice%22%3Atrue%2C%22withV2Timeline%22%3Atrue%7D&features=%7B%22responsive_web_twitter_blue_verified_badge_is_enabled%22%3Atrue%2C%22verified_phone_label_enabled%22%3Atrue%2C%22responsive_web_graphql_timeline_navigation_enabled%22%3Atrue%2C%22view_counts_public_visibility_enabled%22%3Atrue%2C%22longform_notetweets_consumption_enabled%22%3Afalse%2C%22tweetypie_unmention_optimization_enabled%22%3Atrue%2C%22responsive_web_uc_gql_enabled%22%3Atrue%2C%22vibe_api_enabled%22%3Atrue%2C%22responsive_web_edit_tweet_api_enabled%22%3Atrue%2C%22graphql_is_translatable_rweb_tweet_is_translatable_enabled%22%3Atrue%2C%22view_counts_everywhere_api_enabled%22%3Atrue%2C%22standardized_nudges_misinfo%22%3Atrue%2C%22tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled%22%3Afalse%2C%22interactive_text_enabled%22%3Atrue%2C%22responsive_web_text_conversations_enabled%22%3Afalse%2C%22responsive_web_enhance_cards_enabled%22%3Afalse%7D`;
+}

package/src/services/{CacheService.ts → util/CacheService.ts}

@@ -2,7 +2,7 @@
 import NodeCache from 'node-cache';
 
 // PARSERS
-import * as Parsers from './helper/Parser';
+import * as Parsers from '../helper/Parser';
 
 /**
  * Handles reading and writing of data from and to cache.
@@ -40,7 +40,9 @@ export class CacheService {
      * Stores the input data in the cache.
      * 
      * @param data The input data to store.
+     * 
      * @returns Whether writing to cache was successful or not.
+     * 
      * @remarks In order to cache data, the data to be cached must have a unique 'id' field.
      */
     public write(data: any): void {
@@ -62,6 +64,7 @@ export class CacheService {
 
     /**
      * @param id The id id of the data to be fetched from cache.
+     * 
      * @returns The data with the given id.
      */
     public read(id: string): any {