apify-client 2.23.5-beta.19 → 2.23.5-beta.20

package/dist/resource_clients/actor.d.ts

@@ -133,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.
      *
@@ -586,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.
  */

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) {
@@ -221,6 +218,60 @@ class ActorClient extends resource_client_1.ResourceClient {
             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.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apify-client",
-  "version": "2.23.5-beta.19",
+  "version": "2.23.5-beta.20",
   "description": "Apify API client for JavaScript",
   "main": "dist/index.js",
   "module": "dist/index.mjs",