rettiwt-api 1.4.0 → 2.0.0

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

@@ -1,141 +0,0 @@
-// PACKAGE
-import {
-    IUserDetailsResponse,
-    IUserFollowersResponse,
-    IUserFollowingResponse,
-    IUserLikesResponse
-} from 'rettiwt-core';
-
-// TYPES
-import { IDataExtract } from '../../../types/Resolvers'
-import { DataErrors } from '../../../enums/Errors';
-
-// PARSERS
-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: IUserDetailsResponse): 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 not found or account suspended
-    if (res.data?.user?.result?.__typename !== 'User') {
-        throw new Error(DataErrors.UserNotFound);
-    }
-
-    // Destructuring user account data
-    required.push(res.data.user.result);
-    users.push(res.data.user.result);
-
-    // 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: IUserFollowersResponse | IUserFollowingResponse): 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.timeline.instructions.forEach(item => {
-        if (item.type === 'TimelineAddEntries') {
-            // If no follow 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 user and user account exists
-                if (entry.entryId.indexOf('user') != -1 && entry.content.itemContent?.user_results.result.__typename === 'User') {
-                    required.push(entry.content.itemContent.user_results.result);
-                    users.push(entry.content.itemContent.user_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 likes data formatted and sorted into required and additional data
- * @param res The raw response received from TwitterAPI
- */
-export function extractUserLikes(res: IUserLikesResponse): 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);
-    }
-
-    // If user likes found
-    if (res.data.user.result.timeline_v2.timeline.instructions.length) {
-        // Extracting the raw list
-        res.data.user.result.timeline_v2.timeline.instructions.forEach(item => {
-            if (item.type === 'TimelineAddEntries') {
-                // 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
-    };
-}

package/src/services/helper/payloads/LoginFlows.ts

@@ -1,90 +0,0 @@
-const LoginFlows = {
-    "InitiateLogin": {
-        url: 'https://api.twitter.com/1.1/onboarding/task.json?flow_name=login'
-    },
-    "JsInstrumentationSubtask": {
-        url: 'https://api.twitter.com/1.1/onboarding/task.json',
-        body: (flowToken: string) => ({
-            "flow_token": flowToken,
-            "subtask_inputs": [
-                {
-                    "subtask_id": "LoginJsInstrumentationSubtask",
-                    "js_instrumentation": {
-                        "response": "{\"rf\":{\"a09453c7341fb1cbb7d51561f92d478fa0752bc77e7ca6b5703258680b2c51d7\":-4,\"bd26c6694e256b10766447d992deaf92bb220bc05e3b8205ba5c9a4f83302230\":0,\"abfa440376b8dc33ca518e1e2a998b3ac4200a8122ef09781eea2c1408717111\":-1,\"a4e87b66027f638a4634561275fab00f9f7446b81a180b5f03eda69fa32eb8f4\":-224},\"s\":\"yET9nlXrlGRAylCyyBKEsxOpUweMpjRz5RfKzTzQyVADnKE64gmpyILfKBK0-HIHWY8FbJPHGWr6QrCb5A-Z3q2SLRm4DReprZGXykJ111_ynet8kSjFkRjODKKDN2FzT1V6rx9FILnUuRCaMu9ewfPgPBi4wO1g7EUeEsSSHIiCwNc9URJr4c2xVTA3ibIfTbu8p2WhX7RZAk8LWRPpPPB21st8Z1j0LcLlR0bkZoF6LsN-7w75lGB0s4z1JKqus2MVuRcPMay0wWZbn8Qx9In_-tSTvEBLcxjUpDgwu29G0g0iCWoISFzLY4-LLvV7UBGklkByIcPtwYbDbREqRQAAAYYmXAsG\"}",
-                        "link": "next_link"
-                    }
-                }
-            ]
-        })
-    },
-    "EnterUserIdentifier": {
-        url: 'https://api.twitter.com/1.1/onboarding/task.json',
-        body: (flowToken: string, email: string) => ({
-            "flow_token": flowToken,
-            "subtask_inputs": [
-                {
-                    "subtask_id": "LoginEnterUserIdentifierSSO",
-                    "settings_list": {
-                        "setting_responses": [
-                            {
-                                "key": "user_identifier",
-                                "response_data": {
-                                    "text_data": {
-                                        "result": email
-                                    }
-                                }
-                            }
-                        ],
-                        "link": "next_link"
-                    }
-                }
-            ]
-        })
-    },
-    "EnterAlternateUserIdentifier": {
-        url: 'https://api.twitter.com/1.1/onboarding/task.json',
-        body: (flowToken: string, userName: string) => ({
-            "flow_token": flowToken,
-            "subtask_inputs": [
-                {
-                    "subtask_id": "LoginEnterAlternateIdentifierSubtask",
-                    "enter_text": {
-                        "text": userName,
-                        "link": "next_link"
-                    }
-                }
-            ]
-        })
-    },
-    "EnterPassword": {
-        url: 'https://api.twitter.com/1.1/onboarding/task.json',
-        body: (flowToken: string, password: string) => ({
-            "flow_token": flowToken,
-            "subtask_inputs": [
-                {
-                    "subtask_id": "LoginEnterPassword",
-                    "enter_password": {
-                        "password": password,
-                        "link": "next_link"
-                    }
-                }
-            ]
-        })
-    },
-    "AccountDuplicationCheck": {
-        url: 'https://api.twitter.com/1.1/onboarding/task.json',
-        body: (flowToken: string) => ({
-            "flow_token": flowToken,
-            "subtask_inputs": [
-                {
-                    "subtask_id": "AccountDuplicationCheck",
-                    "check_logged_in_account": {
-                        "link": "AccountDuplicationCheck_false"
-                    }
-                }
-            ]
-        })
-    }
-}
-
-export default LoginFlows;

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

@@ -1,6 +0,0 @@
-/**
- * @returns The url for fetching a guest token
- */
-export function guestTokenUrl(): string {
-    return `https://api.twitter.com/1.1/guest/activate.json`;
-}

package/src/services/util/CacheService.ts

@@ -1,76 +0,0 @@
-// PACKAGES
-import NodeCache from 'node-cache';
-
-// PARSERS
-import * as Parsers from '../helper/Parser';
-
-/**
- * Handles reading and writing of data from and to cache.
- * 
- * This services uses a local node-cache instance to cache data, since the data to be cached has no real purpose outside of the server session.
- * This serivce follows a singleton pattern, where at any point, only a single instance of this class exists.
- * This is done so that all the data is cached in a single instance, which makes sharing of cached data between different endpoints possible.
- * @internal
- */
-export class CacheService {
-    // MEMBER DATA
-    private static instance: CacheService;                              // To store the current instance of this service
-    private client: NodeCache;                                          // To store the redis client instance
-
-    // MEMBER METHODS
-    private constructor() {
-        // Initializing new cache
-        this.client = new NodeCache();
-    }
-
-    /**
-     * @returns The current working instance of CacheService
-     */
-    static getInstance(): CacheService {
-        // If an instance doesnt exists already
-        if (!this.instance) {
-            this.instance = new CacheService();
-        }
-        
-        // Returning the current instance
-        return this.instance;
-    }
-
-    /**
-     * 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 {
-        // Converting the data to a list of data
-        data = Parsers.dataToList(data);
-
-        // Iterating over the list of data
-        for (let item of data) {
-            // Storing whether data is already cached or not
-            let cached = this.client.has(Parsers.findJSONKey(item, 'id'));
-
-            // If data does not already exist in cache
-            if(!cached) {
-                // Adding data to cache
-                this.client.set(Parsers.findJSONKey(item, 'id'), item);
-            }
-        }
-    }
-
-    /**
-     * @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 {
-        // Getting data from cache
-        let res = this.client.get(id);
-
-        return res;
-    }
-}

package/src/services/util/FetcherService.ts

@@ -1,143 +0,0 @@
-// PACKAGES
-import axios, { AxiosRequestConfig, AxiosResponse } from 'axios';
-import { ITweet as IRawTweet, IUser as IRawUser } from 'rettiwt-core';
-
-// SERVICES
-import { AuthService } from '../auth/AuthService';
-import { CacheService } from './CacheService';
-
-// MODELS
-import { Tweet } from '../../models/data/Tweet';
-import { User } from '../../models/data/User';
-
-// ENUMS
-import { HttpStatus } from "../../enums/HTTP";
-
-// HELPERS
-import * as Headers from '../helper/Headers'
-import { CurlyOptions } from 'node-libcurl/dist/curly';
-
-/**
- * The different types of http requests.
- */
-export enum HttpMethods {
-    POST = "POST",
-    GET = "GET"
-};
-
-/**
- * Handles all HTTP requests.
- * @internal
- * 
- * This serves as the base service from which all other data services derive their behaviour.
- */
-export class FetcherService {
-    // MEMBER DATA
-    /** The authentication service instance. */
-    protected auth: AuthService;
-
-    /** The caching service instance. */
-    private cache: CacheService;
-
-    /** Whether instance has been authenticated or not. */
-    protected isAuthenticated: boolean;
-
-    // MEMBER METHODS
-    /**
-     * @param auth The AuthService instance to use for authentication.
-     */
-    constructor(auth: AuthService) {
-        this.auth = auth;
-        this.cache = CacheService.getInstance();
-        this.isAuthenticated = this.auth.isAuthenticated;
-    }
-
-    /**
-    * The middleware for handling any HTTP error.
-    * 
-    * @param res The response object received.
-    * 
-    * @returns The received response, if no HTTP errors are found.
-    * 
-    * @throws {@link HttpStatus} error, if any HTTP error is found.
-    */
-    private handleHTTPError(res: AxiosResponse): AxiosResponse {
-        /**
-         * If the status code is not 200 => the HTTP request was not successful. hence throwing error
-         */
-        if (res.status != 200 && res.status in HttpStatus) {
-            throw new Error(HttpStatus[res.status])
-        }
-
-        return res;
-    }
-
-    /**
-     * Creates an HTTP request according to the given parameters.
-     * 
-     * This method internally uses node-libcurl library to make curl requests to the URL, instead of node-fetch.
-     * This has been done since that way it better mimics the HTTP requests made from browser.
-     * 
-     * @param url The url to fetch data from.
-     * @param authenticate Whether to authenticate requests or not.
-     * @param method The HTTP method (from {@link HttpMethods}) to use.
-     * @param data The data to be sent along with the request (for POST request).
-     * 
-     * @returns The {@link AxiosResponse} received.
-     */
-    protected async request<DataType>(url: string, authenticate: boolean = true, method: HttpMethods = HttpMethods.GET, data?: any): Promise<AxiosResponse<DataType>> {
-        /**
-         * Creating the request configuration based on the params
-         */
-        let config: AxiosRequestConfig = {
-            /**
-             * If authorization is required, using the authenticated header, using the authentication credentiials.
-             * Else, using the guest header, using the guest credentials.
-             */
-            headers: authenticate ? Headers.authorizedHeader(await this.auth.getAuthCredentials()) : Headers.guestHeader(await this.auth.getGuestCredentials()),
-        };
-
-        /**
-         * While making requests, if data is to be sent, the JSON data first need to be stringified.
-         * After making the request, the response is then passed to HTTP error handling middlware for HTTP error handling.
-         */
-        // If POST request is to be made
-        if (method == HttpMethods.POST) {
-            return await axios.post(url, data, config).then(res => this.handleHTTPError(res));
-        }
-        // If GET request is to be made
-        else {
-            return await axios.get(url, config).then(res => this.handleHTTPError(res));
-        }
-    }
-
-    /**
-     * Caches the extracted data into the {@link CacheService} instance.
-     * 
-     * @param data The extracted data to be cached.
-     */
-    protected cacheData(data: any): void {
-        /**
-         * The extracted data is in raw form.
-         * This raw data is deserialized into the respective known types.
-         */
-        let users = data.users.map((user: IRawUser) => new User(user));
-        let tweets = data.tweets.map((tweet: IRawTweet) => new Tweet(tweet));
-
-        // Caching the data
-        this.cache.write(users);
-        this.cache.write(tweets);
-    }
-
-    /**
-     * Fetches the data with the given id from the cache.
-     * 
-     * @param id The id of the data to be read from cache.
-     * 
-     * @returns The data with the given id. If does not exists, returns undefined.
-     */
-    protected readData(id: string): any {
-        // Reading data from cache
-        return this.cache.read(id);
-    }
-}

package/src/types/Args.ts

@@ -1,12 +0,0 @@
-/**
- * The arguments for fetching cursored list.
- * 
- * @public
- */
-export interface IListArgs {
-    /** The number of data items to fetch. */
-    count?: number;
-
-    /** The cursor to the batch of data to fetch. */
-    cursor?: string;
-};

package/src/types/Authentication.ts

@@ -1,63 +0,0 @@
-/**
- * The guest credentials for guest authentication.
- * 
- * @internal
- */
-export interface IGuestCredentials {
-    /** The bearer token from twitter.com.
-     * 
-     * @remarks This is a static bearer token from twitter.com.
-     */
-    authToken: string;
-
-    /** The guest token.
-     * 
-     * @remarks This is generated from twitter.com by calling GETTING https://api.twitter.com/1.1/guest/activate.json endpoint.
-     */
-    guestToken: string;
-};
-
-/**
- * The credentials for authenticated/logged in users.
- * 
- * @internal
- */
-export interface IAuthCredentials {
-    /** The bearer token from twitter.com.
-     * 
-     * @remarks This is a static bearer token from twitter.com.
-     */
-    authToken: string;
-
-    /** The guest token.
-     * 
-     * @remarks This is generated from twitter.com by calling GETTING https://api.twitter.com/1.1/guest/activate.json endpoint.
-     */
-    csrfToken: string;
-
-    /** The cookie of the twitter account, which is used to authenticate against twitter.
-     * 
-     * @remarks The cookie can be obtained/scraped from any one of the outgoing HTTP request headers to twitter.com.
-     * It can also be obtained after logging in to twitter, from the 'set-cookie' field of response.
-     */
-    cookie: string;
-};
-
-/**
- * The cookie containing the tokens that are used to authenticate against Twitter.
- * 
- * @public
- */
-export interface IAuthCookie {
-    /** Token used to authenticate a device. */
-    kdt: string;
-
-    /** Token used to authenticate a user using a Twitter ID. */
-    twid: string;
-
-    /** The CSRF token of the session. */
-    ct0: string;
-
-    /** The authentication token used while logging in to the account. */
-    auth_token: string;
-};

package/src/types/Resolvers.ts

@@ -1,18 +0,0 @@
-/**
- * The data returned from extractor methods.
- * 
- * @internal
- */
-export interface IDataExtract {
-    /** The required data. */
-    required: any[];
-
-    /** The cursor string to the next batch of data. */
-    cursor: string;
-
-    /** Additional extracted user details. */
-    users: any[];
-
-    /** Additional extracted tweet details */
-    tweets: any[];
-}

package/src/types/Rettiwt.ts

@@ -1,20 +0,0 @@
-// SERVICES
-import { AccountService } from "../services/auth/AccountService";
-import { TweetService } from "../services/data/TweetService";
-import { UserService } from "../services/data/UserService";
-
-/**
- * The data context from where data is to be fetched.
- * 
- * @public
- */
-export interface IDataContext {
-    /** Handles data related to users. */
-    users: UserService,
-
-    /** Handles data related to tweets. */
-    tweets: TweetService,
-
-    /** Handles account related operations. */
-    account: AccountService
-}

package/src/types/Service.ts

@@ -1,24 +0,0 @@
-/**
- * The cursor to the batch of data to be fetched.
- * 
- * @public
- */
-export interface ICursor {
-    /** The cursor string. */
-    value: string;
-};
-
-/**
- * The data that us fetched batch-wise along with a cursor.
- * 
- * @typeParam Type - The type of data present in the list.
- * 
- * @public
- */
-export interface ICursoredData<Type> {
-    /** The list of data of the given type. */
-    list: Type[];
-
-    /** The cursor to the next batch of data. */
-    next: ICursor;
-};