@zapier/kitcore 0.7.0 → 0.8.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @zapier/kitcore
 
+## 0.8.0
+
+### Minor Changes
+
+- cec12cd: Added `concatLists`, which lists one page of several paginated lists joined end to end, returning a plain promise of `{ data, nextCursor }`. Pass a page's `nextCursor` to a fresh call to resume the concatenation.
+
+  Deprecated `concatPaginated` in favor of `concatLists`. It now delegates to `concatLists` and logs a deprecation warning; awaiting it yields the same page, but the page-iterable half of its old return shape is removed.
+
+- 769751e: Paginated list results now expose `.pages()`, a plain async iterable over pages. Unlike iterating the result directly (which still works but is deprecated), `.pages()` is not also a promise, so returning it from an `async` function no longer silently collapses it to the first page. `.items()` is unchanged and remains the way to iterate individual items across pages. The `toIterable()` helper is deprecated in favor of `.pages()` and now logs a deprecation warning.
+
 ## 0.7.0
 
 ### Minor Changes

package/dist/index.cjs

@@ -31,6 +31,7 @@ __export(index_exports, {
   CoreSignal: () => CoreSignal,
   addPlugin: () => addPlugin,
   composePlugins: () => composePlugins,
+  concatLists: () => concatLists,
   concatPaginated: () => concatPaginated,
   coreOptionsPluginRef: () => coreOptionsPluginRef,
   createAsyncContext: () => createAsyncContext,
@@ -544,53 +545,49 @@ function decodeConcatCursor(incoming) {
   }
   return { index: 0, cursor: incoming };
 }
-function concatPaginated({
+async function concatLists({
   sources,
   pageSize = 100,
   cursor
 }) {
   if (sources.length === 0) {
-    const empty = { data: [] };
-    return Object.assign(Promise.resolve(empty), {
-      [Symbol.asyncIterator]: async function* () {
-        yield empty;
-      }
-    });
+    return { data: [] };
   }
   const pageFunction = async (options) => {
-    let { index, cursor: sourceCursor } = decodeConcatCursor(options.cursor);
+    let { index, cursor: listCursor } = decodeConcatCursor(options.cursor);
     while (index < sources.length) {
-      const page = await sources[index]({ cursor: sourceCursor });
-      const hasMoreInSource = page.nextCursor != null;
-      if (page.data.length === 0 && !hasMoreInSource) {
+      const page = await sources[index]({ cursor: listCursor });
+      const hasMoreInList = page.nextCursor != null;
+      if (page.data.length === 0 && !hasMoreInList) {
         index++;
-        sourceCursor = void 0;
+        listCursor = void 0;
         continue;
       }
       return {
         data: page.data,
-        nextCursor: hasMoreInSource ? encodeConcatCursor(index, page.nextCursor) : index < sources.length - 1 ? encodeConcatCursor(index + 1, void 0) : void 0
+        nextCursor: hasMoreInList ? encodeConcatCursor(index, page.nextCursor) : index < sources.length - 1 ? encodeConcatCursor(index + 1, void 0) : void 0
       };
     }
     return { data: [] };
   };
-  const iterator = paginateBuffered(pageFunction, { pageSize, cursor });
-  const firstPagePromise = iterator.next().then((result) => {
-    if (result.done) {
-      return { data: [] };
-    }
-    return result.value;
-  });
-  return Object.assign(firstPagePromise, {
-    [Symbol.asyncIterator]: async function* () {
-      yield await firstPagePromise;
-      for await (const page of { [Symbol.asyncIterator]: () => iterator }) {
-        yield page;
-      }
-    }
-  });
+  const result = await paginateBuffered(pageFunction, {
+    pageSize,
+    cursor
+  }).next();
+  return result.done ? { data: [] } : result.value;
+}
+function concatPaginated({
+  sources,
+  pageSize,
+  cursor
+}) {
+  logDeprecation("concatPaginated() is deprecated. Use concatLists() instead.");
+  return concatLists({ sources, pageSize, cursor });
 }
 function toIterable(source) {
+  logDeprecation(
+    "toIterable() is deprecated. Call .pages() on the paginated result instead."
+  );
   return { [Symbol.asyncIterator]: () => source[Symbol.asyncIterator]() };
 }
 
@@ -943,6 +940,13 @@ function createPaginatedFunction(coreFn, options) {
             [Symbol.asyncIterator]() {
               return pageStream;
             },
+            pages: function() {
+              return {
+                [Symbol.asyncIterator]() {
+                  return pageStream;
+                }
+              };
+            },
             items: function() {
               return {
                 [Symbol.asyncIterator]: async function* () {
@@ -3766,6 +3770,7 @@ function openEnum(values, description) {
   CoreSignal,
   addPlugin,
   composePlugins,
+  concatLists,
   concatPaginated,
   coreOptionsPluginRef,
   createAsyncContext,