rettiwt-api 1.2.0 → 1.3.0

package/dist/twitter/types/user/Tweets.js

@@ -1,3 +0,0 @@
-"use strict";
-exports.__esModule = true;
-//# sourceMappingURL=Tweets.js.map

package/dist/twitter/types/user/Tweets.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Tweets.js","sourceRoot":"","sources":["../../../../src/twitter/types/user/Tweets.ts"],"names":[],"mappings":""}

package/dist/twitter/types/user/User.d.ts

@@ -1,117 +0,0 @@
-export default interface Root {
-    data: Data;
-}
-export interface Data {
-    user: User;
-}
-export interface User {
-    result: Result;
-}
-export interface Result {
-    __typename: string;
-    id: string;
-    rest_id: string;
-    affiliates_highlighted_label: AffiliatesHighlightedLabel;
-    has_nft_avatar: boolean;
-    legacy: Legacy;
-    smart_blocked_by: boolean;
-    smart_blocking: boolean;
-    super_follow_eligible: boolean;
-    super_followed_by: boolean;
-    super_following: boolean;
-    legacy_extended_profile: LegacyExtendedProfile;
-    is_profile_translatable: boolean;
-}
-export interface AffiliatesHighlightedLabel {
-}
-export interface Legacy {
-    blocked_by: boolean;
-    blocking: boolean;
-    can_dm: boolean;
-    can_media_tag: boolean;
-    created_at: string;
-    default_profile: boolean;
-    default_profile_image: boolean;
-    description: string;
-    entities: Entities;
-    fast_followers_count: number;
-    favourites_count: number;
-    follow_request_sent: boolean;
-    followed_by: boolean;
-    followers_count: number;
-    following: boolean;
-    friends_count: number;
-    has_custom_timelines: boolean;
-    is_translator: boolean;
-    listed_count: number;
-    location: string;
-    media_count: number;
-    muting: boolean;
-    name: string;
-    normal_followers_count: number;
-    notifications: boolean;
-    pinned_tweet_ids_str: any[];
-    possibly_sensitive: boolean;
-    profile_banner_extensions: ProfileBannerExtensions;
-    profile_banner_url: string;
-    profile_image_extensions: ProfileImageExtensions;
-    profile_image_url_https: string;
-    profile_interstitial_type: string;
-    protected: boolean;
-    screen_name: string;
-    statuses_count: number;
-    translator_type: string;
-    verified: boolean;
-    want_retweets: boolean;
-    withheld_in_countries: any[];
-}
-export interface Entities {
-    description: Description;
-}
-export interface Description {
-    urls: any[];
-}
-export interface ProfileBannerExtensions {
-    mediaColor: MediaColor;
-}
-export interface MediaColor {
-    r: R;
-}
-export interface R {
-    ok: Ok;
-}
-export interface Ok {
-    palette: Palette[];
-}
-export interface Palette {
-    percentage: number;
-    rgb: Rgb;
-}
-export interface Rgb {
-    blue: number;
-    green: number;
-    red: number;
-}
-export interface ProfileImageExtensions {
-    mediaColor: MediaColor2;
-}
-export interface MediaColor2 {
-    r: R2;
-}
-export interface R2 {
-    ok: Ok2;
-}
-export interface Ok2 {
-    palette: Palette2[];
-}
-export interface Palette2 {
-    percentage: number;
-    rgb: Rgb2;
-}
-export interface Rgb2 {
-    blue: number;
-    green: number;
-    red: number;
-}
-export interface LegacyExtendedProfile {
-}

package/dist/twitter/types/user/User.js

@@ -1,3 +0,0 @@
-"use strict";
-exports.__esModule = true;
-//# sourceMappingURL=User.js.map

package/dist/twitter/types/user/User.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"User.js","sourceRoot":"","sources":["../../../../src/twitter/types/user/User.ts"],"names":[],"mappings":""}

package/src/models/args/TweetFilter.ts

