apify-client 2.23.1 → 2.23.2-beta.1

package/dist/bundle.js

@@ -16087,8 +16087,13 @@ const SAFETY_BUFFER_PERCENT = 0.01 / 100; // 0.01%
         var _this = this;
         ow__rspack_import_4_default()(options, ow__rspack_import_4_default().object.exactShape({
             limit: (ow__rspack_import_4_default().optional.number.not.negative),
-            exclusiveStartId: (ow__rspack_import_4_default().optional.string)
-        }));
+            exclusiveStartId: (ow__rspack_import_4_default().optional.string),
+            cursor: (ow__rspack_import_4_default().optional.string),
+            filter: ow__rspack_import_4_default().optional.array.ofType(ow__rspack_import_4_default().string.oneOf([
+                'locked',
+                'pending'
+            ])).minLength(1)
+        }).validate((0,_utils__rspack_import_3.mutuallyExclusive)('exclusiveStartId', 'cursor')));
         const getPaginatedList = async function() {
             let rqListOptions = arguments.length > 0 && arguments[0] !== void 0 ? arguments[0] : {};
             const response = await _this.httpClient.call({
@@ -16097,6 +16102,7 @@ const SAFETY_BUFFER_PERCENT = 0.01 / 100; // 0.01%
                 timeout: Math.min(_base_resource_client__rspack_import_2.MEDIUM_TIMEOUT_MILLIS, _this.timeoutMillis ?? Infinity),
                 params: _this._params({
                     ...rqListOptions,
+                    filter: rqListOptions.filter ? rqListOptions.filter.join(',') : undefined,
                     clientKey: _this.clientKey
                 })
             });
@@ -16110,13 +16116,15 @@ const SAFETY_BUFFER_PERCENT = 0.01 / 100; // 0.01%
             // RQ API response does not indicate whether there are more requests left, so we have to try and in case
             // of exhausting all requests we get response with empty items which ends the loop.
             while(currentPage.items.length > 0 && // Continue only if at least some items were returned in the last page.
+            currentPage.nextCursor && // Continue only if the API returned a cursor for the next page.
             (remainingItems === undefined || remainingItems > 0 // Continue only if the limit was not exceeded.
             )){
-                const exclusiveStartId = currentPage.items[currentPage.items.length - 1].id;
                 const newOptions = {
                     ...options,
                     limit: remainingItems,
-                    exclusiveStartId
+                    // remove original exclusiveStartId, if there was any, and use cursor-based pagination
+                    exclusiveStartId: undefined,
+                    cursor: currentPage.nextCursor
                 };
                 currentPage = await getPaginatedList(newOptions);
                 yield* currentPage.items;
@@ -16169,13 +16177,22 @@ const SAFETY_BUFFER_PERCENT = 0.01 / 100; // 0.01%
         ow__rspack_import_4_default()(options, ow__rspack_import_4_default().object.exactShape({
             limit: (ow__rspack_import_4_default().optional.number.not.negative),
             maxPageLimit: (ow__rspack_import_4_default().optional.number),
-            exclusiveStartId: (ow__rspack_import_4_default().optional.string)
-        }));
-        const { limit, exclusiveStartId, maxPageLimit = DEFAULT_REQUEST_QUEUE_REQUEST_PAGE_LIMIT } = options;
-        return new _utils__rspack_import_3.PaginationIterator({
-            getPage: this.listRequests.bind(this),
+            exclusiveStartId: (ow__rspack_import_4_default().optional.string),
+            cursor: (ow__rspack_import_4_default().optional.string),
+            filter: ow__rspack_import_4_default().optional.array.ofType(ow__rspack_import_4_default().string.oneOf([
+                'locked',
+                'pending'
+            ])).minLength(1)
+        }).validate((0,_utils__rspack_import_3.mutuallyExclusive)('exclusiveStartId', 'cursor')));
+        const { limit, exclusiveStartId, cursor, filter, maxPageLimit = DEFAULT_REQUEST_QUEUE_REQUEST_PAGE_LIMIT } = options;
+        return new _utils__rspack_import_3.RequestQueuePaginationIterator({
+            getPage: async (pageOptions)=>this.listRequests({
+                    ...pageOptions,
+                    filter
+                }),
             limit,
             exclusiveStartId,
+            cursor,
             maxPageLimit
         });
     }
