scrapfly-sdk 0.5.1 → 0.6.2

package/script/result.d.ts

@@ -0,0 +1,297 @@
+/// <reference types="node" />
+import type { HttpMethod, Rec } from './types.js';
+import { cheerio } from './deps.js';
+export type ConfigData = {
+    url: string;
+    retry: boolean;
+    method: HttpMethod;
+    country?: string;
+    render_js: boolean;
+    cache: boolean;
+    cache_clear: boolean;
+    ssl: boolean;
+    dns: boolean;
+    asp: boolean;
+    debug: boolean;
+    raise_on_upstream_error: boolean;
+    cache_ttl: number;
+    proxy_pool: string;
+    session?: string;
+    tags: Set<string>;
+    correlation_id?: string;
+    cookies: Record<string, string>;
+    body?: string;
+    data?: Rec<any>;
+    headers: Rec<string>;
+    js?: string;
+    rendering_wait?: number;
+    wait_for_selector?: string;
+    session_sticky_proxy: boolean;
+    screenshots?: Rec<any>;
+    webhook?: string;
+    timeout?: number;
+    js_scenario?: Rec<any>;
+    extract?: Rec<any>;
+    lang?: string[];
+    os?: string;
+    auto_scroll?: boolean;
+};
+export type ContextData = {
+    asp: boolean;
+    bandwidth_consumed: number;
+    cache: {
+        state: string;
+        entry?: string;
+    };
+    cookies: Record<string, string>;
+    cost: {
+        details: Array<{
+            amount: number;
+            code: string;
+            description: string;
+        }>;
+        total: number;
+    };
+    created_at: string;
+    debug: {
+        response_url: string;
+        screenshot_url?: string;
+    };
+    env: string;
+    fingerprint: string;
+    headers: Record<string, string>;
+    is_xml_http_request: boolean;
+    job?: string;
+    lang: Array<string>;
+    os: {
+        distribution: string;
+        name: string;
+        type: string;
+        version: string;
+    };
+    project: string;
+    proxy: {
+        country: string;
+        identity: string;
+        network: string;
+        pool: string;
+    };
+    redirects: Array<string>;
+    retry: number;
+    schedule?: string;
+    session?: string;
+    spider?: any;
+    throttler?: any;
+    uri: {
+        base_url: string;
+        fragment?: string;
+        host: string;
+        params?: Rec<string>;
+        port: number;
+        query?: string;
+        root_domain: string;
+        scheme: string;
+    };
+    url: string;
+    webhook?: string;
+};
+export type ResultData = {
+    browser_data: {
+        javascript_evaluation_result?: string;
+        js_scenario?: {
+            duration: number;
+            executed: number;
+            response: any;
+            steps: Array<{
+                action: string;
+                config: Rec<string>;
+                duration: number;
+                executed: boolean;
+                result?: string;
+                success: boolean;
+            }>;
+        };
+        local_storage_data?: Rec<string>;
+        session_storage_data?: Rec<string>;
+        websockets?: Array<any>;
+        xhr_call?: Array<{
+            body?: string;
+            headers: Rec<string>;
+            method: string;
+            type: string;
+            url: string;
+            response: {
+                body: string;
+                duration: number;
+                format: string;
+                headers: Rec<string>;
+                status: number;
+            };
+        }>;
+    };
+    content: string;
+    content_encoding: string;
+    content_type: string;
+    cookies: Array<{
+        name: string;
+        value: string;
+        expires: string;
+        path: string;
+        comment: string;
+        domain: string;
+        max_age: number;
+        secure: boolean;
+        http_only: boolean;
+        version: string;
+        size: number;
+    }>;
+    data?: Rec<any>;
+    dns?: Rec<Array<Rec<any>>>;
+    duration: number;
+    error?: {
+        code: string;
+        http_code: number;
+        links: Rec<string>;
+        message: string;
+        retryable: boolean;
+        doc_url?: string;
+    };
+    format: string;
+    iframes: Array<{
+        url: string;
+        uri: {
+            root_domain: string;
+            base_url: string;
+            host: string;
+            scheme: string;
+            query?: string;
+            fragment?: string;
+            port: number;
+            params?: Rec<string>;
+        };
+        content: string;
+    }>;
+    log_url: string;
+    reason: string;
+    request_headers: Rec<string>;
+    response_headers: Rec<string>;
+    screenshots: Rec<{
+        css_selector?: string;
+        extension: string;
+        format: string;
+        size: number;
+        url: string;
+    }>;
+    size: number;
+    ssl?: {
+        certs: Array<Rec<any>>;
+    };
+    status: string;
+    status_code: number;
+    success: boolean;
+    url: string;
+};
+export declare class ScrapeResult {
+    config: ConfigData;
+    context: ContextData;
+    result: ResultData;
+    uuid: string;
+    private _selector;
+    constructor(data: {
+        config: ConfigData;
+        context: ContextData;
+        result: ResultData;
+        uuid: string;
+    });
+    get selector(): cheerio.CheerioAPI;
+}
+export type ScrapeResultData = Record<string | number | symbol, never>;
+export type AccountData = {
+    account: {
+        account_id: string;
+        currency: string;
+        timezone: string;
+    };
+    project: {
+        allow_extra_usage: boolean;
+        allowed_networks: Array<string>;
+        budget_limit: any;
+        budget_spent: any;
+        concurrency_limit?: number;
+        name: string;
+        quota_reached: boolean;
+        scrape_request_count: number;
+        scrape_request_limit: number;
+        tags: Array<string>;
+    };
+    subscription: {
+        billing: {
+            current_extra_scrape_request_price: {
+                currency: string;
+                amount: number;
+            };
+            extra_scrape_request_price_per_10k: {
+                currency: string;
+                amount: number;
+            };
+            ongoing_payment: {
+                currency: string;
+                amount: number;
+            };
+            plan_price: {
+                currency: string;
+                amount: number;
+            };
+        };
+        extra_scrape_allowed: boolean;
+        max_concurrency: number;
+        period: {
+            start: string;
+            end: string;
+        };
+        plan_name: string;
+        usage: {
+            schedule: {
+                current: number;
+                limit: number;
+            };
+            spider: {
+                current: number;
+                limit: number;
+            };
+            scrape: {
+                concurrent_limit: number;
+                concurrent_remaining: number;
+                concurrent_usage: number;
+                current: number;
+                extra: number;
+                limit: number;
+                remaining: number;
+            };
+        };
+    };
+};
+export type ScreenshotMetadata = {
+    extension_name: string;
+    upstream_status_code: number;
+    upstream_url: string;
+};
+export declare class ScreenshotResult {
+    image: ArrayBuffer;
+    metadata: ScreenshotMetadata;
+    result: object | null;
+    constructor(response: Response, data: ArrayBuffer);
+    private defineMetadata;
+    private decodeResponse;
+}
+export declare class ExtractionResult {
+    data: string;
+    content_type: string;
+    data_quality?: string;
+    constructor(response: {
+        data: string;
+        content_type: string;
+        data_quality?: string;
+    });
+}
+//# sourceMappingURL=result.d.ts.map

