rettiwt-api 5.0.0-alpha.1 → 5.0.0-alpha.2

package/dist/types/{ReturnTypes.js → auth/TidHeader.js}

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=ReturnTypes.js.map
+//# sourceMappingURL=TidHeader.js.map

package/dist/types/auth/TidHeader.js.map

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

package/dist/types/auth/TidParams.d.ts

@@ -0,0 +1,27 @@
+/**
+ * The parameters for generating the transaction ID.
+ *
+ * @internal
+ */
+export interface ITidParams {
+    /** Secret used for transaction ID calculation. */
+    keyword: string;
+    /** Request method. */
+    method: string;
+    /** Endpoint path without query parameters. */
+    path: string;
+    /** Twitter verification key received from HTML. */
+    verificationKey: string;
+    /** Animation frames extracted from HTML. */
+    frames: number[][][];
+    /** Indices used for getting the correct verification key bytes during animation key calculation. */
+    indices: number[];
+    /** Final byte of the transaction ID. */
+    extraByte: number;
+    /** Current time */
+    time?: number;
+    /** XOR byte used for final hash calculation, must be in 0-255 range. */
+    xorByte?: number;
+    /** Precomputed animation key. */
+    animationKey?: string;
+}

package/dist/types/auth/TidParams.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=TidParams.js.map

package/dist/types/auth/TidParams.js.map

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

package/dist/types/auth/TidProvider.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Service responsible for generating the `x-client-transaction-id` header.
+ *
+ * @public
+ */
+export interface ITidProvider {
+    /**
+     * Generates new `x-client-transaction-id` header.
+     *
+     * @param method - Request method.
+     * @param path - Endpoint path without query parameters.
+     */
+    generate(method: string, path: string): Promise<string | undefined>;
+    /**
+     * Refresh arguments obtained from parsing the HTML page, if any.
+     */
+    refreshDynamicArgs(): Promise<void>;
+}

package/dist/types/auth/TidProvider.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=TidProvider.js.map

package/dist/types/auth/TidProvider.js.map

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

package/dist/types/data/CursoredData.d.ts

@@ -12,14 +12,5 @@ export interface ICursoredData<T extends INotification | ITweet | IUser> {
     /** The batch of data of the given type. */
     list: T[];
     /** The cursor to the next batch of data. */
-    next: ICursor;
-}
-/**
- * The cursor to the batch of data to fetch.
- *
- * @public
- */
-export interface ICursor {
-    /** The cursor string. */
-    value: string;
+    next: string;
 }

package/dist/types/data/Notification.d.ts

@@ -1,4 +1,4 @@
-import { ENotificationType } from '../../enums/Data';
+import { ENotificationType } from '../../enums/Notification';
 /**
  * The details of a single notification.
  *
@@ -12,7 +12,7 @@ export interface INotification {
     /** The text contents of the notification. */
     message: string;
     /** The date/time at which the notification was received. */
-    receivedAt: Date;
+    receivedAt: string;
     /** The list of id of the target tweet(s) of the notification. */
     target: string[];
     /** The type of notification. */

package/dist/types/data/Tweet.d.ts

@@ -1,4 +1,4 @@
-import { EMediaType } from 'rettiwt-core';
+import { EMediaType } from '../../enums/Media';
 import { IUser } from './User';
 /**
  * The details of a single tweet.
@@ -10,7 +10,7 @@ export interface ITweet {
     bookmarkCount: number;
     /** The ID of tweet which started the current conversation. */
     conversationId: string;
-    /** The date and time of creation of the tweet, in UTC string format. */
+    /** The creation date of the tweet. */
     createdAt: string;
     /** Additional tweet entities like urls, mentions, etc. */
     entities: ITweetEntities;

package/dist/types/params/Variables.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Media to be sent as payload.
+ *
+ * @internal
+ */
+export interface IMediaVariable {
+    media_entities: IMediaEntityVariable[];
+    possibly_sensitive: boolean;
+}
+/**
+ * Each media item in the media payload.
+ *
+ * @internal
+ */
+export interface IMediaEntityVariable {
+    media_id: string;
+    tagged_users: string[];
+}
+/**
+ * Reply specific details to be sent in payload.
+ *
+ * @internal
+ */
+export interface IReplyVariable {
+    exclude_reply_user_ids: string[];
+    in_reply_to_tweet_id: string;
+}

