@the-convocation/twitter-scraper 0.0.9 → 0.1.1

package/dist/types/search.d.ts

@@ -1,19 +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>;
+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/timeline-async.d.ts

@@ -1,15 +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>;
+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.d.ts

@@ -1,154 +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;
+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/trends.d.ts

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

package/dist/types/tweets.d.ts

@@ -1,52 +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>;
+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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@the-convocation/twitter-scraper",
-  "version": "0.0.9",
+  "version": "0.1.1",
   "main": "dist/scraper.js",
   "repository": "https://github.com/the-convocation/twitter-scraper.git",
   "author": "karashiiro <49822414+karashiiro@users.noreply.github.com>",