rettiwt-api 1.1.8 → 1.2.0

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;
+}