@the-convocation/twitter-scraper 0.0.8

package/dist/types/profile.d.ts

@@ -0,0 +1,67 @@
+import { RequestApiResult } from './api';
+import { TwitterGuestAuth } from './auth';
+export interface LegacyUserRaw {
+    created_at?: string;
+    description?: string;
+    entities?: {
+        url?: {
+            urls?: {
+                expanded_url?: string;
+            }[];
+        };
+    };
+    favourites_count?: number;
+    followers_count?: number;
+    friends_count?: number;
+    id_str?: string;
+    listed_count?: number;
+    name?: string;
+    location: string;
+    pinned_tweet_ids_str?: string[];
+    profile_banner_url?: string;
+    profile_image_url_https?: string;
+    protected?: boolean;
+    screen_name?: string;
+    statuses_count?: number;
+    verified?: boolean;
+}
+/**
+ * A parsed profile object.
+ */
+export interface Profile {
+    avatar?: string;
+    banner?: string;
+    biography?: string;
+    birthday?: string;
+    followersCount?: number;
+    followingCount?: number;
+    friendsCount?: number;
+    isPrivate?: boolean;
+    isVerified?: boolean;
+    joined?: Date;
+    likesCount?: number;
+    listedCount?: number;
+    location: string;
+    name?: string;
+    pinnedTweetIds?: string[];
+    tweetsCount?: number;
+    url?: string;
+    userId?: string;
+    username?: string;
+    website?: string;
+}
+export interface UserRaw {
+    data: {
+        user: {
+            rest_id?: string;
+            legacy: LegacyUserRaw;
+        };
+    };
+    errors?: {
+        message: string;
+    }[];
+}
+export declare function parseProfile(user: LegacyUserRaw): Profile;
+export declare function getProfile(username: string, auth: TwitterGuestAuth): Promise<RequestApiResult<Profile>>;
+export declare function getUserIdByScreenName(screenName: string, auth: TwitterGuestAuth): Promise<RequestApiResult<string>>;
+//# sourceMappingURL=profile.d.ts.map

package/dist/types/profile.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"profile.d.ts","sourceRoot":"","sources":["../../src/profile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAc,gBAAgB,EAAE,MAAM,OAAO,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAE1C,MAAM,WAAW,aAAa;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE;QACT,GAAG,CAAC,EAAE;YACJ,IAAI,CAAC,EAAE;gBACL,YAAY,CAAC,EAAE,MAAM,CAAC;aACvB,EAAE,CAAC;SACL,CAAC;KACH,CAAC;IACF,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,MAAM,CAAC,EAAE,IAAI,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,OAAO;IACtB,IAAI,EAAE;QACJ,IAAI,EAAE;YACJ,OAAO,CAAC,EAAE,MAAM,CAAC;YACjB,MAAM,EAAE,aAAa,CAAC;SACvB,CAAC;KACH,CAAC;IACF,MAAM,CAAC,EAAE;QACP,OAAO,EAAE,MAAM,CAAC;KACjB,EAAE,CAAC;CACL;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,aAAa,GAAG,OAAO,CA+BzD;AAED,wBAAsB,UAAU,CAC9B,QAAQ,EAAE,MAAM,EAChB,IAAI,EAAE,gBAAgB,GACrB,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC,CA0CpC;AAID,wBAAsB,qBAAqB,CACzC,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,gBAAgB,GACrB,OAAO,CAAC,gBAAgB,CAAC,MAAM,CAAC,CAAC,CAyBnC"}

package/dist/types/scraper.d.ts