package/script/result.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"result.d.ts","sourceRoot":"","sources":["../src/result.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AAElD,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,MAAM,MAAM,UAAU,GAAG;IACvB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,OAAO,CAAC;IACf,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,OAAO,CAAC;IACf,WAAW,EAAE,OAAO,CAAC;IACrB,GAAG,EAAE,OAAO,CAAC;IACb,GAAG,EAAE,OAAO,CAAC;IACb,GAAG,EAAE,OAAO,CAAC;IACb,KAAK,EAAE,OAAO,CAAC;IACf,uBAAuB,EAAE,OAAO,CAAC;IACjC,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IAChB,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACrB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,oBAAoB,EAAE,OAAO,CAAC;IAC9B,WAAW,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IACvB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IACvB,OAAO,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACxB,GAAG,EAAE,OAAO,CAAC;IACb,kBAAkB,EAAE,MAAM,CAAC;IAC3B,KAAK,EAAE;QACL,KAAK,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,IAAI,EAAE;QACJ,OAAO,EAAE,KAAK,CAAC;YAAE,MAAM,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAC;YAAC,WAAW,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;QACtE,KAAK,EAAE,MAAM,CAAC;KACf,CAAC;IACF,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE;QACL,YAAY,EAAE,MAAM,CAAC;QACrB,cAAc,CAAC,EAAE,MAAM,CAAC;KACzB,CAAC;IACF,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,mBAAmB,EAAE,OAAO,CAAC;IAC7B,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACpB,EAAE,EAAE;QACF,YAAY,EAAE,MAAM,CAAC;QACrB,IAAI,EAAE,MAAM,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE;QACL,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC;IACF,SAAS,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,SAAS,CAAC,EAAE,GAAG,CAAC;IAChB,GAAG,EAAE;QACH,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,IAAI,EAAE,MAAM,CAAC;QACb,MAAM,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;QACrB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,WAAW,EAAE,MAAM,CAAC;QACpB,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,UAAU,GAAG;IACvB,YAAY,EAAE;QACZ,4BAA4B,CAAC,EAAE,MAAM,CAAC;QACtC,WAAW,CAAC,EAAE;YACZ,QAAQ,EAAE,MAAM,CAAC;YACjB,QAAQ,EAAE,MAAM,CAAC;YACjB,QAAQ,EAAE,GAAG,CAAC;YACd,KAAK,EAAE,KAAK,CAAC;gBACX,MAAM,EAAE,MAAM,CAAC;gBACf,MAAM,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;gBACpB,QAAQ,EAAE,MAAM,CAAC;gBACjB,QAAQ,EAAE,OAAO,CAAC;gBAClB,MAAM,CAAC,EAAE,MAAM,CAAC;gBAChB,OAAO,EAAE,OAAO,CAAC;aAClB,CAAC,CAAC;SACJ,CAAC;QACF,kBAAkB,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;QACjC,oBAAoB,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;QACnC,UAAU,CAAC,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC;QACxB,QAAQ,CAAC,EAAE,KAAK,CAAC;YACf,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;YACrB,MAAM,EAAE,MAAM,CAAC;YACf,IAAI,EAAE,MAAM,CAAC;YACb,GAAG,EAAE,MAAM,CAAC;YACZ,QAAQ,EAAE;gBACR,IAAI,EAAE,MAAM,CAAC;gBACb,QAAQ,EAAE,MAAM,CAAC;gBACjB,MAAM,EAAE,MAAM,CAAC;gBACf,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;gBACrB,MAAM,EAAE,MAAM,CAAC;aAChB,CAAC;SACH,CAAC,CAAC;KACJ,CAAC;IACF,OAAO,EAAE,MAAM,CAAC;IAChB,gBAAgB,EAAE,MAAM,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,KAAK,CAAC;QACb,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,MAAM,CAAC;QACf,OAAO,EAAE,MAAM,CAAC;QAChB,MAAM,EAAE,OAAO,CAAC;QAChB,SAAS,EAAE,OAAO,CAAC;QACnB,OAAO,EAAE,MAAM,CAAC;QAChB,IAAI,EAAE,MAAM,CAAC;KACd,CAAC,CAAC;IACH,IAAI,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IAChB,GAAG,CAAC,EAAE,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;IAC3B,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE;QACN,IAAI,EAAE,MAAM,CAAC;QACb,SAAS,EAAE,MAAM,CAAC;QAClB,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;QACnB,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,EAAE,OAAO,CAAC;QACnB,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,KAAK,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE;YACH,WAAW,EAAE,MAAM,CAAC;YACpB,QAAQ,EAAE,MAAM,CAAC;YACjB,IAAI,EAAE,MAAM,CAAC;YACb,MAAM,EAAE,MAAM,CAAC;YACf,KAAK,CAAC,EAAE,MAAM,CAAC;YACf,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,IAAI,EAAE,MAAM,CAAC;YACb,MAAM,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;SACtB,CAAC;QACF,OAAO,EAAE,MAAM,CAAC;KACjB,CAAC,CAAC;IACH,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;IACf,eAAe,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC7B,gBAAgB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IAC9B,WAAW,EAAE,GAAG,CAAC;QACf,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,SAAS,EAAE,MAAM,CAAC;QAClB,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;KACb,CAAC,CAAC;IACH,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE;QACJ,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;KACxB,CAAC;IACF,MAAM,EAAE,MAAM,CAAC;IACf,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,EAAE,OAAO,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF,qBAAa,YAAY;IACvB,MAAM,EAAE,UAAU,CAAC;IACnB,OAAO,EAAE,WAAW,CAAC;IACrB,MAAM,EAAE,UAAU,CAAC;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,SAAS,CAAiC;gBAEtC,IAAI,EAAE;QAAE,MAAM,EAAE,UAAU,CAAC;QAAC,OAAO,EAAE,WAAW,CAAC;QAAC,MAAM,EAAE,UAAU,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE;IAQhG,IAAI,QAAQ,IAAI,OAAO,CAAC,UAAU,CAUjC;CACF;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,KAAK,CAAC,CAAC;AAEvE,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE;QACP,UAAU,EAAE,MAAM,CAAC;QACnB,QAAQ,EAAE,MAAM,CAAC;QACjB,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,OAAO,EAAE;QACP,iBAAiB,EAAE,OAAO,CAAC;QAC3B,gBAAgB,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAChC,YAAY,EAAE,GAAG,CAAC;QAClB,YAAY,EAAE,GAAG,CAAC;QAClB,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAC3B,IAAI,EAAE,MAAM,CAAC;QACb,aAAa,EAAE,OAAO,CAAC;QACvB,oBAAoB,EAAE,MAAM,CAAC;QAC7B,oBAAoB,EAAE,MAAM,CAAC;QAC7B,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;KACrB,CAAC;IACF,YAAY,EAAE;QACZ,OAAO,EAAE;YACP,kCAAkC,EAAE;gBAAE,QAAQ,EAAE,MAAM,CAAC;gBAAC,MAAM,EAAE,MAAM,CAAA;aAAE,CAAC;YACzE,kCAAkC,EAAE;gBAAE,QAAQ,EAAE,MAAM,CAAC;gBAAC,MAAM,EAAE,MAAM,CAAA;aAAE,CAAC;YACzE,eAAe,EAAE;gBAAE,QAAQ,EAAE,MAAM,CAAC;gBAAC,MAAM,EAAE,MAAM,CAAA;aAAE,CAAC;YACtD,UAAU,EAAE;gBAAE,QAAQ,EAAE,MAAM,CAAC;gBAAC,MAAM,EAAE,MAAM,CAAA;aAAE,CAAC;SAClD,CAAC;QACF,oBAAoB,EAAE,OAAO,CAAC;QAC9B,eAAe,EAAE,MAAM,CAAC;QACxB,MAAM,EAAE;YACN,KAAK,EAAE,MAAM,CAAC;YACd,GAAG,EAAE,MAAM,CAAC;SACb,CAAC;QACF,SAAS,EAAE,MAAM,CAAC;QAClB,KAAK,EAAE;YACL,QAAQ,EAAE;gBAAE,OAAO,EAAE,MAAM,CAAC;gBAAC,KAAK,EAAE,MAAM,CAAA;aAAE,CAAC;YAC7C,MAAM,EAAE;gBAAE,OAAO,EAAE,MAAM,CAAC;gBAAC,KAAK,EAAE,MAAM,CAAA;aAAE,CAAC;YAC3C,MAAM,EAAE;gBACN,gBAAgB,EAAE,MAAM,CAAC;gBACzB,oBAAoB,EAAE,MAAM,CAAC;gBAC7B,gBAAgB,EAAE,MAAM,CAAC;gBACzB,OAAO,EAAE,MAAM,CAAC;gBAChB,KAAK,EAAE,MAAM,CAAC;gBACd,KAAK,EAAE,MAAM,CAAC;gBACd,SAAS,EAAE,MAAM,CAAC;aACnB,CAAC;SACH,CAAC;KACH,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,kBAAkB,GAAG;IAC/B,cAAc,EAAE,MAAM,CAAC;IACvB,oBAAoB,EAAE,MAAM,CAAC;IAC7B,YAAY,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,qBAAa,gBAAgB;IAC3B,KAAK,EAAE,WAAW,CAAC;IACnB,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;gBAEV,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE,WAAW;IAMjD,OAAO,CAAC,cAAc;IAatB,OAAO,CAAC,cAAc;CAMvB;AAED,qBAAa,gBAAgB;IAC3B,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,MAAM,CAAC;gBAEV,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,MAAM,CAAA;KAAE;CAKpF"}

