rettiwt-api 1.1.2 → 1.1.7

package/tsconfig.json

@@ -12,8 +12,8 @@
 		// "target": "es2016",                               /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
 		// "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
 		// "jsx": "preserve",                                /* Specify what JSX code is generated. */
-		// "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
-		// "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+		"experimentalDecorators": true,                      /* Enable experimental support for TC39 stage 2 draft decorators. */
+		"emitDecoratorMetadata": true,                       /* Emit design-type metadata for decorated declarations in source files. */
 		// "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
 		// "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
 		// "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */

package/src/services/AuthService.ts

@@ -1,68 +0,0 @@
-// PACKAGE
-import axios from 'axios';
-
-// URLS
-import { guestTokenUrl } from './helper/urls/Authentication';
-
-// TYPES
-import { GuestCredentials, AuthCredentials } from '../types/Authentication';
-
-// CONFIGS
-import { config } from '../config/env';
-
-/**
- * Handles authentication of http requests and other authentication related tasks.
- * @internal
- */
-export class AuthService {
-    // MEMBER DATA
-    /** The common bearer token for authentication. */
-    private authToken: string;
-
-    /** The current authentication credentials. */
-    private credentials: AuthCredentials;
-
-    /** Whether instance has been authenticated or not. */
-    public isAuthenticated: boolean;
-
-    // MEMBER METHODS
-    constructor(cookie: string = '') {
-        // Reading the auth token from the config, since it's always the same
-        this.authToken = config.twitter_auth_token;
-
-        // Setting authentication status
-        this.isAuthenticated = cookie != '';
-
-        // Setting up the authenticated credentials
-        /**
-         * The following regex pattern is used to extract the csrfToken from the cookie string.
-         * This is done by matching any string between the characters 'ct0=' and nearest enclosing ';'.
-         * (?<=pattern) starts matching after the given pattern.
-         * (?=pattern) stops matching just before the pattern.
-         */
-        this.credentials = { authToken: this.authToken, csrfToken: cookie.match(/(?<=ct0=).+?(?=;)/) + '', cookie: cookie};
-        
-    }
-    
-    /**
-     * @returns The current authentication credentials. A different credential is returned each time this is invoked
-     */
-    async getAuthCredentials(): Promise<AuthCredentials> {
-        return this.credentials;
-    }
-
-    /**
-     * @returns The guest credentials fetched from twitter.
-     */
-    async getGuestCredentials(): Promise<GuestCredentials> {
-        // Getting the guest credentials from twitter
-        return await axios.post<{ guest_token: string }>(guestTokenUrl(), null, {
-            headers: {
-                'Authorization': this.authToken
-            }
-        }).then(res => ({
-            authToken: this.authToken,
-            guestToken: res.data.guest_token
-        }));
-    }
-}

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

@@ -1,70 +0,0 @@
-// TYPES
-import { Tweet, TweetEntities } from '../../../types/data/Tweet';
-import { Result as RawTweet, Entities2 as RawTweetEntities } from '../../../types/raw/tweet/Tweet';
-
-// PARSERS
-import * as Parsers from '../Parser';
-
-/**
- * @returns A TweetEntities object containing the various tweet entities
- * @param data The raw tweet entities data from the response received from TwitterAPI
- */
-export function toTweetEntities(data: RawTweetEntities): TweetEntities {
-    let entities: TweetEntities = {
-        mentionedUsers: [],
-        urls: [],
-        media: [],
-        hashtags: []
-    };
-    
-    // Extracting user mentions
-    if(data.user_mentions) {
-        for(let user of data.user_mentions) {
-            entities.mentionedUsers.push(user.id_str);
-        }
-    }
-
-    // Extracting urls
-    if(data.urls) {
-        for(let url of data.urls) {
-            entities.urls.push(url.expanded_url);
-        }
-    }
-    
-    // Extracting hashtags
-    if(data.hashtags) {
-        for(let hashtag of data.hashtags) {
-            entities.hashtags.push(hashtag.text);
-        }
-    }
-
-    // Extracting media urls (if any)
-    if(data.media) {
-        for(const media of data.media) {
-            entities.media.push(media.media_url_https);
-        }
-    }
-
-    return entities;
-}
-
-/**
- * @returns A Tweet object containing the tweet data
- * @param data The raw tweet data from the response received from TwitterAPI
- */
-export function toTweet(data: RawTweet): Tweet {
-    return {
-        id: data.rest_id,
-        createdAt: data.legacy.created_at,
-        tweetBy: data.legacy.user_id_str,
-        entities: toTweetEntities(data.legacy.entities),
-        quoted: data.legacy.quoted_status_id_str,
-        fullText: Parsers.normalizeText(data.legacy.full_text),
-        replyTo: data.legacy.in_reply_to_status_id_str,
-        lang: data.legacy.lang,
-        quoteCount: data.legacy.quote_count,
-        replyCount: data.legacy.reply_count,
-        retweetCount: data.legacy.retweet_count,
-        likeCount: data.legacy.favorite_count
-    };
-}

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

