@book000/twitterts 0.57.54 → 0.58.0

package/dist/scraper.d.ts

@@ -1,79 +1,326 @@
 import { Browser, Page } from 'puppeteer-core';
 import { EndPointResponseType, GraphQLEndpoint } from './models/responses/endpoints';
 import { ResponseDatabaseOptions } from './saving-responses';
+/**
+ * HTTP メソッド
+ */
 export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+/**
+ * レスポンス種別
+ */
 export type RequestType = 'REST' | 'GRAPHQL';
+/**
+ * レスポンスの詳細
+ */
 interface ResponseDetails {
+    /**
+     * リクエストのキー（${type}_${name}_${method} の大文字）
+     */
     key: string;
+    /**
+     * リクエストの種別（REST | GRAPHQL）
+     */
     type: RequestType;
+    /**
+     * リクエストの HTTP メソッド（GET | POST | PUT | DELETE | PATCH）
+     */
     method: HttpMethod;
+    /**
+     * リクエスト名
+     */
     name: string;
+    /**
+     * レスポンステキスト
+     */
     text: string;
 }
+/**
+ * レスポンスデバッグ出力オプション
+ *
+ * レスポンスデバッグ出力オプションを指定すると、デバッグ用にレスポンスをデータベースに保存します。
+ */
 export interface TwitterScraperDebugOutputResponseOptions {
+    /**
+     * レスポンスをデータベースに保存するか
+     */
     enable: boolean;
+    /**
+     * レスポンスを保存するデータベースのオプション
+     *
+     * データベース接続情報を指定しない場合は、以下の環境変数を使用します。
+     * - RESPONSE_DB_HOSTNAME: データベースホスト名 (MySQL のみ)
+     * - RESPONSE_DB_PORT: データベースポート (MySQL のみ)
+     * - RESPONSE_DB_USERNAME: データベースユーザー名 (MySQL のみ)
+     * - RESPONSE_DB_PASSWORD: データベースパスワード (MySQL のみ)
+     * - RESPONSE_DB_DATABASE: データベース名 (MySQL のみ)
+     */
     db?: ResponseDatabaseOptions;
+    /**
+     * レスポンス時に実行されるコールバック関数
+     *
+     * @param details レスポンスの詳細
+     */
     onResponse?: (details: ResponseDetails) => void;
 }
+/**
+ * デバッグオプション
+ */
 export interface TwitterScraperDebugOptions {
+    /**
+     * レスポンスデバッグ出力オプション
+     *
+     * 指定しない場合はデバッグ出力されません。
+     */
     outputResponse?: TwitterScraperDebugOutputResponseOptions;
 }
+/**
+ * Puppeteer プロキシオプション
+ */
 export interface PuppeteerProxyOptions {
+    /**
+     * プロキシサーバー URL
+     */
     server: string;
+    /**
+     * プロキシサーバーのユーザー名
+     */
     username?: string;
+    /**
+     * プロキシサーバーのパスワード
+     */
     password?: string;
 }
+/**
+ * Puppeteer オプション
+ */
 export interface PuppeteerOptions {
+    /**
+     * Puppeteer の実行ファイルパス
+     *
+     * 指定しない場合は chrome channel が使用されます。
+     */
     executablePath?: string;
+    /**
+     * デフォルトのビューポート
+     */
     defaultViewport?: {
+        /**
+         * ビューポートの幅
+         */
         width: number;
+        /**
+         * ビューポートの高さ
+         */
         height: number;
     };
+    /**
+     * ユーザーデータディレクトリ
+     *
+     * 指定しない場合は /data/userdata が使用されます。
+     */
     userDataDirectory?: string;
+    /**
+     * DevTools を有効にするか
+     */
     enableDevtools?: boolean;
+    /**
+     * プロキシ設定
+     */
     proxy?: PuppeteerProxyOptions;
 }
