apify-client 3.0.0-beta.57 → 3.0.0-beta.59

package/dist/resource_clients/actor.d.ts

@@ -297,7 +297,7 @@ export declare class ActorClient extends ResourceClient {
 /**
  * Fields that can be updated when modifying an Actor.
  */
-export type ActorUpdateOptions = Partial<Pick<ActorResource, 'name' | 'description' | 'isPublic' | 'isDeprecated' | 'seoTitle' | 'seoDescription' | 'title' | 'versions' | 'categories' | 'defaultRunOptions' | 'actorStandby' | 'actorPermissionLevel' | 'taggedBuilds'>>;
+export type ActorUpdateOptions = Partial<Pick<ActorResource, 'name' | 'description' | 'isPublic' | 'isDeprecated' | 'seoTitle' | 'seoDescription' | 'title' | 'versions' | 'categories' | 'defaultRunOptions' | 'actorStandby' | 'actorPermissionLevel' | 'taggedBuilds' | 'pricingInfos' | 'exampleRunInput'>>;
 /**
  * Input for an Actor run, as taken by {@link ActorClient.start}, {@link ActorClient.call},
  * {@link ActorClient.validateInput} and {@link RunClient.metamorph}.

package/dist/resource_clients/key_value_store.d.ts

@@ -77,6 +77,8 @@ export declare class KeyValueStoreClient extends ResourceClient {
      *
      * @param options - Listing options
      * @param options.limit - Maximum number of keys to return. Default is 1000.
+     * @param options.chunkSize - Maximum number of keys requested per API call when iterating across pages. `limit`
+     *   then caps the total across all pages.
      * @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.
@@ -287,6 +289,12 @@ export interface KeyValueClientUpdateOptions {
  */
 export interface KeyValueClientListKeysOptions extends TimeoutOptions {
     limit?: number;
+    /**
+     * Maximum number of keys returned in one API response. When the call is iterated with `for await`, the iterator
+     * fetches keys in chunks of this size and yields them one by one, until `limit` is reached or the store has no
+     * more keys. Awaiting the call returns only the first chunk.
+     */
+    chunkSize?: number;
     exclusiveStartKey?: string;
     collection?: string;
     /**
@@ -301,11 +309,11 @@ export interface KeyValueClientListKeysOptions extends TimeoutOptions {
 /**
  * Options for creating a public URL to list keys in a Key-Value Store.
  *
- * Extends {@link KeyValueClientListKeysOptions} with URL expiration control, minus `signature` (this
- * method produces one).
+ * Extends {@link KeyValueClientListKeysOptions} with URL expiration control, minus `chunkSize` (it only sizes a
+ * client-side iteration) and `signature` (this method produces one).
  * @since Added in 2.16.0
  */
-export interface KeyValueClientCreateKeysUrlOptions extends Omit<KeyValueClientListKeysOptions, 'signature'> {
+export interface KeyValueClientCreateKeysUrlOptions extends Omit<KeyValueClientListKeysOptions, 'chunkSize' | 'signature'> {
     expiresInSecs?: number;
 }
 /**

package/dist/resource_clients/key_value_store.js

@@ -5,9 +5,10 @@ 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';
+import { anyObjectSchema, applyQueryParamsToUrl, catchNotFoundOrThrow, isBuffer, isStream, minForLimitParam, parseArgument, parseResponse, } from '../utils.js';
 const listKeysOptionsSchema = z.strictObject({
     limit: z.number().min(0).optional(),
+    chunkSize: z.number().positive().optional(),
     exclusiveStartKey: z.string().optional(),
     collection: z.string().optional(),
     prefix: z.string().optional(),
@@ -15,7 +16,8 @@ const listKeysOptionsSchema = z.strictObject({
     ...timeoutOptionsShape,
 });
 const nonEmptyKeySchema = z.string().min(1);
-// `signature` is left out - this method produces one. The options type omits it to match.
+// `chunkSize` (client-side only) and `signature` (which this method produces) are left out. The options type omits
+// both to match.
 const createKeysPublicUrlOptionsSchema = z.strictObject({
     limit: z.number().min(0).optional(),
     exclusiveStartKey: z.string().optional(),
@@ -135,6 +137,8 @@ export class KeyValueStoreClient extends ResourceClient {
      *
      * @param options - Listing options
      * @param options.limit - Maximum number of keys to return. Default is 1000.
+     * @param options.chunkSize - Maximum number of keys requested per API call when iterating across pages. `limit`
+     *   then caps the total across all pages.
      * @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.
@@ -164,7 +168,8 @@ export class KeyValueStoreClient extends ResourceClient {
      * ```
      */
     listKeys(options = {}) {
-        const { timeoutSecs = 'medium', signal, ...parsed } = parseArgument(options, listKeysOptionsSchema, 'KeyValueClientListKeysOptions');
+        // `chunkSize` only sizes the page requests; it is not an API parameter, so it must not reach the query string.
+        const { chunkSize, timeoutSecs = 'medium', signal, ...parsed } = parseArgument(options, listKeysOptionsSchema, 'KeyValueClientListKeysOptions');
         const getPaginatedList = async (kvsListOptions = {}) => {
             const response = await this.httpClient.call({
                 url: this.buildUrl('keys'),
@@ -175,7 +180,7 @@ export class KeyValueStoreClient extends ResourceClient {
             });
             return parseResponse(response, schemas.ListOfKeys());
         };
-        const paginatedListPromise = getPaginatedList(parsed);
+        const paginatedListPromise = getPaginatedList({ ...parsed, limit: minForLimitParam(parsed.limit, chunkSize) });
         async function* asyncGenerator() {
             let currentPage = await paginatedListPromise;
             yield* currentPage.items;
@@ -188,7 +193,7 @@ export class KeyValueStoreClient extends ResourceClient {
             ) {
                 const newOptions = {
                     ...parsed,
-                    limit: remainingItems,
+                    limit: minForLimitParam(remainingItems, chunkSize),
                     exclusiveStartKey: currentPage.nextExclusiveStartKey,
                 };
                 currentPage = await getPaginatedList(newOptions);

package/dist/resource_clients/request_queue.d.ts

@@ -301,6 +301,8 @@ export declare class RequestQueueClient extends ResourceClient {
      * queue contents.
      *
      * @param options - Pagination options
+     * @param options.chunkSize - Maximum number of requests fetched per API call when iterating across pages. `limit`
+     *   then caps the total across all pages.
      * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
      * @returns List of requests with pagination information
      * @see https://docs.apify.com/api/v2/request-queue-requests-get
@@ -383,6 +385,12 @@ export type RequestQueueListRequestsFilter = 'locked' | 'pending';
  */
 export interface RequestQueueClientListRequestsOptions extends TimeoutOptions {
     limit?: number;
+    /**
+     * Maximum number of requests returned in one API response. When the call is iterated with `for await`, the iterator
+     * fetches requests in chunks of this size and yields them one by one, until `limit` is reached or the RQ is
+     * exhausted. Awaiting the call returns only the first chunk.
+     */
+    chunkSize?: number;
     /**
      * @since Added in 2.23.2
      */

package/dist/resource_clients/request_queue.js

@@ -5,7 +5,7 @@ import { ResourceClient } from '../base/resource_client.js';
 import { ResponseValidationError } from '../response_validation_error.js';
 import * as schemas from '../schemas.js';
 import { optionalSignalSchema, optionalTimeoutSchema, timeoutOptionsSchema, timeoutOptionsShape } from '../timeouts.js';
-import { anyObjectSchema, catchNotFoundOrThrow, isNonArrayObject, parseArgument, parseResponse, RequestQueuePaginationIterator, sleep, splitIntoJsonArrayBatches, utf8ByteLength, } from '../utils.js';
+import { anyObjectSchema, catchNotFoundOrThrow, isNonArrayObject, minForLimitParam, parseArgument, parseResponse, RequestQueuePaginationIterator, sleep, splitIntoJsonArrayBatches, utf8ByteLength, } from '../utils.js';
 const DEFAULT_PARALLEL_BATCH_ADD_REQUESTS = 5;
 const DEFAULT_UNPROCESSED_RETRIES_BATCH_ADD_REQUESTS = 3;
 const DEFAULT_MIN_DELAY_BETWEEN_UNPROCESSED_REQUESTS_RETRIES_MILLIS = 500;
@@ -39,6 +39,7 @@ const prolongRequestLockOptionsSchema = z.strictObject({
 const requestFilterSchema = z.array(z.enum(['locked', 'pending'])).min(1);
 const listRequestsOptionsSchema = z.strictObject({
     limit: z.number().min(0).optional(),
+    chunkSize: z.number().positive().optional(),
     cursor: z.string().optional(),
     filter: requestFilterSchema.optional(),
     ...timeoutOptionsShape,
@@ -622,15 +623,17 @@ export class RequestQueueClient extends ResourceClient {
      * queue contents.
      *
      * @param options - Pagination options
+     * @param options.chunkSize - Maximum number of requests fetched per API call when iterating across pages. `limit`
+     *   then caps the total across all pages.
      * @param options.timeoutSecs - Timeout for each API request. Default is `'medium'`.
      * @returns List of requests with pagination information
      * @see https://docs.apify.com/api/v2/request-queue-requests-get
      * @since Added in 2.5.1
      */
     listRequests(options = {}) {
-        // `timeoutSecs` and `signal` apply to every page request; they are not API parameters, so they must not reach
-        // the query string.
-        const { timeoutSecs, signal, ...parsed } = parseArgument(options, listRequestsOptionsSchema, 'RequestQueueClientListRequestsOptions');
+        // `chunkSize` only sizes the page requests, and `timeoutSecs` and `signal` apply to every one of them; none of
+        // them is an API parameter, so they must not reach the query string.
+        const { chunkSize, timeoutSecs, signal, ...parsed } = parseArgument(options, listRequestsOptionsSchema, 'RequestQueueClientListRequestsOptions');
         const pageTimeout = this.#resolveTimeout(timeoutSecs, 'medium');
         const getPaginatedList = async (rqListOptions = {}) => {
             const response = await this.httpClient.call({
@@ -646,7 +649,7 @@ export class RequestQueueClient extends ResourceClient {
             });
             return parseResponse(response, schemas.ListOfRequests());
         };
-        const paginatedListPromise = getPaginatedList(parsed);
+        const paginatedListPromise = getPaginatedList({ ...parsed, limit: minForLimitParam(parsed.limit, chunkSize) });
         async function* asyncGenerator() {
             let currentPage = await paginatedListPromise;
             yield* currentPage.items;
@@ -659,7 +662,7 @@ export class RequestQueueClient extends ResourceClient {
             ) {
                 const newOptions = {
                     ...parsed,
-                    limit: remainingItems,
+                    limit: minForLimitParam(remainingItems, chunkSize),
                     cursor: currentPage.nextCursor,
                 };
                 currentPage = await getPaginatedList(newOptions);

package/dist/utils.d.ts

@@ -149,6 +149,12 @@ export interface PaginationOptions {
      * */
     chunkSize?: number;
 }
+/**
+ * The smaller of two page limits, for the `limit` query parameter. The API treats a `limit` of 0 as unset, so 0 here
+ * means no limit and loses to any other value.
+ * @internal
+ */
+export declare function minForLimitParam(a: number | undefined, b: number | undefined): number | undefined;
 /**
  * Schema shape of {@link PaginationOptions}, to spread into every paginating client's list schema. One
  * copy stops it drifting from the interface.

package/dist/utils.js

@@ -288,6 +288,22 @@ export class RequestQueuePaginationIterator {
         }
     }
 }
+/**
+ * The smaller of two page limits, for the `limit` query parameter. The API treats a `limit` of 0 as unset, so 0 here
+ * means no limit and loses to any other value.
+ * @internal
+ */
+export function minForLimitParam(a, b) {
+    if (a === 0)
+        a = undefined;
+    if (b === 0)
+        b = undefined;
+    if (a === undefined)
+        return b;
+    if (b === undefined)
+        return a;
+    return Math.min(a, b);
+}
 /**
  * Schema shape of {@link PaginationOptions}, to spread into every paginating client's list schema. One
  * copy stops it drifting from the interface.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apify-client",
-  "version": "3.0.0-beta.57",
+  "version": "3.0.0-beta.59",
   "description": "Apify API client for JavaScript",
   "engines": {
     "node": ">=22.13.0"