@@ -1,26 +0,0 @@
-// TYPES
-import { User } from '../../../types/data/User';
-import { Result as RawUser } from '../../../types/raw/user/User';
-
-/**
- * @returns A User object containing the user details
- * @param data The raw user data from Twitter API
- */
-export function toUser(data: RawUser): User {
-    return {
-        id: data.rest_id,
-        userName: data.legacy.screen_name,
-        fullName: data.legacy.name,
-        createdAt: data.legacy.created_at,
-        description: data.legacy.description,
-        isVerified: data.legacy.verified,
-        favouritesCount: data.legacy.favourites_count,
-        followersCount: data.legacy.followers_count,
-        followingsCount: data.legacy.friends_count,
-        statusesCount: data.legacy.statuses_count,
-        location: data.legacy.location,
-        pinnedTweet: data.legacy.pinned_tweet_ids_str[0],
-        profileBanner: data.legacy.profile_banner_url,
-        profileImage: data.legacy.profile_image_url_https
-    };
-}

package/src/types/data/Errors.ts

@@ -1,37 +0,0 @@
-/**
- * Different types of error messages related to authentication.
- *
- * @public
- */
-export enum AuthenticationErrors {
-    NotAuthenticated = "Cannot fetch this data without authentication",
-    InvalidEmail = "No Twitter account found for the given email address",
-    InvalidUsername = "Incorrect username given for the given Twitter account",
-    InvalidPassword = "Incorrect password given for the given Twitter account"
-};
-
-/**
- * Different types error messages for validation errors.
- *
- * @public
- */
-export enum ValidationErrors {
-    InvalidTweetFilter = "Atleast one of fromUsers/toUsers/mentions/hashtags/words argument is required",
-    NoUserIdentification = "Either userName or id must be given",
-    InvalidCount = "Invalid count provided"
-};
-
-/**
- * Different type of error messages that are returned by services.
- *
- * @public
- */
-export enum DataErrors {
-    UserNotFound = "An account with given username/id was not found",
-    TweetNotFound = "A tweet with the given id was not found",
-    NoTweetsFound = "No tweets matching the given criteria found",
-    NoLikersFound = "No likers found for the tweet with the given id",
-    NoRetweetersFound = "No retweeters found for the tweet with the given id",
-    NoFollowsFound = "No follow details were found for the user with the given id",
-    NoLikedTweetsFound = "No liked tweets were found for the user with the given id"
-};

package/src/types/data/Service.ts

@@ -1,55 +0,0 @@
-// SERVICES
-import { AccountService } from "../../services/accounts/AccountService";
-import { TweetService } from "../../services/data/TweetService";
-import { UserService } from "../../services/data/UserService";
-
-/**
- * The cursor to the batch of data to be fetched.
- * 
- * @public
- */
-export class Cursor {
-    // MEMBER DATA
-    /** The cursor string. */
-    value: string;
-
-    // MEMBER DATA
-    /**
-     * Initializes a new cursor from the given cursor string.
-     * 
-     * @param cursorStr The string representation of the cursor.
-     */
-    constructor(cursorStr: string) {
-        this.value = cursorStr;
-    }
-}
-
-/**
- * The data that us fetched batch-wise along with a cursor.
- * 
- * @typeParam Type - The type of data present in the list.
- * @public
- */
-export interface CursoredData<Type> {
-    /** The list of data of the given type. */
-    list: Type[];
-
-    /** The cursor to the next batch of data. */
-    next: Cursor;
-}
-
-/**
- * The data context from where data is to be fetched.
- * 
- * @public
- */
-export interface DataContext {
-    /** Handles data related to users. */
-    users: UserService,
-
-    /** Handles data related to tweets. */
-    tweets: TweetService,
-
-    /** Handles account related operations. */
-    account: AccountService
-}