package/script/result.js

@@ -0,0 +1,147 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExtractionResult = exports.ScreenshotResult = exports.ScrapeResult = void 0;
+const errors = __importStar(require("./errors.js"));
+const deps_js_1 = require("./deps.js");
+class ScrapeResult {
+    constructor(data) {
+        Object.defineProperty(this, "config", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "context", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "result", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "uuid", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "_selector", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.config = data.config;
+        this.context = data.context;
+        this.result = data.result;
+        this.uuid = data.uuid;
+        this._selector = undefined;
+    }
+    get selector() {
+        if (!this._selector) {
+            if (!this.result.response_headers['content-type'].includes('text/html')) {
+                throw new errors.ContentTypeError(`Cannot use selector on non-html content-type, received: ${this.result.response_headers['content-type']}`);
+            }
+            this._selector = deps_js_1.cheerio.load(this.result.content);
+        }
+        return this._selector;
+    }
+}
+exports.ScrapeResult = ScrapeResult;
+class ScreenshotResult {
+    constructor(response, data) {
+        Object.defineProperty(this, "image", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "metadata", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "result", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.image = data;
+        this.metadata = this.defineMetadata(response);
+        this.result = this.decodeResponse(response, data); // raw result
+    }
+    defineMetadata(response) {
+        const contentType = response.headers.get('content-type');
+        let extension_name = '';
+        if (contentType) {
+            extension_name = contentType.split('/')[1].split(';')[0];
+        }
+        return {
+            extension_name: extension_name,
+            upstream_status_code: parseInt(response.headers.get('X-Scrapfly-Upstream-Http-Code') || '200', 10),
+            upstream_url: response.headers.get('X-Scrapfly-Upstream-Url') || '',
+        };
+    }
+    decodeResponse(response, data) {
+        if (response.headers.get('content-type') === 'json') {
+            return JSON.parse(new TextDecoder().decode(data));
+        }
+        return null;
+    }
+}
+exports.ScreenshotResult = ScreenshotResult;
+class ExtractionResult {
+    constructor(response) {
+        Object.defineProperty(this, "data", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "content_type", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "data_quality", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.data = response.data;
+        this.content_type = response.content_type;
+        this.data_quality = response.data_quality;
+    }
+}
+exports.ExtractionResult = ExtractionResult;

package/script/scrapeconfig.d.ts

@@ -0,0 +1,120 @@
+import type { HttpMethod, Rec } from './types.js';
+export declare enum ScreenshotFlags {
+    /**
+      Options to customize the screenshot behavior
+      Attributes:
+          LOAD_IMAGES: Enable image rendering with the request, add extra usage for the bandwidth consumed.
+          DARK_MODE: Enable dark mode display.
+          BLOCK_BANNERS: Block cookies banners and overlay that cover the screen.
+          PRINT_MEDIA_FORMAT: Render the page in the print mode.
+      */
+    LOAD_IMAGES = "load_images",
+    DARK_MODE = "dark_mode",
+    BLOCK_BANNERS = "block_banners",
+    PRINT_MEDIA_FORMAT = "print_media_format",
+    HIGH_QUALITY = "high_quality"
+}
+export declare enum Format {
+    /**
+      Format of the scraped content.
+      Attributes:
+          JSON: JSON format.
+          TEXT: Text format.
+          MARKDOWN: Markdown format.
+          CLEAN_HTML: Clean HTML format.
+      */
+    JSON = "json",
+    TEXT = "text",
+    MARKDOWN = "markdown",
+    CLEAN_HTML = "clean_html",
+    RAW = "raw"
+}
+export declare enum FormatOption {
+    NO_LINKS = "no_links",
+    NO_IMAGES = "no_images"
+}
+type ScrapeConfigOptions = {
+    url: string;
+    retry?: boolean;
+    method?: HttpMethod;
+    country?: string;
+    render_js?: boolean;
+    cache?: boolean;
+    cache_clear?: boolean;
+    cost_budget?: number;
+    ssl?: boolean;
+    dns?: boolean;
+    asp?: boolean;
+    debug?: boolean;
+    raise_on_upstream_error?: boolean;
+    cache_ttl?: number;
+    proxy_pool?: string;
+    session?: string;
+    tags?: string[];
+    format?: Format;
+    format_options?: FormatOption[];
+    correlation_id?: string;
+    cookies?: Rec<string>;
+    body?: string;
+    data?: Rec<any>;
+    headers?: Rec<string>;
+    js?: string;
+    rendering_wait?: number;
+    wait_for_selector?: string;
+    screenshots?: Rec<any>;
+    screenshot_flags?: ScreenshotFlags[];
+    session_sticky_proxy?: boolean;
+    webhook?: string;
+    timeout?: number;
+    js_scenario?: Rec<any>;
+    os?: string;
+    lang?: string[];
+    auto_scroll?: boolean;
+};
+export declare class ScrapeConfig {
+    static PUBLIC_DATACENTER_POOL: string;
+    static PUBLIC_RESIDENTIAL_POOL: string;
+    url: string;
+    retry: boolean;
+    method: HttpMethod;
+    country?: string | null;
+    render_js: boolean;
+    cache: boolean;
+    cache_clear: boolean;
+    cost_budget?: number;
+    ssl: boolean;
+    dns: boolean;
+    asp: boolean;
+    debug: boolean;
+    raise_on_upstream_error: boolean;
+    cache_ttl?: number;
+    proxy_pool?: string;
+    session?: string;
+    tags: Set<string>;
+    format?: Format;
+    format_options?: FormatOption[];
+    correlation_id?: string;
+    cookies?: Rec<string>;
+    body?: string;
+    data?: Rec<any>;
+    headers?: Rec<string>;
+    js?: string;
+    rendering_wait?: number;
+    wait_for_selector?: string;
+    session_sticky_proxy: boolean;
+    screenshots?: Rec<any>;
+    screenshot_flags?: ScreenshotFlags[];
+    webhook?: string;
+    timeout?: number;
+    js_scenario?: Rec<any>;
+    lang?: string[];
+    os?: string;
+    auto_scroll?: boolean;
+    constructor(options: ScrapeConfigOptions);
+    private validateOptions;
+    toApiParams(options: {
+        key: string;
+    }): Record<string, any>;
+}
+export {};
+//# sourceMappingURL=scrapeconfig.d.ts.map

package/script/scrapeconfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"scrapeconfig.d.ts","sourceRoot":"","sources":["../src/scrapeconfig.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,YAAY,CAAC;AAGlD,oBAAY,eAAe;IACzB;;;;;;;QAOI;IACJ,WAAW,gBAAgB;IAC3B,SAAS,cAAc;IACvB,aAAa,kBAAkB;IAC/B,kBAAkB,uBAAuB;IACzC,YAAY,iBAAiB;CAC9B;AAED,oBAAY,MAAM;IAChB;;;;;;;QAOI;IACJ,IAAI,SAAS;IACb,IAAI,SAAS;IACb,QAAQ,aAAa;IACrB,UAAU,eAAe;IACzB,GAAG,QAAQ;CACZ;AAED,oBAAY,YAAY;IACtB,QAAQ,aAAa;IACrB,SAAS,cAAc;CACxB;AAED,KAAK,mBAAmB,GAAG;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAClC,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,YAAY,EAAE,CAAC;IAChC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IAChB,OAAO,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACtB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,WAAW,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IACvB,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrC,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IACvB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,WAAW,CAAC,EAAE,OAAO,CAAC;CACvB,CAAC;AAEF,qBAAa,YAAY;IACvB,MAAM,CAAC,sBAAsB,SAA4B;IACzD,MAAM,CAAC,uBAAuB,SAA6B;IAE3D,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,UAAQ;IACb,MAAM,EAAE,UAAU,CAAS;IAC3B,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAQ;IAC/B,SAAS,UAAS;IAClB,KAAK,UAAS;IACd,WAAW,UAAS;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,UAAS;IACZ,GAAG,UAAS;IACZ,GAAG,UAAS;IACZ,KAAK,UAAS;IACd,uBAAuB,UAAQ;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,GAAG,CAAC,MAAM,CAAC,CAAqB;IACtC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,cAAc,CAAC,EAAE,YAAY,EAAE,CAAC;IAChC,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACtB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IAChB,OAAO,CAAC,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;IACtB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,oBAAoB,UAAS;IAC7B,WAAW,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IACvB,gBAAgB,CAAC,EAAE,eAAe,EAAE,CAAC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,OAAO,CAAC;gBAEV,OAAO,EAAE,mBAAmB;IAgFxC,OAAO,CAAC,eAAe;IASvB,WAAW,CAAC,OAAO,EAAE;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;CAmJ3D"}