@zapier/kitcore 0.7.0 → 0.8.0

package/dist/index.d.mts

@@ -20,27 +20,43 @@ interface SdkPage<T = unknown> {
     nextCursor?: string;
 }
 /**
- * Return type of every paginated SDK method. The same value is both:
+ * Return type of every paginated SDK method. The documented surface is:
  *
- *   - a Promise that resolves to the first page (`SdkPage<TItem>`), and
- *   - an AsyncIterable that yields each page in turn,
+ *   - `await` the result for the first page (`SdkPage<TItem>`),
+ *   - `.pages()` for an AsyncIterable over pages, and
+ *   - `.items()` for an AsyncIterable over individual items across pages.
  *
- * with an `.items()` method that returns an AsyncIterable over individual
- * items across all pages. Named so paginated plugin signatures serialize
- * as `PaginatedSdkResult<AppItem>` in `.d.ts` rather than expanding the
- * full triple-intersection at every callsite.
+ * `.pages()` and `.items()` return plain iterables (not thenables), so they
+ * survive being returned from an `async` function; the result itself is a
+ * thenable, so an `async` boundary silently collapses it to the first page.
+ * Named so paginated plugin signatures serialize as
+ * `PaginatedSdkResult<AppItem>` in `.d.ts` rather than expanding the full
+ * intersection at every callsite.
  *
  * The faces share one underlying cursor, so a result is consumed once:
  *
  *   - `await` / `.then()` read the buffered first page without starting the
  *     stream, so awaiting is a repeatable peek and you can still iterate the
  *     result afterward.
- *   - The page-iterable and `.items()` are two views over one page stream, so
- *     consuming either drains the other: the second view yields nothing (it
- *     does not replay page 1). To read a result more than once, call the
- *     method again for a fresh result.
+ *   - `.pages()`, `.items()`, and the deprecated bare iteration are views
+ *     over one page stream, so consuming any view drains the others: the
+ *     second view yields nothing (it does not replay page 1). To read a
+ *     result more than once, call the method again for a fresh result.
  */