@@ -0,0 +1,102 @@
+import { Profile } from './profile';
+import { SearchMode } from './search';
+import { QueryProfilesResponse, QueryTweetsResponse } from './timeline';
+import { Tweet } from './tweets';
+/**
+ * An interface to Twitter's undocumented API.
+ * Reusing Scraper objects is recommended to minimize the time spent authenticating unnecessarily.
+ */
+export declare class Scraper {
+    private auth;
+    private authTrends;
+    /**
+     * Creates a new Scraper object. Scrapers maintain their own guest tokens for Twitter's internal API.
+     * Reusing Scraper objects is recommended to minimize the time spent authenticating unnecessarily.
+     */
+    constructor();
+    /**
+     * Fetches a Twitter profile.
+     * @param username The Twitter username of the profile to fetch, without an `@` at the beginning.
+     * @returns The requested profile.
+     */
+    getProfile(username: string): Promise<Profile>;
+    /**
+     * Fetches the user ID corresponding to the provided screen name.
+     * @param screenName The Twitter screen name of the profile to fetch.
+     * @returns The ID of the corresponding account.
+     */
+    getUserIdByScreenName(screenName: string): Promise<string>;
+    /**
+     * Fetches tweets from Twitter.
+     * @param query The search query. Any Twitter-compatible query format can be used.
+     * @param maxTweets The maximum number of tweets to return.
+     * @param includeReplies Whether or not replies should be included in the response.
+     * @param searchMode The category filter to apply to the search. Defaults to `Top`.
+     * @returns An async generator of tweets matching the provided filters.
+     */
+    searchTweets(query: string, maxTweets: number, includeReplies: boolean, searchMode?: SearchMode): AsyncGenerator<Tweet>;
+    /**
+     * Fetches profiles from Twitter.
+     * @param query The search query. Any Twitter-compatible query format can be used.
+     * @param maxProfiles The maximum number of profiles to return.
+     * @returns An async generator of tweets matching the provided filters.
+     */
+    searchProfiles(query: string, maxProfiles: number): AsyncGenerator<Profile>;
+    /**
+     * Fetches tweets from Twitter.
+     * @param query The search query. Any Twitter-compatible query format can be used.
+     * @param maxTweets The maximum number of tweets to return.
+     * @param includeReplies Whether or not replies should be included in the response.
+     * @param searchMode The category filter to apply to the search. Defaults to `Top`.
+     * @param cursor The search cursor, which can be passed into further requests for more results.
+     * @returns A page of results, containing a cursor that can be used in further requests.
+     */
+    fetchSearchTweets(query: string, maxTweets: number, includeReplies: boolean, searchMode: SearchMode, cursor?: string): Promise<QueryTweetsResponse>;
+    /**
+     * Fetches profiles from Twitter.
+     * @param query The search query. Any Twitter-compatible query format can be used.
+     * @param maxProfiles The maximum number of profiles to return.
+     * @param cursor The search cursor, which can be passed into further requests for more results.
+     * @returns A page of results, containing a cursor that can be used in further requests.
+     */
+    fetchSearchProfiles(query: string, maxProfiles: number, cursor?: string): Promise<QueryProfilesResponse>;
+    /**
+     * Fetches the current trends from Twitter.
+     * @returns The current list of trends.
+     */
+    getTrends(): Promise<string[]>;
+    /**
+     * Fetches tweets from a Twitter user.
+     * @param user The user whose tweets should be returned.
+     * @param maxTweets The maximum number of tweets to return.
+     * @param includeReplies Whether or not to include tweet replies.
+     * @returns An async generator of tweets from the provided user.
+     */
+    getTweets(user: string, maxTweets: number, includeReplies: boolean): AsyncGenerator<Tweet>;
+    /**
+     * Fetches a single tweet.
+     * @param id The ID of the tweet to fetch.
+     * @param includeReplies Whether or not to include tweet replies.
+     * @returns The request tweet, or `null` if it couldn't be fetched.
+     */
+    getTweet(id: string, includeReplies: boolean): Promise<Tweet | null>;
+    /**
+     * 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`.
+     */
+    hasGuestToken(): boolean;
+    /**
+     * Sets the optional cookie to be used in requests.
+     * @param cookie The cookie to be used in requests.
+     * @returns This scraper instance.
+     */
+    withCookie(cookie: string): Scraper;
+    /**
+     * Sets the optional CSRF token to be used in requests.
+     * @param token The CSRF token to be used in requests.
+     * @returns This scraper instance.
+     */
+    withXCsrfToken(token: string): Scraper;
+    private handleResponse;
+}
+//# sourceMappingURL=scraper.d.ts.map