+/**
+ * {@link TwitterScraper} オプション
+ */
 export interface TwitterScraperOptions {
+    /**
+     * Twitter ユーザー名
+     */
     username: string;
+    /**
+     * Twitter パスワード
+     */
     password: string;
+    /**
+     * Twitter One Time Password シークレット
+     */
     otpSecret?: string;
+    /**
+     * デバッグオプション
+     */
     debugOptions?: TwitterScraperDebugOptions;
+    /**
+     * Puppeteer オプション
+     */
     puppeteerOptions?: PuppeteerOptions;
 }
+/**
+ * レスポンス取得オプション
+ */
 export interface TwitterScraperGetResponseOptions {
+    /**
+     * ページ遷移先 URL
+     */
     url: string;
+    /**
+     * レスポンスを取得したいリクエストの HTTP メソッド
+     */
     method: HttpMethod;
+    /**
+     * レスポンスを取得したいリクエストの種別
+     */
     type: RequestType;
+    /**
+     * 取得処理のタイムアウト (ミリ秒)
+     *
+     * 指定しない場合は 30 秒でタイムアウトします。
+     * タイムアウトした場合は 'Response timeout.' Error が throw されます。
+     */
     timeout?: number;
 }
+/**
+ * Twitter スクレイピング ページクラス
+ */
 export declare class TwitterScraperPage {
+    /**
+     * Puppeteer のページインスタンス
+     */
     readonly page: Page;
+    /**
+     * レスポンスの保持オブジェクト
+     */
     private readonly responses;
+    /**
+     * @param page Puppeteer のページ
+     */
     constructor(page: Page);
+    /**
+     * 条件に一致するレスポンスをひとつのみ取得します。
+     * 指定した timeout 値 (ミリ秒) でタイムアウトします。指定しない場合は 30 秒でタイムアウトします。
+     *
+     * @param options レスポンス取得オプション
+     * @returns レスポンス
+     */
     waitSingleResponse<M extends HttpMethod, T extends RequestType, N extends GraphQLEndpoint>(url: string | null, method: M, type: T, name: N, timeout?: number): Promise<EndPointResponseType<M, T, N>>;
+    /**
+     * 条件に一致するレスポンスをひとつ取得します。繰り返し呼び出すことで複数のレスポンスを取得できます。
+     * waitSingleResponse と異なり、レスポンス待ちを行わず、ページ遷移もしません（goto メソッドによるページ遷移が必要です）。
+     *
+     * @param options レスポンス取得オプション
+     * @returns レスポンス。一致するレスポンスがない場合は null
+     */
     shiftResponse<M extends HttpMethod, T extends RequestType, N extends GraphQLEndpoint>(method: M, type: T, name: N): EndPointResponseType<M, T, N> | null;
+    /**
+     * 指定した URL に遷移します。
+     *
+     * @param url 遷移先 URL
+     */
     goto(url: string): Promise<void>;
+    /**
+     * 要素を探し、描画範囲内に表示されるようにスクロールしたあと、クリックします。
+     * 要素が検索処理は、指定した timeout 値 (ミリ秒) でタイムアウトします。指定しない場合は 30 秒でタイムアウトします。
+     *
+     * @param selector 要素のセレクタ
+     */
     waitAndClick(selector: string, isEvaluate?: boolean, timeout?: number): Promise<void>;
+    /**
+     * リダイレクトを待ち、リダイレクト先の URL を返します。
+     *
+     * @param sourceUrl リダイレクト前の URL
+     * @returns リダイレクト先の URL
+     */
     getRedirectTo(sourceUrl: string, timeout?: number): Promise<string>;
+    /**
+     * ページの最下部までスクロールします。
+     */
     scrollToBottom(): Promise<void>;
+    /**
+     * ページを閉じます。
+     */
     close(): Promise<void>;
+    /**
+     * レスポンスを保持するようにハンドラを設定します。
+     *
+     * @param page Puppeteer ページインスタンス
+     */
     private setRetentionResponse;
 }
