@redocly/cli 2.62.2 → 2.63.0

package/lib/eject-assets/generators/tanstack-query/render.ts

@@ -1,4 +1,4 @@
-// Ejected from @redocly/client-generator@0.5.3 — the built-in "tanstack-query" generator.
+// Ejected from @redocly/client-generator@0.6.0 — the built-in "tanstack-query" generator.
 // This file is yours: edit freely; the generated client stays machine-owned and is
 // rebuilt by `redocly generate-client`. Newer generator versions merge in with
 // `redocly eject-generator tanstack-query --update`.
@@ -11,7 +11,7 @@
 // `<op>InfiniteOptions(vars, init?)` with `initialPageParam`/`getNextPageParam` compiled
 // from the pagination rule's JSON pointers. Per mutation: `<op>Mutation(init?)`. Calls go
 // through the client instance's methods, which take one input object in either
-// `--args-style`; only the infinite query's cursor override differs between them.
+// `--args-style`; only the infinite query's page-param override differs between them.
 //
 // The factory bodies are authored as source text — the emitted module verbatim
 // and normalizes everything to the printer's canonical style. Every interpolated piece
@@ -58,6 +58,7 @@ export function renderTanstackModule(model: ApiModel, opts: TanstackOptions): st
   const pagination = opts.pagination ?? new Map();
   const source = [
     importHeader(ops, opts, pagination),
+    ...(ops.some((op) => isBodyLinkInfinite(op, pagination)) ? [NEXT_LINK_QUERY] : []),
     ...ops.filter(isQuery).map((op) => queryKeySource(op, opts.queryKeyPrefix)),
     factoriesSource(model, ops, pagination, opts.queryKeyPrefix, opts.argsStyle),
     ...defaultBindings(ops, pagination),
@@ -69,14 +70,36 @@ export function renderTanstackModule(model: ApiModel, opts: TanstackOptions): st
  * Whether the op gets an `<op>InfiniteOptions` factory: a paginated query operation.
  * `link`-style pagination is excluded — its next page lives in the `Link` response
  * HEADER, which a TanStack `queryFn` (body-only) cannot see; use the sdk's
- * `.pages()`/`.items()` iterators for those operations instead.
+ * `.pages()`/`.items()` iterators for those operations instead. `body-link` qualifies
+ * when the operation has a query parameter to carry the link's parameters.
  */
 function isInfinite(op: OperationModel, pagination: ModelPagination): boolean {
   if (!isQuery(op)) return false;
   const paginated = pagination.get(op.name);
-  return paginated !== undefined && paginated.spec.style !== 'link';
+  if (paginated === undefined || paginated.spec.style === 'link') return false;
+  return paginated.spec.style !== 'body-link' || op.queryParams.length > 0;
 }
 
+/** A query op whose `body-link` pagination gets an `<op>InfiniteOptions` factory. */
+function isBodyLinkInfinite(op: OperationModel, pagination: ModelPagination): boolean {
+  return isInfinite(op, pagination) && pagination.get(op.name)?.spec.style === 'body-link';
+}
+
+/**
+ * The module-private helper a body-link `queryFn` merges the next page's query
+ * parameters with, the way the sdk's link iterator does: a repeated key becomes an array.
+ */
+const NEXT_LINK_QUERY =
+  '/** The query parameters of a next-page link; a repeated key becomes an array. */\n' +
+  'const nextLinkQuery = (link: string) => {\n' +
+  '    const query: Record<string, string | string[]> = {};\n' +
+  '    for (const [key, value] of new URL(link, "http://relative.invalid").searchParams) {\n' +
+  '        const seen = query[key];\n' +
+  '        query[key] = seen === undefined ? value : Array.isArray(seen) ? [...seen, value] : [seen, value];\n' +
+  '    }\n' +
+  '    return query;\n' +
+  '};';
+
 /**
  * The import header: the option helpers from `@tanstack/${framework}-query` (only the
  * ones used), then the sdk's `client` instance plus the referenced types.
@@ -133,9 +156,9 @@ function factoriesSource(
 ): string {
   const members = ops.flatMap((op) => {
     if (!isQuery(op)) return [mutationMember(op, prefix)];
-    const paginated = pagination.get(op.name);
-    return paginated !== undefined && paginated.spec.style !== 'link'
-      ? [optionsMember(op), infiniteMember(model, op, paginated.spec, argsStyle)]
+    const spec = pagination.get(op.name)?.spec;
+    return spec !== undefined && spec.style !== 'link' && isInfinite(op, pagination)
+      ? [optionsMember(op), infiniteMember(model, op, spec, argsStyle)]
       : [optionsMember(op)];
   });
   return (
@@ -179,7 +202,8 @@ function mutationMember(op: OperationModel, prefix: string | undefined): string
  * page param rides the rule's advance query parameter, `initialPageParam` resumes from
  * the caller's own value, and `getNextPageParam` mirrors the runtime iterators' stop
  * conditions (cursor: absent/`null`/`''`, plus the optional `hasMore === false`;
- * offset/page: an empty items page).
+ * offset/page: an empty items page). A body link is the page param itself: the first
+ * page sends `vars` as given, later pages merge the link's query parameters over them.
  */
 function infiniteMember(
   model: ApiModel,
@@ -188,6 +212,29 @@ function infiniteMember(
   argsStyle: TanstackOptions['argsStyle']
 ): string {
   const { params, keyArg } = varsPieces(op);
+  if (spec.style === 'body-link') {
+    const merged =
+      argsStyle === 'flat'
+        ? '{ ...vars, ...nextLinkQuery(pageParam) }'
+        : '{ ...vars, query: { ...vars.query, ...nextLinkQuery(pageParam) } }';
+    const pointer = spec.nextLink;
+    const checks = cursorStopChecks(model, op, pointer);
+    const next =
+      checks.length === 0
+        ? `            return lastPage${pointerChain(pointer)};\n`
+        : `            const next = lastPage${pointerChain(pointer)};\n` +
+          `            return ${checks.join(' || ')} ? undefined : next;\n`;
+    return (
+      `    ${op.name}InfiniteOptions: (${params}) => infiniteQueryOptions({\n` +
+      `        queryKey: [...${op.name}QueryKey(${keyArg}), "infinite"] as const,\n` +
+      `        queryFn: ({ pageParam, signal }) => instance.${op.name}(pageParam === undefined ? vars : ${merged} as ${variablesName(op)}, { ...init, signal, envelope: undefined }),\n` +
+      `        initialPageParam: undefined as string | undefined,\n` +
+      `        getNextPageParam: (lastPage) => {\n` +
+      next +
+      `        },\n` +
+      `    })`
+    );
+  }
   // The cursor is a query parameter, so it lands in the sdk's own spelling for one:
   // inside the `query` layer, or at the top level of a merged call.
   const cursor = safeIdent(spec.param);
@@ -208,7 +255,7 @@ function infiniteMember(
 function nextPageSource(
   model: ApiModel,
   op: OperationModel,
-  spec: Exclude<PaginationSpec, { style: 'link' }>,
+  spec: Exclude<PaginationSpec, { style: 'link' | 'body-link' }>,
   argsStyle: TanstackOptions['argsStyle']
 ): string {
   const advance = paramsAccess(spec.param);

package/lib/eject-assets/generators/transformers/index.ts

@@ -1,4 +1,4 @@
-// Ejected from @redocly/client-generator@0.5.3 — the built-in "transformers" generator.
+// Ejected from @redocly/client-generator@0.6.0 — the built-in "transformers" generator.
 // This file is yours: edit freely; the generated client stays machine-owned and is
 // rebuilt by `redocly generate-client`. Newer generator versions merge in with
 // `redocly eject-generator transformers --update`.
@@ -42,5 +42,5 @@ export default {
   run: transformersGenerator,
   requires: ["typescript"],
   dateTypes: ["Date"],
-  requiresGenerator: '^0.5.3',
+  requiresGenerator: '^0.6.0',
 };

package/lib/eject-assets/generators/transformers/render.ts

@@ -1,4 +1,4 @@
-// Ejected from @redocly/client-generator@0.5.3 — the built-in "transformers" generator.
+// Ejected from @redocly/client-generator@0.6.0 — the built-in "transformers" generator.
 // This file is yours: edit freely; the generated client stays machine-owned and is
 // rebuilt by `redocly generate-client`. Newer generator versions merge in with
 // `redocly eject-generator transformers --update`.

package/lib/eject-assets/generators/typescript/banner.ts

@@ -1,4 +1,4 @@
-// Ejected from @redocly/client-generator@0.5.3 — the built-in "typescript" generator.
+// Ejected from @redocly/client-generator@0.6.0 — the built-in "typescript" generator.
 // This file is yours: edit freely; the generated client stays machine-owned and is
 // rebuilt by `redocly generate-client`. Newer generator versions merge in with
 // `redocly eject-generator typescript --update`.

package/lib/eject-assets/generators/typescript/client.ts

@@ -1,4 +1,4 @@
-// Ejected from @redocly/client-generator@0.5.3 — the built-in "typescript" generator.
+// Ejected from @redocly/client-generator@0.6.0 — the built-in "typescript" generator.
 // This file is yours: edit freely; the generated client stays machine-owned and is
 // rebuilt by `redocly generate-client`. Newer generator versions merge in with
 // `redocly eject-generator typescript --update`.

package/lib/eject-assets/generators/typescript/descriptor.ts

@@ -1,4 +1,4 @@
-// Ejected from @redocly/client-generator@0.5.3 — the built-in "typescript" generator.
+// Ejected from @redocly/client-generator@0.6.0 — the built-in "typescript" generator.
 // This file is yours: edit freely; the generated client stays machine-owned and is
 // rebuilt by `redocly generate-client`. Newer generator versions merge in with
 // `redocly eject-generator typescript --update`.

package/lib/eject-assets/generators/typescript/index.ts

@@ -1,4 +1,4 @@
-// Ejected from @redocly/client-generator@0.5.3 — the built-in "typescript" generator.
+// Ejected from @redocly/client-generator@0.6.0 — the built-in "typescript" generator.
 // This file is yours: edit freely; the generated client stays machine-owned and is
 // rebuilt by `redocly generate-client`. Newer generator versions merge in with
 // `redocly eject-generator typescript --update`.
@@ -97,5 +97,5 @@ export default {
   run: typescriptGenerator,
   sample: typescriptSample,
   docs: typescriptDocs,
-  requiresGenerator: '^0.5.3',
+  requiresGenerator: '^0.6.0',
 };

package/lib/eject-assets/generators/typescript/inline-runtime.ts

@@ -1,4 +1,4 @@
-// Ejected from @redocly/client-generator@0.5.3 — the built-in "typescript" generator.
+// Ejected from @redocly/client-generator@0.6.0 — the built-in "typescript" generator.
 // This file is yours: edit freely; the generated client stays machine-owned and is
 // rebuilt by `redocly generate-client`. Newer generator versions merge in with
 // `redocly eject-generator typescript --update`.

package/lib/eject-assets/generators/typescript/operation-signature.ts

@@ -1,4 +1,4 @@
-// Ejected from @redocly/client-generator@0.5.3 — the built-in "typescript" generator.
+// Ejected from @redocly/client-generator@0.6.0 — the built-in "typescript" generator.
 // This file is yours: edit freely; the generated client stays machine-owned and is
 // rebuilt by `redocly generate-client`. Newer generator versions merge in with
 // `redocly eject-generator typescript --update`.

package/lib/eject-assets/generators/typescript/operation-types.ts

@@ -1,4 +1,4 @@
-// Ejected from @redocly/client-generator@0.5.3 — the built-in "typescript" generator.
+// Ejected from @redocly/client-generator@0.6.0 — the built-in "typescript" generator.
 // This file is yours: edit freely; the generated client stays machine-owned and is
 // rebuilt by `redocly generate-client`. Newer generator versions merge in with
 // `redocly eject-generator typescript --update`.

package/lib/eject-assets/generators/typescript/operations.ts

@@ -1,4 +1,4 @@
-// Ejected from @redocly/client-generator@0.5.3 — the built-in "typescript" generator.
+// Ejected from @redocly/client-generator@0.6.0 — the built-in "typescript" generator.
 // This file is yours: edit freely; the generated client stays machine-owned and is
 // rebuilt by `redocly generate-client`. Newer generator versions merge in with
 // `redocly eject-generator typescript --update`.

package/lib/eject-assets/generators/typescript/response-headers.ts

@@ -1,4 +1,4 @@
-// Ejected from @redocly/client-generator@0.5.3 — the built-in "typescript" generator.
+// Ejected from @redocly/client-generator@0.6.0 — the built-in "typescript" generator.
 // This file is yours: edit freely; the generated client stays machine-owned and is
 // rebuilt by `redocly generate-client`. Newer generator versions merge in with
 // `redocly eject-generator typescript --update`.

package/lib/eject-assets/generators/typescript/type-guards.ts

@@ -1,4 +1,4 @@
-// Ejected from @redocly/client-generator@0.5.3 — the built-in "typescript" generator.
+// Ejected from @redocly/client-generator@0.6.0 — the built-in "typescript" generator.
 // This file is yours: edit freely; the generated client stays machine-owned and is
 // rebuilt by `redocly generate-client`. Newer generator versions merge in with
 // `redocly eject-generator typescript --update`.

package/lib/eject-assets/generators/typescript/types.ts

@@ -1,4 +1,4 @@
-// Ejected from @redocly/client-generator@0.5.3 — the built-in "typescript" generator.
+// Ejected from @redocly/client-generator@0.6.0 — the built-in "typescript" generator.
 // This file is yours: edit freely; the generated client stays machine-owned and is
 // rebuilt by `redocly generate-client`. Newer generator versions merge in with
 // `redocly eject-generator typescript --update`.

package/lib/eject-assets/generators/zod/index.ts

@@ -1,4 +1,4 @@
-// Ejected from @redocly/client-generator@0.5.3 — the built-in "zod" generator.
+// Ejected from @redocly/client-generator@0.6.0 — the built-in "zod" generator.
 // This file is yours: edit freely; the generated client stays machine-owned and is
 // rebuilt by `redocly generate-client`. Newer generator versions merge in with
 // `redocly eject-generator zod --update`.
@@ -28,5 +28,5 @@ export const zodGenerator: Generator = ({ model, output, banner }) => {
 export default {
   name: 'zod',
   run: zodGenerator,
-  requiresGenerator: '^0.5.3',
+  requiresGenerator: '^0.6.0',
 };

package/lib/eject-assets/generators/zod/schemas.ts

@@ -1,4 +1,4 @@
-// Ejected from @redocly/client-generator@0.5.3 — the built-in "zod" generator.
+// Ejected from @redocly/client-generator@0.6.0 — the built-in "zod" generator.
 // This file is yours: edit freely; the generated client stays machine-owned and is
 // rebuilt by `redocly generate-client`. Newer generator versions merge in with
 // `redocly eject-generator zod --update`.

package/lib/eject-assets/skills/tanstack-query-generator/SKILL.md

@@ -21,8 +21,11 @@ query keys. One generator, four framework variants (`react` default, `-vue`,
 - **Options factories, not hooks:** consumers call `useQuery(<op>Options(...))`, so the
   output works with any of the framework adapters and stays testable.
 - **`queryKeyPrefix`** namespaces every key when several clients share a cache.
-- **Infinite queries** derive `getNextPageParam` from the resolved pagination rule; a
-  `link`-style rule reads the `Link` header the descriptor declares.
+- **Infinite queries** derive `getNextPageParam` from the resolved pagination rule. A
+  `body-link` rule gets one when the operation has a query parameter: the next page's
+  URL is the page param, and each later page merges the URL's query parameters over
+  `vars`. A `Link` header is invisible to a `queryFn`, so `link`-style operations get
+  only the sdk's `.pages()`/`.items()`.
 - **`envelope` is excluded and stripped** — cached data is the plain body.
 - Requires `typescript`; throw-mode only (it wraps thrown errors into query errors).
 

package/lib/eject-assets/skills/typescript-generator/SKILL.md

@@ -26,6 +26,11 @@ relatively (`runtime: module`).
   an entry that `export *`s it; the entry type-imports only the schema names it
   references (`collectEntrySchemaRefs`).
 - **Zero runtime dependencies.** `Date`, `Blob`, `fetch` — nothing else.
+- **Timeouts need no platform statics.** `send()` uses `AbortSignal.timeout()` and
+  `AbortSignal.any()` where they exist and builds the same signal from an `AbortController`
+  and `setTimeout` where they do not (Chrome before 116, Safari before 17.4, Firefox before
+  124). A timed-out attempt is recognized by its own timeout signal having fired, never by
+  the abort reason's name, because Chrome 103 to 123 abort a timeout with `AbortError`.
 - **Names are collision-safe:** `packageIdents` seeds every reserved wiring name before
   any operation is sanitized, so renames are deterministic (`configure` → `configure_2`).
   A rename becomes part of the SDK's public API, so the warning must say WHICH cause it