apify-client 2.20.1-beta.6 → 2.20.1-beta.8

package/dist/resource_clients/dataset_collection.d.ts

@@ -2,19 +2,39 @@ 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';
+/**
+ * Client for managing the collection of datasets in your account.
+ *
+ * Datasets store structured data results from Actor runs. This client provides methods
+ * to list, create, or get datasets by name.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const datasetsClient = client.datasets();
+ *
+ * // List all datasets
+ * const { items } = await datasetsClient.list();
+ *
+ * // Get or create a dataset by name
+ * const dataset = await datasetsClient.getOrCreate('my-dataset');
+ * ```
+ *
+ * @see https://docs.apify.com/platform/storage/dataset
+ */
 export declare class DatasetCollectionClient extends ResourceCollectionClient {
     /**
      * @hidden
      */
     constructor(options: ApiClientSubResourceOptions);
     /**
-     * https://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets
+     * Lists all Datasets.
      *
      * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
      * items in a single API call is limited.
      * ```javascript
      * const paginatedList = await client.list(options);
-     *```
+     * ```
      *
      * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
      * retrieved.
@@ -22,10 +42,19 @@ export declare class DatasetCollectionClient extends ResourceCollectionClient {
      * ```javascript
      * for await (const singleItem of client.list(options)) {...}
      * ```
+     *
+     * @param options - Pagination options.
+     * @returns A paginated iterator of Datasets.
+     * @see https://docs.apify.com/api/v2/datasets-get
      */
     list(options?: DatasetCollectionClientListOptions): Promise<DatasetCollectionClientListResult> & AsyncIterable<Dataset>;
     /**
-     * https://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset
+     * 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.
+     * @returns The dataset object.
+     * @see https://docs.apify.com/api/v2/datasets-post
      */
     getOrCreate(name?: string, options?: DatasetCollectionClientGetOrCreateOptions): Promise<Dataset>;
 }