+/**
+ * Twitter スクレイピングクラス
+ */
 export declare class TwitterScraper {
+    /**
+     * Twitter スクレイピングオプション
+     */
     private readonly options;
+    /**
+     * Puppeteer ブラウザインスタンス
+     */
     private browser;
+    /**
+     * レスポンスデータベース
+     */
     private readonly responseDatabase;
+    /**
+     * @param options Twitter スクレイピングオプション
+     */
     constructor(options: TwitterScraperOptions);
+    /**
+     * Twitter にログインします。
+     */
     login(): Promise<void>;
+    /**
+     * TwitterScraperPage インスタンスを作成します。
+     *
+     * @returns TwitterScraperPage インスタンス
+     */
     getScraperPage(): Promise<TwitterScraperPage>;
+    /**
+     * ブラウザを閉じます。
+     */
     close(): Promise<void>;
     getBrowser(): Browser | undefined;
+    /**
+     * Puppeteer ブラウザインスタンスを作成します。
+     *
+     * @returns Puppeteer ブラウザインスタンス
+     */
     private createBrowser;
+    /**
+     * 新しいページを作成します。
+     */
     private newPage;
+    /**
+     * レスポンスを自動保存するハンドラを設定します。
+     *
+     * @param page Puppeteer ページインスタンス
+     */
     private setAutoSaveResponse;
+    /**
+     * 引数の値がJSONとしてパースできるかどうかを返します。
+     *
+     * @param value パースしたい値
+     * @returns パースできるかどうか
+     */
     private isJSON;
+    /**
+     * データベースを初期化します。
+     */
     private initDatabase;
+    /**
+     * 指定したセレクタの要素を取得します。
+     *
+     * @param page Puppeteer ページインスタンス
+     * @param selector セレクタ
+     * @param timeout タイムアウトミリ秒
+     * @returns 要素。見つからなかった場合は null
+     */
     private getElement;
+    /**
+     * シークレットをもとに OTP を生成します。
+     *
+     * @param secret シークレット
+     * @returns OTP コード
+     */
     private getOneTimePassword;
 }
 export {};

