@redocly/cli 2.63.0 → 2.64.1

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

@@ -1,16 +1,21 @@
-// Ejected from @redocly/client-generator@0.6.0 — the built-in "typescript" generator.
+// Ejected from @redocly/client-generator@0.7.1 — 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`.
 import {
   type CodeSample,
+  type EmitOptions,
   type Generator,
+  GENERATOR_VERSION,
+  type GeneratedFile,
   type OperationModel,
   renderReferencePage,
   type SampleContext,
 } from '@redocly/client-generator';
+import { TELEMETRY_RUNTIME_SOURCE } from '@redocly/client-generator/runtime-sources';
 import { join } from 'node:path';
 
+import { HEADER } from './banner.ts';
 import { emitClientSingleFile, emitClientSplit, emitRuntimeFiles } from './client.ts';
 import { packageIdents } from './descriptor.ts';
 
@@ -29,6 +34,10 @@ export const typescriptGenerator: Generator = ({ model, output, outputMode, emit
     path: join(output.dir, 'runtime', name),
     content,
   }));
+  const telemetry: GeneratedFile[] = [];
+  if (emit.telemetry === 'on') {
+    telemetry.push(telemetryFile(output.dir, output.stem, emit));
+  }
   if (outputMode === 'split') {
     const { dir, stem } = output;
     const { entry, schemas } = emitClientSplit(model, emit, stem);
@@ -38,11 +47,28 @@ export const typescriptGenerator: Generator = ({ model, output, outputMode, emit
         : [{ path: join(dir, `${stem}.schemas.ts`), content: schemas }]),
       { path: output.path, content: entry },
       ...runtime,
+      ...telemetry,
     ];
   }
-  return [{ path: output.path, content: emitClientSingleFile(model, emit) }, ...runtime];
+  return [
+    { path: output.path, content: emitClientSingleFile(model, emit) },
+    ...runtime,
+    ...telemetry,
+  ];
 };
 
+function telemetryFile(dir: string, stem: string, emit: EmitOptions): GeneratedFile {
+  const clientModule = `./${stem}.${emit.importExt ?? 'js'}`;
+  const content = TELEMETRY_RUNTIME_SOURCE.replace(
+    "from '../../../runtime-contract.js';",
+    () => `from '${clientModule}';`
+  ).replace(
+    "const GENERATOR_VERSION: string = 'dev';",
+    () => `const GENERATOR_VERSION: string = '${GENERATOR_VERSION}';`
+  );
+  return { path: join(dir, `${stem}.telemetry.ts`), content: `${HEADER}\n\n${content}` };
+}
+
 /**
  * The client's own reference page, written when `client.docs` is on. Its snippets come from
  * `typescriptSample` below, so the page shows the calling convention this run generated —
@@ -97,5 +123,5 @@ export default {
   run: typescriptGenerator,
   sample: typescriptSample,
   docs: typescriptDocs,
-  requiresGenerator: '^0.6.0',
+  requiresGenerator: '^0.7.1',
 };

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

@@ -1,4 +1,4 @@
-// Ejected from @redocly/client-generator@0.6.0 — the built-in "typescript" generator.
+// Ejected from @redocly/client-generator@0.7.1 — 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.6.0 — the built-in "typescript" generator.
+// Ejected from @redocly/client-generator@0.7.1 — 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.6.0 — the built-in "typescript" generator.
+// Ejected from @redocly/client-generator@0.7.1 — 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.6.0 — the built-in "typescript" generator.
+// Ejected from @redocly/client-generator@0.7.1 — 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.6.0 — the built-in "typescript" generator.
+// Ejected from @redocly/client-generator@0.7.1 — 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.6.0 — the built-in "typescript" generator.
+// Ejected from @redocly/client-generator@0.7.1 — 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.6.0 — the built-in "typescript" generator.
+// Ejected from @redocly/client-generator@0.7.1 — 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.6.0 — the built-in "zod" generator.
+// Ejected from @redocly/client-generator@0.7.1 — 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.6.0',
+  requiresGenerator: '^0.7.1',
 };

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

@@ -1,4 +1,4 @@
-// Ejected from @redocly/client-generator@0.6.0 — the built-in "zod" generator.
+// Ejected from @redocly/client-generator@0.7.1 — 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/typescript-generator/SKILL.md

@@ -17,6 +17,10 @@ operation, and the runtime — embedded in the file (`runtime: inline`, the defa
 written as real modules in a `runtime/` folder beside it that the client imports
 relatively (`runtime: module`).
 
+With `client.telemetry: on`, it also writes `<stem>.telemetry.ts`: the usage telemetry
+middleware. The module exports `telemetry()` and `flush()`, and the application registers
+it with `use(telemetry({ sdkName, sdkVersion, client }))`.
+
 ## Design decisions that must hold
 
 - **Descriptor-driven:** generated code is DATA (`OPERATIONS` + `Ops`) plus wiring;
@@ -61,6 +65,18 @@ relatively (`runtime: module`).
   derives, boundary included), `send()` sets the operation's declared content type only
   when the caller set none, the same rule the JSON branch already follows. A forwarded
   multipart boundary therefore survives, and a binary upload is never sent untyped.
+- **`onSettled` sees every sent call once.** `send()` calls it after the last attempt
+  with the final response, the error, or both, the attempt count, and the duration from
+  the first attempt to the end of the `onResponse` hooks on the final response. A call
+  that fails in `onRequest` or in body serialization does not reach it. A call whose
+  signal is already aborted reaches it with 0 attempts.
+  Every hook runs. The first hook error rejects a successful call; on a failed call, the
+  original error wins.
+- **Telemetry is opt-in at generation time.** Without `telemetry: on`, the output holds
+  no telemetry code, and the client file does not change. An event holds only the
+  operation id, the counts, the window, and the SDK identity. The kill switches and a
+  browser turn the middleware off. The module embeds on its own, not in
+  `RUNTIME_SOURCES`, so `telemetry` and `flush` never become reserved names of a client.
 - **Throw mode returns the body**; `{ envelope: true }` opts into
   `{ data, headers, response }` with typed declared headers. Result mode returns
   `{ data, error, response }` and ignores `envelope`.
@@ -82,6 +98,9 @@ inside the package and reach the generator through
 `@redocly/client-generator/runtime-sources` (in this repo they live in `runtime/` beside
 these files). Naming and string escaping live in the TypeScript printer
 (`@redocly/client-generator/printers/typescript`).
+The telemetry middleware ships the same way, as `TELEMETRY_RUNTIME_SOURCE` (in this repo
+it lives in `telemetry/`); `index.ts` writes it with the contract import pointed at the
+client entry and the generator version baked in.
 
 ## Ejecting it