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

package/dist/resource_clients/key_value_store.js

@@ -1,51 +1,47 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.KeyValueStoreClient = void 0;
-const tslib_1 = require("tslib");
-const zod_1 = require("zod");
-const log_1 = tslib_1.__importDefault(require("@apify/log"));
-const utilities_1 = require("@apify/utilities");
-const resource_client_1 = require("../base/resource_client");
-const utils_1 = require("../utils");
-const listKeysOptionsSchema = zod_1.z.strictObject({
-    limit: zod_1.z.number().min(0).optional(),
-    exclusiveStartKey: zod_1.z.string().optional(),
-    collection: zod_1.z.string().optional(),
-    prefix: zod_1.z.string().optional(),
-    signature: zod_1.z.string().optional(),
+import { z } from 'zod';
+import log from '@apify/log';
+import { createHmacSignatureAsync, 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, isBuffer, isNode, isStream, parseArgument, parseDateFields, pluckData, } from '../utils.js';
+const listKeysOptionsSchema = z.strictObject({
+    limit: z.number().min(0).optional(),
+    exclusiveStartKey: z.string().optional(),
+    collection: z.string().optional(),
+    prefix: z.string().optional(),
+    signature: z.string().optional(),
 });
-const nonEmptyKeySchema = zod_1.z.string().min(1);
+const nonEmptyKeySchema = z.string().min(1);
 // `signature` is left out - this method produces one. The options type omits it to match.
-const createKeysPublicUrlOptionsSchema = zod_1.z.strictObject({
-    limit: zod_1.z.number().min(0).optional(),
-    exclusiveStartKey: zod_1.z.string().optional(),
-    collection: zod_1.z.string().optional(),
-    prefix: zod_1.z.string().optional(),
-    expiresInSecs: zod_1.z.number().optional(),
+const createKeysPublicUrlOptionsSchema = z.strictObject({
+    limit: z.number().min(0).optional(),
+    exclusiveStartKey: z.string().optional(),
+    collection: z.string().optional(),
+    prefix: z.string().optional(),
+    expiresInSecs: z.number().optional(),
 });
-const keySchema = zod_1.z.string();
-const getRecordOptionsSchema = zod_1.z.strictObject({
-    buffer: zod_1.z.boolean().optional(),
-    stream: zod_1.z.boolean().optional(),
-    disableRedirect: zod_1.z.boolean().optional(),
-    signature: zod_1.z.string().optional(),
+const keySchema = z.string();
+const getRecordOptionsSchema = z.strictObject({
+    buffer: z.boolean().optional(),
+    stream: z.boolean().optional(),
+    disableRedirect: z.boolean().optional(),
+    signature: z.string().optional(),
 });
-const recordSchema = zod_1.z.strictObject({
-    key: zod_1.z.string(),
+const recordSchema = z.strictObject({
+    key: z.string(),
     // Values are arbitrary, and a `z.object()` arm would walk every key of a large buffer.
     // Symbols, bigints, functions and non-finite numbers are rejected because they cannot be serialized
     // to JSON - symbols and bigints throw, functions stringify to `undefined` (an empty request body),
     // and `NaN` / `Infinity` would silently become `null`.
-    value: zod_1.z.custom((value) => value !== undefined &&
+    value: z.custom((value) => value !== undefined &&
         typeof value !== 'symbol' &&
         typeof value !== 'bigint' &&
         typeof value !== 'function' &&
         (typeof value !== 'number' || Number.isFinite(value)), 'Expected a defined, JSON-serializable value'),
-    contentType: zod_1.z.string().min(1).optional(),
+    contentType: z.string().min(1).optional(),
 });
-const recordOptionsSchema = zod_1.z.strictObject({
-    timeoutSecs: zod_1.z.number().optional(),
-    doNotRetryTimeouts: zod_1.z.boolean().optional(),
+const recordOptionsSchema = z.strictObject({
+    timeoutSecs: z.number().optional(),
+    doNotRetryTimeouts: z.boolean().optional(),
 });
 /**
  * Client for managing a specific key-value store.
@@ -75,7 +71,7 @@ const recordOptionsSchema = zod_1.z.strictObject({
  *
  * @see https://docs.apify.com/platform/storage/key-value-store
  */
-class KeyValueStoreClient extends resource_client_1.ResourceClient {
+export class KeyValueStoreClient extends ResourceClient {
     /**
      * @hidden
      */
@@ -92,7 +88,7 @@ class KeyValueStoreClient extends resource_client_1.ResourceClient {
      * @see https://docs.apify.com/api/v2/key-value-store-get
      */
     async get() {
-        return this._get({}, resource_client_1.SMALL_TIMEOUT_MILLIS);
+        return this._get({}, SMALL_TIMEOUT_MILLIS);
     }
     /**
      * Updates the key-value store with specified fields.
@@ -105,8 +101,8 @@ class KeyValueStoreClient extends resource_client_1.ResourceClient {
      * @see https://docs.apify.com/api/v2/key-value-store-put
      */
     async update(newFields) {
-        (0, utils_1.parseArgument)(newFields, utils_1.anyObjectSchema);
-        return this._update(newFields, resource_client_1.DEFAULT_TIMEOUT_MILLIS);
+        parseArgument(newFields, anyObjectSchema);
+        return this._update(newFields, DEFAULT_TIMEOUT_MILLIS);
     }
     /**
      * Deletes the key-value store.
@@ -114,7 +110,7 @@ class KeyValueStoreClient extends resource_client_1.ResourceClient {
      * @see https://docs.apify.com/api/v2/key-value-store-delete
      */
     async delete() {
-        return this._delete(resource_client_1.SMALL_TIMEOUT_MILLIS);
+        return this._delete(SMALL_TIMEOUT_MILLIS);
     }
     /**
      * Lists all keys in the key-value store.
@@ -152,15 +148,15 @@ class KeyValueStoreClient extends resource_client_1.ResourceClient {
      * ```
      */
     listKeys(options = {}) {
-        const parsed = (0, utils_1.parseArgument)(options, listKeysOptionsSchema, 'KeyValueClientListKeysOptions');
+        const parsed = parseArgument(options, listKeysOptionsSchema, 'KeyValueClientListKeysOptions');
         const getPaginatedList = async (kvsListOptions = {}) => {
             const response = await this.httpClient.call({
                 url: this._url('keys'),
                 method: 'GET',
                 params: this._params(kvsListOptions),
-                timeout: resource_client_1.MEDIUM_TIMEOUT_MILLIS,
+                timeout: MEDIUM_TIMEOUT_MILLIS,
             });
-            return (0, utils_1.cast)((0, utils_1.parseDateFields)((0, utils_1.pluckData)(response.data)));
+            return cast(parseDateFields(pluckData(response.data)));
         };
         const paginatedListPromise = getPaginatedList(parsed);
         async function* asyncGenerator() {
@@ -208,11 +204,11 @@ class KeyValueStoreClient extends resource_client_1.ResourceClient {
      * @since Added in 2.14.0
      */
     async getRecordPublicUrl(key) {
-        (0, utils_1.parseArgument)(key, nonEmptyKeySchema);
+        parseArgument(key, nonEmptyKeySchema);
         const store = await this.get();
         const recordPublicUrl = new URL(this._publicUrl(['records', key]));
         if (store?.urlSigningSecretKey) {
-            const signature = await (0, utilities_1.createHmacSignatureAsync)(store.urlSigningSecretKey, key);
+            const signature = await createHmacSignatureAsync(store.urlSigningSecretKey, key);
             recordPublicUrl.searchParams.append('signature', signature);
         }
         return recordPublicUrl.toString();
@@ -241,19 +237,19 @@ class KeyValueStoreClient extends resource_client_1.ResourceClient {
      * @since Added in 2.13.0
      */
     async createKeysPublicUrl(options = {}) {
-        const parsed = (0, utils_1.parseArgument)(options, createKeysPublicUrlOptionsSchema, 'KeyValueClientCreateKeysUrlOptions');
+        const parsed = parseArgument(options, createKeysPublicUrlOptionsSchema, 'KeyValueClientCreateKeysUrlOptions');
         const store = await this.get();
         const { expiresInSecs, ...queryOptions } = parsed;
         let createdPublicKeysUrl = new URL(this._publicUrl('keys'));
         if (store?.urlSigningSecretKey) {
-            const signature = await (0, utilities_1.createStorageContentSignatureAsync)({
+            const signature = await createStorageContentSignatureAsync({
                 resourceId: store.id,
                 urlSigningSecretKey: store.urlSigningSecretKey,
                 expiresInMillis: expiresInSecs ? expiresInSecs * 1000 : undefined,
             });
             createdPublicKeysUrl.searchParams.set('signature', signature);
         }
-        createdPublicKeysUrl = (0, utils_1.applyQueryParamsToUrl)(createdPublicKeysUrl, queryOptions);
+        createdPublicKeysUrl = applyQueryParamsToUrl(createdPublicKeysUrl, queryOptions);
         return createdPublicKeysUrl.toString();
     }
     /**
@@ -285,18 +281,18 @@ class KeyValueStoreClient extends resource_client_1.ResourceClient {
             return true;
         }
         catch (err) {
-            (0, utils_1.catchNotFoundOrThrow)(err);
+            catchNotFoundOrThrow(err);
         }
         return false;
     }
     async getRecord(key, options = {}) {
-        (0, utils_1.parseArgument)(key, keySchema);
-        const parsed = (0, utils_1.parseArgument)(options, getRecordOptionsSchema, 'KeyValueClientGetRecordOptions');
-        if (parsed.stream && !(0, utils_1.isNode)()) {
+        parseArgument(key, keySchema);
+        const parsed = parseArgument(options, getRecordOptionsSchema, 'KeyValueClientGetRecordOptions');
+        if (parsed.stream && !isNode()) {
             throw new Error('The stream option can only be used in Node.js environment.');
         }
         if ('disableRedirect' in parsed) {
-            log_1.default.deprecated('The disableRedirect option for getRecord() is deprecated. ' +
+            log.deprecated('The disableRedirect option for getRecord() is deprecated. ' +
                 'It has no effect and will be removed in the following major release.');
         }
         const queryParams = { attachment: 'true' };
@@ -306,7 +302,7 @@ class KeyValueStoreClient extends resource_client_1.ResourceClient {
             url: this._url(['records', key]),
             method: 'GET',
             params: this._params(queryParams),
-            timeout: resource_client_1.DEFAULT_TIMEOUT_MILLIS,
+            timeout: DEFAULT_TIMEOUT_MILLIS,
         };
         if (parsed.buffer)
             requestOpts.forceBuffer = true;
@@ -321,7 +317,7 @@ class KeyValueStoreClient extends resource_client_1.ResourceClient {
             };
         }
         catch (err) {
-            (0, utils_1.catchNotFoundOrThrow)(err);
+            catchNotFoundOrThrow(err);
         }
         return undefined;
     }
@@ -373,12 +369,12 @@ class KeyValueStoreClient extends resource_client_1.ResourceClient {
      * ```
      */
     async setRecord(record, options = {}) {
-        (0, utils_1.parseArgument)(record, recordSchema);
-        const parsed = (0, utils_1.parseArgument)(options, recordOptionsSchema, 'KeyValueStoreRecordOptions');
+        parseArgument(record, recordSchema);
+        const parsed = parseArgument(options, recordOptionsSchema, 'KeyValueStoreRecordOptions');
         const { key } = record;
         let { value, contentType } = record;
         const { timeoutSecs, doNotRetryTimeouts } = parsed;
-        const isValueStreamOrBuffer = (0, utils_1.isStream)(value) || (0, utils_1.isBuffer)(value);
+        const isValueStreamOrBuffer = isStream(value) || isBuffer(value);
         // To allow saving Objects to JSON without providing content type
         if (!contentType) {
             if (isValueStreamOrBuffer)
@@ -405,7 +401,7 @@ class KeyValueStoreClient extends resource_client_1.ResourceClient {
             data: value,
             headers: contentType ? { 'content-type': contentType } : undefined,
             doNotRetryTimeouts,
-            timeout: timeoutSecs !== undefined ? timeoutSecs * 1000 : resource_client_1.DEFAULT_TIMEOUT_MILLIS,
+            timeout: timeoutSecs !== undefined ? timeoutSecs * 1000 : DEFAULT_TIMEOUT_MILLIS,
         };
         await this.httpClient.call(uploadOpts);
     }
@@ -421,13 +417,12 @@ class KeyValueStoreClient extends resource_client_1.ResourceClient {
      * ```
      */
     async deleteRecord(key) {
-        (0, utils_1.parseArgument)(key, keySchema);
+        parseArgument(key, keySchema);
         await this.httpClient.call({
             url: this._url(['records', key]),
             method: 'DELETE',
             params: this._params(),
-            timeout: resource_client_1.SMALL_TIMEOUT_MILLIS,
+            timeout: SMALL_TIMEOUT_MILLIS,
         });
     }
 }
-exports.KeyValueStoreClient = KeyValueStoreClient;

package/dist/resource_clients/key_value_store_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 { KeyValueStore } from './key_value_store';
+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 { KeyValueStore } from './key_value_store.js';
 /**
  * Client for managing the collection of Key-value stores in your account.
  *

package/dist/resource_clients/key_value_store_collection.js

@@ -1,18 +1,15 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.KeyValueStoreCollectionClient = 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 Key-value stores in your account.
  *
@@ -33,7 +30,7 @@ const schemaSchema = utils_1.anyObjectSchema.optional();
  *
  * @see https://docs.apify.com/platform/storage/key-value-store
  */
-class KeyValueStoreCollectionClient extends resource_collection_client_1.ResourceCollectionClient {
+export class KeyValueStoreCollectionClient extends ResourceCollectionClient {
     /**
      * @hidden
      */
@@ -64,7 +61,7 @@ class KeyValueStoreCollectionClient extends resource_collection_client_1.Resourc
      * @see https://docs.apify.com/api/v2/key-value-stores-get
      */
     list(options = {}) {
-        const parsed = (0, utils_1.parseArgument)(options, listOptionsSchema, 'KeyValueStoreCollectionClientListOptions');
+        const parsed = parseArgument(options, listOptionsSchema, 'KeyValueStoreCollectionClientListOptions');
         return this._listPaginated(parsed);
     }
     /**
@@ -76,9 +73,8 @@ class KeyValueStoreCollectionClient extends resource_collection_client_1.Resourc
      * @see https://docs.apify.com/api/v2/key-value-stores-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.KeyValueStoreCollectionClient = KeyValueStoreCollectionClient;

package/dist/resource_clients/log.d.ts

@@ -1,8 +1,8 @@
 import type { Readable } from 'node:stream';
 import type { Log } from '@apify/log';
 import { Logger, LogLevel } from '@apify/log';
-import type { ApiClientSubResourceOptions } from '../base/api_client';
-import { ResourceClient } from '../base/resource_client';
+import type { ApiClientSubResourceOptions } from '../base/api_client.js';
+import { ResourceClient } from '../base/resource_client.js';
 /**
  * Client for accessing Actor run or build logs.
  *

package/dist/resource_clients/log.js

@@ -1,11 +1,7 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.StreamedLog = exports.LoggerActorRedirect = exports.LogClient = void 0;
-const tslib_1 = require("tslib");
-const ansi_colors_1 = tslib_1.__importDefault(require("ansi-colors"));
-const log_1 = tslib_1.__importStar(require("@apify/log"));
-const resource_client_1 = require("../base/resource_client");
-const utils_1 = require("../utils");
+import c from 'ansi-colors';
+import log, { Logger, LogLevel } from '@apify/log';
+import { ResourceClient } from '../base/resource_client.js';
+import { cast, catchNotFoundOrThrow } from '../utils.js';
 /**
  * Client for accessing Actor run or build logs.
  *
@@ -28,7 +24,7 @@ const utils_1 = require("../utils");
  *
  * @see https://docs.apify.com/platform/actors/running/runs-and-builds#logging
  */
-class LogClient extends resource_client_1.ResourceClient {
+export class LogClient extends ResourceClient {
     /**
      * @hidden
      */
@@ -54,10 +50,10 @@ class LogClient extends resource_client_1.ResourceClient {
         };
         try {
             const response = await this.httpClient.call(requestOpts);
-            return (0, utils_1.cast)(response.data);
+            return cast(response.data);
         }
         catch (err) {
-            (0, utils_1.catchNotFoundOrThrow)(err);
+            catchNotFoundOrThrow(err);
         }
         return undefined;
     }
@@ -82,22 +78,21 @@ class LogClient extends resource_client_1.ResourceClient {
         };
         try {
             const response = await this.httpClient.call(requestOpts);
-            return (0, utils_1.cast)(response.data);
+            return cast(response.data);
         }
         catch (err) {
-            (0, utils_1.catchNotFoundOrThrow)(err);
+            catchNotFoundOrThrow(err);
         }
         return undefined;
     }
 }
-exports.LogClient = LogClient;
 /**
  * Logger for redirected actor logs.
  * @since Added in 2.20.0
  */
-class LoggerActorRedirect extends log_1.Logger {
+export class LoggerActorRedirect extends Logger {
     constructor(options = {}) {
-        super({ skipTime: true, level: log_1.LogLevel.DEBUG, ...options });
+        super({ skipTime: true, level: LogLevel.DEBUG, ...options });
     }
     _log(level, message, data, exception, opts = {}) {
         if (level > this.options.level) {
@@ -112,19 +107,18 @@ class LoggerActorRedirect extends log_1.Logger {
         if (!this.options.skipTime) {
             maybeDate = `${new Date().toISOString().replace('Z', '').replace('T', ' ')} `;
         }
-        const line = `${ansi_colors_1.default.gray(maybeDate)}${ansi_colors_1.default.cyan(prefix)}${message || ''}`;
+        const line = `${c.gray(maybeDate)}${c.cyan(prefix)}${message || ''}`;
         // All redirected logs are logged at info level to avid any console specific formating for non-info levels,
         // which have already been applied once to the original log. (For example error stack traces etc.)
-        this._outputWithConsole(log_1.LogLevel.INFO, line);
+        this._outputWithConsole(LogLevel.INFO, line);
         return line;
     }
 }
-exports.LoggerActorRedirect = LoggerActorRedirect;
 /**
  * Helper class for redirecting streamed Actor logs to another log.
  * @since Added in 2.20.0
  */
-class StreamedLog {
+export class StreamedLog {
     destinationLog;
     streamBuffer = [];
     splitMarker = /(?:\n|^)(\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}\.\d{3}Z)/g;
@@ -185,7 +179,7 @@ class StreamedLog {
             }
         }
         catch (err) {
-            log_1.default.warning(`Log redirection stopped due to error`, err);
+            log.warning(`Log redirection stopped due to error`, err);
         }
     }
     async logStreamChunks(logStream) {
@@ -235,4 +229,3 @@ class StreamedLog {
         });
     }
 }
-exports.StreamedLog = StreamedLog;

package/dist/resource_clients/request_queue.d.ts

@@ -1,8 +1,8 @@
 import type { STORAGE_GENERAL_ACCESS } from '@apify/consts';
-import type { ApiClientSubResourceOptions } from '../base/api_client';
-import { ResourceClient } from '../base/resource_client';
-import type { RequestQueue, RequestQueueClientAddRequestResult, RequestQueueClientBatchDeleteRequestsResult, RequestQueueClientBatchRequestsOperationResult, RequestQueueClientListAndLockHeadResult, RequestQueueClientListHeadResult, RequestQueueClientListRequestsResult, RequestQueueClientProlongRequestLockResult, RequestQueueClientRequestSchema, RequestQueueClientRequestToAdd, RequestQueueClientRequestToUpdate, RequestQueueClientUnlockRequestsResult } from '../models';
-export type { AllowedHttpMethods, RequestQueue, RequestQueueClientAddRequestResult, RequestQueueClientBatchDeleteRequestsResult, RequestQueueClientBatchRequestsOperationResult, RequestQueueClientListAndLockHeadResult, RequestQueueClientListHeadResult, RequestQueueClientListItem, RequestQueueClientListRequestsResult, RequestQueueClientLockedListItem, RequestQueueClientProlongRequestLockResult, RequestQueueClientRequestSchema, RequestQueueClientRequestToAdd, RequestQueueClientRequestToUpdate, RequestQueueClientUnlockRequestsResult, RequestQueueStats, } from '../models';
+import type { ApiClientSubResourceOptions } from '../base/api_client.js';
+import { ResourceClient } from '../base/resource_client.js';
+import type { RequestQueue, RequestQueueClientAddRequestResult, RequestQueueClientBatchDeleteRequestsResult, RequestQueueClientBatchRequestsOperationResult, RequestQueueClientListAndLockHeadResult, RequestQueueClientListHeadResult, RequestQueueClientListRequestsResult, RequestQueueClientProlongRequestLockResult, RequestQueueClientRequestSchema, RequestQueueClientRequestToAdd, RequestQueueClientRequestToUpdate, RequestQueueClientUnlockRequestsResult } from '../models.js';
+export type { AllowedHttpMethods, RequestQueue, RequestQueueClientAddRequestResult, RequestQueueClientBatchDeleteRequestsResult, RequestQueueClientBatchRequestsOperationResult, RequestQueueClientListAndLockHeadResult, RequestQueueClientListHeadResult, RequestQueueClientListItem, RequestQueueClientListRequestsResult, RequestQueueClientLockedListItem, RequestQueueClientProlongRequestLockResult, RequestQueueClientRequestSchema, RequestQueueClientRequestToAdd, RequestQueueClientRequestToUpdate, RequestQueueClientUnlockRequestsResult, RequestQueueStats, } from '../models.js';
 /**
  * Client for managing a specific Request queue.
  *