rettiwt-api 1.4.0 → 2.0.0

package/src/graphql/types/UserTypes.ts

@@ -1,134 +0,0 @@
-// PACKAGE
-import { GraphQLBoolean, GraphQLObjectType, GraphQLString, GraphQLInt, GraphQLList, GraphQLUnionType, GraphQLType } from 'graphql';
-
-// TYPES
-import { Tweet, TweetList } from './TweetTypes'
-import { Cursor } from './Global';
-
-// RESOLVERS
-import UserResolver from '../resolvers/UserResolver';
-import TweetResolver from '../resolvers/TweetResolver';
-
-export const User: GraphQLObjectType = new GraphQLObjectType({
-    name: 'User',
-    description: 'The details of a single target twitter user',
-    fields: () => ({
-        id: { type: GraphQLString },
-        userName: { type: GraphQLString },
-        fullName: { type: GraphQLString },
-        createdAt: { type: GraphQLString },
-        description: { type: GraphQLString },
-        isVerified: { type: GraphQLBoolean },
-        location: { type: GraphQLString },
-        pinnedTweet: {
-            type: Tweet,
-            resolve: (parent, args, context) => (parent.pinnedTweet) ? new TweetResolver(context).resolveTweet(parent.pinnedTweet) : undefined
-        },
-        profileBanner: { type: GraphQLString },
-        profileImage: { type: GraphQLString },
-        favouritesCount: { type: GraphQLInt },
-        likes: {
-            type: TweetList,
-            args: {
-                count: {
-                    description: "The number of liked tweets to fetch, must be >= 40 (when no cursor if provided)",
-                    type: GraphQLInt,
-                    defaultValue: 10
-                },
-                all: {
-                    description: "Whether to fetch all tweets liked by user",
-                    type: GraphQLBoolean,
-                    defaultValue: false
-                },
-                cursor: {
-                    type: GraphQLString,
-                    description: 'The cursor to the batch of likes list to fetch',
-                    defaultValue: ''
-                }
-            },
-            resolve: (parent, args, context) => new UserResolver(context).resolveUserLikes(parent.id, args.count, args.all, args.cursor, parent.favouritesCount)
-        },
-        followersCount: { type: GraphQLInt },
-        followers: {
-            type: UserList,
-            args: {
-                count: {
-                    description: "The number of followers to fetch, must be >= 40 (when no cursor is provided)",
-                    type: GraphQLInt,
-                    defaultValue: 40
-                },
-                all: {
-                    description: "Whether to fetch all followers list",
-                    type: GraphQLBoolean,
-                    defaultValue: false
-                },
-                cursor: {
-                    type: GraphQLString,
-                    description: 'The cursor to the batch of followers list to fetch',
-                    defaultValue: ''
-                }
-            },
-            resolve: (parent, args, context) => new UserResolver(context).resolveUserFollowers(parent.id, args.count, args.all, args.cursor, parent.followersCount)
-        },
-        followingsCount: { type: GraphQLInt },
-        following: {
-            type: UserList,
-            args: {
-                count: {
-                    type: GraphQLInt,
-                    description: "The number of followings to fetch, must be >= 40 (when no cursor is provided)",
-                    defaultValue: 40
-                },
-                all: {
-                    description: "Whether to fetch all followings list",
-                    type: GraphQLBoolean,
-                    defaultValue: false
-                },
-                cursor: {
-                    type: GraphQLString,
-                    description: 'The cursor to the batch of followers list to fetch',
-                    defaultValue: ''
-                }
-            },
-            resolve: (parent, args, context) => new UserResolver(context).resolveUserFollowing(parent.id, args.count, args.all, args.cursor, parent.followingsCount)
-        },
-        statusesCount: { type: GraphQLInt },
-        tweets: {
-            type: TweetList,
-            args: {
-                count: {
-                    description: "The number of tweets to fetch, must be >= 1",
-                    type: GraphQLInt,
-                    defaultValue: 10
-                },
-                all: {
-                    description: "Whether to fetch all tweets made by user",
-                    type: GraphQLBoolean,
-                    defaultValue: false
-                },
-                cursor: {
-                    type: GraphQLString,
-                    description: 'The cursor to the batch of tweets list to fetch',
-                    defaultValue: ''
-                }
-            },
-            resolve: (parent, args, context) => new UserResolver(context).resolveUserTweets(parent.userName, args.count, args.all, args.cursor, parent.statusesCount)
-        }
-    })
-});
-
-export const UserList: GraphQLList<GraphQLType> = new GraphQLList(new GraphQLUnionType({
-    name: 'UserCursorUnion',
-    description: 'A union type which can either be a User or a Cursor, used in cursored User lists',
-    types: [User, Cursor],
-    resolveType: (data) => {
-        // If it has a userName field => this is a User object
-        if (data.userName) {
-            return User;
-        }
-        // If it has a value field => this is a Cursor object
-        else if (data.value) {
-            return Cursor;
-        }
-    }
-}));

package/src/models/args/TweetListArgs.ts

