apify 2.3.1-beta.4 → 3.0.0-alpha.0

package/build/typedefs.d.ts

@@ -1,146 +0,0 @@
-/**
- * Represents information about an actor run, as returned by the
- * {@link Apifycall } or {@link ApifycallTask } function.
- * The object is almost equivalent to the JSON response
- * of the
- * [Actor run](https://apify.com/docs/api/v2#/reference/actors/run-collection/run-actor)
- * Apify API endpoint and extended with certain fields.
- * For more details, see
- * [Runs.](https://docs.apify.com/actor/run)
- */
-export type ActorRun = {
-    /**
-     *   Actor run ID
-     */
-    id: string;
-    /**
-     *   Actor ID
-     */
-    actId: string;
-    /**
-     *   Time when the actor run started
-     */
-    startedAt: Date;
-    /**
-     *   Time when the actor run finished. Contains `null` for running actors.
-     */
-    finishedAt: Date;
-    /**
-     *   Status of the run. For possible values, see
-     *   [Run lifecycle](https://docs.apify.com/actors/running#lifecycle)
-     *   in Apify actor documentation.
-     */
-    status: string;
-    /**
-     *   Actor run meta-data. For example:
-     *   ```
-     *   {
-     *     "origin": "API",
-     *     "clientIp": "1.2.3.4",
-     *     "userAgent": "ApifyClient/0.2.13 (Linux; Node/v8.11.3)"
-     *   }
-     *   ```
-     */
-    meta: {
-        [x: string]: string;
-    };
-    /**
-     *   An object containing various actor run statistics. For example:
-     *   ```
-     *   {
-     *     "inputBodyLen": 22,
-     *     "restartCount": 0,
-     *     "workersUsed": 1,
-     *   }
-     *   ```
-     *   Beware that object fields might change in future releases.
-     */
-    stats: {
-        [x: string]: number;
-    };
-    /**
-     *   Actor run options. For example:
-     *   ```
-     *   {
-     *     "build": "latest",
-     *     "waitSecs": 0,
-     *     "memoryMbytes": 256,
-     *     "diskMbytes": 512
-     *   }
-     *   ```
-     */
-    options: {
-        [x: string]: any;
-    };
-    /**
-     *   ID of the actor build used for the run. For details, see
-     *   [Builds](https://docs.apify.com/actor/build)
-     *   in Apify actor documentation.
-     */
-    buildId: string;
-    /**
-     *   Number of the actor build used for the run. For example, `0.0.10`.
-     */
-    buildNumber: string;
-    /**
-     *   Exit code of the actor run process. It's `null` if actor is still running.
-     */
-    exitCode: number;
-    /**
-     *   ID of the default key-value store associated with the actor run. See {@link KeyValueStore } for details.
-     */
-    defaultKeyValueStoreId: string;
-    /**
-     *   ID of the default dataset associated with the actor run. See {@link Dataset } for details.
-     */
-    defaultDatasetId: string;
-    /**
-     *   ID of the default request queue associated with the actor run. See {@link RequestQueue } for details.
-     */
-    defaultRequestQueueId: string;
-    /**
-     *   URL on which the web server running inside actor run's Docker container can be accessed.
-     *   For more details, see
-     *   [Container web server](https://docs.apify.com/actor/run#container-web-server)
-     *   in Apify actor documentation.
-     */
-    containerUrl: string;
-    /**
-     *   Contains output of the actor run. The value is `null` or `undefined` in case the actor is still running,
-     *   or if you pass `false` to the `fetchOutput` option of {@link Apifycall }.
-     *
-     *   For example:
-     *   ```
-     *   {
-     *     "contentType": "application/json; charset=utf-8",
-     *     "body": {
-     *       "message": "Hello world!"
-     *     }
-     *   }
-     *   ```
-     */
-    output: ({
-        [x: string]: any;
-    } | null | undefined);
-};
-export type DirectNavigationOptions = {
-    /**
-     * Maximum operation time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The
-     * default value can be changed by using the browserContext.setDefaultNavigationTimeout(timeout),
-     * browserContext.setDefaultTimeout(timeout), page.setDefaultNavigationTimeout(timeout) or
-     * page.setDefaultTimeout(timeout) methods.
-     */
-    timeout?: number | undefined;
-    /**
-     * When to consider operation succeeded, defaults to `load`. Events can be either:
-     * - `'domcontentloaded'` - consider operation to be finished when the `DOMContentLoaded` event is fired.
-     * - `'load'` - consider operation to be finished when the `load` event is fired.
-     * - `'networkidle'` - consider operation to be finished when there are no network connections for at least `500` ms.
-     */
-    waitUntil?: "domcontentloaded" | "load" | "networkidle" | undefined;
-    /**
-     * Referer header value. If provided it will take preference over the referer header value set by page.setExtraHTTPHeaders(headers).
-     */
-    referer?: string | undefined;
-};
-//# sourceMappingURL=typedefs.d.ts.map