-interface PaginatedSdkResult<TItem> extends Promise<SdkPage<TItem>>, AsyncIterable<SdkPage<TItem>> {
+interface PaginatedSdkResult<TItem> extends Promise<SdkPage<TItem>> {
+    /**
+     * @deprecated Iterate `.pages()` instead. Bare iteration works but is easy
+     * to break: because the result is also a thenable, an `async` boundary
+     * collapses it to its first page and the iterable is silently lost.
+     *
+     * Deliberately no runtime deprecation warning: this face is not scheduled
+     * for deletion (removing it is a breaking change deferred to a separate
+     * decision), and structural consumers such as the CLI's page streaming
+     * detect pagination via `Symbol.asyncIterator`, so a warning would fire on
+     * the SDK's own machinery.
+     */
+    [Symbol.asyncIterator](): AsyncIterator<SdkPage<TItem>>;
+    pages(): AsyncIterable<SdkPage<TItem>>;
     items(): AsyncIterable<TItem>;
 }
 type PaginatedSdkFunction<TOptions, TItem> = (options: TOptions) => PaginatedSdkResult<TItem>;
@@ -3376,41 +3392,54 @@ interface PaginatedResult<TItem> {
     nextCursor?: string;
 }
 /**
- * One page-at-a-time source for `concatPaginated`: called with that source's
- * own cursor, resolves one page. An SDK paginated method fits directly
- * (`({ cursor }) => sdk.listThings({ cursor })` — awaiting a paginated
+ * Supplies one list to `concatLists`: called with that list's own cursor,
+ * resolves one page. An SDK paginated method fits directly
+ * (`({ cursor }) => sdk.listThings({ cursor })`; awaiting a paginated
  * result yields the requested page).
  */
-type PaginatedSource<TItem> = (options: {
+type ListSource<TItem> = (options: {
     cursor?: string;
 }) => PromiseLike<PaginatedResult<TItem>>;
 /**
- * Concatenate multiple paginated sources into a single paginated stream.
- * Sources are drained in order, one page per underlying call.
+ * List one page of several paginated lists joined end to end. Lists are
+ * drained in order; pass a page's `nextCursor` back in to get the next page.
  *
- * Pagination is stateless: every outgoing cursor encodes which source to
- * resume plus that source's own cursor, so a fresh `concatPaginated` call
- * with `cursor` continues exactly where the previous page left off. Sources
- * must therefore produce disjoint items themselves; there is no cross-source
- * dedupe (an in-memory seen-set could not survive the cursor round-trip).
+ * Pagination is stateless: every outgoing cursor encodes which list to
+ * resume plus that list's own cursor, so a fresh `concatLists` call
+ * continues exactly where the previous page left off. A cursor stores its
+ * position by list index, so it is only valid while `sources` keeps the
+ * same lists in the same order. Lists must produce disjoint items
+ * themselves; there is no cross-list dedupe (an in-memory seen-set could
+ * not survive the cursor round-trip).
  *
- * Uses paginateBuffered internally to normalize page sizes across source
- * boundaries — e.g. if the first source only has 2 items, they'll be
- * buffered with items from the next source into a full page.
- *
- * The result is a thenable for the first page that also async-iterates
- * pages in-process.
+ * Uses paginateBuffered internally to normalize page sizes across list
+ * boundaries: if the first list only has 2 items, they'll be buffered with
+ * items from the next list into a full page.
+ */
+declare function concatLists<TItem>({ sources, pageSize, cursor, }: {
+    /** The lists to concatenate, each supplied as a page-fetching source. */
+    sources: ListSource<TItem>[];
+    pageSize?: number;
+    /** Cursor from a previous `concatLists` page; resumes there. */
+    cursor?: string;
+}): Promise<PaginatedResult<TItem>>;
+/**
+ * @deprecated Use {@link concatLists}; awaiting either yields the same one
+ * page. The page-iterable half of the old return shape is gone; to walk
+ * pages, pass each page's `nextCursor` to a fresh call.
  */
 declare function concatPaginated<TItem>({ sources, pageSize, cursor, }: {
-    sources: PaginatedSource<TItem>[];
+    sources: ListSource<TItem>[];
     pageSize?: number;
-    /** Cursor from a previous `concatPaginated` page; resumes the stream. */
     cursor?: string;
-}): PromiseLike<PaginatedResult<TItem>> & AsyncIterable<PaginatedResult<TItem>>;
+}): Promise<PaginatedResult<TItem>>;
 /**
  * Strip the PromiseLike from an async iterable, returning a plain
  * AsyncIterable. This prevents async functions from unwrapping the
  * iterable (since async only unwraps PromiseLike, not AsyncIterable).
+ *
+ * @deprecated Call `.pages()` on the paginated result instead; it returns a
+ * plain AsyncIterable over pages with no wrapper needed.
  */
 declare function toIterable<T>(source: AsyncIterable<T>): AsyncIterable<T>;
 
@@ -3495,4 +3524,4 @@ declare class CoreCancelledSignal extends CoreSignal {
     constructor(message?: string);
 }
 
-export { type AdaptError, type AdaptErrorOptions, type AdaptPage, type AggregatePlugin, type ArrayResolver$1 as ArrayResolver, type AsyncContext, type BoundFormatter, type BoundResolver, CONTEXT, CORE_ERROR_SYMBOL, CORE_OPTIONS_ID, CORE_SIGNAL_SYMBOL, type CategoryDefinition, type ConstantResolver$1 as ConstantResolver, type Controller, type ControllerAction, type ControllerAffordance, type ControllerAnswerFn, type ControllerChoice, type ControllerError, type ControllerIssue, type ControllerListingPage, type ControllerListingPosition, type ControllerMethodDescription, type ControllerMethodSummary, type ControllerPagination, type ControllerParameterDescription, type ControllerPath, type ControllerQuestion, type ControllerResult, type ControllerSdk, type ControllerSelectPage, type ControllerState, type CoreApiError, CoreCancelledSignal, CoreDisposeError, CoreError, CoreErrorCode, type CoreErrorOptions, type CoreOptions, CoreSignal, type CreateSdkOptions, type DeprecatedPromptConfigChoice, type DeprecationLogger, type DeprecationWarning, type DisposeFn, type DynamicListResolver, type DynamicMember, type DynamicResolver$1 as DynamicResolver, type DynamicSearchResolver, type FieldsResolver, type FormattedItem, type Formatter, type FunctionDeprecation, type FunctionRegistryEntry, type HookPlugin, type LeafMeta, type LeafSummary, type LegacyMergePlugin, type LegacyPlugin, type ListItemsResult, type ListPromptConfig, type MethodAttachment, type MethodHooks, type MethodOverridePlugin, type MethodPlugin, type MethodScope, type Resolver as ModelResolver, type OnMethodEnd, type OnMethodEndContext, type OnMethodStart, type OnMethodStartContext, type OutputFormatter, type PaginatedSdkFunction, type PaginatedSdkResult, type Plugin, type PluginMeta, type PluginProvides, type PluginStack, type PluginSummary, type PluginSurface, type PositionalMetadata, type PromptConfig, type PromptConfigChoice, type PropertyPlugin, type RegistryResult, type RequiredSdkOf, type Resolver$1 as Resolver, type ResolverConfig, type ResolverFieldItem, type ResolverMetadata, type ResolverPromptConfig, type ResolverType, type Sdk, type SdkContext, type SdkPage, type StaticResolver$1 as StaticResolver, type ValidResolvers, addPlugin, composePlugins, concatPaginated, coreOptionsPluginRef, createAsyncContext, createController, createCoreError, createCorePlugin, createDeprecationLogger, createFunction, createPaginatedFunction, createPaginatedPluginMethod, createPluginMethod, createPluginStack, createPrefixedCursor, createSdk, createValidator, dangerousContextPlugin, declareMethod, declareOptionalProperty, declarePlugin, declareProperty, decodeIncomingCursor, defaultLogDeprecation, defineFormatter, defineHook, defineLegacyMerge, defineMethod, defineMethodOverride, definePlugin, defineProperty, defineResolver, disposeSdk, fromFunctionPlugin, getContext, getCoreErrorCause, getCoreErrorCode, getCurrentDepth, getCurrentScope, getFieldDescriptions, getOutputSchema, getRegistryPlugin, getSchemaDescription, isCoreError, isCoreSignal, isNestedMethodCall, isPositional, isTelemetryNested, omitExports, openEnum, paginate, paginateBuffered, paginateMaxItems, resolvePlugin, runInMethodScope, runWithTelemetryContext, selectExports, splitPrefixedCursor, toIterable, toSnakeCase, toTitleCase, validateOptions, withOutputSchema, withPositional, withResolver };
+export { type AdaptError, type AdaptErrorOptions, type AdaptPage, type AggregatePlugin, type ArrayResolver$1 as ArrayResolver, type AsyncContext, type BoundFormatter, type BoundResolver, CONTEXT, CORE_ERROR_SYMBOL, CORE_OPTIONS_ID, CORE_SIGNAL_SYMBOL, type CategoryDefinition, type ConstantResolver$1 as ConstantResolver, type Controller, type ControllerAction, type ControllerAffordance, type ControllerAnswerFn, type ControllerChoice, type ControllerError, type ControllerIssue, type ControllerListingPage, type ControllerListingPosition, type ControllerMethodDescription, type ControllerMethodSummary, type ControllerPagination, type ControllerParameterDescription, type ControllerPath, type ControllerQuestion, type ControllerResult, type ControllerSdk, type ControllerSelectPage, type ControllerState, type CoreApiError, CoreCancelledSignal, CoreDisposeError, CoreError, CoreErrorCode, type CoreErrorOptions, type CoreOptions, CoreSignal, type CreateSdkOptions, type DeprecatedPromptConfigChoice, type DeprecationLogger, type DeprecationWarning, type DisposeFn, type DynamicListResolver, type DynamicMember, type DynamicResolver$1 as DynamicResolver, type DynamicSearchResolver, type FieldsResolver, type FormattedItem, type Formatter, type FunctionDeprecation, type FunctionRegistryEntry, type HookPlugin, type LeafMeta, type LeafSummary, type LegacyMergePlugin, type LegacyPlugin, type ListItemsResult, type ListPromptConfig, type MethodAttachment, type MethodHooks, type MethodOverridePlugin, type MethodPlugin, type MethodScope, type Resolver as ModelResolver, type OnMethodEnd, type OnMethodEndContext, type OnMethodStart, type OnMethodStartContext, type OutputFormatter, type PaginatedSdkFunction, type PaginatedSdkResult, type Plugin, type PluginMeta, type PluginProvides, type PluginStack, type PluginSummary, type PluginSurface, type PositionalMetadata, type PromptConfig, type PromptConfigChoice, type PropertyPlugin, type RegistryResult, type RequiredSdkOf, type Resolver$1 as Resolver, type ResolverConfig, type ResolverFieldItem, type ResolverMetadata, type ResolverPromptConfig, type ResolverType, type Sdk, type SdkContext, type SdkPage, type StaticResolver$1 as StaticResolver, type ValidResolvers, addPlugin, composePlugins, concatLists, concatPaginated, coreOptionsPluginRef, createAsyncContext, createController, createCoreError, createCorePlugin, createDeprecationLogger, createFunction, createPaginatedFunction, createPaginatedPluginMethod, createPluginMethod, createPluginStack, createPrefixedCursor, createSdk, createValidator, dangerousContextPlugin, declareMethod, declareOptionalProperty, declarePlugin, declareProperty, decodeIncomingCursor, defaultLogDeprecation, defineFormatter, defineHook, defineLegacyMerge, defineMethod, defineMethodOverride, definePlugin, defineProperty, defineResolver, disposeSdk, fromFunctionPlugin, getContext, getCoreErrorCause, getCoreErrorCode, getCurrentDepth, getCurrentScope, getFieldDescriptions, getOutputSchema, getRegistryPlugin, getSchemaDescription, isCoreError, isCoreSignal, isNestedMethodCall, isPositional, isTelemetryNested, omitExports, openEnum, paginate, paginateBuffered, paginateMaxItems, resolvePlugin, runInMethodScope, runWithTelemetryContext, selectExports, splitPrefixedCursor, toIterable, toSnakeCase, toTitleCase, validateOptions, withOutputSchema, withPositional, withResolver };

package/dist/index.d.ts

@@ -20,27 +20,43 @@ interface SdkPage<T = unknown> {
     nextCursor?: string;
 }
 /**
- * Return type of every paginated SDK method. The same value is both:
+ * Return type of every paginated SDK method. The documented surface is:
  *
- *   - a Promise that resolves to the first page (`SdkPage<TItem>`), and
- *   - an AsyncIterable that yields each page in turn,
+ *   - `await` the result for the first page (`SdkPage<TItem>`),
+ *   - `.pages()` for an AsyncIterable over pages, and
+ *   - `.items()` for an AsyncIterable over individual items across pages.
  *
- * with an `.items()` method that returns an AsyncIterable over individual
- * items across all pages. Named so paginated plugin signatures serialize
- * as `PaginatedSdkResult<AppItem>` in `.d.ts` rather than expanding the
- * full triple-intersection at every callsite.
+ * `.pages()` and `.items()` return plain iterables (not thenables), so they
+ * survive being returned from an `async` function; the result itself is a
+ * thenable, so an `async` boundary silently collapses it to the first page.
+ * Named so paginated plugin signatures serialize as
+ * `PaginatedSdkResult<AppItem>` in `.d.ts` rather than expanding the full
+ * intersection at every callsite.
  *
  * The faces share one underlying cursor, so a result is consumed once:
  *
  *   - `await` / `.then()` read the buffered first page without starting the
  *     stream, so awaiting is a repeatable peek and you can still iterate the
  *     result afterward.
- *   - The page-iterable and `.items()` are two views over one page stream, so
- *     consuming either drains the other: the second view yields nothing (it
- *     does not replay page 1). To read a result more than once, call the
- *     method again for a fresh result.
+ *   - `.pages()`, `.items()`, and the deprecated bare iteration are views
+ *     over one page stream, so consuming any view drains the others: the
+ *     second view yields nothing (it does not replay page 1). To read a
+ *     result more than once, call the method again for a fresh result.
  */
-interface PaginatedSdkResult<TItem> extends Promise<SdkPage<TItem>>, AsyncIterable<SdkPage<TItem>> {
+interface PaginatedSdkResult<TItem> extends Promise<SdkPage<TItem>> {
+    /**
+     * @deprecated Iterate `.pages()` instead. Bare iteration works but is easy
+     * to break: because the result is also a thenable, an `async` boundary
+     * collapses it to its first page and the iterable is silently lost.
+     *
+     * Deliberately no runtime deprecation warning: this face is not scheduled
+     * for deletion (removing it is a breaking change deferred to a separate
+     * decision), and structural consumers such as the CLI's page streaming
+     * detect pagination via `Symbol.asyncIterator`, so a warning would fire on
+     * the SDK's own machinery.
+     */
+    [Symbol.asyncIterator](): AsyncIterator<SdkPage<TItem>>;
+    pages(): AsyncIterable<SdkPage<TItem>>;
     items(): AsyncIterable<TItem>;
 }
 type PaginatedSdkFunction<TOptions, TItem> = (options: TOptions) => PaginatedSdkResult<TItem>;
@@ -3376,41 +3392,54 @@ interface PaginatedResult<TItem> {
     nextCursor?: string;
 }
 /**
- * One page-at-a-time source for `concatPaginated`: called with that source's
- * own cursor, resolves one page. An SDK paginated method fits directly
- * (`({ cursor }) => sdk.listThings({ cursor })` — awaiting a paginated
+ * Supplies one list to `concatLists`: called with that list's own cursor,
+ * resolves one page. An SDK paginated method fits directly
+ * (`({ cursor }) => sdk.listThings({ cursor })`; awaiting a paginated
  * result yields the requested page).
  */
-type PaginatedSource<TItem> = (options: {
+type ListSource<TItem> = (options: {
     cursor?: string;
 }) => PromiseLike<PaginatedResult<TItem>>;
 /**
- * Concatenate multiple paginated sources into a single paginated stream.
- * Sources are drained in order, one page per underlying call.
+ * List one page of several paginated lists joined end to end. Lists are
+ * drained in order; pass a page's `nextCursor` back in to get the next page.
  *
- * Pagination is stateless: every outgoing cursor encodes which source to
- * resume plus that source's own cursor, so a fresh `concatPaginated` call
- * with `cursor` continues exactly where the previous page left off. Sources
- * must therefore produce disjoint items themselves; there is no cross-source
- * dedupe (an in-memory seen-set could not survive the cursor round-trip).
+ * Pagination is stateless: every outgoing cursor encodes which list to
+ * resume plus that list's own cursor, so a fresh `concatLists` call
+ * continues exactly where the previous page left off. A cursor stores its
+ * position by list index, so it is only valid while `sources` keeps the
+ * same lists in the same order. Lists must produce disjoint items
+ * themselves; there is no cross-list dedupe (an in-memory seen-set could
+ * not survive the cursor round-trip).
  *
- * Uses paginateBuffered internally to normalize page sizes across source
- * boundaries — e.g. if the first source only has 2 items, they'll be
- * buffered with items from the next source into a full page.
- *
- * The result is a thenable for the first page that also async-iterates
- * pages in-process.
+ * Uses paginateBuffered internally to normalize page sizes across list
+ * boundaries: if the first list only has 2 items, they'll be buffered with
+ * items from the next list into a full page.
+ */
+declare function concatLists<TItem>({ sources, pageSize, cursor, }: {
+    /** The lists to concatenate, each supplied as a page-fetching source. */
+    sources: ListSource<TItem>[];
+    pageSize?: number;
+    /** Cursor from a previous `concatLists` page; resumes there. */
+    cursor?: string;
+}): Promise<PaginatedResult<TItem>>;
+/**
+ * @deprecated Use {@link concatLists}; awaiting either yields the same one
+ * page. The page-iterable half of the old return shape is gone; to walk
+ * pages, pass each page's `nextCursor` to a fresh call.
  */
 declare function concatPaginated<TItem>({ sources, pageSize, cursor, }: {
-    sources: PaginatedSource<TItem>[];
+    sources: ListSource<TItem>[];
     pageSize?: number;
-    /** Cursor from a previous `concatPaginated` page; resumes the stream. */
     cursor?: string;
-}): PromiseLike<PaginatedResult<TItem>> & AsyncIterable<PaginatedResult<TItem>>;
+}): Promise<PaginatedResult<TItem>>;
 /**
  * Strip the PromiseLike from an async iterable, returning a plain
  * AsyncIterable. This prevents async functions from unwrapping the
  * iterable (since async only unwraps PromiseLike, not AsyncIterable).
+ *
+ * @deprecated Call `.pages()` on the paginated result instead; it returns a
+ * plain AsyncIterable over pages with no wrapper needed.
  */
 declare function toIterable<T>(source: AsyncIterable<T>): AsyncIterable<T>;
 
@@ -3495,4 +3524,4 @@ declare class CoreCancelledSignal extends CoreSignal {
     constructor(message?: string);
 }
 
-export { type AdaptError, type AdaptErrorOptions, type AdaptPage, type AggregatePlugin, type ArrayResolver$1 as ArrayResolver, type AsyncContext, type BoundFormatter, type BoundResolver, CONTEXT, CORE_ERROR_SYMBOL, CORE_OPTIONS_ID, CORE_SIGNAL_SYMBOL, type CategoryDefinition, type ConstantResolver$1 as ConstantResolver, type Controller, type ControllerAction, type ControllerAffordance, type ControllerAnswerFn, type ControllerChoice, type ControllerError, type ControllerIssue, type ControllerListingPage, type ControllerListingPosition, type ControllerMethodDescription, type ControllerMethodSummary, type ControllerPagination, type ControllerParameterDescription, type ControllerPath, type ControllerQuestion, type ControllerResult, type ControllerSdk, type ControllerSelectPage, type ControllerState, type CoreApiError, CoreCancelledSignal, CoreDisposeError, CoreError, CoreErrorCode, type CoreErrorOptions, type CoreOptions, CoreSignal, type CreateSdkOptions, type DeprecatedPromptConfigChoice, type DeprecationLogger, type DeprecationWarning, type DisposeFn, type DynamicListResolver, type DynamicMember, type DynamicResolver$1 as DynamicResolver, type DynamicSearchResolver, type FieldsResolver, type FormattedItem, type Formatter, type FunctionDeprecation, type FunctionRegistryEntry, type HookPlugin, type LeafMeta, type LeafSummary, type LegacyMergePlugin, type LegacyPlugin, type ListItemsResult, type ListPromptConfig, type MethodAttachment, type MethodHooks, type MethodOverridePlugin, type MethodPlugin, type MethodScope, type Resolver as ModelResolver, type OnMethodEnd, type OnMethodEndContext, type OnMethodStart, type OnMethodStartContext, type OutputFormatter, type PaginatedSdkFunction, type PaginatedSdkResult, type Plugin, type PluginMeta, type PluginProvides, type PluginStack, type PluginSummary, type PluginSurface, type PositionalMetadata, type PromptConfig, type PromptConfigChoice, type PropertyPlugin, type RegistryResult, type RequiredSdkOf, type Resolver$1 as Resolver, type ResolverConfig, type ResolverFieldItem, type ResolverMetadata, type ResolverPromptConfig, type ResolverType, type Sdk, type SdkContext, type SdkPage, type StaticResolver$1 as StaticResolver, type ValidResolvers, addPlugin, composePlugins, concatPaginated, coreOptionsPluginRef, createAsyncContext, createController, createCoreError, createCorePlugin, createDeprecationLogger, createFunction, createPaginatedFunction, createPaginatedPluginMethod, createPluginMethod, createPluginStack, createPrefixedCursor, createSdk, createValidator, dangerousContextPlugin, declareMethod, declareOptionalProperty, declarePlugin, declareProperty, decodeIncomingCursor, defaultLogDeprecation, defineFormatter, defineHook, defineLegacyMerge, defineMethod, defineMethodOverride, definePlugin, defineProperty, defineResolver, disposeSdk, fromFunctionPlugin, getContext, getCoreErrorCause, getCoreErrorCode, getCurrentDepth, getCurrentScope, getFieldDescriptions, getOutputSchema, getRegistryPlugin, getSchemaDescription, isCoreError, isCoreSignal, isNestedMethodCall, isPositional, isTelemetryNested, omitExports, openEnum, paginate, paginateBuffered, paginateMaxItems, resolvePlugin, runInMethodScope, runWithTelemetryContext, selectExports, splitPrefixedCursor, toIterable, toSnakeCase, toTitleCase, validateOptions, withOutputSchema, withPositional, withResolver };
+export { type AdaptError, type AdaptErrorOptions, type AdaptPage, type AggregatePlugin, type ArrayResolver$1 as ArrayResolver, type AsyncContext, type BoundFormatter, type BoundResolver, CONTEXT, CORE_ERROR_SYMBOL, CORE_OPTIONS_ID, CORE_SIGNAL_SYMBOL, type CategoryDefinition, type ConstantResolver$1 as ConstantResolver, type Controller, type ControllerAction, type ControllerAffordance, type ControllerAnswerFn, type ControllerChoice, type ControllerError, type ControllerIssue, type ControllerListingPage, type ControllerListingPosition, type ControllerMethodDescription, type ControllerMethodSummary, type ControllerPagination, type ControllerParameterDescription, type ControllerPath, type ControllerQuestion, type ControllerResult, type ControllerSdk, type ControllerSelectPage, type ControllerState, type CoreApiError, CoreCancelledSignal, CoreDisposeError, CoreError, CoreErrorCode, type CoreErrorOptions, type CoreOptions, CoreSignal, type CreateSdkOptions, type DeprecatedPromptConfigChoice, type DeprecationLogger, type DeprecationWarning, type DisposeFn, type DynamicListResolver, type DynamicMember, type DynamicResolver$1 as DynamicResolver, type DynamicSearchResolver, type FieldsResolver, type FormattedItem, type Formatter, type FunctionDeprecation, type FunctionRegistryEntry, type HookPlugin, type LeafMeta, type LeafSummary, type LegacyMergePlugin, type LegacyPlugin, type ListItemsResult, type ListPromptConfig, type MethodAttachment, type MethodHooks, type MethodOverridePlugin, type MethodPlugin, type MethodScope, type Resolver as ModelResolver, type OnMethodEnd, type OnMethodEndContext, type OnMethodStart, type OnMethodStartContext, type OutputFormatter, type PaginatedSdkFunction, type PaginatedSdkResult, type Plugin, type PluginMeta, type PluginProvides, type PluginStack, type PluginSummary, type PluginSurface, type PositionalMetadata, type PromptConfig, type PromptConfigChoice, type PropertyPlugin, type RegistryResult, type RequiredSdkOf, type Resolver$1 as Resolver, type ResolverConfig, type ResolverFieldItem, type ResolverMetadata, type ResolverPromptConfig, type ResolverType, type Sdk, type SdkContext, type SdkPage, type StaticResolver$1 as StaticResolver, type ValidResolvers, addPlugin, composePlugins, concatLists, concatPaginated, coreOptionsPluginRef, createAsyncContext, createController, createCoreError, createCorePlugin, createDeprecationLogger, createFunction, createPaginatedFunction, createPaginatedPluginMethod, createPluginMethod, createPluginStack, createPrefixedCursor, createSdk, createValidator, dangerousContextPlugin, declareMethod, declareOptionalProperty, declarePlugin, declareProperty, decodeIncomingCursor, defaultLogDeprecation, defineFormatter, defineHook, defineLegacyMerge, defineMethod, defineMethodOverride, definePlugin, defineProperty, defineResolver, disposeSdk, fromFunctionPlugin, getContext, getCoreErrorCause, getCoreErrorCode, getCurrentDepth, getCurrentScope, getFieldDescriptions, getOutputSchema, getRegistryPlugin, getSchemaDescription, isCoreError, isCoreSignal, isNestedMethodCall, isPositional, isTelemetryNested, omitExports, openEnum, paginate, paginateBuffered, paginateMaxItems, resolvePlugin, runInMethodScope, runWithTelemetryContext, selectExports, splitPrefixedCursor, toIterable, toSnakeCase, toTitleCase, validateOptions, withOutputSchema, withPositional, withResolver };

package/dist/index.mjs

@@ -445,53 +445,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]() };
 }
 
@@ -846,6 +842,13 @@ function createPaginatedFunction(coreFn, options) {
             [Symbol.asyncIterator]() {
               return pageStream;
             },
+            pages: function() {
+              return {
+                [Symbol.asyncIterator]() {
+                  return pageStream;
+                }
+              };
+            },
             items: function() {
               return {
                 [Symbol.asyncIterator]: async function* () {
@@ -3668,6 +3671,7 @@ export {
   CoreSignal,
   addPlugin,
   composePlugins,
+  concatLists,
   concatPaginated,
   coreOptionsPluginRef,
   createAsyncContext,