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

package/dist/bundle.js

@@ -13419,9 +13419,6 @@ __webpack_require__.r(__webpack_exports__);
             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) {
@@ -13501,6 +13498,62 @@ __webpack_require__.r(__webpack_exports__);
             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) {
+        let options = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : {};
+        // 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.
+        ow__rspack_import_11_default()(options, ow__rspack_import_11_default().object.exactShape({
+            build: (ow__rspack_import_11_default().optional.string),
+            contentType: (ow__rspack_import_11_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.
      *
@@ -18031,7 +18084,7 @@ function isStream(value) {
 function getVersionData() {
     if (true) {
         return {
-            version: "2.23.5-beta.19"
+            version: "2.23.5-beta.20"
         };
     }
     // eslint-disable-next-line