@@ -1,140 +0,0 @@
-// PACKAGE
-import { IsArray, IsBoolean, IsNumberString, IsString, IsOptional, IsDateString, validateSync } from 'class-validator';
-
-// TYPES
-import { ITweetFilter } from '../../types/Args';
-import { DataValidationError } from '../errors/DataValidationError';
-
-/**
- * The this to be used for fetching tweets from Twitter.
- * 
- * @internal
- */
-export class TweetFilter implements ITweetFilter {
-    /** The list of words to search. */
-    @IsArray()
-    @IsString({ each: true })
-    @IsOptional()
-    words?: string[];
-
-    /** The list of hashtags to search.
-     *
-     * @remarks
-     * '#' must be excluded from the hashtag!
-     */
-    @IsArray()
-    @IsString({ each: true })
-    @IsOptional()
-    hashtags?: string[];
-
-    /** The list of usernames whose tweets are to be searched.
-     *
-     * @remarks
-     * '@' must be excluded from the username!
-     */
-    @IsArray()
-    @IsString({ each: true })
-    @IsOptional()
-    fromUsers?: string[];
-
-    /** The list of username to whom the tweets to be searched, are adressed.
-     *
-     * @remarks
-     * '@' must be excluded from the username!
-     */
-    @IsArray()
-    @IsString({ each: true })
-    @IsOptional()
-    toUsers?: string[];
-
-    /** The list of username mentioned in the tweets to search.
-     *
-     * @remarks
-     * '@' must be excluded from the username!
-     */
-    @IsArray()
-    @IsString({ each: true })
-    @IsOptional()
-    mentions?: string[];
-
-    /** The date starting from which tweets are to be searched.
-     *
-     * @remarks
-     * Must be in the format YYYY-MM-DD.
-     */
-    @IsOptional()
-    @IsDateString()
-    startDate?: string;
-
-    /** The date upto which tweets are to be searched.
-     *
-     * @remarks
-     * Must be in the format YYYY-MM-DD.
-     */
-    @IsOptional()
-    @IsDateString()
-    endDate?: string;
-
-    /** The id of the tweet, after which the tweets are to be searched. */
-    @IsNumberString()
-    @IsOptional()
-    sinceId?: string;
-
-    /** The id of the tweet which is quoted in the tweets to search. */
-    @IsNumberString()
-    @IsOptional()
-    quoted?: string;
-
-    /** Whether to fetch tweets that are links or not.
-     *
-     * @defaultValue false
-     */
-    @IsBoolean()
-    @IsOptional()
-    links?: boolean;
-
-    /**
-     * @param this The incoming this in JSON format.
-     */
-    constructor(filter: TweetFilter) {
-        this.endDate = filter.endDate;
-        this.fromUsers = filter.fromUsers;
-        this.hashtags = filter.hashtags;
-        this.links = filter.links;
-        this.mentions = filter.mentions;
-        this.quoted = filter.quoted;
-        this.sinceId = filter.sinceId;
-        this.startDate = filter.startDate;
-        this.toUsers = filter.toUsers;
-        this.words = filter.words;
-
-        // Validating the this
-        const validationResult = validateSync(this);
-
-        // If valiation error occured
-        if (validationResult.length) {
-            throw new DataValidationError(validationResult);
-        }
-    }
-
-    /**
-     * Converts this object to it's string representation.
-     * 
-     * @returns 'this' object's string representation.
-     */
-    toString() {
-        return [
-            this.words ? this.words.join(' ') : '',
-            this.hashtags ? `(${this.hashtags.map(hashtag => '#' + hashtag).join(' OR ')})` : '',
-            this.fromUsers ? `(${this.fromUsers.map(user => `from:${user}`).join(' OR ')})` : '',
-            this.toUsers ? `(${this.toUsers.map(user => `to:${user}`).join(' OR ')})` : '',
-            this.mentions ? `(${this.mentions.map(mention => '@' + mention).join(' OR ')})` : '',
-            this.startDate ? `since:${this.startDate}` : '',
-            this.endDate ? `until:${this.endDate}` : '',
-            this.sinceId ? `since_id:${this.sinceId}` : '',
-            this.quoted ? `quoted_tweet_id:${this.quoted}` : ''
-        ]
-            .filter(item => item !== '()' && item !== '')
-            .join(' ') + (!this.links ? ' -this:links' : '');
-    }
-}

package/src/models/errors/DataValidationError.ts

@@ -1,29 +0,0 @@
-// PACKAGES
-import { ValidationError } from "class-validator";
-
-/**
- * Error when any fields of a JSON data fails to validate.
- * 
- * @internal
- * 
- * @param errorDetails The details of about the specific fields that failed to validate.
- */
-export class DataValidationError implements Error {
-    /** The name of the error. */
-    name: string;
-
-    /** The user-friendly error message. */
-    message: string;
-
-    /** The error data. */
-    data: ValidationError[];
-
-    /**
-     * @param data The error details.
-     */
-    constructor(errorDetails: ValidationError[]) {
-        this.name = 'ValidationError';
-        this.message = 'One or more validation errors occured. Refer to data for details';
-        this.data = errorDetails;
-    }
-}

package/src/twitter/Url.ts