@@ -1,47 +0,0 @@
-// PACKAGES
-import { IsInt, IsString, IsOptional, Min, validateSync, Max, ValidateIf } from 'class-validator';
-import { DataValidationError } from 'rettiwt-core';
-
-// TYPES
-import { IListArgs } from '../../types/Args';
-
-/**
- * The arguments for fetching cursored list in TweetService.
- * 
- * @internal
- */
-export class TweetListArgs implements IListArgs {
-    /** The number of data items to fetch.
-     * 
-     * @defaultValue 10
-     * @remarks Must be >= 10 and <= 100
-     */
-    @IsInt()
-    @IsOptional()
-    @Max(100)
-    @ValidateIf(ob => ob.cursor.length == 0)
-    @Min(10)
-    count: number;
-
-    /** The cursor to the batch of data to fetch. */
-    @IsString()
-    @IsOptional()
-    cursor: string;
-
-    /**
-     * @param count The number of data items to fetch.
-     * @param cursor The cursor to the batch of data to fetch.
-     */
-    constructor(count: number = 10, cursor: string = '') {
-        this.count = count;
-        this.cursor = cursor;
-
-        // Validating the arguments
-        const validationResult = validateSync(this);
-
-        // If valiation error occured
-        if (validationResult.length) {
-            throw new DataValidationError(validationResult);
-        }
-    }
-}

package/src/models/args/UserListArgs.ts

@@ -1,47 +0,0 @@
-// PACKAGES
-import { IsInt, IsString, IsOptional, Min, validateSync, Max, ValidateIf } from 'class-validator';
-import { DataValidationError } from 'rettiwt-core';
-
-// TYPES
-import { IListArgs } from '../../types/Args';
-
-/**
- * The arguments for fetching cursored list in TweetService.
- * 
- * @internal
- */
-export class UserListArgs implements IListArgs {
-    /** The number of data items to fetch.
-     * 
-     * @defaultValue 40
-     * @remarks Must be >= 40 and <= 100
-     */
-    @IsInt()
-    @IsOptional()
-    @Max(100)
-    @ValidateIf(ob => ob.cursor.length == 0)
-    @Min(40)
-    count: number;
-
-    /** The cursor to the batch of data to fetch. */
-    @IsString()
-    @IsOptional()
-    cursor: string;
-
-    /**
-     * @param count The number of data items to fetch.
-     * @param cursor The cursor to the batch of data to fetch.
-     */
-    constructor(count: number = 40, cursor: string = '') {
-        this.count = count;
-        this.cursor = cursor;
-
-        // Validating the arguments
-        const validationResult = validateSync(this);
-
-        // If valiation error occured
-        if (validationResult.length) {
-            throw new DataValidationError(validationResult);
-        }
-    }
-}

package/src/models/auth/AuthCookie.ts

@@ -1,43 +0,0 @@
-// TYPES
-import { IAuthCookie } from '../../types/Authentication';
-
-/**
- * The cookie containing the tokens that are used to authenticate against Twitter.
- * 
- * @internal
- */
-export class AuthCookie implements 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;
-
-    constructor(cookie?: IAuthCookie) {
-        this.auth_token = cookie?.auth_token ?? '';
-        this.ct0 = cookie?.ct0 ?? '';
-        this.kdt = cookie?.kdt ?? '';
-        this.twid = cookie?.twid ?? '';
-    }
-
-    /**
-     * @returns The string respresentation of this cookie in the valid cookie string format.
-     */
-    toString(): string {
-        /** The string representation of this cookie. */
-        let cookieString: string = '';
-        
-        // Iterating through the (key, value) pairs of this cookie
-        for (let [key, value] of Object.entries(this)) {
-            cookieString += `${key}=${value};`;
-        }
-
-        return cookieString;
-    }
-}

package/src/models/data/CursoredData.ts