package/dist/types/params/Variables.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Variables.js.map

package/dist/types/params/Variables.js.map

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

package/dist/types/raw/base/Analytic.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Represents the raw data of the analytic result of the User.
+ *
+ * @public
+ */
+export interface IAnalytics {
+    __typename: string;
+    organic_metrics_time_series: IAnalyticsMetric[];
+    id: string;
+}
+export interface IAnalyticsMetric {
+    metric_value: IAnalyticsMetricValue[];
+    timestamp: IAnalyticsTimeStamp;
+}
+export interface IAnalyticsMetricValue {
+    metric_value: number;
+    metric_type: string;
+}
+export interface IAnalyticsTimeStamp {
+    iso8601_time: string;
+}

package/dist/types/raw/base/Analytic.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Analytic.js.map

package/dist/types/raw/base/Analytic.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Analytic.js","sourceRoot":"","sources":["../../../../src/types/raw/base/Analytic.ts"],"names":[],"mappings":";AAAA,oBAAoB"}

package/dist/types/raw/base/Cursor.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Represents a cursor object used for pagination.
+ *
+ * @public
+ */
+export interface ICursor {
+    entryType: string;
+    __typename: string;
+    value: string;
+    cursorType: string;
+}

package/dist/types/raw/base/Cursor.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Cursor.js.map

package/dist/types/raw/base/Cursor.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Cursor.js","sourceRoot":"","sources":["../../../../src/types/raw/base/Cursor.ts"],"names":[],"mappings":";AAAA,oBAAoB"}

package/dist/types/raw/base/LimitedVisibilityTweet.d.ts

@@ -0,0 +1,32 @@
+import { ITweet } from './Tweet';
+/**
+ * Represents the raw data of a single Tweet with limited visibility actions.
+ *
+ * @public
+ */
+export interface ILimitedVisibilityTweet {
+    __typename: string;
+    tweet: ITweet;
+    limitedActionResults: ITweetLimitedActionResults;
+}
+export interface ITweetLimitedActionResults {
+    limited_actions: ITweetLimitedAction[];
+}
+export interface ITweetLimitedAction {
+    action: string;
+    prompt: ILimitedActionPrompt;
+}
+export interface ILimitedActionPrompt {
+    __typename: string;
+    cta_type: string;
+    headline: IPromptHeadline;
+    subtext: IPromptSubtext;
+}
+export interface IPromptHeadline {
+    text: string;
+    entities: any[];
+}
+export interface IPromptSubtext {
+    text: string;
+    entities: any[];
+}

package/dist/types/raw/base/LimitedVisibilityTweet.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=LimitedVisibilityTweet.js.map

package/dist/types/raw/base/LimitedVisibilityTweet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LimitedVisibilityTweet.js","sourceRoot":"","sources":["../../../../src/types/raw/base/LimitedVisibilityTweet.ts"],"names":[],"mappings":";AAAA,oBAAoB"}

package/dist/types/raw/base/List.d.ts

@@ -0,0 +1,43 @@
+import { IDataResult } from '../composite/DataResult';
+import { IUser } from './User';
+/**
+ * Represents the raw data of a single List.
+ *
+ * @public
+ */
+export interface IList {
+    created_at: number;
+    default_banner_media: IDefaultBannerMedia;
+    default_banner_media_results: IDefaultBannerMediaResults;
+    description: string;
+    following: boolean;
+    id: string;
+    id_str: string;
+    is_member: boolean;
+    member_count: number;
+    mode: string;
+    muting: boolean;
+    name: string;
+    subscriber_count: number;
+    user_results: IDataResult<IUser>;
+    facepile_urls: string[];
+    followers_context: string;
+    members_context: string;
+}
+export interface IDefaultBannerMedia {
+    media_info: IBannerMediaInfo;
+}
+export interface IDefaultBannerMediaResults {
+    result: IBannerMediaResult;
+}
+export interface IBannerMediaResult {
+    id: string;
+    media_key: string;
+    media_id: string;
+    media_info: IBannerMediaInfo;
+}
+export interface IBannerMediaInfo {
+    original_img_url: string;
+    original_img_width: number;
+    original_img_height: number;
+}

package/dist/types/raw/base/List.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=List.js.map