package/dist/types/scraper.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scraper.d.ts","sourceRoot":"","sources":["../../src/scraper.ts"],"names":[],"mappings":"AAEA,OAAO,EAAqC,OAAO,EAAE,MAAM,WAAW,CAAC;AACvE,OAAO,EAGL,UAAU,EAGX,MAAM,UAAU,CAAC;AAClB,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAExE,OAAO,EAAuB,KAAK,EAAE,MAAM,UAAU,CAAC;AAEtD;;;GAGG;AACH,qBAAa,OAAO;IAClB,OAAO,CAAC,IAAI,CAAmB;IAC/B,OAAO,CAAC,UAAU,CAAmB;IAErC;;;OAGG;;IAMH;;;;OAIG;IACU,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAK3D;;;;OAIG;IACU,qBAAqB,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAKvE;;;;;;;OAOG;IACI,YAAY,CACjB,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,OAAO,EACvB,UAAU,GAAE,UAA2B,GACtC,cAAc,CAAC,KAAK,CAAC;IAUxB;;;;;OAKG;IACI,cAAc,CACnB,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,GAClB,cAAc,CAAC,OAAO,CAAC;IAI1B;;;;;;;;OAQG;IACI,iBAAiB,CACtB,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,OAAO,EACvB,UAAU,EAAE,UAAU,EACtB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,mBAAmB,CAAC;IAW/B;;;;;;OAMG;IACI,mBAAmB,CACxB,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,EACnB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,qBAAqB,CAAC;IAIjC;;;OAGG;IACI,SAAS,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAIrC;;;;;;OAMG;IACI,SAAS,CACd,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,OAAO,GACtB,cAAc,CAAC,KAAK,CAAC;IAIxB;;;;;OAKG;IACI,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,cAAc,EAAE,OAAO,GAAG,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC;IAI3E;;;OAGG;IACI,aAAa,IAAI,OAAO;IAI/B;;;;OAIG;IACI,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO;IAM1C;;;;OAIG;IACI,cAAc,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO;IAM7C,OAAO,CAAC,cAAc;CAOvB"}

package/dist/types/search.d.ts

@@ -0,0 +1,19 @@
+import { TwitterGuestAuth } from './auth';
+import { Profile } from './profile';
+import { QueryProfilesResponse, QueryTweetsResponse } from './timeline';
+import { Tweet } from './tweets';
+/**
+ * The categories that can be used in Twitter searches.
+ */
+export declare enum SearchMode {
+    Top = 0,
+    Latest = 1,
+    Photos = 2,
+    Videos = 3,
+    Users = 4
+}
+export declare function searchTweets(query: string, maxTweets: number, includeReplies: boolean, searchMode: SearchMode, auth: TwitterGuestAuth): AsyncGenerator<Tweet>;
+export declare function searchProfiles(query: string, maxProfiles: number, auth: TwitterGuestAuth): AsyncGenerator<Profile>;
+export declare function fetchSearchTweets(query: string, maxTweets: number, includeReplies: boolean, searchMode: SearchMode, auth: TwitterGuestAuth, cursor?: string): Promise<QueryTweetsResponse>;
+export declare function fetchSearchProfiles(query: string, maxProfiles: number, auth: TwitterGuestAuth, cursor?: string): Promise<QueryProfilesResponse>;
+//# sourceMappingURL=search.d.ts.map

package/dist/types/search.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"search.d.ts","sourceRoot":"","sources":["../../src/search.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAC1C,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAGL,qBAAqB,EACrB,mBAAmB,EAEpB,MAAM,YAAY,CAAC;AAEpB,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEjC;;GAEG;AACH,oBAAY,UAAU;IACpB,GAAG,IAAA;IACH,MAAM,IAAA;IACN,MAAM,IAAA;IACN,MAAM,IAAA;IACN,KAAK,IAAA;CACN;AAED,wBAAgB,YAAY,CAC1B,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,OAAO,EACvB,UAAU,EAAE,UAAU,EACtB,IAAI,EAAE,gBAAgB,GACrB,cAAc,CAAC,KAAK,CAAC,CAIvB;AAED,wBAAgB,cAAc,CAC5B,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,gBAAgB,GACrB,cAAc,CAAC,OAAO,CAAC,CAIzB;AAED,wBAAsB,iBAAiB,CACrC,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,OAAO,EACvB,UAAU,EAAE,UAAU,EACtB,IAAI,EAAE,gBAAgB,EACtB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,mBAAmB,CAAC,CAW9B;AAED,wBAAsB,mBAAmB,CACvC,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,EACnB,IAAI,EAAE,gBAAgB,EACtB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,qBAAqB,CAAC,CAWhC"}

