apify-client 2.23.5-beta.2 → 2.23.5-beta.21

package/dist/http_client.js

@@ -11,79 +11,19 @@ const utils_1 = require("./utils");
 const { version } = (0, utils_1.getVersionData)();
 const RATE_LIMIT_EXCEEDED_STATUS_CODE = 429;
 class HttpClient {
+    stats;
+    maxRetries;
+    minDelayBetweenRetriesMillis;
+    userProvidedRequestInterceptors;
+    logger;
+    timeoutMillis;
+    httpAgent;
+    httpsAgent;
+    axios;
+    workflowKey;
+    nodeInitPromise;
+    userAgentSuffix;
     constructor(options) {
-        Object.defineProperty(this, "stats", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "maxRetries", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "minDelayBetweenRetriesMillis", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "userProvidedRequestInterceptors", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "logger", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "timeoutMillis", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "httpAgent", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "httpsAgent", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "axios", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "workflowKey", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "nodeInitPromise", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "userAgentSuffix", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
         const { token } = options;
         this.stats = options.apifyClientStats;
         this.maxRetries = options.maxRetries;
@@ -137,10 +77,9 @@ class HttpClient {
         interceptors_1.responseInterceptors.forEach((i) => this.axios.interceptors.response.use(i));
     }
     async ensureNodeInit() {
-        var _a;
         if (!(0, utils_1.isNode)())
             return;
-        (_a = this.nodeInitPromise) !== null && _a !== void 0 ? _a : (this.nodeInitPromise = this.initNode());
+        this.nodeInitPromise ??= this.initNode();
         return this.nodeInitPromise;
     }
     async initNode() {
@@ -160,7 +99,7 @@ class HttpClient {
             timeout: this.timeoutMillis,
             // Keep alive timeout for free sockets (15 seconds)
             // Node.js will close unused sockets after this period
-            keepAliveMsecs: 15000,
+            keepAliveMsecs: 15_000,
             // Maximum number of sockets per host
             maxSockets: 256,
             maxFreeSockets: 256,
@@ -210,7 +149,6 @@ class HttpClient {
      */
     _createRequestHandler(config) {
         const makeRequest = async (stopTrying, attempt) => {
-            var _a;
             this.stats.requests++;
             let response;
             const requestIsStream = (0, utils_1.isStream)(config.data);
@@ -222,7 +160,7 @@ class HttpClient {
                     config = { ...config, maxRedirects: 0 };
                 }
                 // Increase timeout with each attempt. Max timeout is bounded by the client timeout.
-                config.timeout = Math.min(this.timeoutMillis, ((_a = config.timeout) !== null && _a !== void 0 ? _a : this.timeoutMillis) * 2 ** (attempt - 1));
+                config.timeout = Math.min(this.timeoutMillis, (config.timeout ?? this.timeoutMillis) * 2 ** (attempt - 1));
                 response = await this.axios.request(config);
                 if (this._isStatusOk(response.status))
                     return response;

package/dist/interceptors.js

@@ -14,20 +14,10 @@ const utils_1 = require("./utils");
  * The properties mimic AxiosError for easier integration in HttpClient error handling.
  */
 class InvalidResponseBodyError extends Error {
+    code;
+    response;
     constructor(response, cause) {
         super(`Response body could not be parsed.\nCause:${cause.message}`);
-        Object.defineProperty(this, "code", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "response", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
         this.name = this.constructor.name;
         this.code = 'invalid-response-body';
         this.response = response;
@@ -36,7 +26,6 @@ class InvalidResponseBodyError extends Error {
 }
 exports.InvalidResponseBodyError = InvalidResponseBodyError;
 function serializeRequest(config) {
-    var _a, _b;
     const [defaultTransform] = axios_1.default.defaults.transformRequest;
     // The function not only serializes data, but it also adds correct headers.
     const data = defaultTransform(config.data, config.headers);
@@ -46,7 +35,7 @@ function serializeRequest(config) {
     // it's a small price to pay. The axios default transform does a lot
     // of body type checks and we would have to copy all of them to the resource clients.
     if (config.stringifyFunctions) {
-        const contentTypeHeader = ((_a = config.headers) === null || _a === void 0 ? void 0 : _a['Content-Type']) || ((_b = config.headers) === null || _b === void 0 ? void 0 : _b['content-type']);
+        const contentTypeHeader = config.headers?.['Content-Type'] || config.headers?.['content-type'];
         try {
             const { type } = content_type_1.default.parse(contentTypeHeader);
             if (type === 'application/json' && typeof config.data === 'object') {
@@ -81,12 +70,11 @@ function stringifyWithFunctions(obj) {
     });
 }
 async function maybeGzipRequest(config) {
-    var _a, _b;
-    if ((_a = config.headers) === null || _a === void 0 ? void 0 : _a['content-encoding'])
+    if (config.headers?.['content-encoding'])
         return config;
     const maybeZippedData = await (0, utils_1.maybeGzipValue)(config.data);
     if (maybeZippedData) {
-        (_b = config.headers) !== null && _b !== void 0 ? _b : (config.headers = {});
+        config.headers ??= {};
         config.headers['content-encoding'] = 'gzip';
         config.data = maybeZippedData;
     }

package/dist/resource_clients/actor.d.ts

@@ -1,5 +1,5 @@
 import type { RUN_GENERAL_ACCESS } from '@apify/consts';
-import { ACT_JOB_STATUSES, ACTOR_PERMISSION_LEVEL } from '@apify/consts';
+import { ACTOR_JOB_STATUSES, ACTOR_PERMISSION_LEVEL, META_ORIGINS } from '@apify/consts';
 import { Log } from '@apify/log';
 import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceClient } from '../base/resource_client';
@@ -13,6 +13,7 @@ import { RunClient } from './run';
 import { RunCollectionClient } from './run_collection';
 import type { WebhookUpdateData } from './webhook';
 import { WebhookCollectionClient } from './webhook_collection';
+import type { ValueOf } from 'type-fest';
 /**
  * Client for managing a specific Actor.
  *
@@ -132,6 +133,37 @@ export declare class ActorClient extends ResourceClient {
      * ```
      */
     call(input?: unknown, options?: ActorCallOptions): Promise<ActorRun>;
+    /**
+     * Validates the provided input for the Actor against its input schema.
+     *
+     * Sends the input to the API, which validates it against the Actor's input schema without
+     * starting a run. If the input is valid, the method resolves with `true`. If the input is
+     * invalid, the API responds with an error that is thrown as an `ApifyApiError` describing the
+     * validation problem.
+     *
+     * @param input - Input to validate against the Actor's input schema. Can be any JSON-serializable
+     *                value (object, array, string, number). If `contentType` is specified in options,
+     *                input should be a string or Buffer.
+     * @param options - Validation options
+     * @param options.build - Tag or number of the build whose input schema the input is validated against
+     *                         (e.g., `'latest'` or `'1.2.345'`). If not provided, uses the default build.
+     * @param options.contentType - Content type of the input. If specified, input must be a string or Buffer.
+     * @returns `true` if the input is valid. Invalid input causes the underlying API call to throw an `ApifyApiError`.
+     * @see https://docs.apify.com/api/v2/act-input-validate-post
+     *
+     * @example
+     * ```javascript
+     * // Validate input against the default build's input schema
+     * const isValid = await client.actor('my-actor').validateInput({ url: 'https://example.com' });
+     *
+     * // Validate against a specific build
+     * const isValid = await client.actor('my-actor').validateInput(
+     *   { url: 'https://example.com' },
+     *   { build: 'beta' },
+     * );
+     * ```
+     */
+    validateInput(input?: unknown, options?: ActorValidateInputOptions): Promise<boolean>;
     /**
      * Builds the Actor.
      *
@@ -462,7 +494,7 @@ export interface ActorRunListItem {
     actorTaskId?: string;
     startedAt: Date;
     finishedAt: Date;
-    status: (typeof ACT_JOB_STATUSES)[keyof typeof ACT_JOB_STATUSES];
+    status: (typeof ACTOR_JOB_STATUSES)[keyof typeof ACTOR_JOB_STATUSES];
     meta: ActorRunMeta;
     buildId: string;
     buildNumber: string;
@@ -585,6 +617,23 @@ export interface ActorRunOptions {
     maxTotalChargeUsd?: number;
     restartOnError?: boolean;
 }
+/**
+ * Options for validating an Actor input.
+ */
+export interface ActorValidateInputOptions {
+    /**
+     * Tag or number of the Actor build whose input schema the input is validated against
+     * (e.g. `beta` or `1.2.345`). If not provided, the default build is used.
+     */
+    build?: string;
+    /**
+     * Content type for the `input`. If not specified,
+     * `input` is expected to be an object that will be stringified to JSON and content type set to
+     * `application/json; charset=utf-8`. If `options.contentType` is specified, then `input` must be a
+     * `String` or `Buffer`.
+     */
+    contentType?: string;
+}
 /**
  * Options for building an Actor.
  */
@@ -598,7 +647,8 @@ export interface ActorBuildOptions {
  * Options for filtering the last run of an Actor.
  */
 export interface ActorLastRunOptions {
-    status?: keyof typeof ACT_JOB_STATUSES;
+    status?: ValueOf<typeof ACTOR_JOB_STATUSES>;
+    origin?: ValueOf<typeof META_ORIGINS>;
 }
 /**
  * Actor definition from the `.actor/actor.json` file.

package/dist/resource_clients/actor.js

@@ -140,9 +140,6 @@ class ActorClient extends resource_client_1.ResourceClient {
             params: this._params(params),
             // Apify internal property. Tells the request serialization interceptor
             // to stringify functions to JSON, instead of omitting them.
-            // TODO: remove this ts-expect-error once we migrate HttpClient to TS and define Apify
-            // extension of Axios configs
-            // @ts-expect-error Apify extension
             stringifyFunctions: true,
         };
         if (options.contentType) {
@@ -212,15 +209,69 @@ class ActorClient extends resource_client_1.ResourceClient {
         // Creating a new instance of RunClient here would only allow
         // setting it up as a nested route under actor API.
         const newRunClient = this.apifyClient.run(id);
-        const streamedLog = await newRunClient.getStreamedLog({ toLog: options === null || options === void 0 ? void 0 : options.log });
-        streamedLog === null || streamedLog === void 0 ? void 0 : streamedLog.start();
+        const streamedLog = await newRunClient.getStreamedLog({ toLog: options?.log });
+        streamedLog?.start();
         return this.apifyClient
             .run(id)
             .waitForFinish({ waitSecs })
             .finally(async () => {
-            await (streamedLog === null || streamedLog === void 0 ? void 0 : streamedLog.stop());
+            await streamedLog?.stop();
         });
     }
+    /**
+     * Validates the provided input for the Actor against its input schema.
+     *
+     * Sends the input to the API, which validates it against the Actor's input schema without
+     * starting a run. If the input is valid, the method resolves with `true`. If the input is
+     * invalid, the API responds with an error that is thrown as an `ApifyApiError` describing the
+     * validation problem.
+     *
+     * @param input - Input to validate against the Actor's input schema. Can be any JSON-serializable
+     *                value (object, array, string, number). If `contentType` is specified in options,
+     *                input should be a string or Buffer.
+     * @param options - Validation options
+     * @param options.build - Tag or number of the build whose input schema the input is validated against
+     *                         (e.g., `'latest'` or `'1.2.345'`). If not provided, uses the default build.
+     * @param options.contentType - Content type of the input. If specified, input must be a string or Buffer.
+     * @returns `true` if the input is valid. Invalid input causes the underlying API call to throw an `ApifyApiError`.
+     * @see https://docs.apify.com/api/v2/act-input-validate-post
+     *
+     * @example
+     * ```javascript
+     * // Validate input against the default build's input schema
+     * const isValid = await client.actor('my-actor').validateInput({ url: 'https://example.com' });
+     *
+     * // Validate against a specific build
+     * const isValid = await client.actor('my-actor').validateInput(
+     *   { url: 'https://example.com' },
+     *   { build: 'beta' },
+     * );
+     * ```
+     */
+    async validateInput(input, options = {}) {
+        // input can be anything, so no point in validating it. E.g. if you set content-type to application/pdf
+        // then it will process input as a buffer.
+        (0, ow_1.default)(options, ow_1.default.object.exactShape({
+            build: ow_1.default.optional.string,
+            contentType: ow_1.default.optional.string,
+        }));
+        const request = {
+            url: this._url('validate-input'),
+            method: 'POST',
+            data: input,
+            params: this._params({ build: options.build }),
+            // Apify internal property. Tells the request serialization interceptor
+            // to stringify functions to JSON, instead of omitting them.
+            stringifyFunctions: true,
+        };
+        if (options.contentType) {
+            request.headers = {
+                'content-type': options.contentType,
+            };
+        }
+        const response = await this.httpClient.call(request);
+        return response.data.valid;
+    }
     /**
      * Builds the Actor.
      *
@@ -326,7 +377,7 @@ class ActorClient extends resource_client_1.ResourceClient {
      */
     lastRun(options = {}) {
         (0, ow_1.default)(options, ow_1.default.object.exactShape({
-            status: ow_1.default.optional.string.oneOf(Object.values(consts_1.ACT_JOB_STATUSES)),
+            status: ow_1.default.optional.string.oneOf(Object.values(consts_1.ACTOR_JOB_STATUSES)),
             origin: ow_1.default.optional.string.oneOf(Object.values(consts_1.META_ORIGINS)),
         }));
         return new run_1.RunClient(this._subResourceOptions({

package/dist/resource_clients/actor_collection.d.ts

@@ -1,3 +1,4 @@
+import type { ACTOR_PERMISSION_LEVEL } from '@apify/consts';
 import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceCollectionClient } from '../base/resource_collection_client';
 import type { PaginatedIterator, PaginatedList, PaginationOptions } from '../utils';
@@ -95,4 +96,5 @@ export interface ActorCollectionCreateOptions {
     actorStandby?: ActorStandby & {
         isEnabled: boolean;
     };
+    actorPermissionLevel?: ACTOR_PERMISSION_LEVEL;
 }

package/dist/resource_clients/dataset.js

@@ -134,14 +134,13 @@ class DatasetClient extends resource_client_1.ResourceClient {
             signature: ow_1.default.optional.string,
         }));
         const fetchItems = async (datasetListOptions = {}) => {
-            var _a;
             const response = await this.httpClient.call({
                 url: this._url('items'),
                 method: 'GET',
                 params: this._params(datasetListOptions),
                 timeout: resource_client_1.DEFAULT_TIMEOUT_MILLIS,
             });
-            return this._createPaginationList(response, (_a = datasetListOptions.desc) !== null && _a !== void 0 ? _a : false);
+            return this._createPaginationList(response, datasetListOptions.desc ?? false);
         };
         return this._listPaginatedFromCallback(fetchItems, options);
     }
@@ -339,7 +338,7 @@ class DatasetClient extends resource_client_1.ResourceClient {
         const dataset = await this.get();
         const { expiresInSecs, ...queryOptions } = options;
         let createdItemsPublicUrl = new URL(this._publicUrl('items'));
-        if (dataset === null || dataset === void 0 ? void 0 : dataset.urlSigningSecretKey) {
+        if (dataset?.urlSigningSecretKey) {
             const signature = await (0, utilities_1.createStorageContentSignatureAsync)({
                 resourceId: dataset.id,
                 urlSigningSecretKey: dataset.urlSigningSecretKey,
@@ -351,7 +350,6 @@ class DatasetClient extends resource_client_1.ResourceClient {
         return createdItemsPublicUrl.toString();
     }
     _createPaginationList(response, userProvidedDesc) {
-        var _a;
         return {
             items: response.data,
             total: Number(response.headers['x-apify-pagination-total']),
@@ -359,7 +357,7 @@ class DatasetClient extends resource_client_1.ResourceClient {
             count: response.data.length, // because x-apify-pagination-count returns invalid values when hidden/empty items are skipped
             limit: Number(response.headers['x-apify-pagination-limit']), // API returns 999999999999 when no limit is used
             // TODO: Replace this once https://github.com/apify/apify-core/issues/3503 is solved
-            desc: JSON.parse((_a = response.headers['x-apify-pagination-desc']) !== null && _a !== void 0 ? _a : userProvidedDesc),
+            desc: JSON.parse(response.headers['x-apify-pagination-desc'] ?? userProvidedDesc),
         };
     }
 }

package/dist/resource_clients/dataset_collection.js

@@ -75,7 +75,7 @@ class DatasetCollectionClient extends resource_collection_client_1.ResourceColle
      */
     async getOrCreate(name, options) {
         (0, ow_1.default)(name, ow_1.default.optional.string);
-        (0, ow_1.default)(options === null || options === void 0 ? void 0 : options.schema, ow_1.default.optional.object); // TODO: Add schema validatioon
+        (0, ow_1.default)(options?.schema, ow_1.default.optional.object); // TODO: Add schema validatioon
         return this._getOrCreate(name, options);
     }
 }

package/dist/resource_clients/key_value_store.js

@@ -174,7 +174,7 @@ class KeyValueStoreClient extends resource_client_1.ResourceClient {
         (0, ow_1.default)(key, ow_1.default.string.nonEmpty);
         const store = await this.get();
         const recordPublicUrl = new URL(this._publicUrl(`records/${key}`));
-        if (store === null || store === void 0 ? void 0 : store.urlSigningSecretKey) {
+        if (store?.urlSigningSecretKey) {
             const signature = await (0, utilities_1.createHmacSignatureAsync)(store.urlSigningSecretKey, key);
             recordPublicUrl.searchParams.append('signature', signature);
         }
@@ -213,7 +213,7 @@ class KeyValueStoreClient extends resource_client_1.ResourceClient {
         const store = await this.get();
         const { expiresInSecs, ...queryOptions } = options;
         let createdPublicKeysUrl = new URL(this._publicUrl('keys'));
-        if (store === null || store === void 0 ? void 0 : store.urlSigningSecretKey) {
+        if (store?.urlSigningSecretKey) {
             const signature = await (0, utilities_1.createStorageContentSignatureAsync)({
                 resourceId: store.id,
                 urlSigningSecretKey: store.urlSigningSecretKey,

package/dist/resource_clients/key_value_store_collection.js

@@ -75,7 +75,7 @@ class KeyValueStoreCollectionClient extends resource_collection_client_1.Resourc
      */
     async getOrCreate(name, options) {
         (0, ow_1.default)(name, ow_1.default.optional.string);
-        (0, ow_1.default)(options === null || options === void 0 ? void 0 : options.schema, ow_1.default.optional.object); // TODO: Add schema validatioon
+        (0, ow_1.default)(options?.schema, ow_1.default.optional.object); // TODO: Add schema validatioon
         return this._getOrCreate(name, options);
     }
 }

package/dist/resource_clients/log.js

@@ -123,49 +123,14 @@ exports.LoggerActorRedirect = LoggerActorRedirect;
  * Helper class for redirecting streamed Actor logs to another log.
  */
 class StreamedLog {
+    destinationLog;
+    streamBuffer = [];
+    splitMarker = /(?:\n|^)(\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z)/g;
+    relevancyTimeLimit;
+    logClient;
+    streamingTask = null;
+    stopLogging = false;
     constructor(options) {
-        Object.defineProperty(this, "destinationLog", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "streamBuffer", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: []
-        });
-        Object.defineProperty(this, "splitMarker", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: /(?:\n|^)(\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z)/g
-        });
-        Object.defineProperty(this, "relevancyTimeLimit", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "logClient", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "streamingTask", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: null
-        });
-        Object.defineProperty(this, "stopLogging", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: false
-        });
         const { toLog, logClient, fromStart = true } = options;
         this.destinationLog = toLog;
         this.logClient = logClient;