apify-client 2.23.5-beta.8 → 2.24.0

package/dist/http_client.js

@@ -122,7 +122,7 @@ class HttpClient {
         this.axios.defaults.httpsAgent = this.httpsAgent;
         // Works only in Node. Cannot be set in browser
         const isAtHome = !!process.env[consts_1.APIFY_ENV_VARS.IS_AT_HOME];
-        let userAgent = `ApifyClient/${version} (${os.type()}; Node/${process.version}); isAtHome/${isAtHome}`;
+        let userAgent = `ApifyClient/${version} (${os.platform()}; Node/${process.version}); isAtHome/${isAtHome}`;
         if (this.userAgentSuffix) {
             userAgent += `; ${(0, utils_1.asArray)(this.userAgentSuffix).join('; ')}`;
         }

package/dist/interceptors.js

@@ -69,14 +69,14 @@ function stringifyWithFunctions(obj) {
         return typeof value === 'function' ? value.toString() : value;
     });
 }
-async function maybeGzipRequest(config) {
+async function maybeCompressRequest(config) {
     if (config.headers?.['content-encoding'])
         return config;
-    const maybeZippedData = await (0, utils_1.maybeGzipValue)(config.data);
-    if (maybeZippedData) {
+    const maybeCompressed = await (0, utils_1.maybeCompressValue)(config.data);
+    if (maybeCompressed) {
         config.headers ??= {};
-        config.headers['content-encoding'] = 'gzip';
-        config.data = maybeZippedData;
+        config.headers['content-encoding'] = maybeCompressed.encoding;
+        config.data = maybeCompressed.data;
     }
     return config;
 }
@@ -103,7 +103,7 @@ function parseResponseData(response) {
     return response;
 }
 exports.requestInterceptors = [
-    maybeGzipRequest,
+    maybeCompressRequest,
     serializeRequest,
     ensureHeadersPrototype,
 ];

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-validate-input-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) {
@@ -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-validate-input-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/task.d.ts

@@ -1,8 +1,7 @@
-import { ACT_JOB_STATUSES } from '@apify/consts';
 import type { ApiClientSubResourceOptions } from '../base/api_client';
 import { ResourceClient } from '../base/resource_client';
 import type { Dictionary } from '../utils';
-import type { ActorRun, ActorStandby, ActorStartOptions } from './actor';
+import type { ActorLastRunOptions, ActorRun, ActorStandby, ActorStartOptions } from './actor';
 import { RunClient } from './run';
 import { RunCollectionClient } from './run_collection';
 import { WebhookCollectionClient } from './webhook_collection';
@@ -170,8 +169,7 @@ export type TaskUpdateData = Partial<Pick<Task, 'name' | 'title' | 'description'
 /**
  * Options for filtering the last run of a Task.
  */
-export interface TaskLastRunOptions {
-    status?: keyof typeof ACT_JOB_STATUSES;
+export interface TaskLastRunOptions extends ActorLastRunOptions {
 }
 /**
  * Options for starting a Task.

package/dist/utils.d.ts

@@ -41,10 +41,15 @@ export declare function parseDateFields(input: JsonValue, shouldParseField?: ((k
  * Helper function that converts array of webhooks to base64 string
  */
 export declare function stringifyWebhooksToBase64(webhooks: WebhookUpdateData[]): string | undefined;
+export interface CompressedValue {
+    data: Buffer;
+    encoding: 'br' | 'gzip';
+}
 /**
- * Gzip provided value, otherwise returns undefined.
+ * Compress the passed value using brotli if available or using gzip as a fallback. Returns undefined
+ * if the data is too small / wrong type.
  */
-export declare function maybeGzipValue(value: unknown): Promise<Buffer | undefined>;
+export declare function maybeCompressValue(value: unknown): Promise<CompressedValue | undefined>;
 /**
  * Helper function slice the items from array to fit the max byte length.
  */

package/dist/utils.js

@@ -5,7 +5,7 @@ exports.pluckData = pluckData;
 exports.catchNotFoundOrThrow = catchNotFoundOrThrow;
 exports.parseDateFields = parseDateFields;
 exports.stringifyWebhooksToBase64 = stringifyWebhooksToBase64;
-exports.maybeGzipValue = maybeGzipValue;
+exports.maybeCompressValue = maybeCompressValue;
 exports.sliceArrayByByteLength = sliceArrayByByteLength;
 exports.isNode = isNode;
 exports.isBuffer = isBuffer;
@@ -19,7 +19,7 @@ const ow_1 = tslib_1.__importDefault(require("ow"));
 const NOT_FOUND_STATUS_CODE = 404;
 const RECORD_NOT_FOUND_TYPE = 'record-not-found';
 const RECORD_OR_TOKEN_NOT_FOUND_TYPE = 'record-or-token-not-found';
-const MIN_GZIP_BYTES = 1024;
+const MIN_COMPRESS_BYTES = 1024;
 /**
  * Returns object's 'data' property or throws if parameter is not an object,
  * or an object without a 'data' property.
@@ -99,26 +99,59 @@ function stringifyWebhooksToBase64(webhooks) {
 }
 let gzipPromisified;
 /**
- * Gzip provided value, otherwise returns undefined.
+ * Gzip-compress the provided value.
  */
-async function maybeGzipValue(value) {
-    if (!isNode())
-        return;
-    if (typeof value !== 'string' && !Buffer.isBuffer(value))
-        return;
-    // Request compression is not that important so let's
-    // skip it instead of throwing for unsupported types.
-    const areDataLargeEnough = Buffer.byteLength(value) >= MIN_GZIP_BYTES;
-    if (areDataLargeEnough) {
-        if (!gzipPromisified) {
-            const { promisify } = await import('node:util');
-            const { gzip } = await import('node:zlib');
-            gzipPromisified = promisify(gzip);
+async function gzipValue(value) {
+    if (!gzipPromisified) {
+        const { promisify } = await import('node:util');
+        const { gzip } = await import('node:zlib');
+        gzipPromisified = promisify(gzip);
+    }
+    return gzipPromisified(value);
+}
+// null = confirmed unavailable; undefined = not yet checked
+let brotliCompressPromisified;
+/**
+ * Brotli-compress the provided value, or return undefined if brotli is unavailable
+ * (Node.js < v10.16.0), this is a strict defensive guard.
+ */
+async function maybeBrotliValue(value) {
+    if (brotliCompressPromisified === undefined) {
+        const { promisify } = await import('node:util');
+        const { brotliCompress, constants } = await import('node:zlib');
+        if (typeof brotliCompress === 'function') {
+            const compress = promisify(brotliCompress);
+            brotliCompressPromisified = async (value) => compress(value, { params: { [constants.BROTLI_PARAM_QUALITY]: 6 } });
         }
-        return gzipPromisified(value);
+        else {
+            brotliCompressPromisified = null;
+        }
+    }
+    if (brotliCompressPromisified !== null) {
+        return brotliCompressPromisified(value);
     }
     return undefined;
 }
+/**
+ * Compress the passed value using brotli if available or using gzip as a fallback. Returns undefined
+ * if the data is too small / wrong type.
+ */
+async function maybeCompressValue(value) {
+    if (!isNode())
+        return undefined;
+    // Request compression is not that important so let's
+    // skip it instead of throwing for unsupported types.
+    if (typeof value !== 'string' && !Buffer.isBuffer(value))
+        return undefined;
+    const areDataLargeEnough = Buffer.byteLength(value) >= MIN_COMPRESS_BYTES;
+    if (!areDataLargeEnough)
+        return undefined;
+    const brotli = await maybeBrotliValue(value);
+    if (brotli)
+        return { data: brotli, encoding: 'br' };
+    const gzipped = await gzipValue(value);
+    return { data: gzipped, encoding: 'gzip' };
+}
 /**
  * Helper function slice the items from array to fit the max byte length.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apify-client",
-  "version": "2.23.5-beta.8",
+  "version": "2.24.0",
   "description": "Apify API client for JavaScript",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -63,7 +63,7 @@
     "type-fest": "^4.0.0"
   },
   "devDependencies": {
-    "@apify/oxlint-config": "^0.2.5",
+    "@apify/oxlint-config": "^0.3.0",
     "@apify/tsconfig": "^0.2.0",
     "@crawlee/puppeteer": "^3.2.2",
     "@rsbuild/core": "^2.0.0",
@@ -81,9 +81,9 @@
     "esbuild": "0.28.1",
     "express": "^5.0.0",
     "gen-esm-wrapper": "^1.1.2",
-    "oxfmt": "0.55.0",
-    "oxlint": "1.69.0",
-    "oxlint-tsgolint": "0.23.0",
+    "oxfmt": "0.61.0",
+    "oxlint": "1.75.0",
+    "oxlint-tsgolint": "7.0.2001",
     "puppeteer": "^25.0.0",
     "rimraf": "^6.0.0",
     "rolldown": "^1.0.0-rc.4",