@apify/consts
Version:
Tools and constants shared across Apify projects.
635 lines (632 loc) • 26.4 kB
text/typescript
declare const FREE_SUBSCRIPTION_PLAN_CODE = "DEV";
declare const ACTOR_JOB_TYPES: {
readonly BUILD: "BUILD";
readonly RUN: "RUN";
};
declare const ACTOR_SOURCE_TYPES: {
readonly SOURCE_CODE: "SOURCE_CODE";
readonly SOURCE_FILES: "SOURCE_FILES";
readonly GIT_REPO: "GIT_REPO";
readonly TARBALL: "TARBALL";
readonly GITHUB_GIST: "GITHUB_GIST";
};
declare const ACTOR_EVENT_NAMES: {
readonly CPU_INFO: "cpuInfo";
readonly SYSTEM_INFO: "systemInfo";
readonly MIGRATING: "migrating";
readonly PERSIST_STATE: "persistState";
readonly ABORTING: "aborting";
};
/**
* Dictionary of possible values for 'status' field of act2Builds or act2Runs collections.
*/
declare const ACTOR_JOB_STATUSES: {
readonly READY: "READY";
readonly RUNNING: "RUNNING";
readonly SUCCEEDED: "SUCCEEDED";
readonly FAILED: "FAILED";
readonly TIMING_OUT: "TIMING-OUT";
readonly TIMED_OUT: "TIMED-OUT";
readonly ABORTING: "ABORTING";
readonly ABORTED: "ABORTED";
};
/**
* Dictionary of possible values for 'status' field of webhookDispatches collections.
*/
declare const WEBHOOK_DISPATCH_STATUSES: {
readonly ACTIVE: "ACTIVE";
readonly SUCCEEDED: "SUCCEEDED";
readonly FAILED: "FAILED";
};
/**
* An array of act jobs statuses that are final for the jobs.
*/
declare const ACTOR_JOB_TERMINAL_STATUSES: ("SUCCEEDED" | "FAILED" | "TIMED-OUT" | "ABORTED")[];
declare const WORKER_SERVICE_TYPES: {
readonly CRAWLING: "crawling";
readonly ACTOR: "actor";
};
declare const META_ORIGINS: {
readonly DEVELOPMENT: "DEVELOPMENT";
readonly WEB: "WEB";
readonly API: "API";
readonly SCHEDULER: "SCHEDULER";
readonly TEST: "TEST";
readonly WEBHOOK: "WEBHOOK";
readonly ACTOR: "ACTOR";
readonly CLI: "CLI";
readonly STANDBY: "STANDBY";
};
/**
* Keys of labels applied to act Docker images and containers.
*/
declare const DOCKER_LABELS: {
readonly ACTOR_BUILD_ID: "com.apify.actBuildId";
readonly ACTOR_RUN_ID: "com.apify.actRunId";
/** @deprecated Use ACTOR_BUILD_ID instead! */
readonly ACT_BUILD_ID: "com.apify.actBuildId";
/** @deprecated Use ACTOR_RUN_ID instead! */
readonly ACT_RUN_ID: "com.apify.actRunId";
};
/**
* Acts types
*/
declare const ACTOR_TYPES: {
readonly ACT: "acts";
readonly CRAWLER: "crawlers";
};
/**
* Used as username for returning user own info from API v2/users/username
*/
declare const ME_USER_NAME_PLACEHOLDER = "me";
/**
* Username used when user is anonymous.
*/
declare const ANONYMOUS_USERNAME = "anonymous";
/**
* Username constraints.
*/
declare const USERNAME: {
MIN_LENGTH: number;
MAX_LENGTH: number;
REGEX: RegExp;
};
declare const EMAIL: {
MAX_LENGTH: number;
REGEX: RegExp;
};
/**
* Profile name (such as organization or first / last name) constraints.
*/
declare const PROFILE_NAME: {
MAX_LENGTH: number;
REGEX: RegExp;
};
/**
* Max length for DNS safe string
*/
declare const DNS_SAFE_NAME_MAX_LENGTH = 63;
/**
* Actor name constraints.
*/
declare const ACTOR_NAME: {
MIN_LENGTH: number;
MAX_LENGTH: number;
REGEX: RegExp;
};
/**
* Length of short crawler ID for nice public crawlers path.
*/
declare const SHORT_CRAWLER_ID_LENGTH = 5;
/**
* Default build tag used for latest act version.
*/
declare const BUILD_TAG_LATEST = "latest";
/**
* Behaviour of act restart on error.
* Act gets restarted when there are less than MAX_RESTARTS in the last INTERVAL_MILLIS.
*/
declare const ACTOR_RESTART_ON_ERROR: {
MAX_RESTARTS: number;
INTERVAL_MILLIS: number;
};
/** @deprecated Use ACTOR_RESTART_ON_ERROR instead */
declare const ACT_RESTART_ON_ERROR: {
MAX_RESTARTS: number;
INTERVAL_MILLIS: number;
};
/** @deprecated Use ACTOR_JOB_TYPES instead */
declare const ACT_JOB_TYPES: {
readonly BUILD: "BUILD";
readonly RUN: "RUN";
};
/** @deprecated Use ACTOR_SOURCE_TYPES instead */
declare const ACT_SOURCE_TYPES: {
readonly SOURCE_CODE: "SOURCE_CODE";
readonly SOURCE_FILES: "SOURCE_FILES";
readonly GIT_REPO: "GIT_REPO";
readonly TARBALL: "TARBALL";
readonly GITHUB_GIST: "GITHUB_GIST";
};
/** @deprecated Use ACTOR_JOB_STATUSES instead */
declare const ACT_JOB_STATUSES: {
readonly READY: "READY";
readonly RUNNING: "RUNNING";
readonly SUCCEEDED: "SUCCEEDED";
readonly FAILED: "FAILED";
readonly TIMING_OUT: "TIMING-OUT";
readonly TIMED_OUT: "TIMED-OUT";
readonly ABORTING: "ABORTING";
readonly ABORTED: "ABORTED";
};
/** @deprecated Use ACTOR_JOB_TERMINAL_STATUSES instead */
declare const ACT_JOB_TERMINAL_STATUSES: ("SUCCEEDED" | "FAILED" | "TIMED-OUT" | "ABORTED")[];
/** @deprecated Use ACTOR_TYPES instead */
declare const ACT_TYPES: {
readonly ACT: "acts";
readonly CRAWLER: "crawlers";
};
/**
* 1 compute unit = 1GB * 1Hour.
*/
declare const COMPUTE_UNIT_MB = 1024;
declare const COMPUTE_UNIT_MILLIS: number;
/**
* Contains various Actor platform limits that are shared between the projects.
* IMPORTANT: If you update any of them, update also https://github.com/apifytech/apify-docs/edit/master/docs/actor/limits.md !!!
*/
declare const ACTOR_LIMITS: {
BUILD_DEFAULT_MEMORY_MBYTES: number;
BUILD_TIMEOUT_SECS: number;
RUN_DISK_TO_MEMORY_SIZE_COEFF: number;
RUN_MEMORY_MBYTES_PER_CPU_CORE: number;
FREE_ACCOUNT_MAX_MEMORY_MBYTES: number;
PAID_ACCOUNT_MAX_MEMORY_MBYTES: number;
MIN_RUN_MEMORY_MBYTES: number;
MAX_RUN_MEMORY_MBYTES: number;
INPUT_SCHEMA_MAX_BYTES: number;
LOG_MAX_CHARS: number;
};
/**
* Contains various limits of the Apify platform.
*/
declare const DEFAULT_PLATFORM_LIMITS: {
MAX_ACTORS_PER_USER: number;
MAX_TASKS_PER_USER: number;
MAX_SCHEDULES_PER_USER: number;
MAX_WEBHOOKS_PER_USER: number;
FREE_ACCOUNT_MAX_CONCURRENT_ACTOR_RUNS_PER_USER: number;
PAID_ACCOUNT_MAX_CONCURRENT_ACTOR_RUNS_PER_USER: number;
MAX_ACTORS_PER_SCHEDULER: number;
MAX_TASKS_PER_SCHEDULER: number;
};
/**
* Max length of the queue head that server will return in Request Queue API.
*/
declare const REQUEST_QUEUE_HEAD_MAX_LIMIT = 1000;
/**
* Dictionary of environment variable names prefixed with "APIFY_".
*/
declare const APIFY_ENV_VARS: {
readonly API_BASE_URL: "APIFY_API_BASE_URL";
readonly API_PUBLIC_BASE_URL: "APIFY_API_PUBLIC_BASE_URL";
readonly CHROME_EXECUTABLE_PATH: "APIFY_CHROME_EXECUTABLE_PATH";
readonly DEDICATED_CPUS: "APIFY_DEDICATED_CPUS";
readonly DISABLE_OUTDATED_WARNING: "APIFY_DISABLE_OUTDATED_WARNING";
readonly FACT: "APIFY_FACT";
readonly HEADLESS: "APIFY_HEADLESS";
readonly INPUT_SECRETS_PRIVATE_KEY_FILE: "APIFY_INPUT_SECRETS_PRIVATE_KEY_FILE";
readonly INPUT_SECRETS_PRIVATE_KEY_PASSPHRASE: "APIFY_INPUT_SECRETS_PRIVATE_KEY_PASSPHRASE";
readonly IS_AT_HOME: "APIFY_IS_AT_HOME";
readonly LOCAL_STORAGE_DIR: "APIFY_LOCAL_STORAGE_DIR";
readonly LOG_LEVEL: "APIFY_LOG_LEVEL";
readonly LOG_FORMAT: "APIFY_LOG_FORMAT";
readonly META_ORIGIN: "APIFY_META_ORIGIN";
readonly METAMORPH_AFTER_SLEEP_MILLIS: "APIFY_METAMORPH_AFTER_SLEEP_MILLIS";
readonly PERSIST_STATE_INTERVAL_MILLIS: "APIFY_PERSIST_STATE_INTERVAL_MILLIS";
readonly PROXY_PASSWORD: "APIFY_PROXY_PASSWORD";
readonly PROXY_HOSTNAME: "APIFY_PROXY_HOSTNAME";
readonly PROXY_PORT: "APIFY_PROXY_PORT";
readonly PROXY_STATUS_URL: "APIFY_PROXY_STATUS_URL";
readonly PURGE_ON_START: "APIFY_PURGE_ON_START";
readonly SDK_LATEST_VERSION: "APIFY_SDK_LATEST_VERSION";
readonly SYSTEM_INFO_INTERVAL_MILLIS: "APIFY_SYSTEM_INFO_INTERVAL_MILLIS";
readonly TOKEN: "APIFY_TOKEN";
readonly USER_ID: "APIFY_USER_ID";
readonly WORKFLOW_KEY: "APIFY_WORKFLOW_KEY";
readonly XVFB: "APIFY_XVFB";
readonly ACTOR_BUILD_ID: "APIFY_ACTOR_BUILD_ID";
readonly ACTOR_BUILD_NUMBER: "APIFY_ACTOR_BUILD_NUMBER";
readonly ACTOR_EVENTS_WS_URL: "APIFY_ACTOR_EVENTS_WS_URL";
readonly ACTOR_ID: "APIFY_ACTOR_ID";
readonly ACTOR_MAX_PAID_DATASET_ITEMS: "ACTOR_MAX_PAID_DATASET_ITEMS";
readonly ACTOR_RUN_ID: "APIFY_ACTOR_RUN_ID";
readonly ACTOR_TASK_ID: "APIFY_ACTOR_TASK_ID";
readonly CONTAINER_PORT: "APIFY_CONTAINER_PORT";
readonly CONTAINER_URL: "APIFY_CONTAINER_URL";
readonly DEFAULT_DATASET_ID: "APIFY_DEFAULT_DATASET_ID";
readonly DEFAULT_KEY_VALUE_STORE_ID: "APIFY_DEFAULT_KEY_VALUE_STORE_ID";
readonly DEFAULT_REQUEST_QUEUE_ID: "APIFY_DEFAULT_REQUEST_QUEUE_ID";
readonly INPUT_KEY: "APIFY_INPUT_KEY";
readonly MEMORY_MBYTES: "APIFY_MEMORY_MBYTES";
readonly STARTED_AT: "APIFY_STARTED_AT";
readonly TIMEOUT_AT: "APIFY_TIMEOUT_AT";
readonly ACT_ID: "APIFY_ACT_ID";
readonly ACT_RUN_ID: "APIFY_ACT_RUN_ID";
};
/**
* @deprecated `ENV_VARS` were replaced by `APIFY_ENV_VARS`. We currently keep this for backwards compatibility.
*/
declare const ENV_VARS: {
readonly API_BASE_URL: "APIFY_API_BASE_URL";
readonly API_PUBLIC_BASE_URL: "APIFY_API_PUBLIC_BASE_URL";
readonly CHROME_EXECUTABLE_PATH: "APIFY_CHROME_EXECUTABLE_PATH";
readonly DEDICATED_CPUS: "APIFY_DEDICATED_CPUS";
readonly DISABLE_OUTDATED_WARNING: "APIFY_DISABLE_OUTDATED_WARNING";
readonly FACT: "APIFY_FACT";
readonly HEADLESS: "APIFY_HEADLESS";
readonly INPUT_SECRETS_PRIVATE_KEY_FILE: "APIFY_INPUT_SECRETS_PRIVATE_KEY_FILE";
readonly INPUT_SECRETS_PRIVATE_KEY_PASSPHRASE: "APIFY_INPUT_SECRETS_PRIVATE_KEY_PASSPHRASE";
readonly IS_AT_HOME: "APIFY_IS_AT_HOME";
readonly LOCAL_STORAGE_DIR: "APIFY_LOCAL_STORAGE_DIR";
readonly LOG_LEVEL: "APIFY_LOG_LEVEL";
readonly LOG_FORMAT: "APIFY_LOG_FORMAT";
readonly META_ORIGIN: "APIFY_META_ORIGIN";
readonly METAMORPH_AFTER_SLEEP_MILLIS: "APIFY_METAMORPH_AFTER_SLEEP_MILLIS";
readonly PERSIST_STATE_INTERVAL_MILLIS: "APIFY_PERSIST_STATE_INTERVAL_MILLIS";
readonly PROXY_PASSWORD: "APIFY_PROXY_PASSWORD";
readonly PROXY_HOSTNAME: "APIFY_PROXY_HOSTNAME";
readonly PROXY_PORT: "APIFY_PROXY_PORT";
readonly PROXY_STATUS_URL: "APIFY_PROXY_STATUS_URL";
readonly PURGE_ON_START: "APIFY_PURGE_ON_START";
readonly SDK_LATEST_VERSION: "APIFY_SDK_LATEST_VERSION";
readonly SYSTEM_INFO_INTERVAL_MILLIS: "APIFY_SYSTEM_INFO_INTERVAL_MILLIS";
readonly TOKEN: "APIFY_TOKEN";
readonly USER_ID: "APIFY_USER_ID";
readonly WORKFLOW_KEY: "APIFY_WORKFLOW_KEY";
readonly XVFB: "APIFY_XVFB";
readonly ACTOR_BUILD_ID: "APIFY_ACTOR_BUILD_ID";
readonly ACTOR_BUILD_NUMBER: "APIFY_ACTOR_BUILD_NUMBER";
readonly ACTOR_EVENTS_WS_URL: "APIFY_ACTOR_EVENTS_WS_URL";
readonly ACTOR_ID: "APIFY_ACTOR_ID";
readonly ACTOR_MAX_PAID_DATASET_ITEMS: "ACTOR_MAX_PAID_DATASET_ITEMS";
readonly ACTOR_RUN_ID: "APIFY_ACTOR_RUN_ID";
readonly ACTOR_TASK_ID: "APIFY_ACTOR_TASK_ID";
readonly CONTAINER_PORT: "APIFY_CONTAINER_PORT";
readonly CONTAINER_URL: "APIFY_CONTAINER_URL";
readonly DEFAULT_DATASET_ID: "APIFY_DEFAULT_DATASET_ID";
readonly DEFAULT_KEY_VALUE_STORE_ID: "APIFY_DEFAULT_KEY_VALUE_STORE_ID";
readonly DEFAULT_REQUEST_QUEUE_ID: "APIFY_DEFAULT_REQUEST_QUEUE_ID";
readonly INPUT_KEY: "APIFY_INPUT_KEY";
readonly MEMORY_MBYTES: "APIFY_MEMORY_MBYTES";
readonly STARTED_AT: "APIFY_STARTED_AT";
readonly TIMEOUT_AT: "APIFY_TIMEOUT_AT";
readonly ACT_ID: "APIFY_ACT_ID";
readonly ACT_RUN_ID: "APIFY_ACT_RUN_ID";
};
/**
* Dictionary of environment variable names prefixed with "ACTOR_".
* Follows from Actor specs https://github.com/apify/actor-specs/#environment-variables
*/
declare const ACTOR_ENV_VARS: {
readonly BUILD_ID: "ACTOR_BUILD_ID";
readonly BUILD_NUMBER: "ACTOR_BUILD_NUMBER";
readonly BUILD_TAGS: "ACTOR_BUILD_TAGS";
readonly DEFAULT_DATASET_ID: "ACTOR_DEFAULT_DATASET_ID";
readonly DEFAULT_KEY_VALUE_STORE_ID: "ACTOR_DEFAULT_KEY_VALUE_STORE_ID";
readonly DEFAULT_REQUEST_QUEUE_ID: "ACTOR_DEFAULT_REQUEST_QUEUE_ID";
readonly EVENTS_WEBSOCKET_URL: "ACTOR_EVENTS_WEBSOCKET_URL";
readonly FULL_NAME: "ACTOR_FULL_NAME";
readonly ID: "ACTOR_ID";
readonly INPUT_KEY: "ACTOR_INPUT_KEY";
readonly MAX_PAID_DATASET_ITEMS: "ACTOR_MAX_PAID_DATASET_ITEMS";
readonly MAX_TOTAL_CHARGE_USD: "ACTOR_MAX_TOTAL_CHARGE_USD";
readonly MEMORY_MBYTES: "ACTOR_MEMORY_MBYTES";
readonly RUN_ID: "ACTOR_RUN_ID";
readonly STANDBY_PORT: "ACTOR_STANDBY_PORT";
readonly STANDBY_URL: "ACTOR_STANDBY_URL";
readonly STARTED_AT: "ACTOR_STARTED_AT";
readonly TASK_ID: "ACTOR_TASK_ID";
readonly TIMEOUT_AT: "ACTOR_TIMEOUT_AT";
readonly WEB_SERVER_PORT: "ACTOR_WEB_SERVER_PORT";
readonly WEB_SERVER_URL: "ACTOR_WEB_SERVER_URL";
};
declare const INTEGER_ENV_VARS: readonly ["ACTOR_MAX_PAID_DATASET_ITEMS", "ACTOR_MEMORY_MBYTES", "ACTOR_STANDBY_PORT", "ACTOR_WEB_SERVER_PORT", "ACTOR_MAX_PAID_DATASET_ITEMS", "APIFY_CONTAINER_PORT", "APIFY_DEDICATED_CPUS", "APIFY_MEMORY_MBYTES", "APIFY_METAMORPH_AFTER_SLEEP_MILLIS", "APIFY_PERSIST_STATE_INTERVAL_MILLIS", "APIFY_PROXY_PORT", "APIFY_SYSTEM_INFO_INTERVAL_MILLIS"];
declare const COMMA_SEPARATED_LIST_ENV_VARS: readonly ["ACTOR_BUILD_TAGS"];
/**
* Dictionary of names of build-time variables passed to the Actor's Docker build process.
*/
declare const ACTOR_BUILD_ARGS: {
ACTOR_PATH_IN_DOCKER_CONTEXT: string;
};
/**
* Default value for APIFY_CONTAINER_PORT used both locally and at Apify platform.
*/
declare const DEFAULT_CONTAINER_PORT = 4321;
/**
* @deprecated Please use `DEFAULT_CONTAINER_PORT` instead, the value is the same.
* Default value for ACTOR_STANDBY_PORT used both locally and at Apify platform.
*/
declare const DEFAULT_ACTOR_STANDBY_PORT = 4321;
/**
* Local emulation sub directories for local stores
*/
declare const LOCAL_STORAGE_SUBDIRS: {
readonly datasets: "datasets";
readonly keyValueStores: "key_value_stores";
readonly requestQueues: "request_queues";
};
/**
* Local defaults for of some of the Actor environment variables.
* These are being preset in Apify SDK when it's running out of the Apify platform.
*/
declare const LOCAL_ACTOR_ENV_VARS: {
ACTOR_STANDBY_PORT: string;
ACTOR_DEFAULT_DATASET_ID: string;
ACTOR_DEFAULT_KEY_VALUE_STORE_ID: string;
ACTOR_DEFAULT_REQUEST_QUEUE_ID: string;
ACTOR_WEB_SERVER_PORT: string;
ACTOR_WEB_SERVER_URL: string;
};
/**
* Local defaults for of some of the Apify environment variables.
* These are being preset in Apify SDK when it's running out of the Apify platform.
*/
declare const LOCAL_APIFY_ENV_VARS: {
APIFY_CONTAINER_PORT: string;
APIFY_CONTAINER_URL: string;
APIFY_DEFAULT_DATASET_ID: string;
APIFY_DEFAULT_KEY_VALUE_STORE_ID: string;
APIFY_DEFAULT_REQUEST_QUEUE_ID: string;
APIFY_PROXY_HOSTNAME: string;
APIFY_PROXY_PORT: string;
};
/**
* @deprecated `LOCAL_ENV_VARS` were replaced by `LOCAL_APIFY_ENV_VARS`. We currently keep this for backwards compatibility.
*/
declare const LOCAL_ENV_VARS: {
APIFY_CONTAINER_PORT: string;
APIFY_CONTAINER_URL: string;
APIFY_DEFAULT_DATASET_ID: string;
APIFY_DEFAULT_KEY_VALUE_STORE_ID: string;
APIFY_DEFAULT_REQUEST_QUEUE_ID: string;
APIFY_PROXY_HOSTNAME: string;
APIFY_PROXY_PORT: string;
};
/**
* Defaults input and output key-value stores keys
*/
declare const KEY_VALUE_STORE_KEYS: {
readonly INPUT: "INPUT";
readonly OUTPUT: "OUTPUT";
};
/**
* Represents the maximum size in bytes of a request body (decompressed)
* that will be accepted by the App and API servers.
*/
declare const MAX_PAYLOAD_SIZE_BYTES = 9437184;
/**
* Categories for crawlers and actors
*/
declare const ACTOR_CATEGORIES: {
readonly AI: "AI";
readonly AUTOMATION: "Automation";
readonly BUSINESS: "Business";
readonly COVID_19: "Covid-19";
readonly DEVELOPER_EXAMPLES: "Developer examples";
readonly DEVELOPER_TOOLS: "Developer tools";
readonly ECOMMERCE: "E-commerce";
readonly FOR_CREATORS: "For creators";
readonly GAMES: "Games";
readonly JOBS: "Jobs";
readonly LEAD_GENERATION: "Lead generation";
readonly MARKETING: "Marketing";
readonly NEWS: "News";
readonly SEO_TOOLS: "SEO tools";
readonly SOCIAL_MEDIA: "Social media";
readonly TRAVEL: "Travel";
readonly VIDEOS: "Videos";
readonly REAL_ESTATE: "Real estate";
readonly SPORTS: "Sports";
readonly EDUCATION: "Education";
readonly INTEGRATIONS: "Integrations";
readonly OTHER: "Other";
readonly OPEN_SOURCE: "Open source";
};
/** @deprecated Use ACTOR_CATEGORIES instead! */
declare const ALL_ACTOR_CATEGORIES: {
readonly AI: "AI";
readonly AUTOMATION: "Automation";
readonly BUSINESS: "Business";
readonly COVID_19: "Covid-19";
readonly DEVELOPER_EXAMPLES: "Developer examples";
readonly DEVELOPER_TOOLS: "Developer tools";
readonly ECOMMERCE: "E-commerce";
readonly FOR_CREATORS: "For creators";
readonly GAMES: "Games";
readonly JOBS: "Jobs";
readonly LEAD_GENERATION: "Lead generation";
readonly MARKETING: "Marketing";
readonly NEWS: "News";
readonly SEO_TOOLS: "SEO tools";
readonly SOCIAL_MEDIA: "Social media";
readonly TRAVEL: "Travel";
readonly VIDEOS: "Videos";
readonly REAL_ESTATE: "Real estate";
readonly SPORTS: "Sports";
readonly EDUCATION: "Education";
readonly INTEGRATIONS: "Integrations";
readonly OTHER: "Other";
readonly OPEN_SOURCE: "Open source";
};
/**
* Bases for converting version/build number to/from string/integer
*/
declare const VERSION_INT_MAJOR_BASE = 10000000;
declare const VERSION_INT_MINOR_BASE = 100000;
/**
* Basic options for XSS sanitization
*/
declare const USER_BASIC_TEXT_XSS_OPTIONS: {
whiteList: {
a: string[];
code: never[];
strong: never[];
b: never[];
br: never[];
ul: never[];
li: never[];
ol: never[];
i: never[];
u: never[];
p: never[];
};
};
declare const WEBHOOK_EVENT_TYPES: {
readonly ACTOR_RUN_CREATED: "ACTOR.RUN.CREATED";
readonly ACTOR_RUN_SUCCEEDED: "ACTOR.RUN.SUCCEEDED";
readonly ACTOR_RUN_FAILED: "ACTOR.RUN.FAILED";
readonly ACTOR_RUN_TIMED_OUT: "ACTOR.RUN.TIMED_OUT";
readonly ACTOR_RUN_ABORTED: "ACTOR.RUN.ABORTED";
readonly ACTOR_RUN_RESURRECTED: "ACTOR.RUN.RESURRECTED";
readonly ACTOR_BUILD_CREATED: "ACTOR.BUILD.CREATED";
readonly ACTOR_BUILD_SUCCEEDED: "ACTOR.BUILD.SUCCEEDED";
readonly ACTOR_BUILD_FAILED: "ACTOR.BUILD.FAILED";
readonly ACTOR_BUILD_TIMED_OUT: "ACTOR.BUILD.TIMED_OUT";
readonly ACTOR_BUILD_ABORTED: "ACTOR.BUILD.ABORTED";
readonly TEST: "TEST";
};
declare const WEBHOOK_EVENT_TYPE_GROUPS: {
readonly ACTOR_RUN: readonly ["ACTOR.RUN.CREATED", "ACTOR.RUN.SUCCEEDED", "ACTOR.RUN.FAILED", "ACTOR.RUN.TIMED_OUT", "ACTOR.RUN.ABORTED", "ACTOR.RUN.RESURRECTED"];
readonly ACTOR_BUILD: readonly ["ACTOR.BUILD.CREATED", "ACTOR.BUILD.SUCCEEDED", "ACTOR.BUILD.FAILED", "ACTOR.BUILD.TIMED_OUT", "ACTOR.BUILD.ABORTED"];
readonly ACTOR_RUN_TERMINAL: readonly ["ACTOR.RUN.SUCCEEDED", "ACTOR.RUN.FAILED", "ACTOR.RUN.TIMED_OUT", "ACTOR.RUN.ABORTED"];
readonly ACTOR_BUILD_TERMINAL: readonly ["ACTOR.BUILD.SUCCEEDED", "ACTOR.BUILD.FAILED", "ACTOR.BUILD.TIMED_OUT", "ACTOR.BUILD.ABORTED"];
};
declare const WEBHOOK_DEFAULT_PAYLOAD_TEMPLATE = "{\n \"userId\": {{userId}},\n \"createdAt\": {{createdAt}},\n \"eventType\": {{eventType}},\n \"eventData\": {{eventData}},\n \"resource\": {{resource}}\n}";
declare const WEBHOOK_ALLOWED_PAYLOAD_VARIABLES: Set<string>;
declare const MAX_MULTIFILE_BYTES: number;
declare const SOURCE_FILE_FORMATS: {
readonly TEXT: "TEXT";
readonly BASE64: "BASE64";
};
declare const PROJECT_STATUSES: {
readonly REQUEST: "REQUEST";
readonly SPECIFICATION: "SPECIFICATION";
readonly OFFERS: "OFFERS";
readonly DEPOSIT: "DEPOSIT";
readonly DEPOSIT_PAID: "DEPOSIT_PAID";
readonly NEW: "NEW";
readonly IN_PROGRESS: "IN_PROGRESS";
readonly QA: "QA";
readonly CUSTOMER_QA: "CUSTOMER_QA";
readonly READY_FOR_INVOICE: "READY_FOR_INVOICE";
readonly INVOICED: "INVOICED";
readonly PAID: "PAID";
readonly DELIVERED: "DELIVERED";
readonly CLOSED: "CLOSED";
readonly FINISHED: "FINISHED";
};
declare const FINISHED_PROJECT_STATUSES: readonly ["READY_FOR_INVOICE", "INVOICED", "PAID", "DELIVERED", "FINISHED"];
declare const MARKETPLACE_USER_ROLES: {
readonly DEVELOPER: "DEVELOPER";
readonly DATA_EXPERT: "DATA_EXPERT";
readonly CUSTOMER: "CUSTOMER";
};
declare const USER_PERSONA_TYPES: {
readonly DEVELOPER: "DEVELOPER";
readonly USER: "USER";
};
declare const GIT_MAIN_BRANCH = "main";
declare const REQUEST_QUEUE_MAX_REQUESTS_PER_BATCH_OPERATION = 25;
declare const ISSUES_STATUS_TYPES: {
readonly OPEN: "OPEN";
readonly CLOSED: "CLOSED";
};
/**
* This is used for filtering issues. All issue types to be considered.
*/
declare const ISSUES_STATUS_ALL = "ALL";
/**
* Email validation regexp adapted from https://html.spec.whatwg.org/multipage/forms.html#valid-e-mail-address
* with our restriction that hostname must be a TLD! (will not match example@localhost)
* and two consecutive dots in name are not allowed (based on Mailgun convention, will not match ex..amle@example.com)
*/
declare const EMAIL_REGEX_STR = "[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+";
/**
* Matches a string containing valid email
* Hostname must be a TLD! (will not match example@localhost)
*/
declare const EMAIL_REGEX: RegExp;
/**
* Matches a string containing single email or multiple emails separated by comma
* Hostname must be a TLD! (will not match example@localhost)
*/
declare const COMMA_SEPARATED_EMAILS_REGEX_STR = "([a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+)( *, *[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+(?:\\.[a-zA-Z0-9!#$%&'*+/=?^_`{|}~-]+)*@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)+)*";
/**
* Matches a string containing single email or multiple emails separated by comma
* Hostname must be a TLD! (will not match example@localhost)
*/
declare const COMMA_SEPARATED_EMAILS_REGEX: RegExp;
/**
* Comes from https://github.com/jonschlinkert/is-git-url/ but we have:
* - added support for ...:/dir/subdir syntax
*/
declare const GIT_REPO_REGEX: RegExp;
/**
* Matches a string that might be used in a hostname (e.g. "my-host-name")
*/
declare const DNS_SAFE_NAME_REGEX: RegExp;
/**
* Regular expression to validate Apify Proxy group name and session ID.
* This must correspond to REGEX_STR_USERNAME_VALUE in apify-system!
*/
declare const APIFY_PROXY_VALUE_REGEX: RegExp;
/**
* Regular expression to validate proxy urls, matches
* http://asd:qweqwe@proxy.apify.com:8000
* http://123123:qweqwe:asdasd@proxy.com:55555
* http://proxy.apify.com:5000
* http://root@proxy.apify.com:5000
*/
declare const PROXY_URL_REGEX: RegExp;
/**
* AWS S3 docs say:
* "The following character sets are generally safe for use in key names:
* - Alphanumeric characters [0-9a-zA-Z]
* - Special characters !, -, _, ., *, ', (, and )"
* However, some of those characters are not valid across Win/Unix OS.
* Therefore we allow only a subset and limit the length to 256 characters (TODO: document this)
*/
declare const KEY_VALUE_STORE_KEY_REGEX: RegExp;
declare const TWITTER_REGEX: RegExp;
declare const GITHUB_REGEX: RegExp;
/**
* For matching linkedin URLs for both profiles and companies.
* Used for validating urls in user settings.
*/
declare const LINKEDIN_PROFILE_REGEX: RegExp;
/**
* @deprecated Discontinue usage of this regexps, in favor of HTTP_URL_REGEX
*/
declare const URL_REGEX: RegExp;
declare const HTTP_URL_REGEX: RegExp;
declare const GITHUB_GIST_URL_REGEX: RegExp;
/**
* Split's path /aaa/bbb/ccc into an array ['aaa', 'bbb', 'ccc].
*/
declare const SPLIT_PATH_REGEX: RegExp;
/**
* Check if a URL is relative, i.e. does not start with a protocol
*/
declare const RELATIVE_URL_REGEX: RegExp;
/**
* Check if a link is a mailto/tel/sms type
*/
declare const CONTACT_LINK_REGEX: RegExp;
/**
* Regular expression to match valid ID - 17 alphanumeric chars including chars restricted by SimpleSchema.RegEx.Id (1,l,0,O),
* because we have user objects with that in database.
* @type {RegExp}
*/
declare const APIFY_ID_REGEX: RegExp;
export { ACTOR_BUILD_ARGS, ACTOR_CATEGORIES, ACTOR_ENV_VARS, ACTOR_EVENT_NAMES, ACTOR_JOB_STATUSES, ACTOR_JOB_TERMINAL_STATUSES, ACTOR_JOB_TYPES, ACTOR_LIMITS, ACTOR_NAME, ACTOR_RESTART_ON_ERROR, ACTOR_SOURCE_TYPES, ACTOR_TYPES, ACT_JOB_STATUSES, ACT_JOB_TERMINAL_STATUSES, ACT_JOB_TYPES, ACT_RESTART_ON_ERROR, ACT_SOURCE_TYPES, ACT_TYPES, ALL_ACTOR_CATEGORIES, ANONYMOUS_USERNAME, APIFY_ENV_VARS, APIFY_ID_REGEX, APIFY_PROXY_VALUE_REGEX, BUILD_TAG_LATEST, COMMA_SEPARATED_EMAILS_REGEX, COMMA_SEPARATED_EMAILS_REGEX_STR, COMMA_SEPARATED_LIST_ENV_VARS, COMPUTE_UNIT_MB, COMPUTE_UNIT_MILLIS, CONTACT_LINK_REGEX, DEFAULT_ACTOR_STANDBY_PORT, DEFAULT_CONTAINER_PORT, DEFAULT_PLATFORM_LIMITS, DNS_SAFE_NAME_MAX_LENGTH, DNS_SAFE_NAME_REGEX, DOCKER_LABELS, EMAIL, EMAIL_REGEX, EMAIL_REGEX_STR, ENV_VARS, FINISHED_PROJECT_STATUSES, FREE_SUBSCRIPTION_PLAN_CODE, GITHUB_GIST_URL_REGEX, GITHUB_REGEX, GIT_MAIN_BRANCH, GIT_REPO_REGEX, HTTP_URL_REGEX, INTEGER_ENV_VARS, ISSUES_STATUS_ALL, ISSUES_STATUS_TYPES, KEY_VALUE_STORE_KEYS, KEY_VALUE_STORE_KEY_REGEX, LINKEDIN_PROFILE_REGEX, LOCAL_ACTOR_ENV_VARS, LOCAL_APIFY_ENV_VARS, LOCAL_ENV_VARS, LOCAL_STORAGE_SUBDIRS, MARKETPLACE_USER_ROLES, MAX_MULTIFILE_BYTES, MAX_PAYLOAD_SIZE_BYTES, META_ORIGINS, ME_USER_NAME_PLACEHOLDER, PROFILE_NAME, PROJECT_STATUSES, PROXY_URL_REGEX, RELATIVE_URL_REGEX, REQUEST_QUEUE_HEAD_MAX_LIMIT, REQUEST_QUEUE_MAX_REQUESTS_PER_BATCH_OPERATION, SHORT_CRAWLER_ID_LENGTH, SOURCE_FILE_FORMATS, SPLIT_PATH_REGEX, TWITTER_REGEX, URL_REGEX, USERNAME, USER_BASIC_TEXT_XSS_OPTIONS, USER_PERSONA_TYPES, VERSION_INT_MAJOR_BASE, VERSION_INT_MINOR_BASE, WEBHOOK_ALLOWED_PAYLOAD_VARIABLES, WEBHOOK_DEFAULT_PAYLOAD_TEMPLATE, WEBHOOK_DISPATCH_STATUSES, WEBHOOK_EVENT_TYPES, WEBHOOK_EVENT_TYPE_GROUPS, WORKER_SERVICE_TYPES };