apify-client 2.20.1-beta.2 → 2.20.1-beta.4

package/dist/base/resource_collection_client.d.ts

@@ -1,3 +1,4 @@
+import type { PaginatedResponse, PaginationOptions } from '../utils';
 import { ApiClient } from './api_client';
 /**
  * Resource collection client.
@@ -8,6 +9,10 @@ export declare class ResourceCollectionClient extends ApiClient {
      * @private
      */
     protected _list<T, R>(options?: T): Promise<R>;
+    /**
+     * Returns async iterator to iterate through all items and Promise that can be awaited to get first page of results.
+     */
+    protected _listPaginated<T extends PaginationOptions, Data, R extends PaginatedResponse<Data>>(options?: T): AsyncIterable<Data> & Promise<R>;
     protected _create<D, R>(resource: D): Promise<R>;
     protected _getOrCreate<D, R>(name?: string, resource?: D): Promise<R>;
 }

package/dist/base/resource_collection_client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"resource_collection_client.d.ts","sourceRoot":"","sources":["../../src/base/resource_collection_client.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC;;;GAGG;AACH,qBAAa,wBAAyB,SAAQ,SAAS;IACnD;;OAEG;cACa,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,GAAE,CAAW,GAAG,OAAO,CAAC,CAAC,CAAC;cAS7C,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;cAUtC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CAS9E"}
+{"version":3,"file":"resource_collection_client.d.ts","sourceRoot":"","sources":["../../src/base/resource_collection_client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAErE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC;;;GAGG;AACH,qBAAa,wBAAyB,SAAQ,SAAS;IACnD;;OAEG;cACa,KAAK,CAAC,CAAC,EAAE,CAAC,EAAE,OAAO,GAAE,CAAW,GAAG,OAAO,CAAC,CAAC,CAAC;IAS7D;;OAEG;IACH,SAAS,CAAC,cAAc,CAAC,CAAC,SAAS,iBAAiB,EAAE,IAAI,EAAE,CAAC,SAAS,iBAAiB,CAAC,IAAI,CAAC,EACzF,OAAO,GAAE,CAAW,GACrB,aAAa,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;cA8BnB,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,QAAQ,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;cAUtC,YAAY,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;CAS9E"}

package/dist/base/resource_collection_client.js

@@ -19,6 +19,33 @@ class ResourceCollectionClient extends api_client_1.ApiClient {
         });
         return (0, utils_1.parseDateFields)((0, utils_1.pluckData)(response.data));
     }
