apify-client 3.0.0-beta.1 → 3.0.0-beta.3

package/dist/resource_clients/build_collection.d.ts

@@ -1,8 +1,8 @@
-import type { ApiClientOptionsWithOptionalResourcePath } from '../base/api_client';
-import { ResourceCollectionClient } from '../base/resource_collection_client';
-import type { BuildCollectionClientListItem } from '../models';
-import type { PaginatedIterator, PaginatedList, PaginationOptions } from '../utils';
-export type { BuildCollectionClientListItem } from '../models';
+import type { ApiClientOptionsWithOptionalResourcePath } from '../base/api_client.js';
+import { ResourceCollectionClient } from '../base/resource_collection_client.js';
+import type { BuildCollectionClientListItem } from '../models.js';
+import type { PaginatedIterator, PaginatedList, PaginationOptions } from '../utils.js';
+export type { BuildCollectionClientListItem } from '../models.js';
 /**
  * Client for managing the collection of Actor builds.
  *

package/dist/resource_clients/build_collection.js

@@ -1,12 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BuildCollectionClient = void 0;
-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(),
+import { z } from 'zod';
+import { ResourceCollectionClient } from '../base/resource_collection_client.js';
+import { paginationOptionsShape, parseArgument } from '../utils.js';
+const listOptionsSchema = z.strictObject({
+    ...paginationOptionsShape,
+    desc: z.boolean().optional(),
 });
 /**
  * Client for managing the collection of Actor builds.
@@ -29,7 +26,7 @@ const listOptionsSchema = zod_1.z.strictObject({
  *
  * @see https://docs.apify.com/platform/actors/running/runs-and-builds#builds
  */