package/dist/types/timeline-async.d.ts

@@ -0,0 +1,15 @@
+import { Profile } from './profile';
+import { Tweet } from './tweets';
+export interface FetchProfilesResponse {
+    profiles: Profile[];
+    next?: string;
+}
+export declare type FetchProfiles = (query: string, maxProfiles: number, cursor: string | undefined) => Promise<FetchProfilesResponse>;
+export interface FetchTweetsResponse {
+    tweets: Tweet[];
+    next?: string;
+}
+export declare type FetchTweets = (query: string, maxTweets: number, cursor: string | undefined) => Promise<FetchTweetsResponse>;
+export declare function getUserTimeline(query: string, maxProfiles: number, fetchFunc: FetchProfiles): AsyncGenerator<Profile>;
+export declare function getTweetTimeline(query: string, maxTweets: number, fetchFunc: FetchTweets): AsyncGenerator<Tweet>;
+//# sourceMappingURL=timeline-async.d.ts.map

package/dist/types/timeline-async.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeline-async.d.ts","sourceRoot":"","sources":["../../src/timeline-async.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEjC,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,oBAAY,aAAa,GAAG,CAC1B,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,EACnB,MAAM,EAAE,MAAM,GAAG,SAAS,KACvB,OAAO,CAAC,qBAAqB,CAAC,CAAC;AAEpC,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,oBAAY,WAAW,GAAG,CACxB,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,MAAM,GAAG,SAAS,KACvB,OAAO,CAAC,mBAAmB,CAAC,CAAC;AAElC,wBAAuB,eAAe,CACpC,KAAK,EAAE,MAAM,EACb,WAAW,EAAE,MAAM,EACnB,SAAS,EAAE,aAAa,GACvB,cAAc,CAAC,OAAO,CAAC,CA2BzB;AAED,wBAAuB,gBAAgB,CACrC,KAAK,EAAE,MAAM,EACb,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,WAAW,GACrB,cAAc,CAAC,KAAK,CAAC,CA2BvB"}

package/dist/types/timeline.d.ts