package/src/types/data/Tweet.ts

@@ -1,123 +0,0 @@
-/**
- * The filter to be used for fetching tweets from Twitter.
- * 
- * @public
- */
-export interface TweetFilter {
-    /** The list of words to search. */
-    words?: string[];
-
-    /** The list of hashtags to search.
-     * 
-     * @remarks
-     * '#' must be excluded from the hashtag!
-     */
-    hashtags?: string[];
-
-    /** The list of usernames whose tweets are to be searched.
-     * 
-     * @remarks
-     * '@' must be excluded from the username!
-     */
-    fromUsers?: string[];
-    
-    /** The list of username to whom the tweets to be searched, are adressed.
-     * 
-     * @remarks
-     * '@' must be excluded from the username!
-     */
-    toUsers?: string[];
-
-    /** The list of username mentioned in the tweets to search.
-     * 
-     * @remarks
-     * '@' must be excluded from the username!
-     */
-    mentions?: string[];
-
-    /** The date starting from which tweets are to be searched.
-     * 
-     * @remarks
-     * Must be in the format YYYY-MM-DD.
-     */
-    startDate?: string;
-
-    /** The date upto which tweets are to be searched.
-     * 
-     * @remarks
-     * Must be in the format YYYY-MM-DD.
-     */
-    endDate?: string;
-
-    /** The id of the tweet, after which the tweets are to be searched. */
-    sinceId?: string;
-
-    /** The id of the tweet which is quoted in the tweets to search. */
-    quoted?: string;
-
-    /** Whether to fetch tweets that are links or not.
-     * 
-     * @defaultValue false
-     */
-    links?: boolean;
-};
-
-/**
- * The different types parsed entities like urls, media, mentions, hashtags, etc.
- * 
- * @public
- */
-export interface TweetEntities {
-    /** The list of hashtags mentioned in the tweet. */
-    hashtags: string[];
-
-    /** The list of urls mentioned in the tweet. */
-    urls: string[];
-
-    /** The list of IDs of users mentioned in the tweet. */
-    mentionedUsers: string[];
-
-    /** The list of urls to various media mentioned in the tweet. */
-    media: string[];
-}
-
-/**
- * The details of a single Tweet.
- */
-export interface Tweet {
-    /** The rest id of the tweet. */
-    id: string;
-
-    /** The rest id of the user who made the tweet. */
-    tweetBy: string;
-
-    /** The date and time of creation of the tweet, in UTC string format. */
-    createdAt: string;
-
-    /** Additional tweet entities like urls, mentions, etc. */
-    entities: TweetEntities;
-
-    /** The rest id of the tweet which is quoted in the tweet. */
-    quoted: string;
-
-    /** The full text content of the tweet. */
-    fullText: string;
-
-    /** The rest id of the user to which the tweet is a reply. */
-    replyTo: string;
-
-    /** The language in which the tweet is written. */
-    lang: string;
-
-    /** The number of quotes of the tweet. */
-    quoteCount: number;
-
-    /** The number of replies to the tweet. */
-    replyCount: number;
-
-    /** The number of retweets of the tweet. */
-    retweetCount: number;
-
-    /** The number of likes of the tweet. */
-    likeCount: number;
-}

package/src/types/raw/auth/Cookie.ts

@@ -1,16 +0,0 @@
-/**
- * @summary Stores a single raw cookie
- */
-export default interface Cookie {
-    guest_id_marketing: string,
-    guest_id_ads: string,
-    personalization_id: string,
-    guest_id: string,
-    gt: string,
-    _twitter_sess: string,
-    kdt: string,
-    auth_token: string,
-    ct0: string,
-    att: string,
-    twid: string
-}