package/build/typedefs.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"typedefs.d.ts","sourceRoot":"","sources":["../src/typedefs.js"],"names":[],"mappings":";;;;;;;;;;;;;;QAWc,MAAM;;;;WAEN,MAAM;;;;eAEN,IAAI;;;;gBAEJ,IAAI;;;;;;YAEJ,MAAM;;;;;;;;;;;;YAIC,MAAM,GAAE,MAAM;;;;;;;;;;;;;;YASd,MAAM,GAAE,MAAM;;;;;;;;;;;;;;YAUd,MAAM;;;;;;;aAUb,MAAM;;;;iBAIN,MAAM;;;;cAEN,MAAM;;;;4BAEN,MAAM;;;;sBAEN,MAAM;;;;2BAEN,MAAM;;;;;;;kBAEN,MAAM;;;;;;;;;;;;;;;YAKN,CAAC;YAAO,MAAM;QAAK,IAAI,GAAC,SAAS,CAAC"}

package/build/typedefs.js

@@ -1,88 +0,0 @@
-"use strict";
-/**
- * Represents information about an actor run, as returned by the
- * {@link Apify#call} or {@link Apify#callTask} function.
- * The object is almost equivalent to the JSON response
- * of the
- * [Actor run](https://apify.com/docs/api/v2#/reference/actors/run-collection/run-actor)
- * Apify API endpoint and extended with certain fields.
- * For more details, see
- * [Runs.](https://docs.apify.com/actor/run)
- *
- * @typedef ActorRun
- * @property {string} id
- *   Actor run ID
- * @property {string} actId
- *   Actor ID
- * @property {Date} startedAt
- *   Time when the actor run started
- * @property {Date} finishedAt
- *   Time when the actor run finished. Contains `null` for running actors.
- * @property {string} status
- *   Status of the run. For possible values, see
- *   [Run lifecycle](https://docs.apify.com/actors/running#lifecycle)
- *   in Apify actor documentation.
- * @property {Object<string, string>} meta
- *   Actor run meta-data. For example:
- *   ```
- *   {
- *     "origin": "API",
- *     "clientIp": "1.2.3.4",
- *     "userAgent": "ApifyClient/0.2.13 (Linux; Node/v8.11.3)"
- *   }
- *   ```
- * @property {Object<string, number>} stats
- *   An object containing various actor run statistics. For example:
- *   ```
- *   {
- *     "inputBodyLen": 22,
- *     "restartCount": 0,
- *     "workersUsed": 1,
- *   }
- *   ```
- *   Beware that object fields might change in future releases.
- * @property {Object<string, *>} options
- *   Actor run options. For example:
- *   ```
- *   {
- *     "build": "latest",
- *     "waitSecs": 0,
- *     "memoryMbytes": 256,
- *     "diskMbytes": 512
- *   }
- *   ```
- * @property {string} buildId
- *   ID of the actor build used for the run. For details, see
- *   [Builds](https://docs.apify.com/actor/build)
- *   in Apify actor documentation.
- * @property {string} buildNumber
- *   Number of the actor build used for the run. For example, `0.0.10`.
- * @property {number} exitCode
- *   Exit code of the actor run process. It's `null` if actor is still running.
- * @property {string} defaultKeyValueStoreId
- *   ID of the default key-value store associated with the actor run. See {@link KeyValueStore} for details.
- * @property {string} defaultDatasetId
- *   ID of the default dataset associated with the actor run. See {@link Dataset} for details.
- * @property {string} defaultRequestQueueId
- *   ID of the default request queue associated with the actor run. See {@link RequestQueue} for details.
- * @property {string} containerUrl
- *   URL on which the web server running inside actor run's Docker container can be accessed.
- *   For more details, see
- *   [Container web server](https://docs.apify.com/actor/run#container-web-server)
- *   in Apify actor documentation.
- * @property {(Object<string, *>|null|undefined)} output
- *   Contains output of the actor run. The value is `null` or `undefined` in case the actor is still running,
- *   or if you pass `false` to the `fetchOutput` option of {@link Apify#call}.
- *
- *   For example:
- *   ```
- *   {
- *     "contentType": "application/json; charset=utf-8",
- *     "body": {
- *       "message": "Hello world!"
- *     }
- *   }
- *   ```
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=typedefs.js.map

package/build/typedefs.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"typedefs.js","sourceRoot":"","sources":["../src/typedefs.js"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoFG"}

package/build/utils.d.ts

@@ -1,175 +0,0 @@
-/// <reference types="node" />
-export function newClient(options?: {
-    token?: string | undefined;
-    maxRetries?: string | undefined;
-    minDelayBetweenRetriesMillis?: string | undefined;
-} | undefined): ApifyClient;
-export function logSystemInfo(): void;
-/**
- * The default instance of `ApifyClient` used internally
- * by the SDK.
- *
- * @type {*}
- * @ignore
- */
-export const apifyClient: any;
-export function addCharsetToContentType(contentType: string): string;
-export function isDocker(forceReset: boolean): Promise<boolean>;
-export function weightedAvg(arrValues: number[], arrWeights: number[]): number;
-export function getMemoryInfo(): Promise<MemoryInfo>;
-export function getFirstKey(dict: any): string | undefined;
-export function getTypicalChromeExecutablePath(): string;
-export function isAtHome(): boolean;
-export function sleep(millis: number): Promise<void>;
-export function snakeCaseToCamelCase(snakeCaseStr: string): string;
-export function printOutdatedSdkWarning(): void;
-export function parseContentTypeFromResponse(response: IncomingMessage): {
-    type: string;
-    charset: string;
-};
-export function waitForRunToFinish(options: {
-    actorId: string;
-    runId: string;
-    waitSecs?: string | undefined;
-    token?: string | undefined;
-}): Promise<ActorRun>;
-export function purgeLocalStorage(folder?: string | undefined): Promise<void>;
-export namespace publicUtils {
-    export { isDocker };
-    export { sleep };
-    export { downloadListOfUrls };
-    export { extractUrls };
-    export { htmlToText };
-    export { URL_NO_COMMAS_REGEX };
-    export { URL_WITH_COMMAS_REGEX };
-    export { createRequestDebugInfo };
-    export { waitForRunToFinish };
-    export { purgeLocalStorage };
-}
-/**
- * Describes memory usage of an Actor.
- */
-export type MemoryInfo = {
-    /**
-     * Total memory available in the system or container
-     */
-    totalBytes: number;
-    /**
-     * Amount of free memory in the system or container
-     */
-    freeBytes: number;
-    /**
-     * Amount of memory used (= totalBytes - freeBytes)
-     */
-    usedBytes: number;
-    /**
-     * Amount of memory used the current Node.js process
-     */
-    mainProcessBytes: number;
-    /**
-     * Amount of memory used by child processes of the current Node.js process
-     */
-    childProcessesBytes: number;
-};
-import { ApifyClient } from "apify-client/dist/apify_client";
-import { IncomingMessage } from "http";
-import { ActorRun } from "./typedefs";
-/**
- * Returns a promise that resolves to an array of urls parsed from the resource available at the provided url.
- * Optionally, custom regular expression and encoding may be provided.
- *
- * @param {object} options
- * @param {string} options.url URL to the file
- * @param {string} [options.encoding='utf8'] The encoding of the file.
- * @param {string} [options.proxyUrl] The proxy url to be used for the request.
- * @param {RegExp} [options.urlRegExp=URL_NO_COMMAS_REGEX]
- *   Custom regular expression to identify the URLs in the file to extract.
- *   The regular expression should be case-insensitive and have global flag set (i.e. `/something/gi`).
- * @returns {Promise<Array<string>>}
- * @memberOf utils
- */
-declare function downloadListOfUrls(options: {
-    url: string;
-    encoding?: string | undefined;
-    proxyUrl?: string | undefined;
-    urlRegExp?: RegExp | undefined;
-}): Promise<Array<string>>;
-/**
- * Collects all URLs in an arbitrary string to an array, optionally using a custom regular expression.
- * @param {object} options
- * @param {string} options.string
- * @param {RegExp} [options.urlRegExp=Apify.utils.URL_NO_COMMAS_REGEX]
- * @returns {string[]}
- * @memberOf utils
- */
-declare function extractUrls(options: {
-    string: string;
-    urlRegExp?: RegExp | undefined;
-}): string[];
-/**
- * The function converts a HTML document to a plain text.
- *
- * The plain text generated by the function is similar to a text captured
- * by pressing Ctrl+A and Ctrl+C on a page when loaded in a web browser.
- * The function doesn't aspire to preserve the formatting or to be perfectly correct with respect to HTML specifications.
- * However, it attempts to generate newlines and whitespaces in and around HTML elements
- * to avoid merging distinct parts of text and thus enable extraction of data from the text (e.g. phone numbers).
- *
- * **Example usage**
- * ```javascript
- * const text = htmlToText('<html><body>Some text</body></html>');
- * console.log(text);
- * ```
- *
- * Note that the function uses [cheerio](https://www.npmjs.com/package/cheerio) to parse the HTML.
- * Optionally, to avoid duplicate parsing of HTML and thus improve performance, you can pass
- * an existing Cheerio object to the function instead of the HTML text. The HTML should be parsed
- * with the `decodeEntities` option set to `true`. For example:
- *
- * ```javascript
- * const cheerio = require('cheerio');
- * const html = '<html><body>Some text</body></html>';
- * const text = htmlToText(cheerio.load(html, { decodeEntities: true }));
- * ```
- * @param {(string|CheerioAPI)} html HTML text or parsed HTML represented using a
- * [cheerio](https://www.npmjs.com/package/cheerio) function.
- * @return {string} Plain text
- * @memberOf utils
- * @function
- */
-declare function htmlToText(html: (string | CheerioAPI)): string;
-/**
- * Default regular expression to match URLs in a string that may be plain text, JSON, CSV or other. It supports common URL characters
- * and does not support URLs containing commas or spaces. The URLs also may contain Unicode letters (not symbols).
- * @memberOf utils
- */
-declare const URL_NO_COMMAS_REGEX: RegExp;
-/**
- * Regular expression that, in addition to the default regular expression `URL_NO_COMMAS_REGEX`, supports matching commas in URL path and query.
- * Note, however, that this may prevent parsing URLs from comma delimited lists, or the URLs may become malformed.
- * @memberOf utils
- */
-declare const URL_WITH_COMMAS_REGEX: RegExp;
-/**
- * Creates a standardized debug info from request and response. This info is usually added to dataset under the hidden `#debug` field.
- *
- * @param {(Request|RequestOptions)} request [Apify.Request](https://sdk.apify.com/docs/api/request) object.
- * @param {(*|IncomingMessage|PuppeteerResponse)} [response]
- *   Puppeteer [`Response`](https://pptr.dev/#?product=Puppeteer&version=v1.11.0&show=api-class-response)
- *   or NodeJS [`http.IncomingMessage`](https://nodejs.org/api/http.html#http_class_http_serverresponse).
- * @param {Object<string, *>} [additionalFields] Object containing additional fields to be added.
-
- * @return {Object<string, *>}
- */
-declare function createRequestDebugInfo(request: (Request | RequestOptions), response?: (any | IncomingMessage | PuppeteerResponse), additionalFields?: {
-    [x: string]: any;
-} | undefined): {
-    [x: string]: any;
-};
-import { CheerioAPI } from "cheerio/lib/load";
-import Request from "./request";
-import { RequestOptions } from "./request";
-// @ts-ignore optional peer dependency
-import { HTTPResponse as PuppeteerResponse } from "puppeteer";
-export {};
-//# sourceMappingURL=utils.d.ts.map

