apify-client 2.25.1-beta.7 → 3.0.0-beta.0

package/dist/index.d.ts

@@ -27,5 +27,6 @@ export * from './resource_clients/webhook_collection';
 export * from './resource_clients/webhook_dispatch';
 export * from './resource_clients/webhook_dispatch_collection';
 export * from './apify_api_error';
+export * from './argument_validation_error';
 export { InvalidResponseBodyError } from './interceptors';
 export type { PaginatedList, Dictionary } from './utils';

package/dist/index.js

@@ -31,5 +31,6 @@ tslib_1.__exportStar(require("./resource_clients/webhook_collection"), exports);
 tslib_1.__exportStar(require("./resource_clients/webhook_dispatch"), exports);
 tslib_1.__exportStar(require("./resource_clients/webhook_dispatch_collection"), exports);
 tslib_1.__exportStar(require("./apify_api_error"), exports);
+tslib_1.__exportStar(require("./argument_validation_error"), exports);
 var interceptors_1 = require("./interceptors");
 Object.defineProperty(exports, "InvalidResponseBodyError", { enumerable: true, get: function () { return interceptors_1.InvalidResponseBodyError; } });

package/dist/index.mjs

@@ -11,6 +11,7 @@ export const ActorVersionClient = mod.ActorVersionClient;
 export const ActorVersionCollectionClient = mod.ActorVersionCollectionClient;
 export const ApifyApiError = mod.ApifyApiError;
 export const ApifyClient = mod.ApifyClient;
+export const ArgumentValidationError = mod.ArgumentValidationError;
 export const BuildClient = mod.BuildClient;
 export const BuildCollectionClient = mod.BuildCollectionClient;
 export const DatasetClient = mod.DatasetClient;

package/dist/resource_clients/actor.js

@@ -1,8 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ActorClient = void 0;
-const tslib_1 = require("tslib");
-const ow_1 = tslib_1.__importDefault(require("ow"));
+const zod_1 = require("zod");
 const consts_1 = require("@apify/consts");
 const log_1 = require("@apify/log");
 const resource_client_1 = require("../base/resource_client");
@@ -14,6 +13,46 @@ const build_collection_1 = require("./build_collection");
 const run_1 = require("./run");
 const run_collection_1 = require("./run_collection");
 const webhook_collection_1 = require("./webhook_collection");