@@ -0,0 +1,154 @@
+import { LegacyUserRaw, Profile } from './profile';
+import { PlaceRaw, Tweet } from './tweets';
+export interface Hashtag {
+    text?: string;
+}
+export interface TimelineMediaBasicRaw {
+    media_url_https?: string;
+    type?: string;
+    url?: string;
+}
+export interface TimelineUrlBasicRaw {
+    expanded_url?: string;
+    url?: string;
+}
+export interface ExtSensitiveMediaWarningRaw {
+    adult_content?: boolean;
+    graphic_violence?: boolean;
+    other?: boolean;
+}
+export interface VideoVariant {
+    bitrate?: number;
+    url?: string;
+}
+export interface VideoInfo {
+    variants?: VideoVariant[];
+}
+export interface TimelineMediaExtendedRaw {
+    id_str?: string;
+    media_url_https?: string;
+    ext_sensitive_media_warning?: ExtSensitiveMediaWarningRaw;
+    type?: string;
+    url?: string;
+    video_info?: VideoInfo;
+}
+export interface TimelineTweetRaw {
+    conversation_id_str?: string;
+    created_at?: string;
+    favorite_count?: number;
+    full_text?: string;
+    entities?: {
+        hashtags?: Hashtag[];
+        media?: TimelineMediaBasicRaw[];
+        urls?: TimelineUrlBasicRaw[];
+    };
+    extended_entities?: {
+        media?: TimelineMediaExtendedRaw[];
+    };
+    in_reply_to_status_id_str?: string;
+    place?: PlaceRaw;
+    reply_count?: number;
+    retweet_count?: number;
+    retweeted_status_id_str?: string;
+    quoted_status_id_str?: string;
+    time?: string;
+    user_id_str?: string;
+}
+export interface TimelineGlobalObjectsRaw {
+    tweets?: {
+        [key: string]: TimelineTweetRaw | undefined;
+    };
+    users?: {
+        [key: string]: LegacyUserRaw | undefined;
+    };
+}
+export interface TimelineDataRawCursor {
+    value?: string;
+    cursorType?: string;
+}
+export interface TimelineDataRawEntity {
+    id?: string;
+}
+export interface TimelineDataRawModuleItem {
+    clientEventInfo?: {
+        details?: {
+            guideDetails?: {
+                transparentGuideDetails?: {
+                    trendMetadata?: {
+                        trendName?: string;
+                    };
+                };
+            };
+        };
+    };
+}
+export interface TimelineDataRawAddEntry {
+    content?: {
+        item?: {
+            content?: {
+                tweet?: TimelineDataRawEntity;
+                user?: TimelineDataRawEntity;
+            };
+        };
+        operation?: {
+            cursor?: TimelineDataRawCursor;
+        };
+        timelineModule?: {
+            items?: {
+                item?: TimelineDataRawModuleItem;
+            }[];
+        };
+    };
+}
+export interface TimelineDataRawPinEntry {
+    content?: {
+        item?: {
+            content?: {
+                tweet?: TimelineDataRawEntity;
+            };
+        };
+    };
+}
+export interface TimelineDataRawReplaceEntry {
+    content?: {
+        operation?: {
+            cursor?: TimelineDataRawCursor;
+        };
+    };
+}
+export interface TimelineDataRawInstruction {
+    addEntries?: {
+        entries?: TimelineDataRawAddEntry[];
+    };
+    pinEntry?: {
+        entry?: TimelineDataRawPinEntry;
+    };
+    replaceEntry?: {
+        entry?: TimelineDataRawReplaceEntry;
+    };
+}
+export interface TimelineDataRaw {
+    instructions?: TimelineDataRawInstruction[];
+}
+export interface TimelineRaw {
+    globalObjects?: TimelineGlobalObjectsRaw;
+    timeline?: TimelineDataRaw;
+}
+export declare function parseTweet(timeline: TimelineRaw, id: string): Tweet | null;
+/**
+ * A paginated tweets API response. The `next` field can be used to fetch the next page of results.
+ */
+export interface QueryTweetsResponse {
+    tweets: Tweet[];
+    next?: string;
+}
+export declare function parseTweets(timeline: TimelineRaw): QueryTweetsResponse;
+/**
+ * A paginated profiles API response. The `next` field can be used to fetch the next page of results.
+ */
+export interface QueryProfilesResponse {
+    profiles: Profile[];
+    next?: string;
+}
+export declare function parseUsers(timeline: TimelineRaw): QueryProfilesResponse;
+//# sourceMappingURL=timeline.d.ts.map

