rettiwt-api 1.1.7 → 1.2.0

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

@@ -1,10 +1,10 @@
 // TYPES
 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';
-import RawLikers from '../../../types/raw/tweet/Favouriters';
+import RawTweet from '../../../twitter/types/tweet/Tweet';
+import RawTweets from '../../../twitter/types/tweet/Tweets';
+import RawRetweeters from '../../../twitter/types/tweet/Retweeters';
+import RawLikers from '../../../twitter/types/tweet/Favouriters';
 
 // PARSERS
 import * as Parsers from '../Parser';

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

@@ -1,11 +1,11 @@
 // TYPES
 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';
+import RawUser from '../../../twitter/types/user/User';
+import RawUserTweets from '../../../twitter/types/user/Tweets';
+import RawUserFollowers from '../../../twitter/types/user/Followers';
+import RawUserFollowing from '../../../twitter/types/user/Following';
+import RawUserLikes from '../../../twitter/types/user/Likes';
 
 // PARSERS
 import * as Parsers from '../Parser';

package/src/services/util/FetcherService.ts

@@ -10,8 +10,8 @@ import { Tweet } from '../../models/data/Tweet';
 import { User } from '../../models/data/User';
 
 // TYPES
-import { Result as RawUser } from '../../types/raw/user/User';
-import { Result as RawTweet } from '../../types/raw/tweet/Tweet';
+import { Result as RawUser } from '../../twitter/types/user/User';
+import { Result as RawTweet } from '../../twitter/types/tweet/Tweet';
 
 // ENUMS
 import { HttpStatus } from "../../enums/HTTP";
@@ -37,7 +37,7 @@ export enum HttpMethods {
 export class FetcherService {
     // MEMBER DATA
     /** The authentication service instance. */
-    private auth: AuthService;
+    protected auth: AuthService;
 
     /** The caching service instance. */
     private cache: CacheService;
@@ -71,7 +71,7 @@ export class FetcherService {
         if (res.statusCode != 200 && res.statusCode in HttpStatus) {
             throw new Error(HttpStatus[res.statusCode])
         }
-        
+
         return res;
     }
 

package/src/twitter/Url.ts

@@ -0,0 +1,37 @@
+// 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

@@ -0,0 +1,15 @@
+/**
+ * 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

@@ -0,0 +1,100 @@
+// 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

@@ -0,0 +1,21 @@
+// 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

@@ -0,0 +1,33 @@
+// 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

@@ -0,0 +1,73 @@
+// 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

@@ -0,0 +1,91 @@
+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;
+}