apify-client 3.0.0-beta.9 → 3.0.0-rc.0

package/dist/resource_clients/dataset_collection.js

@@ -2,12 +2,14 @@ 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();
@@ -58,24 +60,33 @@ export class DatasetCollectionClient extends ResourceCollectionClient {
      * ```
      *
      * @param options - Pagination options.
+     * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
      * @returns A paginated iterator of Datasets.
      * @see https://docs.apify.com/api/v2/datasets-get
      */
     list(options = {}) {
         const parsed = parseArgument(options, listOptionsSchema, 'DatasetCollectionClientListOptions');
-        return this._listPaginated(schemas.ListOfDatasets(), parsed);
+        return this.listResourcesPaginated(schemas.ListOfDatasets(), parsed, 'medium');
     }
     /**
      * Gets or creates a dataset with the specified name.
      *
      * @param name - Name of the dataset. If not provided, a default dataset is used.
      * @param options - Additional options like schema.
+     * @param options.schema - Schema of the dataset.
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'short'`.
      * @returns The dataset object.
      * @see https://docs.apify.com/api/v2/datasets-post
      */
     async getOrCreate(name, options) {
         parseArgument(name, nameSchema);
         parseArgument(options?.schema, schemaSchema); // TODO: Add schema validation
-        return this._getOrCreate(schemas.Dataset(), 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.DatasetResource(), name, hasResource ? resource : undefined, timeoutSecs, signal);
     }
 }

package/dist/resource_clients/key_value_store.d.ts

@@ -1,10 +1,11 @@
 import type { Readable } from 'node:stream';
-import type { JsonValue } from 'type-fest';
+import type { JsonValue, TypedArray } from 'type-fest';
 import type { STORAGE_GENERAL_ACCESS } from '@apify/consts';
 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';
+import type { KeyValueStoreResource, KeyValueStoreKey, ListOfKeys } from '../models.js';
+import type { TimeoutOptions } from '../timeouts.js';
+export type { KeyValueStoreResource, KeyValueStoreKey, KeyValueStoreStats, ListOfKeys } from '../models.js';
 /**
  * Client for managing a specific key-value store.
  *
@@ -41,10 +42,12 @@ export declare 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
      */
-    get(): Promise<KeyValueStore | undefined>;
+    get(options?: TimeoutOptions): Promise<KeyValueStoreResource | undefined>;
     /**
      * Updates the key-value store with specified fields.
      *
@@ -52,16 +55,20 @@ export declare 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
      */
-    update(newFields: KeyValueClientUpdateOptions): Promise<KeyValueStore>;
+    update(newFields: KeyValueClientUpdateOptions, options?: TimeoutOptions): Promise<KeyValueStoreResource>;
     /**
      * 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
      */
-    delete(): Promise<void>;
+    delete(options?: TimeoutOptions): Promise<void>;
     /**
      * Lists all keys in the key-value store.
      *
@@ -73,6 +80,7 @@ export declare 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
      *
@@ -97,7 +105,7 @@ export declare class KeyValueStoreClient extends ResourceClient {
      * } while (result.isTruncated);
      * ```
      */
-    listKeys(options?: KeyValueClientListKeysOptions): Promise<KeyValueClientListKeysResult> & AsyncIterable<KeyValueListItem>;
+    listKeys(options?: KeyValueClientListKeysOptions): Promise<ListOfKeys> & AsyncIterable<KeyValueStoreKey>;
     /**
      * Generates a public URL for accessing a specific record in the key-value store.
      *
@@ -106,6 +114,8 @@ export declare 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
@@ -116,7 +126,7 @@ export declare class KeyValueStoreClient extends ResourceClient {
      * ```
      * @since Added in 2.14.0
      */
-    getRecordPublicUrl(key: string): Promise<string>;
+    getRecordPublicUrl(key: string, options?: TimeoutOptions): Promise<string>;
     /**
      * Generates a public URL for accessing the list of keys in the key-value store.
      *
@@ -127,6 +137,7 @@ export declare 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
@@ -147,6 +158,8 @@ export declare 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
      *
@@ -159,15 +172,27 @@ export declare class KeyValueStoreClient extends ResourceClient {
      * ```
      * @since Added in 2.9.0
      */
-    recordExists(key: string): Promise<boolean>;
+    recordExists(key: string, options?: TimeoutOptions): Promise<boolean>;
     /**
+     * By default, the value is parsed by the record's content type: `application/json` is parsed into a value,
+     * `text/*` and `application/*xml` are decoded to a string, and anything else is returned as a Buffer (Node.js)
+     * or ArrayBuffer (browser). A record whose body does not parse as its content type claims, such as a non-JSON
+     * string stored under `application/json`, makes the call throw an {@link InvalidResponseBodyError}, which
+     * carries the raw body in `error.response`.
+     *
      * You can use the `buffer` option to get the value in a Buffer (Node.js)
-     * or ArrayBuffer (browser) format. In Node.js (not in browser) you can also
+     * or ArrayBuffer (browser) format, which skips the parsing. In Node.js (not in browser) you can also
      * use the `stream` option to get a Readable stream.
      *
      * When the record does not exist, the function resolves to `undefined`. It does
-     * NOT resolve to a `KeyValueStore` record with an `undefined` value.
+     * NOT resolve to a `KeyValueStoreRecord` with an `undefined` value.
      *
+     * @param key - The record key
+     * @param options - Retrieval options
+     * @param options.buffer - If `true`, the value is returned as a Buffer (Node.js) or ArrayBuffer (browser).
+     * @param options.stream - If `true`, the value is returned as a Readable stream. Node.js only.
+     * @param options.signature - Signature of a public URL, for reading a record without a token.
+     * @param options.timeoutSecs - Timeout for the API request. Default is `'long'`.
      * @see https://docs.apify.com/api/v2/key-value-store-record-get
      */
     getRecord(key: string): Promise<KeyValueStoreRecord<JsonValue> | undefined>;