@@ -1,37 +0,0 @@
-// ENUMS
-import { ResourceType } from "./enums/Resources";
-
-// PAYLOADS
-import { Args } from './payloads/Args';
-import { Query } from './params/Query';
-
-/**
- * A class that deals with generation of URLs to various resources on Twitter.
- */
-export class Url {
-    /** The base Twitter API url. */
-    private baseUrl: string = 'https://api.twitter.com';
-
-    /** The fully initialized target resource URL. */
-    public fullUrl: string;
-
-    /**
-     * Initializes a URL for fetching the specified resource, using the given arguments.
-     * 
-     * @param resourceType The type of resource to fetch.
-     * @param args Any additional arguments.
-     */
-    constructor(resourceType: ResourceType, args: Args) {
-        /**
-         * Initializing full URL along with additional URL parameters.
-         */
-        this.fullUrl = `${this.baseUrl}${resourceType}?${new Query(resourceType, args).toString()}`;
-    }
-
-    /**
-     * @returns The string representation of thi Url.
-     */
-    public toString(): string {
-        return this.fullUrl;
-    }
-}

package/src/twitter/enums/Resources.ts

@@ -1,15 +0,0 @@
-/**
- * The different types of resources that can be fetched.
- */
-export enum ResourceType {
-    'TWEETS' = '/2/search/adaptive.json',
-    'TWEET_DETAILS' = '/graphql/lXI2kaM2hgmbf7h42kpxuA/TweetDetail',
-    'TWEET_LIKES' = '/graphql/56ZwFC3Vui31fF8IYX8EGA/Favoriters',
-    'TWEET_RETWEETS' = '/graphql/Wd7DVeLqMj_JQiTL0tjJwQ/Retweeters',
-    'USER_DETAILS' = '/graphql/hVhfo_TquFTmgL7gYwf91Q/UserByScreenName',
-    'USER_DETAILS_BY_ID' = '/graphql/mi_IjXgFyr41N9zkszPz9w/UserByRestId',
-    'USER_TWEETS' = '/graphql/xxLjoOBBPpYBHbBTI-hevQ/UserTweetsAndReplies',
-    'USER_FOLLOWING' = '/graphql/mSnjZc5CTm2Z5Lu_i4XsPQ/Following',
-    'USER_FOLLOWERS' = '/graphql/nwlAnaw7oKXcVLi91ehy7Q/Followers',
-    'USER_LIKES' = '/graphql/gP4ZKghLd4tpILgS6VudAQ/Likes'
-};

package/src/twitter/params/Query.ts

@@ -1,100 +0,0 @@
-// PAYLOADS
-import { Variables } from '../payloads/Variables';
-import { Features } from '../payloads/Features';
-import { Args } from '../payloads/Args';
-
-// TYPES
-import { IQuery } from '../types/request/Query';
-
-// ENUMS
-import { ResourceType } from '../enums/Resources';
-
-/**
- * The URL query parameters that must be sent while making requests to Twitter API.
- */
-export class Query implements IQuery {
-    cards_platform?: string;
-    count?: number;
-    cursor?: string;
-    ext?: string;
-    include_blocked_by?: number;
-    include_blocking?: number;
-    include_can_dm?: number;
-    include_can_media_tag?: number;
-    include_cards?: number;
-    include_entities?: boolean = true;
-    include_ext_alt_text?: boolean;
-    include_ext_collab_control?: boolean;
-    include_ext_edit_control?: boolean;
-    include_ext_has_nft_avatar?: number;
-    include_ext_is_blue_verified?: number;
-    include_ext_limited_action_results?: boolean;
-    include_ext_media_availability?: boolean;
-    include_ext_media_color?: boolean;
-    include_ext_sensitive_media_warning?: boolean;
-    include_ext_trusted_friends_metadata?: boolean;
-    include_ext_verified_type?: number;
-    include_ext_views?: boolean;
-    include_followed_by?: number;
-    include_mute_edge?: number;
-    include_profile_interstitial_type?: number;
-    include_quote_count?: boolean = true;
-    include_reply_count?: number = 1;
-    include_user_entities?: boolean = true;
-    include_want_retweets?: number = 1;
-    pc?: number;
-    q?: string;
-    query_source?: string;
-    send_error_codes?: boolean;
-    simple_quoted_tweet?: boolean;
-    skip_status?: number;
-    spelling_corrections?: number;
-    tweet_mode?: string = 'extended';
-    tweet_search_mode?: string = 'live';
-
-    /**
-     * Variables for fetching data.
-     */
-    variables?: string;
-
-    /**
-     * Additional data features that must be fetched.
-     */
-    features?: string;
-
-    /**
-     * Initializes the URL parameters.
-     * 
-     * @param resourceType The type of resource requested.
-     * @param args Additional user-defined arguments to be sent in the request.
-     */
-    constructor(resourceType: ResourceType, args: Args) {
-        /**
-         * Only the endpoint for fetching tweets (using advanced search) requires the parameters defined in this class.
-         * All other endpoints required only 'variables' and 'features' fields.
-         */
-        if (resourceType == ResourceType.TWEETS) {
-            this.q = encodeURIComponent(args.query ?? '');
-            this.count = args.count;
-            this.cursor = args.cursor;
-        }
-        else {
-            this.variables = new Variables(resourceType, args).toString();
-            this.features = new Features().toString();
-        }
-    }
-
-    /**
-     * Converts this object to it's string representation.
-     * 
-     * @returns 'this' object's string representation;
-     */
-    toString(): string {
-        /**
-         * This first filters out all the empty paramters.
-         * Then it formats each parameter key value pair as 'key=value'.
-         * Then it joins the list of all formatted parameters using '&' as a separator.
-         */
-        return Object.entries(this).filter(([key, value]) => value).map(([key, value]) => `${key}=${value}`).join('&');
-    }
-}