package/dist/types/timeline.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"timeline.d.ts","sourceRoot":"","sources":["../../src/timeline.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAgB,OAAO,EAAE,MAAM,WAAW,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAS,MAAM,UAAU,CAAC;AAElD,MAAM,WAAW,OAAO;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,qBAAqB;IACpC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,mBAAmB;IAClC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,2BAA2B;IAC1C,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,EAAE,YAAY,EAAE,CAAC;CAC3B;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,2BAA2B,CAAC,EAAE,2BAA2B,CAAC;IAC1D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,SAAS,CAAC;CACxB;AAED,MAAM,WAAW,gBAAgB;IAC/B,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE;QACT,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAC;QACrB,KAAK,CAAC,EAAE,qBAAqB,EAAE,CAAC;QAChC,IAAI,CAAC,EAAE,mBAAmB,EAAE,CAAC;KAC9B,CAAC;IACF,iBAAiB,CAAC,EAAE;QAClB,KAAK,CAAC,EAAE,wBAAwB,EAAE,CAAC;KACpC,CAAC;IACF,yBAAyB,CAAC,EAAE,MAAM,CAAC;IACnC,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,uBAAuB,CAAC,EAAE,MAAM,CAAC;IACjC,oBAAoB,CAAC,EAAE,MAAM,CAAC;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,wBAAwB;IACvC,MAAM,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAAA;KAAE,CAAC;IACzD,KAAK,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAAA;KAAE,CAAC;CACtD;AAED,MAAM,WAAW,qBAAqB;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,CAAC,EAAE,MAAM,CAAC;CACb;AAED,MAAM,WAAW,yBAAyB;IACxC,eAAe,CAAC,EAAE;QAChB,OAAO,CAAC,EAAE;YACR,YAAY,CAAC,EAAE;gBACb,uBAAuB,CAAC,EAAE;oBACxB,aAAa,CAAC,EAAE;wBACd,SAAS,CAAC,EAAE,MAAM,CAAC;qBACpB,CAAC;iBACH,CAAC;aACH,CAAC;SACH,CAAC;KACH,CAAC;CACH;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE;YACL,OAAO,CAAC,EAAE;gBACR,KAAK,CAAC,EAAE,qBAAqB,CAAC;gBAC9B,IAAI,CAAC,EAAE,qBAAqB,CAAC;aAC9B,CAAC;SACH,CAAC;QACF,SAAS,CAAC,EAAE;YACV,MAAM,CAAC,EAAE,qBAAqB,CAAC;SAChC,CAAC;QACF,cAAc,CAAC,EAAE;YACf,KAAK,CAAC,EAAE;gBACN,IAAI,CAAC,EAAE,yBAAyB,CAAC;aAClC,EAAE,CAAC;SACL,CAAC;KACH,CAAC;CACH;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE;YACL,OAAO,CAAC,EAAE;gBACR,KAAK,CAAC,EAAE,qBAAqB,CAAC;aAC/B,CAAC;SACH,CAAC;KACH,CAAC;CACH;AAED,MAAM,WAAW,2BAA2B;IAC1C,OAAO,CAAC,EAAE;QACR,SAAS,CAAC,EAAE;YACV,MAAM,CAAC,EAAE,qBAAqB,CAAC;SAChC,CAAC;KACH,CAAC;CACH;AAED,MAAM,WAAW,0BAA0B;IACzC,UAAU,CAAC,EAAE;QACX,OAAO,CAAC,EAAE,uBAAuB,EAAE,CAAC;KACrC,CAAC;IACF,QAAQ,CAAC,EAAE;QACT,KAAK,CAAC,EAAE,uBAAuB,CAAC;KACjC,CAAC;IACF,YAAY,CAAC,EAAE;QACb,KAAK,CAAC,EAAE,2BAA2B,CAAC;KACrC,CAAC;CACH;AAED,MAAM,WAAW,eAAe;IAC9B,YAAY,CAAC,EAAE,0BAA0B,EAAE,CAAC;CAC7C;AAED,MAAM,WAAW,WAAW;IAC1B,aAAa,CAAC,EAAE,wBAAwB,CAAC;IACzC,QAAQ,CAAC,EAAE,eAAe,CAAC;CAC5B;AAMD,wBAAgB,UAAU,CAAC,QAAQ,EAAE,WAAW,EAAE,EAAE,EAAE,MAAM,GAAG,KAAK,GAAG,IAAI,CAgL1E;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,wBAAgB,WAAW,CAAC,QAAQ,EAAE,WAAW,GAAG,mBAAmB,CA2CtE;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,EAAE,OAAO,EAAE,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,wBAAgB,UAAU,CAAC,QAAQ,EAAE,WAAW,GAAG,qBAAqB,CAwCvE"}

package/dist/types/trends.d.ts

@@ -0,0 +1,3 @@
+import { TwitterGuestAuth } from './auth';
+export declare function getTrends(auth: TwitterGuestAuth): Promise<string[]>;
+//# sourceMappingURL=trends.d.ts.map

package/dist/types/trends.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trends.d.ts","sourceRoot":"","sources":["../../src/trends.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAG1C,wBAAsB,SAAS,CAAC,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CA0CzE"}

package/dist/types/tweets.d.ts

