apify-client 3.0.0-beta.4 → 3.0.0-beta.40

package/dist/resource_clients/key_value_store.js

@@ -1,14 +1,18 @@
 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';
+import { ResourceClient } from '../base/resource_client.js';
+import * as schemas from '../schemas.js';
+import { timeoutOptionsSchema, timeoutOptionsShape } from '../timeouts.js';
+import { runtime } from '#runtime';
+import { anyObjectSchema, applyQueryParamsToUrl, catchNotFoundOrThrow, isBuffer, isStream, parseArgument, parseResponse, } 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(),
+    ...timeoutOptionsShape,
 });
 const nonEmptyKeySchema = z.string().min(1);
 // `signature` is left out - this method produces one. The options type omits it to match.
@@ -18,6 +22,7 @@ const createKeysPublicUrlOptionsSchema = z.strictObject({
     collection: z.string().optional(),
     prefix: z.string().optional(),
     expiresInSecs: z.number().optional(),
+    ...timeoutOptionsShape,
 });
 const keySchema = z.string();
 const getRecordOptionsSchema = z.strictObject({
@@ -25,6 +30,7 @@ const getRecordOptionsSchema = z.strictObject({
     stream: z.boolean().optional(),
     disableRedirect: z.boolean().optional(),
     signature: z.string().optional(),
+    ...timeoutOptionsShape,
 });
 const recordSchema = z.strictObject({
     key: z.string(),
@@ -36,11 +42,11 @@ const recordSchema = z.strictObject({
         typeof value !== 'symbol' &&
         typeof value !== 'bigint' &&
         typeof value !== 'function' &&
-        (typeof value !== 'number' || Number.isFinite(value)), 'Expected a defined, JSON-serializable value'),
+        (typeof value !== 'number' || Number.isFinite(value)), 'Expected a JSON-serializable value, binary data, or a stream'),
     contentType: z.string().min(1).optional(),
 });
 const recordOptionsSchema = z.strictObject({
-    timeoutSecs: z.number().optional(),
+    ...timeoutOptionsShape,
     doNotRetryTimeouts: z.boolean().optional(),
 });
 /**
@@ -84,11 +90,14 @@ export class KeyValueStoreClient extends ResourceClient {
     /**
      * Gets the key-value store object from the Apify API.
      *
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The KeyValueStore object, or `undefined` if it does not exist
      * @see https://docs.apify.com/api/v2/key-value-store-get
      */
-    async get() {
-        return this._get({}, SMALL_TIMEOUT_MILLIS);
+    async get(options = {}) {
+        const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.getResource(schemas.KeyValueStore(), {}, timeoutSecs, signal);
     }
     /**
      * Updates the key-value store with specified fields.
@@ -97,20 +106,26 @@ export class KeyValueStoreClient extends ResourceClient {
      * @param newFields.name - New name for the store
      * @param newFields.title - New title for the store
      * @param newFields.generalAccess - General resource access level ('FOLLOW_USER_SETTING', 'ANYONE_WITH_ID_CAN_READ' or 'RESTRICTED')
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'long'`.
      * @returns The updated KeyValueStore object
      * @see https://docs.apify.com/api/v2/key-value-store-put
      */
-    async update(newFields) {
+    async update(newFields, options = {}) {
         parseArgument(newFields, anyObjectSchema);
-        return this._update(newFields, DEFAULT_TIMEOUT_MILLIS);
+        const { timeoutSecs = 'long', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.updateResource(schemas.KeyValueStore(), newFields, timeoutSecs, signal);
     }
     /**
      * Deletes the key-value store.
      *
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @see https://docs.apify.com/api/v2/key-value-store-delete
      */
-    async delete() {
-        return this._delete(SMALL_TIMEOUT_MILLIS);
+    async delete(options = {}) {
+        const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.deleteResource(timeoutSecs, signal);
     }
     /**
      * Lists all keys in the key-value store.
@@ -123,6 +138,7 @@ export class KeyValueStoreClient extends ResourceClient {
      * @param options.exclusiveStartKey - Key to start listing from (for pagination). The listing starts with the next key after this one.
      * @param options.collection - Filter keys by collection name.
      * @param options.prefix - Filter keys that start with this prefix.
+     * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
      * @returns Object containing `items` array of key metadata, pagination info (`count`, `limit`, `isTruncated`, `nextExclusiveStartKey`)
      * @see https://docs.apify.com/api/v2/key-value-store-keys-get
      *
@@ -148,15 +164,16 @@ export class KeyValueStoreClient extends ResourceClient {
      * ```
      */
     listKeys(options = {}) {
-        const parsed = parseArgument(options, listKeysOptionsSchema, 'KeyValueClientListKeysOptions');
+        const { timeoutSecs = 'medium', signal, ...parsed } = parseArgument(options, listKeysOptionsSchema, 'KeyValueClientListKeysOptions');
         const getPaginatedList = async (kvsListOptions = {}) => {
             const response = await this.httpClient.call({
-                url: this._url('keys'),
+                url: this.buildUrl('keys'),
                 method: 'GET',
-                params: this._params(kvsListOptions),
-                timeout: MEDIUM_TIMEOUT_MILLIS,
+                params: this.buildParams(kvsListOptions),
+                timeoutSecs,
+                signal,
             });
-            return cast(parseDateFields(pluckData(response.data)));
+            return parseResponse(response, schemas.ListOfKeys());
         };
         const paginatedListPromise = getPaginatedList(parsed);
         async function* asyncGenerator() {
@@ -193,6 +210,8 @@ export class KeyValueStoreClient extends ResourceClient {
      * requiring an API token.
      *
      * @param key - The record key
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request that fetches the store. Default is `'long'`.
      * @returns A public URL string for accessing the record
      *
      * @example
@@ -203,10 +222,11 @@ export class KeyValueStoreClient extends ResourceClient {
      * ```
      * @since Added in 2.14.0
      */
-    async getRecordPublicUrl(key) {
+    async getRecordPublicUrl(key, options = {}) {
         parseArgument(key, nonEmptyKeySchema);
-        const store = await this.get();
-        const recordPublicUrl = new URL(this._publicUrl(['records', key]));
+        const { timeoutSecs = 'long', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        const store = await this.get({ timeoutSecs, signal });
+        const recordPublicUrl = new URL(this.buildPublicUrl(['records', key]));
         if (store?.urlSigningSecretKey) {
             const signature = await createHmacSignatureAsync(store.urlSigningSecretKey, key);
             recordPublicUrl.searchParams.append('signature', signature);
@@ -223,6 +243,7 @@ export class KeyValueStoreClient extends ResourceClient {
      * @param options.expiresInSecs - Number of seconds until the signed URL expires. If omitted, the URL never expires.
      * @param options.limit - Maximum number of keys to return.
      * @param options.prefix - Filter keys by prefix.
+     * @param options.timeoutSecs - Timeout for the API request that fetches the store. Default is `'long'`.
      * @returns A public URL string for accessing the keys list
      *
      * @example
@@ -237,10 +258,9 @@ export class KeyValueStoreClient extends ResourceClient {
      * @since Added in 2.13.0
      */
     async createKeysPublicUrl(options = {}) {
-        const parsed = parseArgument(options, createKeysPublicUrlOptionsSchema, 'KeyValueClientCreateKeysUrlOptions');
-        const store = await this.get();
-        const { expiresInSecs, ...queryOptions } = parsed;
-        let createdPublicKeysUrl = new URL(this._publicUrl('keys'));
+        const { timeoutSecs = 'long', signal, expiresInSecs, ...queryOptions } = parseArgument(options, createKeysPublicUrlOptionsSchema, 'KeyValueClientCreateKeysUrlOptions');
+        const store = await this.get({ timeoutSecs, signal });
+        let createdPublicKeysUrl = new URL(this.buildPublicUrl('keys'));
         if (store?.urlSigningSecretKey) {
             const signature = await createStorageContentSignatureAsync({
                 resourceId: store.id,
@@ -258,6 +278,8 @@ export class KeyValueStoreClient extends ResourceClient {
      * This is more efficient than {@link getRecord} when you only need to check for existence.
      *
      * @param key - The record key to check
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'long'`.
      * @returns `true` if the record exists, `false` if it does not
      * @see https://docs.apify.com/api/v2/key-value-store-record-get
      *
@@ -270,11 +292,14 @@ export class KeyValueStoreClient extends ResourceClient {
      * ```
      * @since Added in 2.9.0
      */
-    async recordExists(key) {
+    async recordExists(key, options = {}) {
+        const { timeoutSecs = 'long', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
         const requestOpts = {
-            url: this._url(['records', key]),
+            url: this.buildUrl(['records', key]),
             method: 'HEAD',
-            params: this._params(),
+            params: this.buildParams(),
+            timeoutSecs,
+            signal,
         };
         try {
             await this.httpClient.call(requestOpts);
@@ -288,7 +313,7 @@ export class KeyValueStoreClient extends ResourceClient {
     async getRecord(key, options = {}) {
         parseArgument(key, keySchema);
         const parsed = parseArgument(options, getRecordOptionsSchema, 'KeyValueClientGetRecordOptions');
-        if (parsed.stream && !isNode()) {
+        if (parsed.stream && !runtime.isNode) {
             throw new Error('The stream option can only be used in Node.js environment.');
         }
         if ('disableRedirect' in parsed) {
@@ -299,13 +324,14 @@ export class KeyValueStoreClient extends ResourceClient {
         if (parsed.signature)
             queryParams.signature = parsed.signature;
         const requestOpts = {
-            url: this._url(['records', key]),
+            url: this.buildUrl(['records', key]),
             method: 'GET',
-            params: this._params(queryParams),
-            timeout: DEFAULT_TIMEOUT_MILLIS,
+            params: this.buildParams(queryParams),
+            timeoutSecs: parsed.timeoutSecs ?? 'long',
+            signal: parsed.signal,
         };
         if (parsed.buffer)
-            requestOpts.forceBuffer = true;
+            requestOpts.responseType = 'buffer';
         if (parsed.stream)
             requestOpts.responseType = 'stream';
         try {
@@ -328,19 +354,27 @@ export class KeyValueStoreClient extends ResourceClient {
      * The content type is automatically determined based on the value type, but can be
      * overridden using the `contentType` property.
      *
+     * A string is sent as it is, even under `application/json`, so a string stored under a JSON content type has
+     * to be valid JSON already, or {@link getRecord} fails to parse it back.
+     *
      * **Note about streams:** If the value is a stream object (has `.pipe` and `.on` methods),
      * the upload cannot be retried on failure or follow redirects. For reliable uploads,
      * buffer the entire stream into memory first.
      *
      * @param record - The record to store
      * @param record.key - Record key (unique identifier)
-     * @param record.value - Record value (object, string, Buffer, or Stream)
+     * @param record.value - Record value (a JSON-serializable value, Buffer, ArrayBuffer, typed array, or Readable)
      * @param record.contentType - Optional MIME type. Auto-detected if not provided:
      *                             - Objects: `'application/json; charset=utf-8'`
      *                             - Strings: `'text/plain; charset=utf-8'`
-     *                             - Buffers/Streams: `'application/octet-stream'`
+     *                             - Binary values and streams: `'application/octet-stream'`
+     *
+     *                             Worth setting for media and archives: the client skips compressing a body
+     *                             whose content type already carries its own compression. The
+     *                             `'application/octet-stream'` fallback is treated as compressible, because
+     *                             it could hold any binary data.
      * @param options - Storage options
-     * @param options.timeoutSecs - Timeout for the upload in seconds. Default varies by value size.
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'long'`.
      * @param options.doNotRetryTimeouts - If `true`, don't retry on timeout errors. Default is `false`.
      * @see https://docs.apify.com/api/v2/key-value-store-record-put
      *
@@ -373,7 +407,7 @@ export class KeyValueStoreClient extends ResourceClient {
         const parsed = parseArgument(options, recordOptionsSchema, 'KeyValueStoreRecordOptions');
         const { key } = record;
         let { value, contentType } = record;
-        const { timeoutSecs, doNotRetryTimeouts } = parsed;
+        const { timeoutSecs = 'long', signal, doNotRetryTimeouts } = parsed;
         const isValueStreamOrBuffer = isStream(value) || isBuffer(value);
         // To allow saving Objects to JSON without providing content type
         if (!contentType) {
@@ -395,13 +429,14 @@ export class KeyValueStoreClient extends ResourceClient {
             }
         }
         const uploadOpts = {
-            url: this._url(['records', key]),
+            url: this.buildUrl(['records', key]),
             method: 'PUT',
-            params: this._params(),
+            params: this.buildParams(),
             data: value,
             headers: contentType ? { 'content-type': contentType } : undefined,
             doNotRetryTimeouts,
-            timeout: timeoutSecs !== undefined ? timeoutSecs * 1000 : DEFAULT_TIMEOUT_MILLIS,
+            timeoutSecs,
+            signal,
         };
         await this.httpClient.call(uploadOpts);
     }
@@ -409,6 +444,8 @@ export class KeyValueStoreClient extends ResourceClient {
      * Deletes a record from the key-value store.
      *
      * @param key - The record key to delete
+     * @param options - Request options
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @see https://docs.apify.com/api/v2/key-value-store-record-delete
      *
      * @example
@@ -416,13 +453,15 @@ export class KeyValueStoreClient extends ResourceClient {
      * await client.keyValueStore('my-store').deleteRecord('temp-data');
      * ```
      */
-    async deleteRecord(key) {
+    async deleteRecord(key, options = {}) {
         parseArgument(key, keySchema);
+        const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
         await this.httpClient.call({
-            url: this._url(['records', key]),
+            url: this.buildUrl(['records', key]),
             method: 'DELETE',
-            params: this._params(),
-            timeout: SMALL_TIMEOUT_MILLIS,
+            params: this.buildParams(),
+            timeoutSecs,
+            signal,
         });
     }
 }

package/dist/resource_clients/key_value_store_collection.d.ts

@@ -1,6 +1,7 @@
 import { STORAGE_OWNERSHIP_FILTER } from '@apify/consts';
 import type { ApiClientSubResourceOptions } from '../base/api_client.js';
 import { ResourceCollectionClient } from '../base/resource_collection_client.js';
+import type { TimeoutOptions } from '../timeouts.js';
 import type { PaginatedList, PaginationOptions } from '../utils.js';
 import type { KeyValueStore } from './key_value_store.js';
 /**
@@ -45,6 +46,7 @@ export declare class KeyValueStoreCollectionClient extends ResourceCollectionCli
      * ```
      *
      * @param options - Pagination options.
+     * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
      * @returns A paginated iterator of Key-value stores.
      * @see https://docs.apify.com/api/v2/key-value-stores-get
      */
@@ -54,12 +56,14 @@ export declare class KeyValueStoreCollectionClient extends ResourceCollectionCli
      *
      * @param name - Name of the key-value store. If not provided, a default store is used.
      * @param options - Additional options like schema.
+     * @param options.schema - Schema of the key-value store.
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The key-value store object.
      * @see https://docs.apify.com/api/v2/key-value-stores-post
      */
     getOrCreate(name?: string, options?: KeyValueStoreCollectionClientGetOrCreateOptions): Promise<KeyValueStore>;
 }
-export interface KeyValueStoreCollectionClientListOptions extends PaginationOptions {
+export interface KeyValueStoreCollectionClientListOptions extends PaginationOptions, TimeoutOptions {
     unnamed?: boolean;
     desc?: boolean;
     /**
@@ -71,7 +75,7 @@ export interface KeyValueStoreCollectionClientListOptions extends PaginationOpti
 /**
  * @since Added in 2.3.0
  */
-export interface KeyValueStoreCollectionClientGetOrCreateOptions {
+export interface KeyValueStoreCollectionClientGetOrCreateOptions extends TimeoutOptions {
     schema?: Record<string, unknown>;
 }
 export type KeyValueStoreCollectionListResult = PaginatedList<KeyValueStore> & {

package/dist/resource_clients/key_value_store_collection.js

@@ -1,12 +1,15 @@
 import { z } from 'zod';
 import { STORAGE_OWNERSHIP_FILTER } from '@apify/consts';
 import { ResourceCollectionClient } from '../base/resource_collection_client.js';
+import * as schemas from '../schemas.js';
+import { optionalSignalSchema, optionalTimeoutSchema, timeoutOptionsShape } from '../timeouts.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(),
+    ...timeoutOptionsShape,
 });
 const nameSchema = z.string().optional();
 const schemaSchema = anyObjectSchema.optional();
@@ -57,24 +60,33 @@ export class KeyValueStoreCollectionClient extends ResourceCollectionClient {
      * ```
      *
      * @param options - Pagination options.
+     * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
      * @returns A paginated iterator of Key-value stores.
      * @see https://docs.apify.com/api/v2/key-value-stores-get
      */
     list(options = {}) {
         const parsed = parseArgument(options, listOptionsSchema, 'KeyValueStoreCollectionClientListOptions');
-        return this._listPaginated(parsed);
+        return this.listResourcesPaginated(schemas.ListOfKeyValueStores(), parsed, 'medium');
     }
     /**
      * Gets or creates a key-value store with the specified name.
      *
      * @param name - Name of the key-value store. If not provided, a default store is used.
      * @param options - Additional options like schema.
+     * @param options.schema - Schema of the key-value store.
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The key-value store object.
      * @see https://docs.apify.com/api/v2/key-value-stores-post
      */
     async getOrCreate(name, options) {
         parseArgument(name, nameSchema);
         parseArgument(options?.schema, schemaSchema); // TODO: Add schema validation
-        return this._getOrCreate(name, options);
+        parseArgument(options?.timeoutSecs, optionalTimeoutSchema);
+        parseArgument(options?.signal, optionalSignalSchema);
+        // `timeoutSecs` and `signal` are not part of the resource, so the body carries only the rest, and stays
+        // absent when there is nothing else to send.
+        const { timeoutSecs = 'short', signal, ...resource } = options ?? {};
+        const hasResource = Object.keys(resource).length > 0;
+        return this.getOrCreateResource(schemas.KeyValueStore(), name, hasResource ? resource : undefined, timeoutSecs, signal);
     }
 }

package/dist/resource_clients/log.d.ts

@@ -3,6 +3,7 @@ import type { Log } from '@apify/log';
 import { Logger, LogLevel } from '@apify/log';
 import type { ApiClientSubResourceOptions } from '../base/api_client.js';
 import { ResourceClient } from '../base/resource_client.js';
+import type { TimeoutOptions } from '../timeouts.js';
 /**
  * Client for accessing Actor run or build logs.
  *
@@ -35,7 +36,9 @@ export declare class LogClient extends ResourceClient {
      *
      * @param options - Log retrieval options.
      * @param options.raw - If `true`, returns raw log content without any processing. Default is `false`.
-     * @returns The log content as a string, or `undefined` if it does not exist.
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'long'`.
+     * @returns The log content as a string, or `undefined` if it does not exist. A chained client such as
+     * `run.log()` throws an `ApifyApiError` on a 404, since the run itself may be what is missing.
      * @see https://docs.apify.com/api/v2/log-get
      */
     get(options?: LogOptions): Promise<string | undefined>;
@@ -44,7 +47,9 @@ export declare class LogClient extends ResourceClient {
      *
      * @param options - Log retrieval options.
      * @param options.raw - If `true`, returns raw log content without any processing. Default is `false`.
-     * @returns The log content as a Readable stream, or `undefined` if it does not exist.
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'long'`.
+     * @returns The log content as a Readable stream, or `undefined` if it does not exist. A chained client such as
+     * `run.log()` throws an `ApifyApiError` on a 404, since the run itself may be what is missing.
      * @see https://docs.apify.com/api/v2/log-get
      */
     stream(options?: LogOptions): Promise<Readable | undefined>;
@@ -52,7 +57,7 @@ export declare class LogClient extends ResourceClient {
 /**
  * @since Added in 2.20.0
  */
-export interface LogOptions {
+export interface LogOptions extends TimeoutOptions {
     /** @default false */
     raw?: boolean;
 }
@@ -69,13 +74,7 @@ export declare class LoggerActorRedirect extends Logger {
  * @since Added in 2.20.0
  */
 export declare class StreamedLog {
-    private destinationLog;
-    private streamBuffer;
-    private splitMarker;
-    private relevancyTimeLimit;
-    private logClient;
-    private streamingTask;
-    private stopLogging;
+    #private;
     constructor(options: StreamedLogOptions);
     /**
      * Start log redirection.
@@ -85,15 +84,6 @@ export declare class StreamedLog {
      * Stop log redirection.
      */
     stop(): Promise<void>;
-    /**
-     * Get log stream from response and redirect it to another log.
-     */
-    private streamLog;
-    private logStreamChunks;
-    /**
-     * Parse the buffer and log complete messages.
-     */
-    private logBufferContent;
 }
 /**
  * @since Added in 2.20.0
@@ -105,4 +95,6 @@ export interface StreamedLogOptions {
     toLog: Log;
     /** Whether to redirect all logs from Actor run start (even logs from the past). */
     fromStart?: boolean;
+    /** Ends the log stream once it aborts. */
+    signal?: AbortSignal;
 }