package/src/twitter/payloads/Args.ts

@@ -1,21 +0,0 @@
-// TYPES
-import { IArgs } from '../types/request/Query';
-
-/**
- * The arguments for fetching cursored list.
- * 
- * @public
- */
-export class Args implements IArgs {
-    /** The query string that may be used to filter data. */
-    query?: string;
-
-    /** The rest id of the data item to be requested. */
-    id?: string;
-
-    /** The number of data items to fetch. */
-    count?: number;
-
-    /** The cursor to the batch of data to fetch. */
-    cursor?: string;
-};

package/src/twitter/payloads/Features.ts

@@ -1,33 +0,0 @@
-// TYPES
-import { IFeatures } from '../types/request/Query';
-
-/**
- * The additional features that may be fetched while making requests to Twitter API.
- */
-export class Features implements IFeatures {
-    graphql_is_translatable_rweb_tweet_is_translatable_enabled = false;
-    interactive_text_enabled = false;
-    longform_notetweets_consumption_enabled = false;
-    responsive_web_edit_tweet_api_enabled = false;
-    responsive_web_enhance_cards_enabled = false;
-    responsive_web_graphql_timeline_navigation_enabled = false;
-    responsive_web_text_conversations_enabled = false;
-    responsive_web_twitter_blue_verified_badge_is_enabled = false;
-    responsive_web_uc_gql_enabled = false;
-    standardized_nudges_misinfo = false;
-    tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled = false;
-    tweetypie_unmention_optimization_enabled = false;
-    verified_phone_label_enabled = false;
-    vibe_api_enabled = false;
-    view_counts_everywhere_api_enabled = false;
-    view_counts_public_visibility_enabled = false;
-
-    /**
-     * Converts this object to it's string representation.
-     * 
-     * @returns 'this' object's string representation.
-     */
-    toString(): string {
-        return `${encodeURIComponent(JSON.stringify(this))}`;
-    }
-}

package/src/twitter/payloads/Variables.ts

@@ -1,73 +0,0 @@
-// PAYLOADS
-import { Args } from './Args';
-
-// TYPES
-import { IVariables } from '../types/request/Query';
-
-// ENUMS
-import { ResourceType } from '../enums/Resources';
-
-/**
- * The variables that must be sent as payload while making requests to Twitter API.
- */
-export class Variables implements IVariables {
-    tweetId?: string;
-    focalTweetId?: string;
-    userId?: string;
-    screen_name?: string;
-    count?: number;
-    cursor?: string;
-    includePromotedContent: boolean = false;
-    referrer: string = '';
-    withBirdwatchNotes: boolean = false;
-    withCommunity: boolean = false;
-    withDownvotePerspective: boolean = false;
-    withQuickPromoteEligibilityTweetFields: boolean = false;
-    withReactionsMetadata: boolean = false;
-    withReactionsPerspective: boolean = false;
-    withSuperFollowsTweetFields: boolean = false;
-    withSuperFollowsUserFields: boolean = false;
-    withV2Timeline: boolean = true;
-    withVoice: boolean = false;
-    with_rux_injections: boolean = false;
-    withClientEventToken: boolean = false;
-
-    /**
-     * Initializes the appropriate Variables object based on the requred resource type and parameters.
-     * 
-     * @param resourceType The type of resource that is requested.
-     * @param args The additional user-defined arguments for fetching the resource.
-     */
-    constructor(resourceType: ResourceType, args: Args) {
-        if (resourceType == ResourceType.TWEET_DETAILS) {
-            this.focalTweetId = args.id;
-            this.count = args.count;
-            this.cursor = args.cursor;
-        }
-        else if (resourceType == ResourceType.TWEET_LIKES || resourceType == ResourceType.TWEET_RETWEETS) {
-            this.tweetId = args.id;
-            this.count = args.count;
-            this.cursor = args.cursor;
-        }
-        else if (resourceType == ResourceType.USER_DETAILS) {
-            this.screen_name = args.id;
-        }
-        else if (resourceType == ResourceType.USER_DETAILS_BY_ID) {
-            this.userId = args.id;
-        }
-        else if (resourceType == ResourceType.USER_FOLLOWERS || resourceType == ResourceType.USER_FOLLOWING || resourceType == ResourceType.USER_LIKES || resourceType == ResourceType.USER_TWEETS) {
-            this.userId = args.id;
-            this.count = args.count;
-            this.cursor = args.cursor;
-        }
-    }
-
-    /**
-     * Converts this object to it's string representation.
-     * 
-     * @returns 'this' object's string representation.
-     */
-    toString(): string {
-        return `${encodeURIComponent(JSON.stringify(this))}`;
-    }
-}

