@the-convocation/twitter-scraper 0.17.2 → 0.18.0

package/dist/types/index.d.ts

@@ -267,9 +267,15 @@ interface LegacyUserRaw {
     entities?: {
         url?: {
             urls?: {
+                url?: string;
                 expanded_url?: string;
+                display_url?: string;
+                indices?: [number, number];
             }[];
         };
+        description?: {
+            urls?: any[];
+        };
     };
     favourites_count?: number;
     followers_count?: number;
@@ -292,6 +298,39 @@ interface LegacyUserRaw {
     has_extended_profile?: boolean;
     url?: string;
     can_dm?: boolean;
+    id?: number;
+    utc_offset?: any;
+    time_zone?: any;
+    lang?: any;
+    contributors_enabled?: boolean;
+    is_translator?: boolean;
+    is_translation_enabled?: boolean;
+    profile_background_image_url?: string;
+    profile_background_image_url_https?: string;
+    profile_background_tile?: boolean;
+    profile_image_url?: string;
+    profile_link_color?: string;
+    profile_sidebar_border_color?: string;
+    profile_sidebar_fill_color?: string;
+    profile_text_color?: string;
+    profile_use_background_image?: boolean;
+    default_profile?: boolean;
+    default_profile_image?: boolean;
+    can_secret_dm?: boolean;
+    can_media_tag?: boolean;
+    following?: boolean;
+    follow_request_sent?: boolean;
+    notifications?: boolean;
+    blocking?: boolean;
+    subscribed_by?: boolean;
+    blocked_by?: boolean;
+    want_retweets?: boolean;
+    dm_blocked_by?: boolean;
+    dm_blocking?: boolean;
+    business_profile_state?: string;
+    translator_type?: string;
+    withheld_in_countries?: any[];
+    followed_by?: boolean;
 }
 /**
  * A parsed profile object.
@@ -323,6 +362,120 @@ interface Profile {
     canDm?: boolean;
 }
 
+interface DmInboxResponse {
+    inbox_initial_state: DmInbox;
+}
+interface DmInbox {
+    last_seen_event_id: string;
+    trusted_last_seen_event_id: string;
+    untrusted_last_seen_event_id: string;
+    cursor: string;
+    inbox_timelines: DmInboxTimelines;
+    entries: DmMessageEntry[];
+    users: {
+        [key: string]: LegacyUserRaw;
+    };
+    conversations: {
+        [key: string]: DmConversation;
+    };
+}
+interface DmConversationResponse {
+    conversation_timeline: DmConversationTimeline;
+}
+interface DmConversationTimeline {
+    status: DmStatus;
+    min_entry_id: string;
+    max_entry_id: string;
+    entries: DmMessageEntry[];
+    users: {
+        [key: string]: LegacyUserRaw;
+    };
+    conversations: {
+        [key: string]: DmConversation;
+    };
+}
+interface DmConversation {
+    conversation_id: string;
+    type: string;
+    sort_event_id: string;
+    sort_timestamp: string;
+    participants: DmParticipant[];
+    nsfw: boolean;
+    notifications_disabled: boolean;
+    mention_notifications_disabled: boolean;
+    last_read_event_id: string;
+    read_only: boolean;
+    trusted: boolean;
+    muted: boolean;
+    status: DmStatus;
+    min_entry_id: string;
+    max_entry_id: string;
+}
+type DmStatus = 'AT_END' | 'HAS_MORE';
+interface DmParticipant {
+    user_id: string;
+    last_read_event_id?: string;
+}
+interface DmMessageEntry {
+    welcome_message_create?: DmWelcomeMessage;
+    message?: DmMessage;
+}
+interface DmMessage {
+    id: string;
+    time: string;
+    affects_sort: boolean;
+    request_id: string;
+    conversation_id: string;
+    message_data: DmMessageData;
+    message_reactions: DmReaction[];
+}
+interface DmMessageData {
+    id: string;
+    time: string;
+    recipient_id: string;
+    sender_id: string;
+    text: string;
+    edit_count?: number;
+    entities?: DmMessageEntities;
+}
+interface DmReaction {
+    id: string;
+    time: string;
+    conversation_id: string;
+    message_id: string;
+    reaction_key: string;
+    emoji_reaction: string;
+    sender_id: string;
+}
+interface DmMessageEntities {
+    hashtags: any[];
+    symbols: any[];
+    user_mentions: any[];
+    urls: DmMessageUrl[];
+}
+interface DmMessageUrl {
+    url: string;
+    expanded_url: string;
+    display_url: string;
+    indices: number[];
+}
+interface DmWelcomeMessage extends DmMessage {
+    welcome_message_id: string;
+}
+interface DmInboxTimelines {
+    trusted: DmTimelineState;
+    untrusted: DmTimelineState;
+    untrusted_low_quality: DmTimelineState;
+}
+interface DmTimelineState {
+    status: DmStatus;
+    min_entry_id: string;
+}
+interface DmCursorOptions {
+    maxId?: string;
+    minId?: string;
+}
+
 interface Mention {
     id: string;
     username?: string;
@@ -749,6 +902,37 @@ declare class Scraper {
      * @returns The {@link Tweet} object, or `null` if it couldn't be fetched.
      */
     getTweet(id: string): Promise<Tweet | null>;
+    /**
+     * Retrieves the direct message inbox for the authenticated user.
+     *
+     * @return A promise that resolves to an object representing the direct message inbox.
+     */
+    getDmInbox(): Promise<DmInbox>;
+    /**
+     * Retrieves the direct message conversation for the specified conversation ID.
+     *
+     * @param conversationId - The unique identifier of the DM conversation to retrieve.
+     * @param cursor - Use `maxId` to get messages before a message ID (older messages), or `minId` to get messages after a message ID (newer messages).
+     * @return A promise that resolves to the timeline of the DM conversation.
+     */
+    getDmConversation(conversationId: string, cursor?: DmCursorOptions): Promise<DmConversationTimeline>;
+    /**
+     * Retrieves direct messages from a specific conversation.
+     *
+     * @param conversationId - The unique identifier of the conversation to fetch messages from.
+     * @param [maxMessages=20] - The maximum number of messages to retrieve per request.
+     * @param cursor - Use `maxId` to get messages before a message ID (older messages), or `minId` to get messages after a message ID (newer messages).
+     * @returns An {@link AsyncGenerator} of messages from the provided conversation.
+     */
+    getDmMessages(conversationId: string, maxMessages?: number, cursor?: DmCursorOptions): AsyncGenerator<DmMessageEntry, void>;
+    /**
+     * Retrieves a list of direct message conversations for a specific user based on their user ID.
+     *
+     * @param inbox - The DM inbox containing all available conversations.
+     * @param userId - The unique identifier of the user whose DM conversations are to be retrieved.
+     * @return An array of DM conversations associated with the specified user ID.
+     */
+    findDmConversationsByUserId(inbox: DmInbox, userId: string): DmConversation[];
     /**
      * Returns if the scraper has a guest token. The token may not be valid.
      * @returns `true` if the scraper has a guest token; otherwise `false`.
@@ -804,4 +988,4 @@ declare class Scraper {
     private handleResponse;
 }
 
-export { ApiError, AuthenticationError, ErrorRateLimitStrategy, type FetchParameters, type FetchTransformOptions, type FlowSubtaskHandler, type FlowSubtaskHandlerApi, type FlowTokenResult, type FlowTokenResultError, type FlowTokenResultSuccess, type Mention, type Photo, type PlaceRaw, type Profile, type QueryProfilesResponse, type QueryTweetsResponse, type RateLimitEvent, type RateLimitStrategy, Scraper, type ScraperOptions, SearchMode, type Tweet, type TweetQuery, type TwitterApiErrorExtensions, type TwitterApiErrorPosition, type TwitterApiErrorRaw, type TwitterApiErrorTraceInfo, type TwitterUserAuthCredentials, type TwitterUserAuthFlowInitRequest, type TwitterUserAuthFlowRequest, type TwitterUserAuthFlowResponse, type TwitterUserAuthFlowSubtaskRequest, type Video, WaitingRateLimitStrategy };
+export { ApiError, AuthenticationError, type DmConversation, type DmConversationResponse, type DmConversationTimeline, type DmInbox, type DmInboxResponse, type DmInboxTimelines, type DmMessage, type DmMessageData, type DmMessageEntities, type DmMessageEntry, type DmMessageUrl, type DmParticipant, type DmReaction, type DmStatus, type DmTimelineState, type DmWelcomeMessage, ErrorRateLimitStrategy, type FetchParameters, type FetchTransformOptions, type FlowSubtaskHandler, type FlowSubtaskHandlerApi, type FlowTokenResult, type FlowTokenResultError, type FlowTokenResultSuccess, type Mention, type Photo, type PlaceRaw, type Profile, type QueryProfilesResponse, type QueryTweetsResponse, type RateLimitEvent, type RateLimitStrategy, Scraper, type ScraperOptions, SearchMode, type Tweet, type TweetQuery, type TwitterApiErrorExtensions, type TwitterApiErrorPosition, type TwitterApiErrorRaw, type TwitterApiErrorTraceInfo, type TwitterUserAuthCredentials, type TwitterUserAuthFlowInitRequest, type TwitterUserAuthFlowRequest, type TwitterUserAuthFlowResponse, type TwitterUserAuthFlowSubtaskRequest, type Video, WaitingRateLimitStrategy };

package/package.json

@@ -7,7 +7,7 @@
     "scraper",
     "crawler"
   ],
-  "version": "0.17.2",
+  "version": "0.18.0",
   "main": "dist/default/cjs/index.js",
   "types": "./dist/types/index.d.ts",
   "exports": {