package/dist/scraper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scraper.d.ts","sourceRoot":"","sources":["../src/scraper.ts"],"names":[],"mappings":"AAAA,OAAkB,EAChB,OAAO,EAGP,IAAI,EACL,MAAM,gBAAgB,CAAA;AAEvB,OAAO,EACL,oBAAoB,EACpB,eAAe,EAChB,MAAM,8BAA8B,CAAA;AAOrC,OAAO,EAAoB,uBAAuB,EAAE,MAAM,oBAAoB,CAAA;AAK9E,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAA;AAKpE,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,SAAS,CAAA;AAK5C,UAAU,eAAe;IAIvB,GAAG,EAAE,MAAM,CAAA;IAKX,IAAI,EAAE,WAAW,CAAA;IAKjB,MAAM,EAAE,UAAU,CAAA;IAKlB,IAAI,EAAE,MAAM,CAAA;IAKZ,IAAI,EAAE,MAAM,CAAA;CACb;AAOD,MAAM,WAAW,wCAAwC;IAIvD,MAAM,EAAE,OAAO,CAAA;IAYf,EAAE,CAAC,EAAE,uBAAuB,CAAA;IAO5B,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,IAAI,CAAA;CAChD;AAKD,MAAM,WAAW,0BAA0B;IAMzC,cAAc,CAAC,EAAE,wCAAwC,CAAA;CAC1D;AAKD,MAAM,WAAW,qBAAqB;IAIpC,MAAM,EAAE,MAAM,CAAA;IAId,QAAQ,CAAC,EAAE,MAAM,CAAA;IAIjB,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAKD,MAAM,WAAW,gBAAgB;IAM/B,cAAc,CAAC,EAAE,MAAM,CAAA;IAKvB,eAAe,CAAC,EAAE;QAIhB,KAAK,EAAE,MAAM,CAAA;QAKb,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IAOD,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAK1B,cAAc,CAAC,EAAE,OAAO,CAAA;IAKxB,KAAK,CAAC,EAAE,qBAAqB,CAAA;CAC9B;AAKD,MAAM,WAAW,qBAAqB;IAIpC,QAAQ,EAAE,MAAM,CAAA;IAKhB,QAAQ,EAAE,MAAM,CAAA;IAKhB,SAAS,CAAC,EAAE,MAAM,CAAA;IAKlB,YAAY,CAAC,EAAE,0BAA0B,CAAA;IAKzC,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;CACpC;AAKD,MAAM,WAAW,gCAAgC;IAI/C,GAAG,EAAE,MAAM,CAAA;IAKX,MAAM,EAAE,UAAU,CAAA;IAKlB,IAAI,EAAE,WAAW,CAAA;IAQjB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAqMD,qBAAa,kBAAkB;IAI7B,SAAgB,IAAI,EAAE,IAAI,CAAA;IAK1B,OAAO,CAAC,QAAQ,CAAC,SAAS,CAEpB;gBAKM,IAAI,EAAE,IAAI;IAaT,kBAAkB,CAC7B,CAAC,SAAS,UAAU,EACpB,CAAC,SAAS,WAAW,EACrB,CAAC,SAAS,eAAe,EAEzB,GAAG,EAAE,MAAM,GAAG,IAAI,EAClB,MAAM,EAAE,CAAC,EACT,IAAI,EAAE,CAAC,EACP,IAAI,EAAE,CAAC,EACP,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,oBAAoB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IAqElC,aAAa,CAClB,CAAC,SAAS,UAAU,EACpB,CAAC,SAAS,WAAW,EACrB,CAAC,SAAS,eAAe,EACzB,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,oBAAoB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI;IAqCvD,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAYhC,YAAY,CACvB,QAAQ,EAAE,MAAM,EAChB,UAAU,UAAQ,EAClB,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,IAAI,CAAC;IA2BH,aAAa,CACxB,SAAS,EAAE,MAAM,EACjB,OAAO,SAAS,GACf,OAAO,CAAC,MAAM,CAAC;IAiCL,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAc/B,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IASnC,OAAO,CAAC,oBAAoB;CAY7B;AAKD,qBAAa,cAAc;IAIzB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAuB;IAK/C,OAAO,CAAC,OAAO,CAAqB;IAKpC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAyB;gBAK9C,OAAO,EAAE,qBAAqB;IAmB7B,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAoHtB,cAAc,IAAI,OAAO,CAAC,kBAAkB,CAAC;IAQ7C,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAS5B,UAAU,IAAI,OAAO,GAAG,SAAS;YAS1B,aAAa;YAsDb,OAAO;IAwCrB,OAAO,CAAC,mBAAmB;IAuD3B,OAAO,CAAC,MAAM;YAYA,YAAY;YAyBZ,UAAU;IAkBxB,OAAO,CAAC,kBAAkB;CAG3B"}
+{"version":3,"file":"scraper.d.ts","sourceRoot":"","sources":["../src/scraper.ts"],"names":[],"mappings":"AAAA,OAAkB,EAChB,OAAO,EAGP,IAAI,EACL,MAAM,gBAAgB,CAAA;AAEvB,OAAO,EACL,oBAAoB,EACpB,eAAe,EAChB,MAAM,8BAA8B,CAAA;AAOrC,OAAO,EAAoB,uBAAuB,EAAE,MAAM,oBAAoB,CAAA;AAE9E;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAA;AAEpE;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,SAAS,CAAA;AAE5C;;GAEG;AACH,UAAU,eAAe;IACvB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,IAAI,EAAE,WAAW,CAAA;IAEjB;;OAEG;IACH,MAAM,EAAE,UAAU,CAAA;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;IAEZ;;OAEG;IACH,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,wCAAwC;IACvD;;OAEG;IACH,MAAM,EAAE,OAAO,CAAA;IAEf;;;;;;;;;OASG;IACH,EAAE,CAAC,EAAE,uBAAuB,CAAA;IAE5B;;;;OAIG;IACH,UAAU,CAAC,EAAE,CAAC,OAAO,EAAE,eAAe,KAAK,IAAI,CAAA;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;;;OAIG;IACH,cAAc,CAAC,EAAE,wCAAwC,CAAA;CAC1D;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,eAAe,CAAC,EAAE;QAChB;;WAEG;QACH,KAAK,EAAE,MAAM,CAAA;QAEb;;WAEG;QACH,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IAED;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IAExB;;OAEG;IACH,KAAK,CAAC,EAAE,qBAAqB,CAAA;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,YAAY,CAAC,EAAE,0BAA0B,CAAA;IAEzC;;OAEG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAA;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,MAAM,EAAE,UAAU,CAAA;IAElB;;OAEG;IACH,IAAI,EAAE,WAAW,CAAA;IAEjB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAkMD;;GAEG;AACH,qBAAa,kBAAkB;IAC7B;;OAEG;IACH,SAAgB,IAAI,EAAE,IAAI,CAAA;IAE1B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,SAAS,CAEpB;IAEN;;OAEG;gBACS,IAAI,EAAE,IAAI;IAMtB;;;;;;OAMG;IACU,kBAAkB,CAC7B,CAAC,SAAS,UAAU,EACpB,CAAC,SAAS,WAAW,EACrB,CAAC,SAAS,eAAe,EAEzB,GAAG,EAAE,MAAM,GAAG,IAAI,EAClB,MAAM,EAAE,CAAC,EACT,IAAI,EAAE,CAAC,EACP,IAAI,EAAE,CAAC,EACP,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,oBAAoB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;IA8DzC;;;;;;OAMG;IACI,aAAa,CAClB,CAAC,SAAS,UAAU,EACpB,CAAC,SAAS,WAAW,EACrB,CAAC,SAAS,eAAe,EACzB,MAAM,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,GAAG,oBAAoB,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,GAAG,IAAI;IAgCpE;;;;OAIG;IACU,IAAI,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAM7C;;;;;OAKG;IACU,YAAY,CACvB,QAAQ,EAAE,MAAM,EAChB,UAAU,UAAQ,EAClB,OAAO,CAAC,EAAE,MAAM,GACf,OAAO,CAAC,IAAI,CAAC;IAqBhB;;;;;OAKG;IACU,aAAa,CACxB,SAAS,EAAE,MAAM,EACjB,OAAO,SAAS,GACf,OAAO,CAAC,MAAM,CAAC;IA8BlB;;OAEG;IACU,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IAW5C;;OAEG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAInC;;;;OAIG;IACH,OAAO,CAAC,oBAAoB;CAY7B;AAED;;GAEG;AACH,qBAAa,cAAc;IACzB;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAuB;IAE/C;;OAEG;IACH,OAAO,CAAC,OAAO,CAAqB;IAEpC;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAyB;IAE1D;;OAEG;gBACS,OAAO,EAAE,qBAAqB;IAgB1C;;OAEG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IA+GnC;;;;OAIG;IACU,cAAc,IAAI,OAAO,CAAC,kBAAkB,CAAC;IAK1D;;OAEG;IACU,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC;IAS5B,UAAU,IAAI,OAAO,GAAG,SAAS;IAIxC;;;;OAIG;YACW,aAAa;IAmD3B;;OAEG;YACW,OAAO;IAmCrB;;;;OAIG;IACH,OAAO,CAAC,mBAAmB;IAiD3B;;;;;OAKG;IACH,OAAO,CAAC,MAAM;IASd;;OAEG;YACW,YAAY;IAiB1B;;;;;;;OAOG;YACW,UAAU;IAYxB;;;;;OAKG;IACH,OAAO,CAAC,kBAAkB;CAG3B"}