package/dist/resource_clients/dataset_collection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"dataset_collection.d.ts","sourceRoot":"","sources":["../../src/resource_clients/dataset_collection.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAC;AAC9E,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACjE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC,qBAAa,uBAAwB,SAAQ,wBAAwB;IACjE;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACA,OAAO,GAAE,kCAAuC,GACjD,OAAO,CAAC,iCAAiC,CAAC,GAAG,aAAa,CAAC,OAAO,CAAC;IActE;;OAEG;IACG,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,yCAAyC,GAAG,OAAO,CAAC,OAAO,CAAC;CAM1G;AAED,MAAM,WAAW,kCAAmC,SAAQ,iBAAiB;IACzE,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,yCAAyC;IACtD,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,MAAM,MAAM,iCAAiC,GAAG,aAAa,CAAC,OAAO,CAAC,GAAG;IAAE,OAAO,EAAE,OAAO,CAAA;CAAE,CAAC"}
+{"version":3,"file":"dataset_collection.d.ts","sourceRoot":"","sources":["../../src/resource_clients/dataset_collection.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAAE,wBAAwB,EAAE,MAAM,oCAAoC,CAAC;AAC9E,OAAO,KAAK,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACjE,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEzC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,uBAAwB,SAAQ,wBAAwB;IACjE;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CACA,OAAO,GAAE,kCAAuC,GACjD,OAAO,CAAC,iCAAiC,CAAC,GAAG,aAAa,CAAC,OAAO,CAAC;IActE;;;;;;;OAOG;IACG,WAAW,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,yCAAyC,GAAG,OAAO,CAAC,OAAO,CAAC;CAM1G;AAED,MAAM,WAAW,kCAAmC,SAAQ,iBAAiB;IACzE,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,yCAAyC;IACtD,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACpC;AAED,MAAM,MAAM,iCAAiC,GAAG,aAAa,CAAC,OAAO,CAAC,GAAG;IAAE,OAAO,EAAE,OAAO,CAAA;CAAE,CAAC"}

package/dist/resource_clients/dataset_collection.js

@@ -4,6 +4,26 @@ exports.DatasetCollectionClient = void 0;
 const tslib_1 = require("tslib");
 const ow_1 = tslib_1.__importDefault(require("ow"));
 const resource_collection_client_1 = require("../base/resource_collection_client");
+/**
+ * Client for managing the collection of datasets in your account.
+ *
+ * Datasets store structured data results from Actor runs. This client provides methods
+ * to list, create, or get datasets by name.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const datasetsClient = client.datasets();
+ *
+ * // List all datasets
+ * const { items } = await datasetsClient.list();
+ *
+ * // Get or create a dataset by name
+ * const dataset = await datasetsClient.getOrCreate('my-dataset');
+ * ```
+ *
+ * @see https://docs.apify.com/platform/storage/dataset
+ */
 class DatasetCollectionClient extends resource_collection_client_1.ResourceCollectionClient {
     /**
      * @hidden
@@ -15,13 +35,13 @@ class DatasetCollectionClient extends resource_collection_client_1.ResourceColle
         });
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/datasets/dataset-collection/get-list-of-datasets
+     * Lists all Datasets.
      *
      * Awaiting the return value (as you would with a Promise) will result in a single API call. The amount of fetched
      * items in a single API call is limited.
      * ```javascript
      * const paginatedList = await client.list(options);
-     *```
+     * ```
      *
      * Asynchronous iteration is also supported. This will fetch additional pages if needed until all items are
      * retrieved.
@@ -29,6 +49,10 @@ class DatasetCollectionClient extends resource_collection_client_1.ResourceColle
      * ```javascript
      * for await (const singleItem of client.list(options)) {...}
      * ```
+     *
+     * @param options - Pagination options.
+     * @returns A paginated iterator of Datasets.
+     * @see https://docs.apify.com/api/v2/datasets-get
      */
     list(options = {}) {
         (0, ow_1.default)(options, ow_1.default.object.exactShape({
@@ -40,7 +64,12 @@ class DatasetCollectionClient extends resource_collection_client_1.ResourceColle
         return this._listPaginated(options);
     }
     /**
-     * https://docs.apify.com/api/v2#/reference/datasets/dataset-collection/create-dataset
+     * 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.
+     * @returns The dataset object.
+     * @see https://docs.apify.com/api/v2/datasets-post
      */
     async getOrCreate(name, options) {
         (0, ow_1.default)(name, ow_1.default.optional.string);

package/dist/resource_clients/dataset_collection.js.map

@@ -1 +1 @@
-{"version":3,"file":"dataset_collection.js","sourceRoot":"","sources":["../../src/resource_clients/dataset_collection.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAGpB,mFAA8E;AAI9E,MAAa,uBAAwB,SAAQ,qDAAwB;IACjE;;OAEG;IACH,YAAY,OAAoC;QAC5C,KAAK,CAAC;YACF,YAAY,EAAE,UAAU;YACxB,GAAG,OAAO;SACb,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,IAAI,CACA,UAA8C,EAAE;QAEhD,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,OAAO,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC5B,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACzB,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC1B,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;SAC5B,CAAC,CACL,CAAC;QAEF,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,WAAW,CAAC,IAAa,EAAE,OAAmD;QAChF,IAAA,YAAE,EAAC,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC7B,IAAA,YAAE,EAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,+BAA+B;QAExE,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;CACJ;AApDD,0DAoDC"}
+{"version":3,"file":"dataset_collection.js","sourceRoot":"","sources":["../../src/resource_clients/dataset_collection.ts"],"names":[],"mappings":";;;;AAAA,oDAAoB;AAGpB,mFAA8E;AAI9E;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAa,uBAAwB,SAAQ,qDAAwB;IACjE;;OAEG;IACH,YAAY,OAAoC;QAC5C,KAAK,CAAC;YACF,YAAY,EAAE,UAAU;YACxB,GAAG,OAAO;SACb,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAI,CACA,UAA8C,EAAE;QAEhD,IAAA,YAAE,EACE,OAAO,EACP,YAAE,CAAC,MAAM,CAAC,UAAU,CAAC;YACjB,OAAO,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;YAC5B,KAAK,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YACzB,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM;YAC1B,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,OAAO;SAC5B,CAAC,CACL,CAAC;QAEF,OAAO,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,WAAW,CAAC,IAAa,EAAE,OAAmD;QAChF,IAAA,YAAE,EAAC,IAAI,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QAC7B,IAAA,YAAE,EAAC,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,MAAM,EAAE,YAAE,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,+BAA+B;QAExE,OAAO,IAAI,CAAC,YAAY,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;CACJ;AA7DD,0DA6DC"}

package/dist/resource_clients/key_value_store.d.ts

@@ -3,53 +3,156 @@ 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';
+/**
+ * Client for managing a specific key-value store.
+ *
+ * Key-value stores are used to store arbitrary data records or files. Each record is identified by
+ * a unique key and can contain any type of data. This client provides methods to get, set, and delete
+ * records, list keys, and manage the store.
+ *
+ * @example
+ * ```javascript
+ * const client = new ApifyClient({ token: 'my-token' });
+ * const storeClient = client.keyValueStore('my-store-id');
+ *
+ * // Set a record
+ * await storeClient.setRecord({
+ *   key: 'OUTPUT',
+ *   value: { foo: 'bar' },
+ *   contentType: 'application/json'
+ * });
+ *
+ * // Get a record
+ * const record = await storeClient.getRecord('OUTPUT');
+ *
+ * // List all keys
+ * const { items } = await storeClient.listKeys();
+ * ```
+ *
+ * @see https://docs.apify.com/platform/storage/key-value-store
+ */
 export declare class KeyValueStoreClient extends ResourceClient {
     /**
      * @hidden
      */
     constructor(options: ApiClientSubResourceOptions);
     /**
-     * https://docs.apify.com/api/v2#/reference/key-value-stores/store-object/get-store
+     * Gets the key-value store object from the Apify API.
+     *
+     * @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>;
     /**
-     * https://docs.apify.com/api/v2#/reference/key-value-stores/store-object/update-store
+     * Updates the key-value store with specified fields.
+     *
+     * @param newFields - Fields to update in the key-value store
+     * @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')
+     * @returns The updated KeyValueStore object
+     * @see https://docs.apify.com/api/v2/key-value-store-put
      */
     update(newFields: KeyValueClientUpdateOptions): Promise<KeyValueStore>;
     /**
-     * https://docs.apify.com/api/v2#/reference/key-value-stores/store-object/delete-store
+     * Deletes the key-value store.
+     *
+     * @see https://docs.apify.com/api/v2/key-value-store-delete
      */
     delete(): Promise<void>;
     /**
-     * https://docs.apify.com/api/v2#/reference/key-value-stores/key-collection/get-list-of-keys
+     * Lists all keys in the key-value store.
+     *
+     * Returns a paginated list of all record keys in the store. Use pagination parameters
+     * to retrieve large lists efficiently.
+     *
+     * @param options - Listing options
+     * @param options.limit - Maximum number of keys to return. Default is 1000.
+     * @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.
+     * @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
+     *
+     * @example
+     * ```javascript
+     * // List all keys
+     * const { items, isTruncated } = await client.keyValueStore('my-store').listKeys();
+     * items.forEach(item => console.log(`${item.key}: ${item.size} bytes`));
+     *
+     * // List keys with prefix
+     * const { items } = await client.keyValueStore('my-store').listKeys({ prefix: 'user-' });
+     *
+     * // Paginate through all keys
+     * let exclusiveStartKey;
+     * do {
+     *   const result = await client.keyValueStore('my-store').listKeys({
+     *     limit: 100,
+     *     exclusiveStartKey
+     *   });
+     *   // Process result.items...
+     *   exclusiveStartKey = result.nextExclusiveStartKey;
+     * } while (result.isTruncated);
+     * ```
      */
     listKeys(options?: KeyValueClientListKeysOptions): Promise<KeyValueClientListKeysResult>;
     /**
-     * Generates a URL that can be used to access key-value store record.
+     * Generates a public URL for accessing a specific record in the key-value store.
      *
      * If the client has permission to access the key-value store's URL signing key,
-     * the URL will include a signature to verify its authenticity.
+     * the URL will include a cryptographic signature for authenticated access without
+     * requiring an API token.
+     *
+     * @param key - The record key
+     * @returns A public URL string for accessing the record
+     *
+     * @example
+     * ```javascript
+     * const url = await client.keyValueStore('my-store').getRecordPublicUrl('OUTPUT');
+     * console.log(`Public URL: ${url}`);
+     * // You can now share this URL or use it in a browser
+     * ```
      */
     getRecordPublicUrl(key: string): Promise<string>;
     /**
-     * Generates a URL that can be used to access key-value store keys.
+     * Generates a public URL for accessing the list of keys in the key-value store.
      *
      * If the client has permission to access the key-value store's URL signing key,
-     * the URL will include a signature which will allow the link to work even without authentication.
+     * the URL will include a cryptographic signature which allows access without authentication.
      *
-     * You can optionally control how long the signed URL should be valid using the `expiresInSecs` option.
-     * This value sets the expiration duration in seconds from the time the URL is generated.
-     * If not provided, the URL will not expire.
+     * @param options - URL generation options (extends all options from {@link listKeys})
+     * @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.
+     * @returns A public URL string for accessing the keys list
      *
-     * Any other options (like `limit` or `prefix`) will be included as query parameters in the URL.
+     * @example
+     * ```javascript
+     * // Create a URL that expires in 1 hour
+     * const url = await client.keyValueStore('my-store').createKeysPublicUrl({
+     *   expiresInSecs: 3600,
+     *   prefix: 'image-'
+     * });
+     * console.log(`Share this URL: ${url}`);
+     * ```
      */
     createKeysPublicUrl(options?: KeyValueClientCreateKeysUrlOptions): Promise<string>;
     /**
      * Tests whether a record with the given key exists in the key-value store without retrieving its value.
      *
-     * https://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record
-     * @param key The queried record key.
-     * @returns `true` if the record exists, `false` if it does not.
+     * This is more efficient than {@link getRecord} when you only need to check for existence.
+     *
+     * @param key - The record key to check
+     * @returns `true` if the record exists, `false` if it does not
+     * @see https://docs.apify.com/api/v2/key-value-store-record-get
+     *
+     * @example
+     * ```javascript
+     * const exists = await client.keyValueStore('my-store').recordExists('OUTPUT');
+     * if (exists) {
+     *   console.log('OUTPUT record exists');
+     * }
+     * ```
      */
     recordExists(key: string): Promise<boolean>;
     /**
@@ -59,27 +162,78 @@ export declare class KeyValueStoreClient extends ResourceClient {
      *
      * When the record does not exist, the function resolves to `undefined`. It does
      * NOT resolve to a `KeyValueStore` record with an `undefined` value.
-     * https://docs.apify.com/api/v2#/reference/key-value-stores/record/get-record
+     *
+     * @see https://docs.apify.com/api/v2/key-value-store-record-get
      */
     getRecord(key: string): Promise<KeyValueStoreRecord<JsonValue> | undefined>;
     getRecord<Options extends KeyValueClientGetRecordOptions = KeyValueClientGetRecordOptions>(key: string, options: Options): Promise<KeyValueStoreRecord<ReturnTypeFromOptions<Options>> | undefined>;
     /**
-     * The value in the record can be a stream object (detected by having the `.pipe`
-     * and `.on` methods). However, note that in that case following redirects or
-     * retrying the request if it fails (for example due to rate limiting) isn't
-     * possible. If you want to keep that behavior, you need to collect the whole
-     * stream contents into a Buffer and then send the full buffer. See [this
-     * StackOverflow answer](https://stackoverflow.com/a/14269536/7292139) for
-     * an example how to do that.
-     *
-     * https://docs.apify.com/api/v2#/reference/key-value-stores/record/put-record
+     * Stores a record in the key-value store.
+     *
+     * The record value can be any JSON-serializable object, a string, or a Buffer/Stream.
+     * The content type is automatically determined based on the value type, but can be
+     * overridden using the `contentType` property.
+     *
+     * **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.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'`
+     * @param options - Storage options
+     * @param options.timeoutSecs - Timeout for the upload in seconds. Default varies by value size.
+     * @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
+     *
+     * @example
+     * ```javascript
+     * // Store JSON object
+     * await client.keyValueStore('my-store').setRecord({
+     *   key: 'OUTPUT',
+     *   value: { crawledUrls: 100, items: [...] }
+     * });
+     *
+     * // Store text
+     * await client.keyValueStore('my-store').setRecord({
+     *   key: 'README',
+     *   value: 'This is my readme text',
+     *   contentType: 'text/plain'
+     * });
+     *
+     * // Store binary data
+     * const imageBuffer = await fetchImageBuffer();
+     * await client.keyValueStore('my-store').setRecord({
+     *   key: 'screenshot.png',
+     *   value: imageBuffer,
+     *   contentType: 'image/png'
+     * });
+     * ```
      */
     setRecord(record: KeyValueStoreRecord<JsonValue>, options?: KeyValueStoreRecordOptions): Promise<void>;
     /**
-     * https://docs.apify.com/api/v2#/reference/key-value-stores/record/delete-record
+     * Deletes a record from the key-value store.
+     *
+     * @param key - The record key to delete
+     * @see https://docs.apify.com/api/v2/key-value-store-record-delete
+     *
+     * @example
+     * ```javascript
+     * await client.keyValueStore('my-store').deleteRecord('temp-data');
+     * ```
      */
     deleteRecord(key: string): Promise<void>;
 }
+/**
+ * Represents a Key-Value Store storage on the Apify platform.
+ *
+ * Key-value stores are used to store arbitrary data records or files. Each record is identified
+ * by a unique key and can contain any data - JSON objects, strings, binary files, etc.
+ */
 export interface KeyValueStore {
     id: string;
     name?: string;
@@ -96,6 +250,9 @@ export interface KeyValueStore {
     urlSigningSecretKey?: string | null;
     keysPublicUrl: string;
 }
+/**
+ * Statistics about Key-Value Store usage and storage.
+ */
 export interface KeyValueStoreStats {
     readCount?: number;
     writeCount?: number;
@@ -103,11 +260,17 @@ export interface KeyValueStoreStats {
     listCount?: number;
     storageBytes?: number;
 }
+/**
+ * Options for updating a Key-Value Store.
+ */
 export interface KeyValueClientUpdateOptions {
     name?: string | null;
     title?: string;
     generalAccess?: STORAGE_GENERAL_ACCESS | null;
 }
+/**
+ * Options for listing keys in a Key-Value Store.
+ */
 export interface KeyValueClientListKeysOptions {
     limit?: number;
     exclusiveStartKey?: string;
@@ -115,9 +278,19 @@ export interface KeyValueClientListKeysOptions {
     prefix?: string;
     signature?: string;
 }
+/**
+ * Options for creating a public URL to list keys in a Key-Value Store.
+ *
+ * Extends {@link KeyValueClientListKeysOptions} with URL expiration control.
+ */
 export interface KeyValueClientCreateKeysUrlOptions extends KeyValueClientListKeysOptions {
     expiresInSecs?: number;
 }
+/**
+ * Result of listing keys in a Key-Value Store.
+ *
+ * Contains paginated list of keys with metadata and pagination information.
+ */
 export interface KeyValueClientListKeysResult {
     count: number;
     limit: number;
@@ -126,24 +299,44 @@ export interface KeyValueClientListKeysResult {
     nextExclusiveStartKey: string;
     items: KeyValueListItem[];
 }
+/**
+ * Metadata about a single key in a Key-Value Store.
+ */
 export interface KeyValueListItem {
     key: string;
     size: number;
     recordPublicUrl: string;
 }
+/**
+ * Options for retrieving a record from a Key-Value Store.
+ */
 export interface KeyValueClientGetRecordOptions {
     buffer?: boolean;
     stream?: boolean;
     signature?: string;
 }
+/**
+ * Represents a record (key-value pair) in a Key-Value Store.
+ *
+ * @template T - The type of the record's value
+ */
 export interface KeyValueStoreRecord<T> {
     key: string;
     value: T;
     contentType?: string;
 }
+/**
+ * Options for storing a record in a Key-Value Store.
+ */
 export interface KeyValueStoreRecordOptions {
     timeoutSecs?: number;
     doNotRetryTimeouts?: boolean;
 }
+/**
+ * Helper type to determine the return type based on getRecord options.
+ *
+ * Returns Readable if stream option is true, Buffer if buffer option is true,
+ * otherwise returns JsonValue.
+ */
 export type ReturnTypeFromOptions<Options extends KeyValueClientGetRecordOptions> = Options['stream'] extends true ? Readable : Options['buffer'] extends true ? Buffer : JsonValue;
 //# sourceMappingURL=key_value_store.d.ts.map

package/dist/resource_clients/key_value_store.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"key_value_store.d.ts","sourceRoot":"","sources":["../../src/resource_clients/key_value_store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAG5C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAE3C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AAK5D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAGH,cAAc,EAEjB,MAAM,yBAAyB,CAAC;AAajC,qBAAa,mBAAoB,SAAQ,cAAc;IACnD;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;OAEG;IACG,GAAG,IAAI,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;IAI/C;;OAEG;IACG,MAAM,CAAC,SAAS,EAAE,2BAA2B,GAAG,OAAO,CAAC,aAAa,CAAC;IAM5E;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAI7B;;OAEG;IACG,QAAQ,CAAC,OAAO,GAAE,6BAAkC,GAAG,OAAO,CAAC,4BAA4B,CAAC;IAsBlG;;;;;OAKG;IACG,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAetD;;;;;;;;;;;OAWG;IACG,mBAAmB,CAAC,OAAO,GAAE,kCAAuC;IAgC1E;;;;;;OAMG;IACG,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAiBjD;;;;;;;;OAQG;IACG,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;IAE3E,SAAS,CAAC,OAAO,SAAS,8BAA8B,GAAG,8BAA8B,EAC3F,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,OAAO,GACjB,OAAO,CAAC,mBAAmB,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAuD3E;;;;;;;;;;OAUG;IACG,SAAS,CAAC,MAAM,EAAE,mBAAmB,CAAC,SAAS,CAAC,EAAE,OAAO,GAAE,0BAA+B,GAAG,OAAO,CAAC,IAAI,CAAC;IAqDhH;;OAEG;IACG,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAUjD;AAED,MAAM,WAAW,aAAa;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,IAAI,CAAC;IAChB,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B,aAAa,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAC9C,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,aAAa,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,kBAAkB;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,2BAA2B;IACxC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;CACjD;AAED,MAAM,WAAW,6BAA6B;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,kCAAmC,SAAQ,6BAA6B;IACrF,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED,MAAM,WAAW,4BAA4B;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB,EAAE,MAAM,CAAC;IAC1B,WAAW,EAAE,OAAO,CAAC;IACrB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,KAAK,EAAE,gBAAgB,EAAE,CAAC;CAC7B;AAED,MAAM,WAAW,gBAAgB;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,8BAA8B;IAC3C,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,mBAAmB,CAAC,CAAC;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,CAAC,CAAC;IACT,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,0BAA0B;IACvC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED,MAAM,MAAM,qBAAqB,CAAC,OAAO,SAAS,8BAA8B,IAAI,OAAO,CAAC,QAAQ,CAAC,SAAS,IAAI,GAC5G,QAAQ,GACR,OAAO,CAAC,QAAQ,CAAC,SAAS,IAAI,GAC5B,MAAM,GACN,SAAS,CAAC"}
+{"version":3,"file":"key_value_store.d.ts","sourceRoot":"","sources":["../../src/resource_clients/key_value_store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAG5C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AAE3C,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AAK5D,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,oBAAoB,CAAC;AACtE,OAAO,EAGH,cAAc,EAEjB,MAAM,yBAAyB,CAAC;AAajC;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,mBAAoB,SAAQ,cAAc;IACnD;;OAEG;gBACS,OAAO,EAAE,2BAA2B;IAOhD;;;;;OAKG;IACG,GAAG,IAAI,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;IAI/C;;;;;;;;;OASG;IACG,MAAM,CAAC,SAAS,EAAE,2BAA2B,GAAG,OAAO,CAAC,aAAa,CAAC;IAM5E;;;;OAIG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAI7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,QAAQ,CAAC,OAAO,GAAE,6BAAkC,GAAG,OAAO,CAAC,4BAA4B,CAAC;IAsBlG;;;;;;;;;;;;;;;;OAgBG;IACG,kBAAkB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAetD;;;;;;;;;;;;;;;;;;;;;OAqBG;IACG,mBAAmB,CAAC,OAAO,GAAE,kCAAuC;IAgC1E;;;;;;;;;;;;;;;;OAgBG;IACG,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAiBjD;;;;;;;;;OASG;IACG,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC,SAAS,CAAC,GAAG,SAAS,CAAC;IAE3E,SAAS,CAAC,OAAO,SAAS,8BAA8B,GAAG,8BAA8B,EAC3F,GAAG,EAAE,MAAM,EACX,OAAO,EAAE,OAAO,GACjB,OAAO,CAAC,mBAAmB,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAuD3E;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8CG;IACG,SAAS,CAAC,MAAM,EAAE,mBAAmB,CAAC,SAAS,CAAC,EAAE,OAAO,GAAE,0BAA+B,GAAG,OAAO,CAAC,IAAI,CAAC;IAqDhH;;;;;;;;;;OAUG;IACG,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAUjD;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC1B,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,IAAI,CAAC;IAChB,UAAU,EAAE,IAAI,CAAC;IACjB,UAAU,EAAE,IAAI,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAC3B,aAAa,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;IAC9C,mBAAmB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpC,aAAa,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAC/B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,YAAY,CAAC,EAAE,MAAM,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IACxC,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,aAAa,CAAC,EAAE,sBAAsB,GAAG,IAAI,CAAC;CACjD;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,kCAAmC,SAAQ,6BAA6B;IACrF,aAAa,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB,EAAE,MAAM,CAAC;IAC1B,WAAW,EAAE,OAAO,CAAC;IACrB,qBAAqB,EAAE,MAAM,CAAC;IAC9B,KAAK,EAAE,gBAAgB,EAAE,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC7B,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,eAAe,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC3C,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,mBAAmB,CAAC,CAAC;IAClC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,CAAC,CAAC;IACT,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACvC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAChC;AAED;;;;;GAKG;AACH,MAAM,MAAM,qBAAqB,CAAC,OAAO,SAAS,8BAA8B,IAAI,OAAO,CAAC,QAAQ,CAAC,SAAS,IAAI,GAC5G,QAAQ,GACR,OAAO,CAAC,QAAQ,CAAC,SAAS,IAAI,GAC5B,MAAM,GACN,SAAS,CAAC"}