-class BuildCollectionClient extends resource_collection_client_1.ResourceCollectionClient {
+export class BuildCollectionClient extends ResourceCollectionClient {
     /**
      * @hidden
      */
@@ -60,8 +57,7 @@ class BuildCollectionClient extends resource_collection_client_1.ResourceCollect
      * @see https://docs.apify.com/api/v2/actor-builds-get
      */
     list(options = {}) {
-        const parsed = (0, utils_1.parseArgument)(options, listOptionsSchema, 'BuildCollectionClientListOptions');
+        const parsed = parseArgument(options, listOptionsSchema, 'BuildCollectionClientListOptions');
         return this._listPaginated(parsed);
     }
 }
-exports.BuildCollectionClient = BuildCollectionClient;

package/dist/resource_clients/dataset.d.ts

@@ -1,9 +1,9 @@
 import type { STORAGE_GENERAL_ACCESS } from '@apify/consts';
-import type { ApiClientSubResourceOptions } from '../base/api_client';
-import { ResourceClient } from '../base/resource_client';
-import type { Dataset, DatasetStatistics } from '../models';
-import type { PaginatedIterator, PaginationOptions } from '../utils';
-export type { Dataset, DatasetStatistics, DatasetStats, FieldStatistics } from '../models';
+import type { ApiClientSubResourceOptions } from '../base/api_client.js';
+import { ResourceClient } from '../base/resource_client.js';
+import type { Dataset, DatasetStatistics } from '../models.js';
+import type { PaginatedIterator, PaginationOptions } from '../utils.js';
+export type { Dataset, DatasetStatistics, DatasetStats, FieldStatistics } from '../models.js';
 /**
  * Client for managing a specific Dataset.
  *

package/dist/resource_clients/dataset.js

@@ -1,63 +1,60 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DownloadItemsFormat = exports.DatasetClient = void 0;
-const zod_1 = require("zod");
-const utilities_1 = require("@apify/utilities");
-const resource_client_1 = require("../base/resource_client");
-const utils_1 = require("../utils");
+import { z } from 'zod';
+import { createStorageContentSignatureAsync } from '@apify/utilities';
+import { DEFAULT_TIMEOUT_MILLIS, MEDIUM_TIMEOUT_MILLIS, ResourceClient, SMALL_TIMEOUT_MILLIS, } from '../base/resource_client.js';
+import { anyObjectSchema, applyQueryParamsToUrl, cast, catchNotFoundOrThrow, isNonArrayObject, paginationOptionsShape, parseArgument, pluckData, } from '../utils.js';
 // A predicate, not a `z.object()` arm, which would walk and copy every key of every pushed item.
-const itemSchema = zod_1.z.custom(utils_1.isNonArrayObject, 'Expected an object');
-const listItemsOptionsSchema = zod_1.z.strictObject({
-    clean: zod_1.z.boolean().optional(),
-    desc: zod_1.z.boolean().optional(),
-    flatten: zod_1.z.array(zod_1.z.string()).optional(),
-    fields: zod_1.z.array(zod_1.z.string()).optional(),
-    omit: zod_1.z.array(zod_1.z.string()).optional(),
-    ...utils_1.paginationOptionsShape,
-    skipEmpty: zod_1.z.boolean().optional(),
-    skipHidden: zod_1.z.boolean().optional(),
-    unwind: zod_1.z.union([zod_1.z.string(), zod_1.z.array(zod_1.z.string())]).optional(),
-    view: zod_1.z.string().optional(),
-    signature: zod_1.z.string().optional(),
+const itemSchema = z.custom(isNonArrayObject, 'Expected an object');
+const listItemsOptionsSchema = z.strictObject({
+    clean: z.boolean().optional(),
+    desc: z.boolean().optional(),
+    flatten: z.array(z.string()).optional(),
+    fields: z.array(z.string()).optional(),
+    omit: z.array(z.string()).optional(),
+    ...paginationOptionsShape,
+    skipEmpty: z.boolean().optional(),
+    skipHidden: z.boolean().optional(),
+    unwind: z.union([z.string(), z.array(z.string())]).optional(),
+    view: z.string().optional(),
+    signature: z.string().optional(),
 });
 // Spells out `limit` / `offset` instead of spreading `paginationOptionsShape`: a download is one
 // request, so `chunkSize` has nothing to size. The options type omits it to match.
-const downloadItemsOptionsSchema = zod_1.z.strictObject({
-    attachment: zod_1.z.boolean().optional(),
-    bom: zod_1.z.boolean().optional(),
-    clean: zod_1.z.boolean().optional(),
-    delimiter: zod_1.z.string().optional(),
-    desc: zod_1.z.boolean().optional(),
-    flatten: zod_1.z.array(zod_1.z.string()).optional(),
-    fields: zod_1.z.array(zod_1.z.string()).optional(),
-    omit: zod_1.z.array(zod_1.z.string()).optional(),
-    limit: zod_1.z.number().min(0).optional(),
-    offset: zod_1.z.number().min(0).optional(),
-    skipEmpty: zod_1.z.boolean().optional(),
-    skipHeaderRow: zod_1.z.boolean().optional(),
-    skipHidden: zod_1.z.boolean().optional(),
-    unwind: zod_1.z.union([zod_1.z.string(), zod_1.z.array(zod_1.z.string())]).optional(),
-    view: zod_1.z.string().optional(),
-    xmlRoot: zod_1.z.string().optional(),
-    xmlRow: zod_1.z.string().optional(),
-    signature: zod_1.z.string().optional(),
+const downloadItemsOptionsSchema = z.strictObject({
+    attachment: z.boolean().optional(),
+    bom: z.boolean().optional(),
+    clean: z.boolean().optional(),
+    delimiter: z.string().optional(),
+    desc: z.boolean().optional(),
+    flatten: z.array(z.string()).optional(),
+    fields: z.array(z.string()).optional(),
+    omit: z.array(z.string()).optional(),
+    limit: z.number().min(0).optional(),
+    offset: z.number().min(0).optional(),
+    skipEmpty: z.boolean().optional(),
+    skipHeaderRow: z.boolean().optional(),
+    skipHidden: z.boolean().optional(),
+    unwind: z.union([z.string(), z.array(z.string())]).optional(),
+    view: z.string().optional(),
+    xmlRoot: z.string().optional(),
+    xmlRow: z.string().optional(),
+    signature: z.string().optional(),
 });
-const pushItemsSchema = zod_1.z.union([itemSchema, zod_1.z.string(), zod_1.z.array(zod_1.z.union([itemSchema, zod_1.z.string()]))]);
+const pushItemsSchema = z.union([itemSchema, z.string(), z.array(z.union([itemSchema, z.string()]))]);
 // Every option becomes a query parameter of the generated URL, so `chunkSize` (client-side only) and
 // `signature` (which this method produces) are left out. The options type omits both to match.
-const createItemsPublicUrlOptionsSchema = zod_1.z.strictObject({
-    clean: zod_1.z.boolean().optional(),
-    desc: zod_1.z.boolean().optional(),
-    flatten: zod_1.z.array(zod_1.z.string()).optional(),
-    fields: zod_1.z.array(zod_1.z.string()).optional(),
-    omit: zod_1.z.array(zod_1.z.string()).optional(),
-    limit: zod_1.z.number().min(0).optional(),
-    offset: zod_1.z.number().min(0).optional(),
-    skipEmpty: zod_1.z.boolean().optional(),
-    skipHidden: zod_1.z.boolean().optional(),
-    unwind: zod_1.z.union([zod_1.z.string(), zod_1.z.array(zod_1.z.string())]).optional(),
-    view: zod_1.z.string().optional(),
-    expiresInSecs: zod_1.z.number().optional(),
+const createItemsPublicUrlOptionsSchema = z.strictObject({
+    clean: z.boolean().optional(),
+    desc: z.boolean().optional(),
+    flatten: z.array(z.string()).optional(),
+    fields: z.array(z.string()).optional(),
+    omit: z.array(z.string()).optional(),
+    limit: z.number().min(0).optional(),
+    offset: z.number().min(0).optional(),
+    skipEmpty: z.boolean().optional(),
+    skipHidden: z.boolean().optional(),
+    unwind: z.union([z.string(), z.array(z.string())]).optional(),
+    view: z.string().optional(),
+    expiresInSecs: z.number().optional(),
 });
 /**
  * Client for managing a specific Dataset.
@@ -88,7 +85,7 @@ const createItemsPublicUrlOptionsSchema = zod_1.z.strictObject({
  *
  * @see https://docs.apify.com/platform/storage/dataset
  */
-class DatasetClient extends resource_client_1.ResourceClient {
+export class DatasetClient extends ResourceClient {
     /**
      * @hidden
      */
@@ -105,7 +102,7 @@ class DatasetClient extends resource_client_1.ResourceClient {
      * @see https://docs.apify.com/api/v2/dataset-get
      */
     async get() {
-        return this._get({}, resource_client_1.SMALL_TIMEOUT_MILLIS);
+        return this._get({}, SMALL_TIMEOUT_MILLIS);
     }
     /**
      * Updates the dataset with specified fields.
@@ -115,8 +112,8 @@ class DatasetClient extends resource_client_1.ResourceClient {
      * @see https://docs.apify.com/api/v2/dataset-put
      */
     async update(newFields) {
-        (0, utils_1.parseArgument)(newFields, utils_1.anyObjectSchema);
-        return this._update(newFields, resource_client_1.SMALL_TIMEOUT_MILLIS);
+        parseArgument(newFields, anyObjectSchema);
+        return this._update(newFields, SMALL_TIMEOUT_MILLIS);
     }
     /**
      * Deletes the dataset.
@@ -124,7 +121,7 @@ class DatasetClient extends resource_client_1.ResourceClient {
      * @see https://docs.apify.com/api/v2/dataset-delete
      */
     async delete() {
-        return this._delete(resource_client_1.SMALL_TIMEOUT_MILLIS);
+        return this._delete(SMALL_TIMEOUT_MILLIS);
     }
     /**
      * Lists items in the dataset.
@@ -171,13 +168,13 @@ class DatasetClient extends resource_client_1.ResourceClient {
      * ```
      */
     listItems(options = {}) {
-        const parsed = (0, utils_1.parseArgument)(options, listItemsOptionsSchema, 'DatasetClientListItemOptions');
+        const parsed = parseArgument(options, listItemsOptionsSchema, 'DatasetClientListItemOptions');
         const fetchItems = async (datasetListOptions = {}) => {
             const response = await this.httpClient.call({
                 url: this._url('items'),
                 method: 'GET',
                 params: this._params(datasetListOptions),
-                timeout: resource_client_1.DEFAULT_TIMEOUT_MILLIS,
+                timeout: DEFAULT_TIMEOUT_MILLIS,
             });
             return this._createPaginationList(response, datasetListOptions.desc ?? false);
         };
@@ -224,8 +221,8 @@ class DatasetClient extends resource_client_1.ResourceClient {
      * ```
      */
     async downloadItems(format, options = {}) {
-        (0, utils_1.parseArgument)(format, itemFormatSchema);
-        const parsed = (0, utils_1.parseArgument)(options, downloadItemsOptionsSchema, 'DatasetClientDownloadItemsOptions');
+        parseArgument(format, itemFormatSchema);
+        const parsed = parseArgument(options, downloadItemsOptionsSchema, 'DatasetClientDownloadItemsOptions');
         const { data } = await this.httpClient.call({
             url: this._url('items'),
             method: 'GET',
@@ -234,9 +231,9 @@ class DatasetClient extends resource_client_1.ResourceClient {
                 ...parsed,
             }),
             forceBuffer: true,
-            timeout: resource_client_1.DEFAULT_TIMEOUT_MILLIS,
+            timeout: DEFAULT_TIMEOUT_MILLIS,
         });
-        return (0, utils_1.cast)(data);
+        return cast(data);
     }
     /**
      * Stores one or more items into the dataset.
@@ -271,7 +268,7 @@ class DatasetClient extends resource_client_1.ResourceClient {
      * ```
      */
     async pushItems(items) {
-        (0, utils_1.parseArgument)(items, pushItemsSchema);
+        parseArgument(items, pushItemsSchema);
         await this.httpClient.call({
             url: this._url('items'),
             method: 'POST',
@@ -281,7 +278,7 @@ class DatasetClient extends resource_client_1.ResourceClient {
             data: items,
             params: this._params(),
             doNotRetryTimeouts: true, // see timeout handling in http-client
-            timeout: resource_client_1.MEDIUM_TIMEOUT_MILLIS,
+            timeout: MEDIUM_TIMEOUT_MILLIS,
         });
     }
     /**
@@ -299,14 +296,14 @@ class DatasetClient extends resource_client_1.ResourceClient {
             url: this._url('statistics'),
             method: 'GET',
             params: this._params(),
-            timeout: resource_client_1.SMALL_TIMEOUT_MILLIS,
+            timeout: SMALL_TIMEOUT_MILLIS,
         };
         try {
             const response = await this.httpClient.call(requestOpts);
-            return (0, utils_1.cast)((0, utils_1.pluckData)(response.data));
+            return cast(pluckData(response.data));
         }
         catch (err) {
-            (0, utils_1.catchNotFoundOrThrow)(err);
+            catchNotFoundOrThrow(err);
         }
         return undefined;
     }
@@ -343,19 +340,19 @@ class DatasetClient extends resource_client_1.ResourceClient {
      * @since Added in 2.13.0
      */
     async createItemsPublicUrl(options = {}) {
-        const parsed = (0, utils_1.parseArgument)(options, createItemsPublicUrlOptionsSchema, 'DatasetClientCreateItemsUrlOptions');
+        const parsed = parseArgument(options, createItemsPublicUrlOptionsSchema, 'DatasetClientCreateItemsUrlOptions');
         const dataset = await this.get();
         const { expiresInSecs, ...queryOptions } = parsed;
         let createdItemsPublicUrl = new URL(this._publicUrl('items'));
         if (dataset?.urlSigningSecretKey) {
-            const signature = await (0, utilities_1.createStorageContentSignatureAsync)({
+            const signature = await createStorageContentSignatureAsync({
                 resourceId: dataset.id,
                 urlSigningSecretKey: dataset.urlSigningSecretKey,
                 expiresInMillis: expiresInSecs ? expiresInSecs * 1000 : undefined,
             });
             createdItemsPublicUrl.searchParams.set('signature', signature);
         }
-        createdItemsPublicUrl = (0, utils_1.applyQueryParamsToUrl)(createdItemsPublicUrl, queryOptions);
+        createdItemsPublicUrl = applyQueryParamsToUrl(createdItemsPublicUrl, queryOptions);
         return createdItemsPublicUrl.toString();
     }
     _createPaginationList(response, userProvidedDesc) {
@@ -370,11 +367,10 @@ class DatasetClient extends resource_client_1.ResourceClient {
         };
     }
 }
-exports.DatasetClient = DatasetClient;
 /**
  * Supported formats for downloading dataset items.
  */
-var DownloadItemsFormat;
+export var DownloadItemsFormat;
 (function (DownloadItemsFormat) {
     DownloadItemsFormat["JSON"] = "json";
     DownloadItemsFormat["JSONL"] = "jsonl";
@@ -383,7 +379,7 @@ var DownloadItemsFormat;
     DownloadItemsFormat["CSV"] = "csv";
     DownloadItemsFormat["XLSX"] = "xlsx";
     DownloadItemsFormat["RSS"] = "rss";
-})(DownloadItemsFormat || (exports.DownloadItemsFormat = DownloadItemsFormat = {}));
+})(DownloadItemsFormat || (DownloadItemsFormat = {}));
 const validItemFormats = [...new Set(Object.values(DownloadItemsFormat).map((item) => item.toLowerCase()))];
 // Declared below `validItemFormats` because it references it at module load time.
-const itemFormatSchema = zod_1.z.enum(validItemFormats);
+const itemFormatSchema = z.enum(validItemFormats);

package/dist/resource_clients/dataset_collection.d.ts

@@ -1,8 +1,8 @@
 import { STORAGE_OWNERSHIP_FILTER } from '@apify/consts';
-import type { ApiClientSubResourceOptions } from '../base/api_client';
-import { ResourceCollectionClient } from '../base/resource_collection_client';
-import type { PaginatedList, PaginationOptions } from '../utils';
-import type { Dataset } from './dataset';
+import type { ApiClientSubResourceOptions } from '../base/api_client.js';
+import { ResourceCollectionClient } from '../base/resource_collection_client.js';
+import type { PaginatedList, PaginationOptions } from '../utils.js';
+import type { Dataset } from './dataset.js';
 /**
  * Client for managing the collection of datasets in your account.
  *

package/dist/resource_clients/dataset_collection.js

@@ -1,18 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.DatasetCollectionClient = void 0;
-const zod_1 = require("zod");
-const consts_1 = require("@apify/consts");
-const resource_collection_client_1 = require("../base/resource_collection_client");
-const utils_1 = require("../utils");
-const listOptionsSchema = zod_1.z.strictObject({
-    unnamed: zod_1.z.boolean().optional(),
-    ...utils_1.paginationOptionsShape,
-    desc: zod_1.z.boolean().optional(),
-    ownership: zod_1.z.enum(consts_1.STORAGE_OWNERSHIP_FILTER).optional(),
+import { z } from 'zod';
+import { STORAGE_OWNERSHIP_FILTER } from '@apify/consts';
+import { ResourceCollectionClient } from '../base/resource_collection_client.js';
+import { anyObjectSchema, paginationOptionsShape, parseArgument } from '../utils.js';
+const listOptionsSchema = z.strictObject({
+    unnamed: z.boolean().optional(),
+    ...paginationOptionsShape,
+    desc: z.boolean().optional(),
+    ownership: z.enum(STORAGE_OWNERSHIP_FILTER).optional(),
 });
-const nameSchema = zod_1.z.string().optional();
-const schemaSchema = utils_1.anyObjectSchema.optional();
+const nameSchema = z.string().optional();
+const schemaSchema = anyObjectSchema.optional();
 /**
  * Client for managing the collection of datasets in your account.
  *
@@ -33,7 +30,7 @@ const schemaSchema = utils_1.anyObjectSchema.optional();
  *
  * @see https://docs.apify.com/platform/storage/dataset
  */
-class DatasetCollectionClient extends resource_collection_client_1.ResourceCollectionClient {
+export class DatasetCollectionClient extends ResourceCollectionClient {
     /**
      * @hidden
      */
@@ -64,7 +61,7 @@ class DatasetCollectionClient extends resource_collection_client_1.ResourceColle
      * @see https://docs.apify.com/api/v2/datasets-get
      */
     list(options = {}) {
-        const parsed = (0, utils_1.parseArgument)(options, listOptionsSchema, 'DatasetCollectionClientListOptions');
+        const parsed = parseArgument(options, listOptionsSchema, 'DatasetCollectionClientListOptions');
         return this._listPaginated(parsed);
     }
     /**
@@ -76,9 +73,8 @@ class DatasetCollectionClient extends resource_collection_client_1.ResourceColle
      * @see https://docs.apify.com/api/v2/datasets-post
      */
     async getOrCreate(name, options) {
-        (0, utils_1.parseArgument)(name, nameSchema);
-        (0, utils_1.parseArgument)(options?.schema, schemaSchema); // TODO: Add schema validation
+        parseArgument(name, nameSchema);
+        parseArgument(options?.schema, schemaSchema); // TODO: Add schema validation
         return this._getOrCreate(name, options);
     }
 }
-exports.DatasetCollectionClient = DatasetCollectionClient;

package/dist/resource_clients/key_value_store.d.ts

@@ -1,10 +1,10 @@
 import type { Readable } from 'node:stream';
 import type { JsonValue } from 'type-fest';
 import type { STORAGE_GENERAL_ACCESS } from '@apify/consts';
-import type { ApiClientSubResourceOptions } from '../base/api_client';
-import { ResourceClient } from '../base/resource_client';
-import type { KeyValueClientListKeysResult, KeyValueListItem, KeyValueStore } from '../models';
-export type { KeyValueClientListKeysResult, KeyValueListItem, KeyValueStore, KeyValueStoreStats } from '../models';
+import type { ApiClientSubResourceOptions } from '../base/api_client.js';
+import { ResourceClient } from '../base/resource_client.js';
+import type { KeyValueClientListKeysResult, KeyValueListItem, KeyValueStore } from '../models.js';
+export type { KeyValueClientListKeysResult, KeyValueListItem, KeyValueStore, KeyValueStoreStats } from '../models.js';
 /**
  * Client for managing a specific key-value store.
  *