+const startOptionsSchema = zod_1.z.strictObject({
+    build: zod_1.z.string().optional(),
+    contentType: zod_1.z.string().optional(),
+    memory: zod_1.z.number().optional(),
+    timeout: zod_1.z.number().optional(),
+    waitForFinish: zod_1.z.number().optional(),
+    webhooks: zod_1.z.array(utils_1.anyObjectSchema).optional(),
+    maxItems: zod_1.z.number().min(0).optional(),
+    maxTotalChargeUsd: zod_1.z.number().min(0).optional(),
+    restartOnError: zod_1.z.boolean().optional(),
+    forcePermissionLevel: zod_1.z.enum(consts_1.ACTOR_PERMISSION_LEVEL).optional(),
+});
+const callOptionsSchema = zod_1.z.strictObject({
+    build: zod_1.z.string().optional(),
+    contentType: zod_1.z.string().optional(),
+    memory: zod_1.z.number().optional(),
+    timeout: zod_1.z.number().min(0).optional(),
+    waitSecs: zod_1.z.number().min(0).optional(),
+    webhooks: zod_1.z.array(utils_1.anyObjectSchema).optional(),
+    maxItems: zod_1.z.number().min(0).optional(),
+    maxTotalChargeUsd: zod_1.z.number().min(0).optional(),
+    log: zod_1.z.union([zod_1.z.null(), zod_1.z.instanceof(log_1.Log), zod_1.z.literal('default')]).optional(),
+    restartOnError: zod_1.z.boolean().optional(),
+    forcePermissionLevel: zod_1.z.enum(consts_1.ACTOR_PERMISSION_LEVEL).optional(),
+});
+const validateInputOptionsSchema = zod_1.z.strictObject({
+    build: zod_1.z.string().optional(),
+    contentType: zod_1.z.string().optional(),
+});
+const versionNumberSchema = zod_1.z.string();
+const buildOptionsSchema = zod_1.z.strictObject({
+    betaPackages: zod_1.z.boolean().optional(),
+    tag: zod_1.z.string().optional(),
+    useCache: zod_1.z.boolean().optional(),
+    waitForFinish: zod_1.z.number().optional(),
+});
+const lastRunOptionsSchema = zod_1.z.strictObject({
+    status: zod_1.z.enum(consts_1.ACTOR_JOB_STATUSES).optional(),
+    origin: zod_1.z.enum(consts_1.META_ORIGINS).optional(),
+});
 /**
  * Client for managing a specific Actor.
  *
@@ -61,7 +100,7 @@ class ActorClient extends resource_client_1.ResourceClient {
      * @see https://docs.apify.com/api/v2/act-put
      */
     async update(newFields) {
-        (0, ow_1.default)(newFields, ow_1.default.object);
+        (0, utils_1.parseArgument)(newFields, utils_1.anyObjectSchema);
         return this._update(newFields);
     }
     /**
@@ -109,25 +148,14 @@ class ActorClient extends resource_client_1.ResourceClient {
     async start(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,
-            memory: ow_1.default.optional.number,
-            timeout: ow_1.default.optional.number,
-            waitForFinish: ow_1.default.optional.number,
-            webhooks: ow_1.default.optional.array.ofType(ow_1.default.object),
-            maxItems: ow_1.default.optional.number.not.negative,
-            maxTotalChargeUsd: ow_1.default.optional.number.not.negative,
-            restartOnError: ow_1.default.optional.boolean,
-            forcePermissionLevel: ow_1.default.optional.string.oneOf(Object.values(consts_1.ACTOR_PERMISSION_LEVEL)),
-        }));
-        const { waitForFinish, timeout, memory, build, maxItems, maxTotalChargeUsd, restartOnError, forcePermissionLevel, } = options;
+        const parsed = (0, utils_1.parseArgument)(options, startOptionsSchema, 'ActorStartOptions');
+        const { waitForFinish, timeout, memory, build, maxItems, maxTotalChargeUsd, restartOnError, forcePermissionLevel, } = parsed;
         const params = {
             waitForFinish,
             timeout,
             memory,
             build,
-            webhooks: (0, utils_1.stringifyWebhooksToBase64)(options.webhooks),
+            webhooks: (0, utils_1.stringifyWebhooksToBase64)(parsed.webhooks),
             maxItems,
             maxTotalChargeUsd,
             restartOnError,
@@ -142,9 +170,9 @@ class ActorClient extends resource_client_1.ResourceClient {
             // to stringify functions to JSON, instead of omitting them.
             stringifyFunctions: true,
         };
-        if (options.contentType) {
+        if (parsed.contentType) {
             request.headers = {
-                'content-type': options.contentType,
+                'content-type': parsed.contentType,
             };
         }
         const response = await this.httpClient.call(request);
@@ -190,26 +218,14 @@ class ActorClient extends resource_client_1.ResourceClient {
     async call(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,
-            memory: ow_1.default.optional.number,
-            timeout: ow_1.default.optional.number.not.negative,
-            waitSecs: ow_1.default.optional.number.not.negative,
-            webhooks: ow_1.default.optional.array.ofType(ow_1.default.object),
-            maxItems: ow_1.default.optional.number.not.negative,
-            maxTotalChargeUsd: ow_1.default.optional.number.not.negative,
-            log: ow_1.default.optional.any(ow_1.default.null, ow_1.default.object.instanceOf(log_1.Log), ow_1.default.string.equals('default')),
-            restartOnError: ow_1.default.optional.boolean,
-            forcePermissionLevel: ow_1.default.optional.string.oneOf(Object.values(consts_1.ACTOR_PERMISSION_LEVEL)),
-        }));
-        const { waitSecs, log, ...startOptions } = options;
+        const parsed = (0, utils_1.parseArgument)(options, callOptionsSchema, 'ActorCallOptions');
+        const { waitSecs, log, ...startOptions } = parsed;
         const { id } = await this.start(input, startOptions);
         // Calling root client because we need access to top level API.
         // 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?.log });
+        const streamedLog = await newRunClient.getStreamedLog({ toLog: log });
         streamedLog?.start();
         return this.apifyClient
             .run(id)
@@ -252,22 +268,19 @@ class ActorClient extends resource_client_1.ResourceClient {
     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 parsed = (0, utils_1.parseArgument)(options, validateInputOptionsSchema, 'ActorValidateInputOptions');
         const request = {
             url: this._url('validate-input'),
             method: 'POST',
             data: input,
-            params: this._params({ build: options.build }),
+            params: this._params({ build: parsed.build }),
             // Apify internal property. Tells the request serialization interceptor
             // to stringify functions to JSON, instead of omitting them.
             stringifyFunctions: true,
         };
-        if (options.contentType) {
+        if (parsed.contentType) {
             request.headers = {
-                'content-type': options.contentType,
+                'content-type': parsed.contentType,
             };
         }
         const response = await this.httpClient.call(request);
@@ -303,19 +316,14 @@ class ActorClient extends resource_client_1.ResourceClient {
      * ```
      */
     async build(versionNumber, options = {}) {
-        (0, ow_1.default)(versionNumber, ow_1.default.string);
-        (0, ow_1.default)(options, ow_1.default.object.exactShape({
-            betaPackages: ow_1.default.optional.boolean,
-            tag: ow_1.default.optional.string,
-            useCache: ow_1.default.optional.boolean,
-            waitForFinish: ow_1.default.optional.number,
-        }));
+        (0, utils_1.parseArgument)(versionNumber, versionNumberSchema);
+        const parsed = (0, utils_1.parseArgument)(options, buildOptionsSchema, 'ActorBuildOptions');
         const response = await this.httpClient.call({
             url: this._url('builds'),
             method: 'POST',
             params: this._params({
                 version: versionNumber,
-                ...options,
+                ...parsed,
             }),
         });
         return (0, utils_1.cast)((0, utils_1.parseDateFields)((0, utils_1.pluckData)(response.data)));
@@ -378,13 +386,10 @@ 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.ACTOR_JOB_STATUSES)),
-            origin: ow_1.default.optional.string.oneOf(Object.values(consts_1.META_ORIGINS)),
-        }));
+        const parsed = (0, utils_1.parseArgument)(options, lastRunOptionsSchema, 'ActorLastRunOptions');
         return new run_1.RunClient(this._subResourceOptions({
             id: 'last',
-            params: this._params(options),
+            params: this._params(parsed),
             resourcePath: 'runs',
         }));
     }