@@ -1,45 +0,0 @@
-// TYPES
-import { ICursor,ICursoredData } from "../../types/Service";
-
-/**
- * The cursor to the batch of data to be fetched.
- * 
- * @internal
- */
-export class Cursor implements ICursor {
-    /** The cursor string. */
-    value: string;
-
-    /**
-     * 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.
- * 
- * @internal
- * 
- * @typeParam Type - The type of data present in the list.
- */
-export class CursoredData<T> implements ICursoredData<T> {
-    /** The list of data of the given type. */
-    list: T[];
-
-    /** The cursor to the next batch of data. */
-    next: Cursor;
-
-    /**
-     * @param list The list of data item to store.
-     * @param next The cursor to the next batch of data.
-     */
-    constructor(list: T[] = [], next: string = '') {
-        this.list = list;
-        this.next = new Cursor(next);
-    }
-}

package/src/models/data/Tweet.ts

@@ -1,118 +0,0 @@
-// TYPES
-import { ITweet, ITweetEntities } from '../../types/Tweet';
-import { ITweet as IRawTweet, IEntities as IRawTweetEntities } from 'rettiwt-core';
-
-// PARSERS
-import * as Parsers from '../../services/helper/Parser';
-
-/**
- * The different types parsed entities like urls, media, mentions, hashtags, etc.
- * 
- * @internal
- */
-export class TweetEntities implements ITweetEntities {
-    // MEMBER DATA
-    /** 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[] = [];
-
-    // MEMBER METHODS
-    constructor(entities: IRawTweetEntities) {
-        // Extracting user mentions
-        if (entities.user_mentions) {
-            for (let user of entities.user_mentions) {
-                this.mentionedUsers.push(user.id_str);
-            }
-        }
-
-        // Extracting urls
-        if (entities.urls) {
-            for (let url of entities.urls) {
-                this.urls.push(url.expanded_url);
-            }
-        }
-
-        // Extracting hashtags
-        if (entities.hashtags) {
-            for (let hashtag of entities.hashtags) {
-                this.hashtags.push(hashtag.text);
-            }
-        }
-
-        // Extracting media urls (if any)
-        if (entities.media) {
-            for (const media of entities.media) {
-                this.media.push(media.media_url_https);
-            }
-        }
-    }
-}
-
-/**
- * The details of a single Tweet.
- * 
- * @internal
- */
-export class Tweet implements ITweet {
-    /** 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;
-
-    /**
-     * @param tweet The raw tweet data.
-     */
-    constructor(tweet: IRawTweet) {
-        this.id = tweet.rest_id;
-        this.createdAt = tweet.legacy.created_at;
-        this.tweetBy = tweet.legacy.user_id_str;
-        this.entities = new TweetEntities(tweet.legacy.entities);
-        this.quoted = tweet.legacy.quoted_status_id_str;
-        this.fullText = Parsers.normalizeText(tweet.legacy.full_text);
-        this.replyTo = tweet.legacy.in_reply_to_status_id_str;
-        this.lang = tweet.legacy.lang;
-        this.quoteCount = tweet.legacy.quote_count;
-        this.replyCount = tweet.legacy.reply_count;
-        this.retweetCount = tweet.legacy.retweet_count;
-        this.likeCount = tweet.legacy.favorite_count;
-    }
-}

package/src/models/data/User.ts

@@ -1,72 +0,0 @@
-// TYPES
-import { IUser } from '../../types/User';
-import { IUser as IRawUser } from 'rettiwt-core';
-
-/**
- * The details of a single user.
- * 
- * @internal
- */
-export class User implements IUser {
-    /** The rest id of the user. */
-    id: string;
-
-    /** The username/screenname of the user. */
-    userName: string;
-
-    /** The full name of the user. */
-    fullName: string;
-
-    /** The creation date of user's account. */
-    createdAt: string;
-
-    /** The user's description. */
-    description: string;
-
-    /** Whether the account is verified or not. */
-    isVerified: boolean;
-
-    /** The number of tweets liked by the user. */
-    favouritesCount: number;
-
-    /** The number of followers of the user. */
-    followersCount: number;
-
-    /** The number of following of the user. */
-    followingsCount: number;
-
-    /** The number of tweets made by the user. */
-    statusesCount: number;
-
-    /** The location of user as provided by user. */
-    location: string;
-
-    /** The rest id of the tweet pinned in the user's profile. */
-    pinnedTweet: string;
-
-    /** The url of the profile banner image. */
-    profileBanner: string;
-
-    /** The url of the profile image. */
-    profileImage: string;
-
-    /**
-     * @param user The raw user data.
-     */
-    constructor(user: IRawUser) {
-        this.id = user.rest_id;
-        this.userName = user.legacy.screen_name;
-        this.fullName = user.legacy.name;
-        this.createdAt = user.legacy.created_at;
-        this.description = user.legacy.description;
-        this.isVerified = user.legacy.verified;
-        this.favouritesCount = user.legacy.favourites_count;
-        this.followersCount = user.legacy.followers_count;
-        this.followingsCount = user.legacy.friends_count;
-        this.statusesCount = user.legacy.statuses_count;
-        this.location = user.legacy.location;
-        this.pinnedTweet = user.legacy.pinned_tweet_ids_str[0];
-        this.profileBanner = user.legacy.profile_banner_url;
-        this.profileImage = user.legacy.profile_image_url_https;
-    }
-}

package/src/server.ts

@@ -1,37 +0,0 @@
-// PACKAGE
-import express from 'express';
-import { graphqlHTTP } from 'express-graphql';
-import { GraphQLSchema } from 'graphql';
-import 'reflect-metadata';
-
-// SERVICES
-import { Rettiwt } from '.';
-
-// SCHEMA
-import { rootQuery } from './graphql/queries/RootQuery';
-
-// CONFIGS
-import { config } from './config/env';
-
-// Initialising express instance
-const app = express();
-
-// Setting up graphql endpoint
-app.use('/graphql', graphqlHTTP(req => ({
-    schema: new GraphQLSchema({
-        query: rootQuery
-    }),
-    context: Rettiwt({
-        auth_token: req.headers['auth_token'] as string,
-        ct0: req.headers['ct0'] as string,
-        kdt: req.headers['kdt'] as string,
-        twid: req.headers['twid'] as string,
-    }),
-    // If app is running in development environment, enable graphiql
-    graphiql: config.is_development
-})));
-
-// Setting up express server
-app.listen(config.port, async () => {
-    console.log(`Listening on port ${config.port}`);
-});