crawlee-one 1.0.0

package/dist/cjs/lib/config.d.ts

@@ -0,0 +1,561 @@
+import type { Actor } from 'apify';
+import type { CheerioCrawlerOptions } from 'crawlee';
+import Joi from 'joi';
+import type { CrawlerUrl } from '../types';
+import { LogLevel } from './log';
+export type AllActorInputs = InputActorInput & CrawlerConfigActorInput & PerfActorInput & StartUrlsActorInput & LoggingActorInput & ProxyActorInput & PrivacyActorInput & RequestActorInput & OutputActorInput & MetamorphActorInput;
+/** Crawler config fields that can be overriden from the actor input */
+export type CrawlerConfigActorInput = Pick<CheerioCrawlerOptions, 'navigationTimeoutSecs' | 'ignoreSslErrors' | 'additionalMimeTypes' | 'suggestResponseEncoding' | 'forceResponseEncoding' | 'requestHandlerTimeoutSecs' | 'maxRequestRetries' | 'maxRequestsPerCrawl' | 'maxRequestsPerMinute' | 'minConcurrency' | 'maxConcurrency' | 'keepAlive'>;
+/** Common input fields related to extending Actor input with remote or generated data */
+export interface InputActorInput {
+    /**
+     * If set, the Actor input is extended with a config from this URL.
+     *
+     * For example, you can store your actor input in a source control, and import it here.
+     *
+     * In case of a conflict (if a field is defined both in Actor input and in imported input)
+     * the Actor input overwrites the imported fields.
+     *
+     * The URL must point to a JSON file containing a single object (the config).
+     */
+    inputExtendUrl?: string;
+    /**
+     * If set, the Actor input is extended with a config from this custom function.
+     *
+     * For example, you can store your actor input in a source control, and import it here.
+     *
+     * In case of a conflict (if a field is defined both in Actor input and in imported input)
+     * the Actor input overwrites the imported fields.
+     *
+     * The URL must point to a JSON file containing a single object (the config).
+     */
+    inputExtendFromFunction?: string;
+}
+/** Common input fields related to performance which are not part of the CrawlerConfig */
+export interface PerfActorInput {
+    /**
+     * If set, multiple Requests will be handled by a single Actor instance.
+     *
+     * See official docs: https://docs.apify.com/platform/actors/development/performance#batch-jobs-win-over-the-single-jobs
+     *
+     * Example: If set to 20, then up to 20 requests will be handled in a single "go".
+     */
+    perfBatchSize?: number;
+    /**
+     * How long to wait between entries within a single batch.
+     *
+     * Increase this value if you're using batching and you're sending requests to the scraped website too fast.
+     *
+     * Example: If set to 1, then after each entry in a batch, wait 1 second before continuing.
+     */
+    perfBatchWaitSecs?: number;
+}
+/** Common input fields for defining URLs to scrape */
+export interface StartUrlsActorInput {
+    /** URLs to start with, defined manually as a list of strings or crawler requests */
+    startUrls?: CrawlerUrl[];
+    /**
+     * Import starting URLs from an existing Dataset.
+     *
+     * String is in the format `datasetID#field` (e.g. `datasetid123#url`).
+     */
+    startUrlsFromDataset?: string;
+    /**
+     * Import or generate starting URLs using a custom function.
+     *
+     * The function has access to Apify's Actor class (under variable `io`), and actor's input
+     * and a shared state in the first argument.
+     *
+     * ```js
+     * // Example: Create and load URLs from a Dataset by combining multiple fields
+     * async ({ io, input, state, itemCacheKey }) => {
+     *   const dataset = await io.openDataset(datasetNameOrId);
+     *   const data = await dataset.getData();
+     *   const urls = data.items.map((item) => `https://example.com/u/${item.userId}/list/${item.listId}`);
+     *   return urls;
+     * }
+     * ```
+     */
+    startUrlsFromFunction?: string;
+}
+/** Common input fields related to logging setup */
+export interface LoggingActorInput {
+    logLevel?: LogLevel;
+    /**
+     * Whether to send actor error reports to <a href="https://sentry.io/">Sentry</a>.
+     *
+     * This info is used by the author of this actor to identify broken integrations,
+     * and track down and fix issues.
+     */
+    errorSendToSentry?: boolean;
+    /**
+     * Dataset ID to which errors should be captured.
+     *
+     * Default: `'REPORTING'`.
+     */
+    errorReportingDatasetId?: string;
+}
+/** Common input fields related to proxy setup */
+export interface ProxyActorInput {
+    proxy?: Parameters<Actor['createProxyConfiguration']>[0];
+}
+/** Common input fields related to actor requests */
+export interface RequestActorInput {
+    /**
+     * If set, only at most this many requests will be scraped.
+     *
+     * The count is determined from the RequestQueue that's used for the Actor run.
+     *
+     * This means that if `requestMaxEntries` is set to 50, but the
+     * associated RequestQueue already handled 40 requests, then only 10 new requests
+     * will be handled.
+     */
+    requestMaxEntries?: number;
+    /**
+     * Option to freely transform a request using a custom function before pushing it to the RequestQueue.
+     *
+     * If not set, the request will remain as is.
+     *
+     * The function has access to Apify's Actor class (under variable `io`), and actor's input
+     * and a shared state in the second argument.
+     *
+     * `async (entry, { io, input, state, itemCacheKey }) => { ... }`
+     */
+    requestTransform?: string;
+    /**
+     * Use this if you need to run one-time initialization code before `requestTransform`.
+     *
+     * The function has access to Apify's Actor class (under variable `io`), and actor's input
+     * and a shared state in the first argument.
+     *
+     * `async ({ io, input, state, itemCacheKey }) => { ... }`
+     */
+    requestTransformBefore?: string;
+    /**
+     * Use this if you need to run one-time teardown code after `requestTransform`.
+     *
+     * The function has access to Apify's Actor class (under variable `io`), and actor's input
+     * and a shared state in the first argument.
+     *
+     * `async ({ io, input, state, itemCacheKey }) => { ... }`
+     */
+    requestTransformAfter?: string;
+    /**
+     * Option to filter a request using a custom function before pushing it to the RequestQueue.
+     *
+     * If not set, all requests will be included.
+     *
+     * This is done after `requestTransform`.
+     *
+     * The function has access to Apify's Actor class (under variable `io`), and actor's input
+     * and a shared state in the second argument.
+     *
+     * `async (entry, { io, input, state, itemCacheKey }) => boolean`
+     */
+    requestFilter?: string;
+    /**
+     * Use this if you need to run one-time initialization code before `requestFilter`.
+     *
+     * The function has access to Apify's Actor class (under variable `io`), and actor's input
+     * and a shared state in the first argument.
+     *
+     * `async ({ io, input, state, itemCacheKey }) => boolean`
+     */
+    requestFilterBefore?: string;
+    /**
+     * Use this if you need to run one-time initialization code after `requestFilter`.
+     *
+     * The function has access to Apify's Actor class (under variable `io`), and actor's input
+     * and a shared state in the first argument.
+     *
+     * `async ({ io, input, state, itemCacheKey }) => boolean`
+     */
+    requestFilterAfter?: string;
+    /** ID of the RequestQueue to which the requests should be pushed */
+    requestQueueId?: string;
+}
+/** Common input fields related to actor output */
+export interface OutputActorInput {
+    /**
+     * If set, only at most this many entries will be scraped.
+     *
+     * The count is determined from the Dataset that's used for the Actor run.
+     *
+     * This means that if `outputMaxEntries` is set to 50, but the
+     * associated Dataset already has 40 items in it, then only 10 new entries
+     * will be saved.
+     */
+    outputMaxEntries?: number;
+    /**
+     * Option to select a subset of keys/fields of an entry that
+     * will be pushed to the dataset.
+     *
+     * If not set, all fields on an entry will be pushed to the dataset.
+     *
+     * This is done after `outputRenameFields`.
+     *
+     * Keys can be nested, e.g. `"someProp.value[0]"`. Nested path is
+     * resolved using Lodash.get().
+     */
+    outputPickFields?: string[];
+    /**
+     * Option to remap the keys before pushing the entries to the dataset.
+     *
+     * This is done before `outputRenameFields`.
+     *
+     * Keys can be nested, e.g. `"someProp.value[0]"`. Nested path is
+     * resolved using Lodash.get().
+     */
+    outputRenameFields?: Record<string, string>;
+    /**
+     * Option to freely transform the output data object using a custom function before pushing it to the dataset.
+     *
+     * If not set, the data will remain as is.
+     *
+     * This is done after `outputPickFields` and `outputRenameFields`.
+     *
+     * The function has access to Apify's Actor class (under variable `io`), and actor's input
+     * and a shared state in the second argument.
+     *
+     * `async (entry, { io, input, state, itemCacheKey }) => { ... }`
+     */
+    outputTransform?: string;
+    /**
+     * Use this if you need to run one-time initialization code before `outputTransform`.
+     *
+     * The function has access to Apify's Actor class (under variable `io`), and actor's input
+     * and a shared state in the first argument.
+     *
+     * `async ({ io, input, state, itemCacheKey }) => { ... }`
+     */
+    outputTransformBefore?: string;
+    /**
+     * Use this if you need to run one-time teardown code after `outputTransform`.
+     *
+     * The function has access to Apify's Actor class (under variable `io`), and actor's input
+     * and a shared state in the first argument.
+     *
+     * `async ({ io, input, state, itemCacheKey }) => { ... }`
+     */
+    outputTransformAfter?: string;
+    /**
+     * Option to filter out the data using a custom function before pushing it to the dataset.
+     *
+     * If not set, all entries will be included.
+     *
+     * This is done after `outputPickFields`, `outputRenameFields`, and `outputTransform`.
+     *
+     * The function has access to Apify's Actor class (under variable `io`), and actor's input
+     * and a shared state in the second argument.
+     *
+     * `async (entry, { io, input, state, itemCacheKey }) => boolean`
+     */
+    outputFilter?: string;
+    /**
+     * Use this if you need to run one-time initialization code before `outputFilter`.
+     *
+     * The function has access to Apify's Actor class (under variable `io`), and actor's input
+     * and a shared state in the first argument.
+     *
+     * `async ({ io, input, state, itemCacheKey }) => boolean`
+     */
+    outputFilterBefore?: string;
+    /**
+     * Use this if you need to run one-time initialization code after `outputFilter`.
+     *
+     * The function has access to Apify's Actor class (under variable `io`), and actor's input
+     * and a shared state in the first argument.
+     *
+     * `async ({ io, input, state, itemCacheKey }) => boolean`
+     */
+    outputFilterAfter?: string;
+    /** ID or name of the dataset to which the data should be pushed */
+    outputDatasetId?: string;
+    /** ID or name of the key-value store used as cache */
+    outputCacheStoreId?: string;
+    /** Define fields that will be used for cache key */
+    outputCachePrimaryKeys?: string[];
+    /** Define whether we want to add, remove, or overwrite cached entries with results from the actor run */
+    outputCacheActionOnResult?: 'add' | 'remove' | 'overwrite' | null;
+}
+/** Common input fields related to actor metamorphing */
+export interface MetamorphActorInput {
+    /**
+     * If you want to run another actor with the same dataset after
+     * this actor has finished (AKA metamorph into another actor),
+     * then set the ID of the target actor.
+     *
+     * See https://docs.apify.com/sdk/python/docs/concepts/interacting-with-other-actors#actormetamorph
+     */
+    metamorphActorId?: string;
+    /**
+     * Tag or number of the target actor build to metamorph into (e.g. `beta` or `1.2.345`).
+     *
+     * See https://docs.apify.com/sdk/python/docs/concepts/interacting-with-other-actors#actormetamorph
+     */
+    metamorphActorBuild?: string;
+    /**
+     * Input passed to the follow-up (metamorph) actor.
+     *
+     * See https://docs.apify.com/sdk/python/docs/concepts/interacting-with-other-actors#actormetamorph
+     */
+    metamorphActorInput?: object;
+}
+/** Common input fields related to privacy setup */
+export interface PrivacyActorInput {
+    includePersonalData?: boolean;
+}
+/** Common input fields related to actor input */
+export declare const inputInput: {
+    inputExtendUrl: import("apify-actor-config").StringField<string, string>;
+    inputExtendFromFunction: import("apify-actor-config").StringField<string, string>;
+};
+/** Common input fields related to crawler setup */
+export declare const crawlerInput: {
+    maxRequestRetries: import("apify-actor-config").IntegerField<number, string>;
+    maxRequestsPerMinute: import("apify-actor-config").IntegerField<number, string>;
+    maxRequestsPerCrawl: import("apify-actor-config").IntegerField<number, string>;
+    minConcurrency: import("apify-actor-config").IntegerField<number, string>;
+    maxConcurrency: import("apify-actor-config").IntegerField<number, string>;
+    navigationTimeoutSecs: import("apify-actor-config").IntegerField<number, string>;
+    requestHandlerTimeoutSecs: import("apify-actor-config").IntegerField<number, string>;
+    keepAlive: import("apify-actor-config").BooleanField<boolean>;
+    ignoreSslErrors: import("apify-actor-config").BooleanField<boolean>;
+    additionalMimeTypes: import("apify-actor-config").ArrayField<any[]>;
+    suggestResponseEncoding: import("apify-actor-config").StringField<string, string>;
+    forceResponseEncoding: import("apify-actor-config").StringField<string, string>;
+};
+/** Common input fields related to performance which are not part of the CrawlerConfig */
+export declare const perfInput: {
+    perfBatchSize: import("apify-actor-config").IntegerField<number, string>;
+    perfBatchWaitSecs: import("apify-actor-config").IntegerField<number, string>;
+};
+/** Common input fields for defining URLs to scrape */
+export declare const startUrlsInput: {
+    startUrls: import("apify-actor-config").ArrayField<any[]>;
+    startUrlsFromDataset: import("apify-actor-config").StringField<string, string>;
+    startUrlsFromFunction: import("apify-actor-config").StringField<string, string>;
+};
+/** Common input fields related to logging setup */
+export declare const loggingInput: {
+    logLevel: import("apify-actor-config").StringField<"error" | "off" | "info" | "debug" | "warn", string>;
+    errorReportingDatasetId: import("apify-actor-config").StringField<string, string>;
+    errorSendToSentry: import("apify-actor-config").BooleanField<boolean>;
+};
+/** Common input fields related to proxy setup */
+export declare const proxyInput: {
+    proxy: import("apify-actor-config").ObjectField<object>;
+};
+/** Common input fields related to proxy setup */
+export declare const privacyInput: {
+    includePersonalData: import("apify-actor-config").BooleanField<boolean>;
+};
+/** Common input fields related to actor request */
+export declare const requestInput: {
+    requestMaxEntries: import("apify-actor-config").IntegerField<number, string>;
+    requestTransform: import("apify-actor-config").StringField<string, string>;
+    requestTransformBefore: import("apify-actor-config").StringField<string, string>;
+    requestTransformAfter: import("apify-actor-config").StringField<string, string>;
+    requestFilter: import("apify-actor-config").StringField<string, string>;
+    requestFilterBefore: import("apify-actor-config").StringField<string, string>;
+    requestFilterAfter: import("apify-actor-config").StringField<string, string>;
+    requestQueueId: import("apify-actor-config").StringField<string, string>;
+};
+/** Common input fields related to actor output */
+export declare const outputInput: {
+    outputMaxEntries: import("apify-actor-config").IntegerField<number, string>;
+    outputRenameFields: import("apify-actor-config").ObjectField<{
+        oldFieldName: string;
+    }>;
+    outputPickFields: import("apify-actor-config").ArrayField<string[]>;
+    outputTransform: import("apify-actor-config").StringField<string, string>;
+    outputTransformBefore: import("apify-actor-config").StringField<string, string>;
+    outputTransformAfter: import("apify-actor-config").StringField<string, string>;
+    outputFilter: import("apify-actor-config").StringField<string, string>;
+    outputFilterBefore: import("apify-actor-config").StringField<string, string>;
+    outputFilterAfter: import("apify-actor-config").StringField<string, string>;
+    outputDatasetId: import("apify-actor-config").StringField<string, string>;
+    outputCacheStoreId: import("apify-actor-config").StringField<string, string>;
+    outputCachePrimaryKeys: import("apify-actor-config").ArrayField<string[]>;
+    outputCacheActionOnResult: import("apify-actor-config").StringField<NonNullable<"add" | "remove" | "overwrite" | null | undefined>, string>;
+};
+/** Common input fields related to actor metamorphing */
+export declare const metamorphInput: {
+    metamorphActorId: import("apify-actor-config").StringField<string, string>;
+    metamorphActorBuild: import("apify-actor-config").StringField<string, string>;
+    metamorphActorInput: import("apify-actor-config").ObjectField<{
+        uploadDatasetToGDrive: boolean;
+    }>;
+};
+export declare const allActorInputs: {
+    metamorphActorId: import("apify-actor-config").StringField<string, string>;
+    metamorphActorBuild: import("apify-actor-config").StringField<string, string>;
+    metamorphActorInput: import("apify-actor-config").ObjectField<{
+        uploadDatasetToGDrive: boolean;
+    }>;
+    logLevel: import("apify-actor-config").StringField<"error" | "off" | "info" | "debug" | "warn", string>;
+    errorReportingDatasetId: import("apify-actor-config").StringField<string, string>;
+    errorSendToSentry: import("apify-actor-config").BooleanField<boolean>;
+    perfBatchSize: import("apify-actor-config").IntegerField<number, string>;
+    perfBatchWaitSecs: import("apify-actor-config").IntegerField<number, string>;
+    maxRequestRetries: import("apify-actor-config").IntegerField<number, string>;
+    maxRequestsPerMinute: import("apify-actor-config").IntegerField<number, string>;
+    maxRequestsPerCrawl: import("apify-actor-config").IntegerField<number, string>;
+    minConcurrency: import("apify-actor-config").IntegerField<number, string>;
+    maxConcurrency: import("apify-actor-config").IntegerField<number, string>;
+    navigationTimeoutSecs: import("apify-actor-config").IntegerField<number, string>;
+    requestHandlerTimeoutSecs: import("apify-actor-config").IntegerField<number, string>;
+    keepAlive: import("apify-actor-config").BooleanField<boolean>;
+    ignoreSslErrors: import("apify-actor-config").BooleanField<boolean>;
+    additionalMimeTypes: import("apify-actor-config").ArrayField<any[]>;
+    suggestResponseEncoding: import("apify-actor-config").StringField<string, string>;
+    forceResponseEncoding: import("apify-actor-config").StringField<string, string>;
+    outputMaxEntries: import("apify-actor-config").IntegerField<number, string>;
+    outputRenameFields: import("apify-actor-config").ObjectField<{
+        oldFieldName: string;
+    }>;
+    outputPickFields: import("apify-actor-config").ArrayField<string[]>;
+    outputTransform: import("apify-actor-config").StringField<string, string>;
+    outputTransformBefore: import("apify-actor-config").StringField<string, string>;
+    outputTransformAfter: import("apify-actor-config").StringField<string, string>;
+    outputFilter: import("apify-actor-config").StringField<string, string>;
+    outputFilterBefore: import("apify-actor-config").StringField<string, string>;
+    outputFilterAfter: import("apify-actor-config").StringField<string, string>;
+    outputDatasetId: import("apify-actor-config").StringField<string, string>;
+    outputCacheStoreId: import("apify-actor-config").StringField<string, string>;
+    outputCachePrimaryKeys: import("apify-actor-config").ArrayField<string[]>;
+    outputCacheActionOnResult: import("apify-actor-config").StringField<NonNullable<"add" | "remove" | "overwrite" | null | undefined>, string>;
+    requestMaxEntries: import("apify-actor-config").IntegerField<number, string>;
+    requestTransform: import("apify-actor-config").StringField<string, string>;
+    requestTransformBefore: import("apify-actor-config").StringField<string, string>;
+    requestTransformAfter: import("apify-actor-config").StringField<string, string>;
+    requestFilter: import("apify-actor-config").StringField<string, string>;
+    requestFilterBefore: import("apify-actor-config").StringField<string, string>;
+    requestFilterAfter: import("apify-actor-config").StringField<string, string>;
+    requestQueueId: import("apify-actor-config").StringField<string, string>;
+    includePersonalData: import("apify-actor-config").BooleanField<boolean>;
+    proxy: import("apify-actor-config").ObjectField<object>;
+    startUrls: import("apify-actor-config").ArrayField<any[]>;
+    startUrlsFromDataset: import("apify-actor-config").StringField<string, string>;
+    startUrlsFromFunction: import("apify-actor-config").StringField<string, string>;
+    inputExtendUrl: import("apify-actor-config").StringField<string, string>;
+    inputExtendFromFunction: import("apify-actor-config").StringField<string, string>;
+};
+export declare const crawlerInputValidationFields: {
+    navigationTimeoutSecs: Joi.NumberSchema<number>;
+    ignoreSslErrors: Joi.BooleanSchema<boolean>;
+    additionalMimeTypes: Joi.ArraySchema<any[]>;
+    suggestResponseEncoding: Joi.StringSchema<string>;
+    forceResponseEncoding: Joi.StringSchema<string>;
+    requestHandlerTimeoutSecs: Joi.NumberSchema<number>;
+    maxRequestRetries: Joi.NumberSchema<number>;
+    maxRequestsPerCrawl: Joi.NumberSchema<number>;
+    maxRequestsPerMinute: Joi.NumberSchema<number>;
+    minConcurrency: Joi.NumberSchema<number>;
+    maxConcurrency: Joi.NumberSchema<number>;
+    keepAlive: Joi.BooleanSchema<boolean>;
+};
+export declare const perfInputValidationFields: {
+    perfBatchSize: Joi.NumberSchema<number>;
+    perfBatchWaitSecs: Joi.NumberSchema<number>;
+};
+export declare const inputInputValidationFields: {
+    inputExtendUrl: Joi.StringSchema<string>;
+    inputExtendFromFunction: Joi.StringSchema<string>;
+};
+export declare const startUrlsInputValidationFields: {
+    startUrls: Joi.ArraySchema<any[]>;
+    startUrlsFromDataset: Joi.StringSchema<string>;
+    startUrlsFromFunction: Joi.StringSchema<string>;
+};
+export declare const loggingInputValidationFields: {
+    logLevel: Joi.StringSchema<string>;
+    errorReportingDatasetId: Joi.StringSchema<string>;
+    errorSendToSentry: Joi.BooleanSchema<boolean>;
+};
+export declare const proxyInputValidationFields: {
+    proxy: Joi.ObjectSchema<any>;
+};
+export declare const privacyInputValidationFields: {
+    includePersonalData: Joi.BooleanSchema<boolean>;
+};
+export declare const requestInputValidationFields: {
+    requestMaxEntries: Joi.NumberSchema<number>;
+    requestTransform: Joi.StringSchema<string>;
+    requestTransformBefore: Joi.StringSchema<string>;
+    requestTransformAfter: Joi.StringSchema<string>;
+    requestFilter: Joi.StringSchema<string>;
+    requestFilterBefore: Joi.StringSchema<string>;
+    requestFilterAfter: Joi.StringSchema<string>;
+    requestQueueId: Joi.StringSchema<string>;
+};
+export declare const outputInputValidationFields: {
+    outputMaxEntries: Joi.NumberSchema<number>;
+    outputPickFields: Joi.ArraySchema<any[]>;
+    outputRenameFields: Joi.ObjectSchema<any>;
+    outputTransform: Joi.StringSchema<string>;
+    outputTransformBefore: Joi.StringSchema<string>;
+    outputTransformAfter: Joi.StringSchema<string>;
+    outputFilter: Joi.StringSchema<string>;
+    outputFilterBefore: Joi.StringSchema<string>;
+    outputFilterAfter: Joi.StringSchema<string>;
+    outputCacheStoreId: Joi.StringSchema<string>;
+    outputCachePrimaryKeys: Joi.ArraySchema<any[]>;
+    outputCacheActionOnResult: Joi.StringSchema<string>;
+    outputDatasetId: Joi.StringSchema<string>;
+};
+export declare const metamorphInputValidationFields: {
+    metamorphActorId: Joi.StringSchema<string>;
+    metamorphActorBuild: Joi.StringSchema<string>;
+    metamorphActorInput: Joi.ObjectSchema<any>;
+};
+export declare const allActorInputValidationFields: {
+    metamorphActorId: Joi.StringSchema<string>;
+    metamorphActorBuild: Joi.StringSchema<string>;
+    metamorphActorInput: Joi.ObjectSchema<any>;
+    logLevel: Joi.StringSchema<string>;
+    errorReportingDatasetId: Joi.StringSchema<string>;
+    errorSendToSentry: Joi.BooleanSchema<boolean>;
+    perfBatchSize: Joi.NumberSchema<number>;
+    perfBatchWaitSecs: Joi.NumberSchema<number>;
+    navigationTimeoutSecs: Joi.NumberSchema<number>;
+    ignoreSslErrors: Joi.BooleanSchema<boolean>;
+    additionalMimeTypes: Joi.ArraySchema<any[]>;
+    suggestResponseEncoding: Joi.StringSchema<string>;
+    forceResponseEncoding: Joi.StringSchema<string>;
+    requestHandlerTimeoutSecs: Joi.NumberSchema<number>;
+    maxRequestRetries: Joi.NumberSchema<number>;
+    maxRequestsPerCrawl: Joi.NumberSchema<number>;
+    maxRequestsPerMinute: Joi.NumberSchema<number>;
+    minConcurrency: Joi.NumberSchema<number>;
+    maxConcurrency: Joi.NumberSchema<number>;
+    keepAlive: Joi.BooleanSchema<boolean>;
+    outputMaxEntries: Joi.NumberSchema<number>;
+    outputPickFields: Joi.ArraySchema<any[]>;
+    outputRenameFields: Joi.ObjectSchema<any>;
+    outputTransform: Joi.StringSchema<string>;
+    outputTransformBefore: Joi.StringSchema<string>;
+    outputTransformAfter: Joi.StringSchema<string>;
+    outputFilter: Joi.StringSchema<string>;
+    outputFilterBefore: Joi.StringSchema<string>;
+    outputFilterAfter: Joi.StringSchema<string>;
+    outputCacheStoreId: Joi.StringSchema<string>;
+    outputCachePrimaryKeys: Joi.ArraySchema<any[]>;
+    outputCacheActionOnResult: Joi.StringSchema<string>;
+    outputDatasetId: Joi.StringSchema<string>;
+    requestMaxEntries: Joi.NumberSchema<number>;
+    requestTransform: Joi.StringSchema<string>;
+    requestTransformBefore: Joi.StringSchema<string>;
+    requestTransformAfter: Joi.StringSchema<string>;
+    requestFilter: Joi.StringSchema<string>;
+    requestFilterBefore: Joi.StringSchema<string>;
+    requestFilterAfter: Joi.StringSchema<string>;
+    requestQueueId: Joi.StringSchema<string>;
+    includePersonalData: Joi.BooleanSchema<boolean>;
+    proxy: Joi.ObjectSchema<any>;
+    startUrls: Joi.ArraySchema<any[]>;
+    startUrlsFromDataset: Joi.StringSchema<string>;
+    startUrlsFromFunction: Joi.StringSchema<string>;
+    inputExtendUrl: Joi.StringSchema<string>;
+    inputExtendFromFunction: Joi.StringSchema<string>;
+};