@@ -418,7 +423,7 @@ class ActorClient extends resource_client_1.ResourceClient {
      * @see https://docs.apify.com/api/v2/act-version-get
      */
     version(versionNumber) {
-        (0, ow_1.default)(versionNumber, ow_1.default.string);
+        (0, utils_1.parseArgument)(versionNumber, versionNumberSchema);
         return new actor_version_1.ActorVersionClient(this._subResourceOptions({
             id: versionNumber,
         }));

package/dist/resource_clients/actor_collection.js

@@ -1,9 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ActorListSortBy = exports.ActorCollectionClient = void 0;
-const tslib_1 = require("tslib");
-const ow_1 = tslib_1.__importDefault(require("ow"));
+const zod_1 = require("zod");
 const resource_collection_client_1 = require("../base/resource_collection_client");
+const utils_1 = require("../utils");
+const actorCreateSchema = utils_1.anyObjectSchema.optional();
 /**
  * Client for managing the collection of Actors in your account.
  *
@@ -58,14 +59,8 @@ class ActorCollectionClient extends resource_collection_client_1.ResourceCollect
      * @see https://docs.apify.com/api/v2/acts-get
      */
     list(options = {}) {
-        (0, ow_1.default)(options, ow_1.default.object.exactShape({
-            my: ow_1.default.optional.boolean,
-            limit: ow_1.default.optional.number.not.negative,
-            offset: ow_1.default.optional.number.not.negative,
-            desc: ow_1.default.optional.boolean,
-            sortBy: ow_1.default.optional.string.oneOf(Object.values(ActorListSortBy)),
-        }));
-        return this._listPaginated(options);
+        const parsed = (0, utils_1.parseArgument)(options, listOptionsSchema, 'ActorCollectionListOptions');
+        return this._listPaginated(parsed);
     }
     /**
      * Creates a new Actor.
@@ -75,7 +70,7 @@ class ActorCollectionClient extends resource_collection_client_1.ResourceCollect
      * @see https://docs.apify.com/api/v2/acts-post
      */
     async create(actor) {
-        (0, ow_1.default)(actor, ow_1.default.optional.object);
+        (0, utils_1.parseArgument)(actor, actorCreateSchema);
         return this._create(actor);
     }
 }
@@ -88,3 +83,10 @@ var ActorListSortBy;
     ActorListSortBy["CREATED_AT"] = "createdAt";
     ActorListSortBy["LAST_RUN_STARTED_AT"] = "stats.lastRunStartedAt";
 })(ActorListSortBy || (exports.ActorListSortBy = ActorListSortBy = {}));
