@the-convocation/twitter-scraper 0.0.8 → 0.1.0

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.8",
+  "version": "0.1.0",
   "main": "dist/scraper.js",
   "repository": "https://github.com/the-convocation/twitter-scraper.git",
   "author": "karashiiro <49822414+karashiiro@users.noreply.github.com>",

package/.commitlintrc

@@ -1,5 +0,0 @@
-{
-  "extends": [
-    "@commitlint/config-conventional"
-  ]
-}

package/.eslintcache

@@ -1 +0,0 @@
-[{"D:\\Users\\luca\\Documents\\GitHub\\twitter-scraper\\gh-pages.js":"1","D:\\Users\\luca\\Documents\\GitHub\\twitter-scraper\\src\\api.ts":"2","D:\\Users\\luca\\Documents\\GitHub\\twitter-scraper\\src\\auth.ts":"3","D:\\Users\\luca\\Documents\\GitHub\\twitter-scraper\\src\\profile.ts":"4","D:\\Users\\luca\\Documents\\GitHub\\twitter-scraper\\src\\scraper.ts":"5","D:\\Users\\luca\\Documents\\GitHub\\twitter-scraper\\src\\search.ts":"6","D:\\Users\\luca\\Documents\\GitHub\\twitter-scraper\\src\\timeline.ts":"7","D:\\Users\\luca\\Documents\\GitHub\\twitter-scraper\\src\\trends.ts":"8","D:\\Users\\luca\\Documents\\GitHub\\twitter-scraper\\src\\tweets.ts":"9","D:\\Users\\luca\\Documents\\GitHub\\twitter-scraper\\src\\search.test.ts":"10","D:\\Users\\luca\\Documents\\GitHub\\twitter-scraper\\src\\trends.test.ts":"11"},{"size":214,"mtime":1653244686068,"results":"12","hashOfConfig":"13"},{"size":2684,"mtime":1653242281934,"results":"14","hashOfConfig":"13"},{"size":3541,"mtime":1653242491067,"results":"15","hashOfConfig":"13"},{"size":4052,"mtime":1653242369416,"results":"16","hashOfConfig":"13"},{"size":6508,"mtime":1653242879269,"results":"17","hashOfConfig":"13"},{"size":2948,"mtime":1653242319801,"results":"18","hashOfConfig":"13"},{"size":10820,"mtime":1653242429993,"results":"19","hashOfConfig":"13"},{"size":1490,"mtime":1653241871443,"results":"20","hashOfConfig":"13"},{"size":2819,"mtime":1653242343249,"results":"21","hashOfConfig":"13"},{"size":1802,"mtime":1653243993888,"results":"22","hashOfConfig":"13"},{"size":259,"mtime":1653244015428,"results":"23","hashOfConfig":"13"},{"filePath":"24","messages":"25","suppressedMessages":"26","errorCount":1,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0,"source":null},"iisw30",{"filePath":"27","messages":"28","suppressedMessages":"29","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"30","messages":"31","suppressedMessages":"32","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"33","messages":"34","suppressedMessages":"35","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"36","messages":"37","suppressedMessages":"38","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"39","messages":"40","suppressedMessages":"41","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"42","messages":"43","suppressedMessages":"44","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"45","messages":"46","suppressedMessages":"47","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"48","messages":"49","suppressedMessages":"50","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"51","messages":"52","suppressedMessages":"53","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},{"filePath":"54","messages":"55","suppressedMessages":"56","errorCount":0,"fatalErrorCount":0,"warningCount":0,"fixableErrorCount":0,"fixableWarningCount":0},"D:\\Users\\luca\\Documents\\GitHub\\twitter-scraper\\gh-pages.js",["57"],[],"D:\\Users\\luca\\Documents\\GitHub\\twitter-scraper\\src\\api.ts",[],[],"D:\\Users\\luca\\Documents\\GitHub\\twitter-scraper\\src\\auth.ts",[],[],"D:\\Users\\luca\\Documents\\GitHub\\twitter-scraper\\src\\profile.ts",[],[],"D:\\Users\\luca\\Documents\\GitHub\\twitter-scraper\\src\\scraper.ts",[],[],"D:\\Users\\luca\\Documents\\GitHub\\twitter-scraper\\src\\search.ts",[],[],"D:\\Users\\luca\\Documents\\GitHub\\twitter-scraper\\src\\timeline.ts",[],[],"D:\\Users\\luca\\Documents\\GitHub\\twitter-scraper\\src\\trends.ts",[],[],"D:\\Users\\luca\\Documents\\GitHub\\twitter-scraper\\src\\tweets.ts",[],[],"D:\\Users\\luca\\Documents\\GitHub\\twitter-scraper\\src\\search.test.ts",[],[],"D:\\Users\\luca\\Documents\\GitHub\\twitter-scraper\\src\\trends.test.ts",[],[],{"ruleId":"58","severity":2,"message":"59","line":1,"column":17,"nodeType":"60","messageId":"61","endLine":1,"endColumn":36},"@typescript-eslint/no-var-requires","Require statement not part of import statement.","CallExpression","noVarReqs"]

package/.eslintrc.js

@@ -1,24 +0,0 @@
-module.exports = {
-  parser: '@typescript-eslint/parser',
-  parserOptions: {
-    tsconfigRootDir: __dirname,
-    sourceType: 'module',
-  },
-  plugins: ['@typescript-eslint/eslint-plugin'],
-  extends: [
-    'plugin:@typescript-eslint/recommended',
-    'plugin:prettier/recommended',
-  ],
-  root: true,
-  env: {
-    node: true,
-    jest: true,
-  },
-  ignorePatterns: ['**/*.js'],
-  rules: {
-    '@typescript-eslint/interface-name-prefix': 'off',
-    '@typescript-eslint/explicit-function-return-type': 'off',
-    '@typescript-eslint/explicit-module-boundary-types': 'off',
-    '@typescript-eslint/no-explicit-any': 'off',
-  },
-};

package/.gitattributes

@@ -1,78 +0,0 @@
-# Auto detect text files and perform LF normalization
-*          text=auto
-
-#
-# The above will handle all files NOT found below
-#
-
-# Code
-*.js       text eol=lf
-*.ts       text eol=lf
-
-# Documents
-*.bibtex   text diff=bibtex
-*.doc      diff=astextplain
-*.DOC      diff=astextplain
-*.docx     diff=astextplain
-*.DOCX     diff=astextplain
-*.dot      diff=astextplain
-*.DOT      diff=astextplain
-*.pdf      diff=astextplain
-*.PDF      diff=astextplain
-*.rtf      diff=astextplain
-*.RTF      diff=astextplain
-*.md       text diff=markdown
-*.mdx      text diff=markdown
-*.tex      text diff=tex
-*.adoc     text
-*.textile  text
-*.mustache text
-*.csv      text
-*.tab      text
-*.tsv      text
-*.txt      text
-*.sql      text
-
-# Graphics
-*.png      binary
-*.jpg      binary
-*.jpeg     binary
-*.gif      binary
-*.tif      binary
-*.tiff     binary
-*.ico      binary
-*.svg      text
-*.eps      binary
-
-# Scripts
-*.bash     text eol=lf
-*.fish     text eol=lf
-*.sh       text eol=lf
-*.zsh      text eol=lf
-*.bat      text eol=crlf
-*.cmd      text eol=crlf
-*.ps1      text eol=crlf
-
-# Serialisation
-*.json     text
-*.toml     text
-*.xml      text
-*.yaml     text
-*.yml      text
-
-# Archives
-*.7z       binary
-*.gz       binary
-*.tar      binary
-*.tgz      binary
-*.zip      binary
-
-# Text files where line endings should be preserved
-*.patch    -text
-
-#
-# Exclude files from exporting
-#
-
-.gitattributes export-ignore
-.gitignore     export-ignore

package/.prettierignore

@@ -1,2 +0,0 @@
-node_modules/
-*.json

package/.prettierrc

@@ -1,5 +0,0 @@
-{
-    "singleQuote": true,
-    "trailingComma": "all",
-    "semi": true
-}