+    /**
+     * Returns async iterator to iterate through all items and Promise that can be awaited to get first page of results.
+     */
+    _listPaginated(options = {}) {
+        const getPaginatedList = this._list.bind(this);
+        const paginatedListPromise = getPaginatedList(options);
+        async function* asyncGenerator() {
+            var _a;
+            let currentPage = await paginatedListPromise;
+            yield* currentPage.items;
+            const offset = (_a = options.offset) !== null && _a !== void 0 ? _a : 0;
+            const limit = Math.min(options.limit || currentPage.total, currentPage.total);
+            let currentOffset = offset + currentPage.items.length;
+            let remainingItems = Math.min(currentPage.total - offset, limit) - currentPage.items.length;
+            while (currentPage.items.length > 0 && // Continue only if at least some items were returned in the last page.
+                remainingItems > 0) {
+                const newOptions = { ...options, limit: remainingItems, offset: currentOffset };
+                currentPage = await getPaginatedList(newOptions);
+                yield* currentPage.items;
+                currentOffset += currentPage.items.length;
+                remainingItems -= currentPage.items.length;
+            }
+        }
+        return Object.defineProperty(paginatedListPromise, Symbol.asyncIterator, {
+            value: asyncGenerator,
+        });
+    }
     async _create(resource) {
         const response = await this.httpClient.call({
             url: this._url(),

package/dist/base/resource_collection_client.js.map

@@ -1 +1 @@
-{"version":3,"file":"resource_collection_client.js","sourceRoot":"","sources":["../../src/base/resource_collection_client.ts"],"names":[],"mappings":";;;AAAA,oCAAsD;AACtD,6CAAyC;AAEzC;;;GAGG;AACH,MAAa,wBAAyB,SAAQ,sBAAS;IACnD;;OAEG;IACO,KAAK,CAAC,KAAK,CAAO,UAAa,EAAO;QAC5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE;YAChB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;SAChC,CAAC,CAAC;QACH,OAAO,IAAA,uBAAe,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAM,CAAC;IAC1D,CAAC;IAES,KAAK,CAAC,OAAO,CAAO,QAAW;QACrC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE;YAChB,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE;YACtB,IAAI,EAAE,QAAQ;SACjB,CAAC,CAAC;QACH,OAAO,IAAA,uBAAe,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAM,CAAC;IAC1D,CAAC;IAES,KAAK,CAAC,YAAY,CAAO,IAAa,EAAE,QAAY;QAC1D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE;YAChB,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC;YAC9B,IAAI,EAAE,QAAQ;SACjB,CAAC,CAAC;QACH,OAAO,IAAA,uBAAe,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAM,CAAC;IAC1D,CAAC;CACJ;AAhCD,4DAgCC"}
+{"version":3,"file":"resource_collection_client.js","sourceRoot":"","sources":["../../src/base/resource_collection_client.ts"],"names":[],"mappings":";;;AACA,oCAAsD;AACtD,6CAAyC;AAEzC;;;GAGG;AACH,MAAa,wBAAyB,SAAQ,sBAAS;IACnD;;OAEG;IACO,KAAK,CAAC,KAAK,CAAO,UAAa,EAAO;QAC5C,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE;YAChB,MAAM,EAAE,KAAK;YACb,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC;SAChC,CAAC,CAAC;QACH,OAAO,IAAA,uBAAe,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAM,CAAC;IAC1D,CAAC;IAED;;OAEG;IACO,cAAc,CACpB,UAAa,EAAO;QAEpB,MAAM,gBAAgB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAC/C,MAAM,oBAAoB,GAAG,gBAAgB,CAAO,OAAO,CAAC,CAAC;QAE7D,KAAK,SAAS,CAAC,CAAC,cAAc;;YAC1B,IAAI,WAAW,GAAG,MAAM,oBAAoB,CAAC;YAC7C,KAAK,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC;YACzB,MAAM,MAAM,GAAG,MAAA,OAAO,CAAC,MAAM,mCAAI,CAAC,CAAC;YACnC,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,WAAW,CAAC,KAAK,EAAE,WAAW,CAAC,KAAK,CAAC,CAAC;YAE9E,IAAI,aAAa,GAAG,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC;YACtD,IAAI,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,KAAK,GAAG,MAAM,EAAE,KAAK,CAAC,GAAG,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC;YAE5F,OACI,WAAW,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,IAAI,uEAAuE;gBACvG,cAAc,GAAG,CAAC,EACpB,CAAC;gBACC,MAAM,UAAU,GAAG,EAAE,GAAG,OAAO,EAAE,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,aAAa,EAAE,CAAC;gBAChF,WAAW,GAAG,MAAM,gBAAgB,CAAO,UAAU,CAAC,CAAC;gBACvD,KAAK,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC;gBACzB,aAAa,IAAI,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC;gBAC1C,cAAc,IAAI,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC;YAC/C,CAAC;QACL,CAAC;QAED,OAAO,MAAM,CAAC,cAAc,CAAC,oBAAoB,EAAE,MAAM,CAAC,aAAa,EAAE;YACrE,KAAK,EAAE,cAAc;SACxB,CAAgD,CAAC;IACtD,CAAC;IAES,KAAK,CAAC,OAAO,CAAO,QAAW;QACrC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE;YAChB,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,IAAI,CAAC,OAAO,EAAE;YACtB,IAAI,EAAE,QAAQ;SACjB,CAAC,CAAC;QACH,OAAO,IAAA,uBAAe,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAM,CAAC;IAC1D,CAAC;IAES,KAAK,CAAC,YAAY,CAAO,IAAa,EAAE,QAAY;QAC1D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;YACxC,GAAG,EAAE,IAAI,CAAC,IAAI,EAAE;YAChB,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,CAAC;YAC9B,IAAI,EAAE,QAAQ;SACjB,CAAC,CAAC;QACH,OAAO,IAAA,uBAAe,EAAC,IAAA,iBAAS,EAAC,QAAQ,CAAC,IAAI,CAAC,CAAM,CAAC;IAC1D,CAAC;CACJ;AAnED,4DAmEC"}