package/dist/types/raw/base/List.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"List.js","sourceRoot":"","sources":["../../../../src/types/raw/base/List.ts"],"names":[],"mappings":";AAAA,oBAAoB"}

package/dist/types/raw/base/Media.d.ts

@@ -0,0 +1,43 @@
+import { ERawMediaType } from '../../../enums/raw/Media';
+/**
+ * Represents the raw data of a single Media.
+ *
+ * @public
+ */
+export interface IMedia {
+    display_url: string;
+    expanded_url: string;
+    id_str: string;
+    media_url_https: string;
+    type: ERawMediaType;
+    url: string;
+}
+export interface IExtendedMedia extends IMedia {
+    media_key: string;
+    ext_media_availability: IMediaAvailability;
+    additional_media_info?: IAdditionalMediaInfo;
+    mediaStats?: IMediaStats;
+    video_info?: IVideoInfo;
+}
+export interface IMediaAvailability {
+    status: string;
+}
+export interface IAdditionalMediaInfo {
+    monetizable: boolean;
+}
+export interface IMediaStats {
+    viewCount: number;
+}
+export interface IMediaAvailability {
+    status: string;
+}
+export interface IVideoInfo {
+    aspect_ratio: number[];
+    duration_millis: number;
+    variants: IVideoVariant[];
+}
+export interface IVideoVariant {
+    bitrate: number;
+    content_type: string;
+    url: string;
+}

package/dist/types/raw/base/Media.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Media.js.map

package/dist/types/raw/base/Media.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Media.js","sourceRoot":"","sources":["../../../../src/types/raw/base/Media.ts"],"names":[],"mappings":";AAAA,oBAAoB"}

package/dist/types/raw/base/Notification.d.ts

@@ -0,0 +1,53 @@
+import { ERawNotificationType } from '../../../enums/raw/Notification';
+/**
+ * Represents the raw data of a single Notification.
+ *
+ * @public
+ */
+export interface INotification {
+    id: string;
+    timestampMs: string;
+    icon: INotificationIcon;
+    message: INotificationMessage;
+    template: INotificationTemplate;
+}
+export interface INotificationIcon {
+    id: ERawNotificationType;
+}
+export interface INotificationMessage {
+    text: string;
+    entities: INotificationMessageEntity[];
+    rtl: boolean;
+}
+export interface INotificationMessageEntity {
+    fromIndex: number;
+    toIndex: number;
+    format: string;
+}
+export interface INotificationTemplate {
+    aggregateUserActionsV1: INotificationUserActions;
+}
+export interface INotificationUserActions {
+    targetObjects: INotificationTargetObject[];
+    fromUsers: INotificationFromUser[];
+    additionalContext: INotificationAdditionalContext;
+}
+export interface INotificationTargetObject {
+    tweet: INotificationTweet;
+}
+export interface INotificationTweet {
+    id: string;
+}
+export interface INotificationFromUser {
+    user: INotificationUser;
+}
+export interface INotificationUser {
+    id: string;
+}
+export interface INotificationAdditionalContext {
+    contextText: INotificationContextText;
+}
+export interface INotificationContextText {
+    text: string;
+    entities: any[];
+}

package/dist/types/raw/base/Notification.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Notification.js.map

package/dist/types/raw/base/Notification.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Notification.js","sourceRoot":"","sources":["../../../../src/types/raw/base/Notification.ts"],"names":[],"mappings":";AAAA,oBAAoB"}

package/dist/types/raw/base/Space.d.ts

@@ -0,0 +1,32 @@
+import { IDataResult } from '../composite/DataResult';
+import { IUser } from './User';
+import { ITweet } from './Tweet';
+/**
+ * Represents the raw data of a single Space.
+ *
+ * @public
+ */
+export interface ISpace {
+    rest_id: string;
+    state: string;
+    title: string;
+    media_key: string;
+    created_at: number;
+    started_at: number;
+    ended_at: string;
+    replay_start_time: number;
+    updated_at: number;
+    creator_results: IDataResult<IUser>;
+    conversation_controls: number;
+    disallow_join: boolean;
+    is_employee_only: boolean;
+    is_locked: boolean;
+    is_muted: boolean;
+    is_space_available_for_clipping: boolean;
+    is_space_available_for_replay: boolean;
+    narrow_cast_space_type: number;
+    no_incognito: boolean;
+    total_replay_watched: number;
+    total_live_listeners: number;
+    tweet_results: IDataResult<ITweet>;
+}