@@ -0,0 +1,52 @@
+import { TwitterGuestAuth } from './auth';
+import { QueryTweetsResponse } from './timeline';
+export interface Video {
+    id: string;
+    preview: string;
+    url?: string;
+}
+export interface PlaceRaw {
+    id?: string;
+    place_type?: string;
+    name?: string;
+    full_name?: string;
+    country_code?: string;
+    country?: string;
+    bounding_box?: {
+        type?: string;
+        coordinates?: number[][][];
+    };
+}
+/**
+ * A parsed Tweet object.
+ */
+export interface Tweet {
+    hashtags: string[];
+    html?: string;
+    id?: string;
+    inReplyToStatus?: Tweet;
+    isQuoted?: boolean;
+    isPin?: boolean;
+    isReply?: boolean;
+    isRetweet?: boolean;
+    likes?: number;
+    permanentUrl?: string;
+    photos: string[];
+    place?: PlaceRaw;
+    quotedStatus?: Tweet;
+    replies?: number;
+    retweets?: number;
+    retweetedStatus?: Tweet;
+    text?: string;
+    timeParsed?: Date;
+    timestamp?: number;
+    urls: string[];
+    userId?: string;
+    username?: string;
+    videos: Video[];
+    sensitiveContent?: boolean;
+}
+export declare function fetchTweets(user: string, maxTweets: number, includeReplies: boolean, cursor: string | undefined, auth: TwitterGuestAuth): Promise<QueryTweetsResponse>;
+export declare function getTweets(user: string, maxTweets: number, includeReplies: boolean, auth: TwitterGuestAuth): AsyncGenerator<Tweet>;
+export declare function getTweet(id: string, includeReplies: boolean, auth: TwitterGuestAuth): Promise<Tweet | null>;
+//# sourceMappingURL=tweets.d.ts.map

package/dist/types/tweets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tweets.d.ts","sourceRoot":"","sources":["../../src/tweets.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAE1C,OAAO,EAA4B,mBAAmB,EAAE,MAAM,YAAY,CAAC;AAG3E,MAAM,WAAW,KAAK;IACpB,EAAE,EAAE,MAAM,CAAC;IACX,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,QAAQ;IACvB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,YAAY,CAAC,EAAE;QACb,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC;KAC5B,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,eAAe,CAAC,EAAE,KAAK,CAAC;IACxB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,YAAY,CAAC,EAAE,KAAK,CAAC;IACrB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,KAAK,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,IAAI,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,wBAAsB,WAAW,CAC/B,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,OAAO,EACvB,MAAM,EAAE,MAAM,GAAG,SAAS,EAC1B,IAAI,EAAE,gBAAgB,GACrB,OAAO,CAAC,mBAAmB,CAAC,CA8B9B;AAED,wBAAgB,SAAS,CACvB,IAAI,EAAE,MAAM,EACZ,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,OAAO,EACvB,IAAI,EAAE,gBAAgB,GACrB,cAAc,CAAC,KAAK,CAAC,CAIvB;AAED,wBAAsB,QAAQ,CAC5B,EAAE,EAAE,MAAM,EACV,cAAc,EAAE,OAAO,EACvB,IAAI,EAAE,gBAAgB,GACrB,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CAoBvB"}

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@the-convocation/twitter-scraper",
+  "version": "0.0.8",
+  "main": "dist/scraper.js",
+  "repository": "https://github.com/the-convocation/twitter-scraper.git",
+  "author": "karashiiro <49822414+karashiiro@users.noreply.github.com>",
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "commit": "cz",
+    "docs:generate": "typedoc --entryPoints src --entryPointStrategy expand --exclude **/*.test.ts",
+    "docs:deploy": "yarn docs:generate && gh-pages -d docs",
+    "format": "prettier --write \\\"src/**/*.ts\\\" \\\"test/**/*.ts\\\"",
+    "prepare": "husky install",
+    "test": "jest"
+  },
+  "dependencies": {
+    "got": "^12.0.4",
+    "got-scraping": "^3.2.9",
+    "tslib": "^2.4.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^17.0.0",
+    "@commitlint/config-conventional": "^17.0.0",
+    "@types/jest": "^27.5.1",
+    "@typescript-eslint/eslint-plugin": "^5.24.0",
+    "@typescript-eslint/parser": "^5.24.0",
+    "cz-conventional-changelog": "^3.3.0",
+    "eslint": "^8.15.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "gh-pages": "^4.0.0",
+    "husky": "^8.0.1",
+    "jest": "^28.1.0",
+    "lint-staged": "^12.4.1",
+    "prettier": "^2.6.2",
+    "ts-jest": "^28.0.2",
+    "typedoc": "^0.22.15",
+    "typescript": "^4.6.4"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
+  "lint-staged": {
+    "*.{js,ts}": [
+      "eslint --cache --fix",
+      "prettier --write"
+    ]
+  }
+}