@@ -17854,7 +17871,7 @@ class Statistics {
 "use strict";
 __webpack_require__.r(__webpack_exports__);
 __webpack_require__.d(__webpack_exports__, {
-  PaginationIterator: () => (PaginationIterator),
+  RequestQueuePaginationIterator: () => (RequestQueuePaginationIterator),
   applyQueryParamsToUrl: () => (applyQueryParamsToUrl),
   asArray: () => (asArray),
   cast: () => (cast),
@@ -17864,6 +17881,7 @@ __webpack_require__.d(__webpack_exports__, {
   isNode: () => (isNode),
   isStream: () => (isStream),
   maybeGzipValue: () => (maybeGzipValue),
+  mutuallyExclusive: () => (mutuallyExclusive),
   parseDateFields: () => (parseDateFields),
   pluckData: () => (pluckData),
   sliceArrayByByteLength: () => (sliceArrayByByteLength),
@@ -18002,7 +18020,7 @@ function isStream(value) {
 function getVersionData() {
     if (true) {
         return {
-            version: "2.23.1"
+            version: "2.23.2-beta.1"
         };
     }
     // eslint-disable-next-line
@@ -18012,24 +18030,27 @@ _computedKey = Symbol.asyncIterator;
 let _computedKey1 = _computedKey;
 /**
  * Helper class to create async iterators from paginated list endpoints with exclusive start key.
- */ class PaginationIterator {
+ */ class RequestQueuePaginationIterator {
     async *[_computedKey1]() {
-        let nextPageExclusiveStartId;
+        let nextCursor = this.cursor;
+        // allow using exclusiveStartId for the first page, but then we'll delete it to avoid using it for any later page
+        let nextExclusiveStartId = this.exclusiveStartId;
         let iterateItemCount = 0;
         while(true){
             const pageLimit = this.limit ? Math.min(this.maxPageLimit, this.limit - iterateItemCount) : this.maxPageLimit;
-            const pageExclusiveStartId = nextPageExclusiveStartId || this.exclusiveStartId;
             const page = await this.getPage({
                 limit: pageLimit,
-                exclusiveStartId: pageExclusiveStartId
+                cursor: nextCursor,
+                exclusiveStartId: nextExclusiveStartId
             });
             // There are no more pages to iterate
             if (page.items.length === 0) return;
             yield page;
             iterateItemCount += page.items.length;
             // Limit reached stopping to iterate
-            if (this.limit && iterateItemCount >= this.limit) return;
-            nextPageExclusiveStartId = page.items[page.items.length - 1].id;
+            if (this.limit && iterateItemCount >= this.limit || !page.nextCursor) return;
+            nextCursor = page.nextCursor;
+            nextExclusiveStartId = undefined; // see comment above - delete it for any page after the first one, and paginate with cursor
         }
     }
     constructor(options){
@@ -18037,9 +18058,11 @@ let _computedKey1 = _computedKey;
         (0,_swc_helpers_define_property__rspack_import_1._)(this, "getPage", void 0);
         (0,_swc_helpers_define_property__rspack_import_1._)(this, "limit", void 0);
         (0,_swc_helpers_define_property__rspack_import_1._)(this, "exclusiveStartId", void 0);
+        (0,_swc_helpers_define_property__rspack_import_1._)(this, "cursor", void 0);
         this.maxPageLimit = options.maxPageLimit;
         this.limit = options.limit;
         this.exclusiveStartId = options.exclusiveStartId;
+        this.cursor = options.cursor;
         this.getPage = options.getPage;
     }
 }
@@ -18069,6 +18092,18 @@ function asArray(value) {
     }
     return url;
 }
+const mutuallyExclusive = function() {
+    for(var _len = arguments.length, keys = new Array(_len), _key = 0; _key < _len; _key++){
+        keys[_key] = arguments[_key];
+    }
+    return (value)=>{
+        const presentKeys = keys.filter((key)=>typeof value[key] !== 'undefined');
+        return {
+            validator: presentKeys.length <= 1,
+            message: `At most one of the following fields is allowed: ${keys.join(', ')}`
+        };
+    };
+};
 
 
 },
@@ -26623,7 +26658,7 @@ const isIterable = (thing) => thing != null && isFunction(thing[iterator]);
 },
 8330(module) {
 "use strict";
-module.exports = JSON.parse('{"name":"apify-client","version":"2.23.1","description":"Apify API client for JavaScript","main":"dist/index.js","module":"dist/index.mjs","types":"dist/index.d.ts","browser":"dist/bundle.js","unpkg":"dist/bundle.js","exports":{"./package.json":"./package.json","./browser":"./dist/bundle.js",".":{"import":"./dist/index.mjs","require":"./dist/index.js","types":"./dist/index.d.ts","browser":"./dist/bundle.js"}},"keywords":["apify","api","apifier","crawler","scraper"],"author":{"name":"Apify","email":"support@apify.com","url":"https://apify.com"},"contributors":["Jan Curn <jan@apify.com>","Marek Trunkát <marek@apify.com>","Ondra Urban <ondra@apify.com>","Jakub Drobník <jakub.drobnik@apify.com>"],"license":"Apache-2.0","repository":{"type":"git","url":"git+https://github.com/apify/apify-client-js"},"bugs":{"url":"https://github.com/apify/apify-client-js/issues"},"homepage":"https://docs.apify.com/api/client/js/","files":["dist","!dist/*.tsbuildinfo"],"scripts":{"build":"npm run clean && npm run build:node && npm run build:browser","postbuild":"gen-esm-wrapper dist/index.js dist/index.mjs","prepublishOnly":"(test $CI || (echo \\"Publishing is reserved to CI!\\"; exit 1))","clean":"rimraf dist","test":"npm run build && vitest run","test:bundling":"npm run build && npm --prefix=./test/bundling run bundle:all","lint":"eslint","lint:fix":"eslint --fix","tsc-check-tests":"tsc --noEmit --project test/tsconfig.json","format":"prettier --write .","format:check":"prettier --check .","build:node":"tsc","build:browser":"rsbuild build"},"dependencies":{"@apify/consts":"^2.50.0","@apify/log":"^2.2.6","@apify/utilities":"^2.23.2","@crawlee/types":"^3.3.0","ansi-colors":"^4.1.1","async-retry":"^1.3.3","axios":"^1.6.7","content-type":"^1.0.5","ow":"^0.28.2","proxy-agent":"^6.5.0","tslib":"^2.5.0","type-fest":"^4.0.0"},"devDependencies":{"@apify/eslint-config":"^1.0.0","@apify/tsconfig":"^0.1.1","@crawlee/puppeteer":"^3.2.2","@rsbuild/core":"^1.3.6","@rsbuild/plugin-node-polyfill":"^1.3.0","@rspack/cli":"^1.7.6","@rspack/core":"^1.7.6","@stylistic/eslint-plugin-ts":"^4.2.0","@types/async-retry":"^1.4.5","@types/compression":"^1.8.1","@types/content-type":"^1.1.5","@types/express":"^5.0.0","@types/node":"^24.0.0","ajv":"^8.17.1","body-parser":"^2.0.0","compression":"^1.7.4","esbuild":"0.27.4","eslint":"^9.24.0","eslint-config-prettier":"^10.1.2","express":"^5.0.0","gen-esm-wrapper":"^1.1.2","globals":"^17.0.0","prettier":"^3.5.3","puppeteer":"^24.0.0","rimraf":"^6.0.0","rolldown":"^1.0.0-rc.4","typescript":"^5.8.3","typescript-eslint":"^8.29.1","vitest":"^4.0.16","webpack":"^5.105.2","webpack-cli":"^7.0.0"},"packageManager":"npm@10.9.2"}')
+module.exports = JSON.parse('{"name":"apify-client","version":"2.23.2-beta.1","description":"Apify API client for JavaScript","main":"dist/index.js","module":"dist/index.mjs","types":"dist/index.d.ts","browser":"dist/bundle.js","unpkg":"dist/bundle.js","exports":{"./package.json":"./package.json","./browser":"./dist/bundle.js",".":{"import":"./dist/index.mjs","require":"./dist/index.js","types":"./dist/index.d.ts","browser":"./dist/bundle.js"}},"keywords":["apify","api","apifier","crawler","scraper"],"author":{"name":"Apify","email":"support@apify.com","url":"https://apify.com"},"contributors":["Jan Curn <jan@apify.com>","Marek Trunkát <marek@apify.com>","Ondra Urban <ondra@apify.com>","Jakub Drobník <jakub.drobnik@apify.com>"],"license":"Apache-2.0","repository":{"type":"git","url":"git+https://github.com/apify/apify-client-js"},"bugs":{"url":"https://github.com/apify/apify-client-js/issues"},"homepage":"https://docs.apify.com/api/client/js/","files":["dist","!dist/*.tsbuildinfo"],"scripts":{"build":"npm run clean && npm run build:node && npm run build:browser","postbuild":"gen-esm-wrapper dist/index.js dist/index.mjs","prepublishOnly":"(test $CI || (echo \\"Publishing is reserved to CI!\\"; exit 1))","clean":"rimraf dist","test":"npm run build && vitest run","test:bundling":"npm run build && npm --prefix=./test/bundling run bundle:all","lint":"eslint","lint:fix":"eslint --fix","tsc-check-tests":"tsc --noEmit --project test/tsconfig.json","format":"prettier --write .","format:check":"prettier --check .","build:node":"tsc","build:browser":"rsbuild build"},"dependencies":{"@apify/consts":"^2.50.0","@apify/log":"^2.2.6","@apify/utilities":"^2.23.2","@crawlee/types":"^3.3.0","ansi-colors":"^4.1.1","async-retry":"^1.3.3","axios":"^1.6.7","content-type":"^1.0.5","ow":"^0.28.2","proxy-agent":"^6.5.0","tslib":"^2.5.0","type-fest":"^4.0.0"},"devDependencies":{"@apify/eslint-config":"^1.0.0","@apify/tsconfig":"^0.1.1","@crawlee/puppeteer":"^3.2.2","@rsbuild/core":"^1.3.6","@rsbuild/plugin-node-polyfill":"^1.3.0","@rspack/cli":"^1.7.6","@rspack/core":"^1.7.6","@stylistic/eslint-plugin-ts":"^4.2.0","@types/async-retry":"^1.4.5","@types/compression":"^1.8.1","@types/content-type":"^1.1.5","@types/express":"^5.0.0","@types/node":"^24.0.0","ajv":"^8.17.1","body-parser":"^2.0.0","compression":"^1.7.4","esbuild":"0.27.4","eslint":"^9.24.0","eslint-config-prettier":"^10.1.2","express":"^5.0.0","gen-esm-wrapper":"^1.1.2","globals":"^17.0.0","prettier":"^3.5.3","puppeteer":"^24.0.0","rimraf":"^6.0.0","rolldown":"^1.0.0-rc.4","typescript":"^5.8.3","typescript-eslint":"^8.29.1","vitest":"^4.0.16","webpack":"^5.105.2","webpack-cli":"^7.0.0"},"packageManager":"npm@10.9.2"}')
 
 },