+// Declared below `ActorListSortBy` because it references it at module load time.
+const listOptionsSchema = zod_1.z.strictObject({
+    my: zod_1.z.boolean().optional(),
+    ...utils_1.paginationOptionsShape,
+    desc: zod_1.z.boolean().optional(),
+    sortBy: zod_1.z.enum(ActorListSortBy).optional(),
+});

package/dist/resource_clients/actor_env_var.js

@@ -1,9 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ActorEnvVarClient = void 0;
-const tslib_1 = require("tslib");
-const ow_1 = tslib_1.__importDefault(require("ow"));
 const resource_client_1 = require("../base/resource_client");
+const utils_1 = require("../utils");
 /**
  * Client for managing a specific Actor environment variable.
  *
@@ -54,7 +53,7 @@ class ActorEnvVarClient extends resource_client_1.ResourceClient {
      * @see https://docs.apify.com/api/v2/act-version-env-var-put
      */
     async update(actorEnvVar) {
-        (0, ow_1.default)(actorEnvVar, ow_1.default.object);
+        (0, utils_1.parseArgument)(actorEnvVar, utils_1.anyObjectSchema);
         return this._update(actorEnvVar);
     }
     /**

package/dist/resource_clients/actor_env_var_collection.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ActorEnvVarCollectionClient = void 0;
-const tslib_1 = require("tslib");
-const ow_1 = tslib_1.__importDefault(require("ow"));
 const resource_collection_client_1 = require("../base/resource_collection_client");
+const utils_1 = require("../utils");
+const actorEnvVarSchema = utils_1.anyObjectSchema.optional();
 /**
  * Client for managing the collection of environment variables for an Actor version.
  *
@@ -71,7 +71,7 @@ class ActorEnvVarCollectionClient extends resource_collection_client_1.ResourceC
      * @see https://docs.apify.com/api/v2/act-version-env-vars-post
      */
     async create(actorEnvVar) {
-        (0, ow_1.default)(actorEnvVar, ow_1.default.optional.object);
+        (0, utils_1.parseArgument)(actorEnvVar, actorEnvVarSchema);
         return this._create(actorEnvVar);
     }
 }

package/dist/resource_clients/actor_version.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ActorSourceType = exports.ActorVersionClient = void 0;
-const tslib_1 = require("tslib");
-const ow_1 = tslib_1.__importDefault(require("ow"));
+const zod_1 = require("zod");
 const resource_client_1 = require("../base/resource_client");
+const utils_1 = require("../utils");
 const actor_env_var_1 = require("./actor_env_var");
 const actor_env_var_collection_1 = require("./actor_env_var_collection");
+const envVarNameSchema = zod_1.z.string();
 /**
  * Client for managing a specific Actor version.
  *
@@ -54,7 +55,7 @@ class ActorVersionClient extends resource_client_1.ResourceClient {
      * @see https://docs.apify.com/api/v2/act-version-put
      */
     async update(newFields) {
-        (0, ow_1.default)(newFields, ow_1.default.object);
+        (0, utils_1.parseArgument)(newFields, utils_1.anyObjectSchema);
         return this._update(newFields);
     }
     /**
@@ -74,7 +75,7 @@ class ActorVersionClient extends resource_client_1.ResourceClient {
      * @since Added in 2.1.0
      */
     envVar(envVarName) {
-        (0, ow_1.default)(envVarName, ow_1.default.string);
+        (0, utils_1.parseArgument)(envVarName, envVarNameSchema);
         return new actor_env_var_1.ActorEnvVarClient(this._subResourceOptions({
             id: envVarName,
         }));

package/dist/resource_clients/actor_version_collection.js

@@ -1,9 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ActorVersionCollectionClient = void 0;
-const tslib_1 = require("tslib");
-const ow_1 = tslib_1.__importDefault(require("ow"));
 const resource_collection_client_1 = require("../base/resource_collection_client");
+const utils_1 = require("../utils");
+const actorVersionSchema = utils_1.anyObjectSchema.optional();
 /**
  * Client for managing the collection of Actor versions.
  *
@@ -68,7 +68,7 @@ class ActorVersionCollectionClient extends resource_collection_client_1.Resource
      * @see https://docs.apify.com/api/v2/act-versions-post
      */
     async create(actorVersion) {
-        (0, ow_1.default)(actorVersion, ow_1.default.optional.object);
+        (0, utils_1.parseArgument)(actorVersion, actorVersionSchema);
         return this._create(actorVersion);
     }
 }

package/dist/resource_clients/build.js