@@ -179,19 +204,27 @@ export declare 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
      *
@@ -219,11 +252,13 @@ export declare class KeyValueStoreClient extends ResourceClient {
      * });
      * ```
      */
-    setRecord(record: KeyValueStoreRecord<JsonValue>, options?: KeyValueStoreRecordOptions): Promise<void>;
+    setRecord(record: KeyValueStoreRecord<KeyValueStoreRecordValue>, options?: KeyValueStoreRecordOptions): Promise<void>;
     /**
      * 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
@@ -231,7 +266,7 @@ export declare class KeyValueStoreClient extends ResourceClient {
      * await client.keyValueStore('my-store').deleteRecord('temp-data');
      * ```
      */
-    deleteRecord(key: string): Promise<void>;
+    deleteRecord(key: string, options?: TimeoutOptions): Promise<void>;
 }
 /**
  * Options for updating a Key-Value Store.
@@ -250,7 +285,7 @@ export interface KeyValueClientUpdateOptions {
 /**
  * Options for listing keys in a Key-Value Store.
  */
-export interface KeyValueClientListKeysOptions {
+export interface KeyValueClientListKeysOptions extends TimeoutOptions {
     limit?: number;
     exclusiveStartKey?: string;
     collection?: string;
@@ -276,7 +311,7 @@ export interface KeyValueClientCreateKeysUrlOptions extends Omit<KeyValueClientL
 /**
  * Options for retrieving a record from a Key-Value Store.
  */
-export interface KeyValueClientGetRecordOptions {
+export interface KeyValueClientGetRecordOptions extends TimeoutOptions {
     buffer?: boolean;
     stream?: boolean;
     /**
@@ -284,6 +319,14 @@ export interface KeyValueClientGetRecordOptions {
      */
     signature?: string;
 }
+/**
+ * A value that `setRecord` accepts.
+ *
+ * Anything JSON-serializable, or binary content the client uploads as bytes instead of JSON-encoding
+ * it: a `Buffer`, an `ArrayBuffer`, a typed array, or a readable stream. `Buffer` is a `Uint8Array`, so
+ * `TypedArray` covers it.
+ */
+export type KeyValueStoreRecordValue = JsonValue | ArrayBuffer | TypedArray | Readable;
 /**
  * Represents a record (key-value pair) in a Key-Value Store.
  *
@@ -298,8 +341,7 @@ export interface KeyValueStoreRecord<T> {
  * Options for storing a record in a Key-Value Store.
  * @since Added in 2.12.4
  */
-export interface KeyValueStoreRecordOptions {
-    timeoutSecs?: number;
+export interface KeyValueStoreRecordOptions extends TimeoutOptions {
     doNotRetryTimeouts?: boolean;
 }
 /**

package/dist/resource_clients/key_value_store.js

@@ -1,15 +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 { ResourceClient } from '../base/resource_client.js';
 import * as schemas from '../schemas.js';
-import { anyObjectSchema, applyQueryParamsToUrl, catchNotFoundOrThrow, isBuffer, isNode, isStream, parseArgument, parseResponse, } from '../utils.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.
@@ -19,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({
@@ -26,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(),
@@ -37,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(),
 });
 /**
@@ -85,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(schemas.KeyValueStore(), {}, SMALL_TIMEOUT_MILLIS);
+    async get(options = {}) {
+        const { timeoutSecs = 'short', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.getResource(schemas.KeyValueStoreResource(), {}, timeoutSecs, signal);
     }
     /**
      * Updates the key-value store with specified fields.
@@ -98,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(schemas.KeyValueStore(), newFields, DEFAULT_TIMEOUT_MILLIS);
+        const { timeoutSecs = 'long', signal } = parseArgument(options, timeoutOptionsSchema, 'TimeoutOptions');
+        return this.updateResource(schemas.KeyValueStoreResource(), 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.
@@ -124,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
      *
@@ -149,13 +164,14 @@ 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 parseResponse(response, schemas.ListOfKeys());
         };
@@ -194,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
@@ -204,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);
@@ -224,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
@@ -238,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,
@@ -259,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
      *
@@ -271,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);
@@ -289,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) {
@@ -300,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 {
@@ -329,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
      *
@@ -374,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) {
@@ -396,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);
     }
@@ -410,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
@@ -417,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,8 +1,9 @@
 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';
+import type { KeyValueStoreResource } from './key_value_store.js';
 /**
  * Client for managing the collection of Key-value stores in your account.
  *
@@ -45,21 +46,24 @@ 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
      */
-    list(options?: KeyValueStoreCollectionClientListOptions): Promise<KeyValueStoreCollectionListResult> & AsyncIterable<KeyValueStore>;
+    list(options?: KeyValueStoreCollectionClientListOptions): Promise<KeyValueStoreCollectionListResult> & AsyncIterable<KeyValueStoreResource>;
     /**
      * 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
      */
-    getOrCreate(name?: string, options?: KeyValueStoreCollectionClientGetOrCreateOptions): Promise<KeyValueStore>;
+    getOrCreate(name?: string, options?: KeyValueStoreCollectionClientGetOrCreateOptions): Promise<KeyValueStoreResource>;
 }
-export interface KeyValueStoreCollectionClientListOptions extends PaginationOptions {
+export interface KeyValueStoreCollectionClientListOptions extends PaginationOptions, TimeoutOptions {
     unnamed?: boolean;
     desc?: boolean;
     /**
@@ -71,9 +75,9 @@ 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> & {
+export type KeyValueStoreCollectionListResult = PaginatedList<KeyValueStoreResource> & {
     unnamed: boolean;
 };