package/src/twitter/types/request/Query.ts

@@ -1,91 +0,0 @@
-export interface IArgs {
-	query?: string;
-	id?: string;
-	count?: number;
-	cursor?: string;
-};
-
-export interface IVariables {
-	tweetId?: string;
-	focalTweetId?: string;
-	userId?: string;
-	screen_name?: string;
-	count?: number;
-	cursor?: string;
-	includePromotedContent: boolean;
-	referrer: string;
-	withBirdwatchNotes: boolean;
-	withCommunity: boolean;
-	withDownvotePerspective: boolean;
-	withQuickPromoteEligibilityTweetFields: boolean;
-	withReactionsMetadata: boolean;
-	withReactionsPerspective: boolean;
-	withSuperFollowsTweetFields: boolean;
-	withSuperFollowsUserFields: boolean;
-	withV2Timeline: boolean;
-	withVoice: boolean;
-	with_rux_injections: boolean;
-	withClientEventToken: boolean;
-
-
-}
-
-export interface IFeatures {
-	graphql_is_translatable_rweb_tweet_is_translatable_enabled: boolean;
-	interactive_text_enabled: boolean;
-	longform_notetweets_consumption_enabled: boolean;
-	responsive_web_edit_tweet_api_enabled: boolean;
-	responsive_web_enhance_cards_enabled: boolean;
-	responsive_web_graphql_timeline_navigation_enabled: boolean;
-	responsive_web_text_conversations_enabled: boolean;
-	responsive_web_twitter_blue_verified_badge_is_enabled: boolean;
-	responsive_web_uc_gql_enabled: boolean;
-	standardized_nudges_misinfo: boolean;
-	tweet_with_visibility_results_prefer_gql_limited_actions_policy_enabled: boolean;
-	tweetypie_unmention_optimization_enabled: boolean;
-	verified_phone_label_enabled: boolean;
-	vibe_api_enabled: boolean;
-	view_counts_everywhere_api_enabled: boolean;
-	view_counts_public_visibility_enabled: boolean;
-}
-
-export interface IQuery {
-	cards_platform?: string;
-	count?: number;
-	cursor?: string;
-	ext?: string;
-	include_blocked_by?: number;
-	include_blocking?: number;
-	include_can_dm?: number;
-	include_can_media_tag?: number;
-	include_cards?: number;
-	include_entities?: boolean;
-	include_ext_alt_text?: boolean;
-	include_ext_collab_control?: boolean;
-	include_ext_edit_control?: boolean;
-	include_ext_has_nft_avatar?: number;
-	include_ext_is_blue_verified?: number;
-	include_ext_limited_action_results?: boolean;
-	include_ext_media_availability?: boolean;
-	include_ext_media_color?: boolean;
-	include_ext_sensitive_media_warning?: boolean;
-	include_ext_trusted_friends_metadata?: boolean;
-	include_ext_verified_type?: number;
-	include_ext_views?: boolean;
-	include_followed_by?: number;
-	include_mute_edge?: number;
-	include_profile_interstitial_type?: number;
-	include_quote_count?: boolean;
-	include_reply_count?: number;
-	include_user_entities?: boolean;
-	include_want_retweets?: number;
-	pc?: number;
-	q?: string;
-	query_source?: string;
-	send_error_codes?: boolean;
-	simple_quoted_tweet?: boolean;
-	skip_status?: number;
-	spelling_corrections?: number;
-	tweet_mode?: string;
-	tweet_search_mode?: string;
-}