package/build/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.js"],"names":[],"mappings":";AA+EO;;;;gBAFK,WAAW,CAmBtB;AAKM,sCAON;AAED;;;;;;GAMG;AACH,8BAAuE;AAUhE,qDALI,MAAM,GACJ,MAAM,CAclB;AA6BM,qCAPI,OAAO,GACN,QAAQ,OAAO,CAAC,CAW3B;AAWM,uCANI,MAAM,EAAE,cACR,MAAM,EAAE,GACP,MAAM,CAajB;AA4BM,iCANM,QAAQ,UAAU,CAAC,CA2H/B;AAOM,2DAIN;AAQM,kDAHK,MAAM,CA6BjB;AAWM,4BANM,OAAO,CAM4C;AAsBzD,8BANI,MAAM,GAIL,QAAQ,IAAI,CAAC,CAIxB;AAgLM,mDAJI,MAAM,GACL,MAAM,CAajB;AAOM,gDAQN;AAQM,uDAJI,eAAe,GACd;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,CAgC5C;AA+BM;IApBoB,OAAO,EAAvB,MAAM;IAEU,KAAK,EAArB,MAAM;IAEW,QAAQ;IAIR,KAAK;IAIpB,QAAQ,QAAQ,CAAC,CA+C7B;AAcM,gEALM,QAAQ,IAAI,CAAC,CAazB;;;;;;;;;;;;;;;;;;;;gBAriBa,MAAM;;;;eACN,MAAM;;;;eACN,MAAM;;;;sBACN,MAAM;;;;yBACN,MAAM;;;;;AAyNpB;;;;;;;;;;;;;GAaG;AACH;IAT2B,GAAG,EAAnB,MAAM;IACW,QAAQ;IACR,QAAQ;IACR,SAAS;IAGxB,QAAQ,MAAM,MAAM,CAAC,CAAC,CAsBlC;AAED;;;;;;;GAOG;AACH;IAL2B,MAAM,EAAtB,MAAM;IACW,SAAS;IACxB,MAAM,EAAE,CAUpB;AAMD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,kCANW,CAAC,MAAM,GAAC,UAAU,CAAC,GAElB,MAAM,CAqDjB;AAxgBD;;;;GAIG;AACH,0CAAoL;AACpL;;;;GAIG;AACH,4CAAuL;AA+fvL;;;;;;;;;;GAUG;AACH,iDARW,CAAC,OAAO,GAAC,cAAc,CAAC,aACxB,CAAC,MAAE,eAAe,GAAC,iBAAiB,CAAC;;;QAK7B,MAAM;EAkBxB"}