@@ -1,11 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BuildClient = void 0;
-const tslib_1 = require("tslib");
-const ow_1 = tslib_1.__importDefault(require("ow"));
+const zod_1 = require("zod");
 const resource_client_1 = require("../base/resource_client");
 const utils_1 = require("../utils");
 const log_1 = require("./log");
+const getOptionsSchema = zod_1.z.strictObject({ waitForFinish: zod_1.z.number().optional() });
+const waitForFinishOptionsSchema = zod_1.z.strictObject({ waitSecs: zod_1.z.number().optional() });
 /**
  * Client for managing a specific Actor build.
  *
@@ -58,10 +59,8 @@ class BuildClient extends resource_client_1.ResourceClient {
      * ```
      */
     async get(options = {}) {
-        (0, ow_1.default)(options, ow_1.default.object.exactShape({
-            waitForFinish: ow_1.default.optional.number,
-        }));
-        return this._get(options);
+        const parsed = (0, utils_1.parseArgument)(options, getOptionsSchema, 'BuildClientGetOptions');
+        return this._get(parsed);
     }
     /**
      * Aborts the Actor build.
@@ -139,10 +138,8 @@ class BuildClient extends resource_client_1.ResourceClient {
      * ```
      */
     async waitForFinish(options = {}) {
-        (0, ow_1.default)(options, ow_1.default.object.exactShape({
-            waitSecs: ow_1.default.optional.number,
-        }));
-        return this._waitForFinish(options);
+        const parsed = (0, utils_1.parseArgument)(options, waitForFinishOptionsSchema, 'BuildClientWaitForFinishOptions');
+        return this._waitForFinish(parsed);
     }
     /**
      * Returns a client for accessing the log of this Actor build.

package/dist/resource_clients/build_collection.js

@@ -1,9 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BuildCollectionClient = void 0;
-const tslib_1 = require("tslib");
-const ow_1 = tslib_1.__importDefault(require("ow"));
+const zod_1 = require("zod");
 const resource_collection_client_1 = require("../base/resource_collection_client");
+const utils_1 = require("../utils");
+const listOptionsSchema = zod_1.z.strictObject({
+    ...utils_1.paginationOptionsShape,
+    desc: zod_1.z.boolean().optional(),
+});
 /**
  * Client for managing the collection of Actor builds.
  *
@@ -56,12 +60,8 @@ class BuildCollectionClient extends resource_collection_client_1.ResourceCollect
      * @see https://docs.apify.com/api/v2/actor-builds-get
      */
     list(options = {}) {
-        (0, ow_1.default)(options, ow_1.default.object.exactShape({
-            limit: ow_1.default.optional.number.not.negative,
-            offset: ow_1.default.optional.number.not.negative,
-            desc: ow_1.default.optional.boolean,
-        }));
-        return this._listPaginated(options);
+        const parsed = (0, utils_1.parseArgument)(options, listOptionsSchema, 'BuildCollectionClientListOptions');
+        return this._listPaginated(parsed);
     }
 }
 exports.BuildCollectionClient = BuildCollectionClient;

package/dist/resource_clients/dataset.d.ts

@@ -315,10 +315,11 @@ export interface DatasetClientListItemOptions extends PaginationOptions {
 /**
  * Options for creating a public URL to access dataset items.
  *
- * Extends {@link DatasetClientListItemOptions} with URL expiration control.
+ * Extends {@link DatasetClientListItemOptions} with URL expiration control, minus `chunkSize` (it only
+ * sizes a client-side iteration) and `signature` (this method produces one).
  * @since Added in 2.16.0
  */
-export interface DatasetClientCreateItemsUrlOptions extends DatasetClientListItemOptions {
+export interface DatasetClientCreateItemsUrlOptions extends Omit<DatasetClientListItemOptions, 'chunkSize' | 'signature'> {
     expiresInSecs?: number;
 }
 /**
@@ -336,9 +337,10 @@ export declare enum DownloadItemsFormat {
 /**
  * Options for downloading dataset items in a specific format.
  *
- * Extends {@link DatasetClientListItemOptions} with format-specific options.
+ * Extends {@link DatasetClientListItemOptions} with format-specific options, minus `chunkSize` - this
+ * downloads the whole range in one request, so there is nothing to size.
  */
-export interface DatasetClientDownloadItemsOptions extends DatasetClientListItemOptions {
+export interface DatasetClientDownloadItemsOptions extends Omit<DatasetClientListItemOptions, 'chunkSize'> {
     attachment?: boolean;
     bom?: boolean;
     delimiter?: string;