package/dist/types/raw/base/Space.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Space.js.map

package/dist/types/raw/base/Space.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Space.js","sourceRoot":"","sources":["../../../../src/types/raw/base/Space.ts"],"names":[],"mappings":";AAAA,oBAAoB"}

package/dist/types/raw/base/Tweet.d.ts

@@ -0,0 +1,119 @@
+import { IDataResult } from '../composite/DataResult';
+import { IUser } from './User';
+import { IMedia, IExtendedMedia } from './Media';
+import { ILimitedVisibilityTweet } from './LimitedVisibilityTweet';
+/**
+ * Represents the raw data of a single Tweet.
+ *
+ * @public
+ */
+export interface ITweet {
+    __typename: string;
+    rest_id: string;
+    core: ITweetCore;
+    edit_control: ITweetEditControl;
+    edit_perspective: ITweetEditPerspective;
+    is_translatable: boolean;
+    views: ITweetViews;
+    source: string;
+    quoted_status_result: IDataResult<ITweet | ILimitedVisibilityTweet>;
+    note_tweet: ITweetNote;
+    legacy: ITweetLegacy;
+    quick_promote_eligibility: ITweetQuickPromoteEligibilityInfo;
+}
+export interface ITweetCore {
+    user_results: IDataResult<IUser>;
+}
+export interface ITweetEditControl {
+    edit_tweet_ids: string[];
+    editable_until_msecs: string;
+    is_edit_eligible: boolean;
+    edits_remaining: string;
+}
+export interface ITweetEditPerspective {
+    favorited: boolean;
+    retweeted: boolean;
+}
+export interface ITweetViews {
+    count: string;
+    state: string;
+}
+export interface ITweetNote {
+    is_expandable: boolean;
+    note_tweet_results: ITweetNoteResults;
+}
+export interface ITweetNoteResults {
+    result: ITweetNoteResult;
+}
+export interface ITweetNoteResult {
+    id: string;
+    text: string;
+    entity_set: IEntities;
+    richtext: IRichtext;
+    media: ITweetNoteMedia;
+}
+export interface IRichtext {
+    richtext_tags: IRichtextTag[];
+}
+export interface IRichtextTag {
+    from_index: number;
+    to_index: number;
+    richtext_types: string[];
+}
+export interface ITweetNoteMedia {
+    inline_media: any[];
+}
+export interface ITweetLegacy {
+    bookmark_count: number;
+    bookmarked: boolean;
+    created_at: string;
+    conversation_id_str: string;
+    display_text_range: number[];
+    entities: IEntities;
+    extended_entities: IExtendedEntities;
+    favorite_count: number;
+    favorited: boolean;
+    full_text: string;
+    in_reply_to_status_id_str: string;
+    is_quote_status: boolean;
+    lang: string;
+    possibly_sensitive: boolean;
+    possibly_sensitive_editable: boolean;
+    quote_count: number;
+    quoted_status_id_str: string;
+    reply_count: number;
+    retweet_count: number;
+    retweeted: boolean;
+    user_id_str: string;
+    id_str: string;
+    retweeted_status_result: IDataResult<ITweet | ILimitedVisibilityTweet>;
+}
+export interface IEntities {
+    media: IMedia[];
+    user_mentions: IUserMention[];
+    urls: IUrl[];
+    hashtags: IHashtag[];
+    symbols: any[];
+}
+export interface IUserMention {
+    id_str: string;
+    name: string;
+    screen_name: string;
+    indices: number[];
+}
+export interface IUrl {
+    display_url: string;
+    expanded_url: string;
+    url: string;
+    indices: number[];
+}
+export interface IHashtag {
+    indices: number[];
+    text: string;
+}
+export interface IExtendedEntities {
+    media: IExtendedMedia[];
+}
+export interface ITweetQuickPromoteEligibilityInfo {
+    eligibility: string;
+}

package/dist/types/raw/base/Tweet.js

@@ -0,0 +1,4 @@
+"use strict";
+/* eslint-disable */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=Tweet.js.map

package/dist/types/raw/base/Tweet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Tweet.js","sourceRoot":"","sources":["../../../../src/types/raw/base/Tweet.ts"],"names":[],"mappings":";AAAA,oBAAoB"}