@kubb/cli 5.0.0-beta.75 → 5.0.0-beta.76

package/LICENSE

@@ -1,14 +1,21 @@
-Copyright (c) 2026 Stijn Van Hulle
-
-This repository contains software under two licenses:
+MIT License
 
-1. Most of the code in this repository is licensed under the
-   MIT License — see licenses/LICENSE-MIT for the full license text.
+Copyright (c) 2026 Stijn Van Hulle
 
-2. The following components are licensed under the
-   GNU Affero General Public License v3.0 or later (AGPL-3.0-or-later)
-   — see licenses/LICENSE-AGPL-3.0 for the full license text:
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-   - packages/agent (published as @kubb/agent)
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-Each package's own LICENSE file or package.json specifies its applicable license.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,95 +1,215 @@
 <div align="center">
-  <h1>Kubb Cli</h1>
   <a href="https://kubb.dev" target="_blank" rel="noopener noreferrer">
-    <img width="180" src="https://raw.githubusercontent.com/kubb-labs/kubb/main/assets/logo.png" alt="Kubb logo">
+    <img src="https://kubb.dev/og.png" alt="Kubb banner">
   </a>
 
 [![npm version][npm-version-src]][npm-version-href]
 [![npm downloads][npm-downloads-src]][npm-downloads-href]
-[![Coverage][coverage-src]][coverage-href]
+[![Stars][stars-src]][stars-href]
 [![License][license-src]][license-href]
-[![Sponsors][sponsors-src]][sponsors-href]
+[![Node][node-src]][node-href]
 
 <h4>
-    <a href="https://codesandbox.io/s/github/kubb-labs/kubb/tree/main//examples/typescript" target="_blank">View Demo</a>
-    <span> · </span>
-      <a href="https://kubb.dev/" target="_blank">Documentation</a>
-    <span> · </span>
-      <a href="https://github.com/kubb-labs/kubb/issues/" target="_blank">Report Bug</a>
-    <span> · </span>
-      <a href="https://github.com/kubb-labs/kubb/issues/" target="_blank">Request Feature</a>
-  </h4>
+<a href="https://kubb.dev" target="_blank">Documentation</a>
+<span> · </span>
+<a href="https://github.com/kubb-labs/kubb/issues/" target="_blank">Report Bug</a>
+<span> · </span>
+<a href="https://github.com/kubb-labs/kubb/issues/" target="_blank">Request Feature</a>
+</h4>
 </div>
 
+<br />
+
+# @kubb/cli
+
+### The command-line interface for Kubb
+
+Official CLI for Kubb. Run `kubb generate` to produce TypeScript types, API clients, hooks, validators, and mocks.
+Includes interactive project setup (`kubb init`), spec validation, watch mode, and an MCP server.
+
+## Installation
+
+```bash
+bun add -D @kubb/cli
+# or
+pnpm add -D @kubb/cli
+# or
+npm install -D @kubb/cli
+```
+
 ## Commands
 
+- [`kubb init`](#kubb-init) — scaffold a new project
+- [`kubb generate`](#kubb-generate) — run code generation
+- [`kubb validate`](#kubb-validate) — validate an OpenAPI spec
+- [`kubb mcp`](#kubb-mcp) — start the MCP server for AI assistants
+
+---
+
 ### `kubb init`
 
-Initialize a new Kubb project with an interactive setup wizard.
+Scaffold a `kubb.config.ts` and install plugins for code generation from an OpenAPI spec. Run without flags for an interactive setup wizard, or pass flags to skip the prompts.
 
 ```bash
 npx kubb init
 ```
 
-Use the `-y` / `--yes` flag to skip all prompts and accept the defaults:
+#### Options
+
+| Flag               | Short | Type    | Default          | Description                                |
+| ------------------ | ----- | ------- | ---------------- | ------------------------------------------ |
+| `--yes`            | `-y`  | boolean | `false`          | Skip all prompts and use defaults          |
+| `--input <path>`   | `-i`  | string  | `./openapi.yaml` | Path to the OpenAPI specification          |
+| `--output <path>`  | `-o`  | string  | `./src/gen`      | Output directory for generated files       |
+| `--plugins <list>` |       | string  |                  | Comma-separated list of plugins to install |
+
+Available plugin values for `--plugins`: `plugin-ts`, `plugin-axios`, `plugin-fetch`, `plugin-react-query`, `plugin-vue-query`, `plugin-zod`, `plugin-faker`, `plugin-msw`, `plugin-cypress`, `plugin-mcp`, `plugin-redoc`.
+
+#### Examples
 
 ```bash
-npx kubb init -y
-```
+# Interactive wizard
+npx kubb init
 
-Defaults when using `-y`:
+# Accept all defaults
+npx kubb init --yes
 
-- Input path: `./openapi.yaml`
-- Output path: `./src/gen`
-- Plugins: OpenAPI Parser + TypeScript
+# Fully non-interactive
+npx kubb init --input ./openapi.yaml --output ./src/gen --plugins plugin-ts,plugin-zod
+
+# Select specific plugins only
+npx kubb init --plugins plugin-ts,plugin-axios,plugin-react-query
+```
 
-This command will:
+The wizard will:
 
-1. Detect or create a `package.json` if it doesn't exist
-2. Prompt you for your OpenAPI specification path (default: `./openapi.yaml`)
-3. Ask for the output directory for generated files (default: `./src/gen`)
-4. Let you select which Kubb plugins to use (default: OpenAPI Parser + TypeScript)
+1. Detect or create a `package.json` if one does not exist
+2. Prompt for your OpenAPI specification path (default: `./openapi.yaml`)
+3. Ask for the output directory (default: `./src/gen`)
+4. Let you choose which plugins to install
 5. Install the selected packages using your package manager (npm, pnpm, yarn, or bun)
-6. Generate a `kubb.config.ts` file with your chosen configuration
+6. Generate a `kubb.config.ts` with your chosen configuration
+
+---
 
 ### `kubb generate`
 
-Generate files based on your `kubb.config.ts` configuration.
+Generate TypeScript types, API clients, React Query hooks, Zod schemas, and more from an OpenAPI specification. Reads `kubb.config.ts` by default. Pass an OpenAPI file path as the first argument to override the input without editing the config.
 
 ```bash
 npx kubb generate
 ```
 
-Options:
+#### Options
+
+| Flag                 | Short | Type    | Default | Description                                                                                         |
+| -------------------- | ----- | ------- | ------- | --------------------------------------------------------------------------------------------------- |
+| `[input]`            |       | string  |         | OpenAPI file path — overrides `input.path` in the config                                            |
+| `--config <path>`    | `-c`  | string  |         | Path to the Kubb config file                                                                        |
+| `--logLevel <level>` | `-l`  | string  | `info`  | Log level: `silent`, `info`, or `verbose`                                                           |
+| `--watch`            | `-w`  | boolean | `false` | Re-generate whenever the input file changes                                                         |
+| `--verbose`          | `-v`  | boolean | `false` | Override log level to `verbose`                                                                     |
+| `--silent`           | `-s`  | boolean | `false` | Override log level to `silent`                                                                      |
+| `--reporter <names>` |       | string  | `cli`   | Reporters that render the run, comma-separated: `cli`, `json`, `file`. Overrides `config.reporters` |
+
+#### Examples
+
+```bash
+# Use kubb.config.ts in the current directory
+npx kubb generate
+
+# Override the input spec without editing the config
+npx kubb generate ./openapi.yaml
+
+# Point to a custom config file
+npx kubb generate --config ./configs/kubb.config.ts
+
+# Watch for changes and regenerate automatically
+npx kubb generate --watch
 
-- `-c, --config <path>` - Path to the Kubb config file
-- `-l, --logLevel <level>` - Set log level (silent, info, verbose, debug)
-- `-w, --watch` - Watch mode based on the input file
-- `-d, --debug` - Enable debug mode
-- `-v, --verbose` - Enable verbose mode
-- `-s, --silent` - Enable silent mode
+# Verbose output
+npx kubb generate --verbose
+
+# Write a JSON run report alongside the CLI output
+npx kubb generate --reporter cli,json
+```
+
+---
 
 ### `kubb validate`
 
-Validate a Swagger/OpenAPI file.
+Parse and validate an OpenAPI/Swagger file for structural correctness. Reports schema errors, missing required fields, and malformed references. Use this before running `generate` to catch spec issues early.
 
 ```bash
-npx kubb validate <path-to-openapi>
+npx kubb validate --input <path-or-url>
 ```
 
+#### Options
+
+| Flag             | Short | Type   | Required | Description                                         |
+| ---------------- | ----- | ------ | -------- | --------------------------------------------------- |
+| `--input <path>` | `-i`  | string | ✅       | Path or URL to the OpenAPI/Swagger file to validate |
+
+#### Examples
+
+```bash
+# Validate a local file
+npx kubb validate --input ./openapi.yaml
+
+# Validate a remote spec
+npx kubb validate --input https://petstore3.swagger.io/api/v3/openapi.json
+```
+
+---
+
 ### `kubb mcp`
 
-Start the MCP server to enable the MCP client to interact with the LLM.
+Start a Model Context Protocol (MCP) server that exposes Kubb code generation as a tool for AI assistants. Once running, configure your AI client (Claude, Cursor, Windsurf, etc.) to connect — the assistant can then call `kubb generate` directly without leaving the chat.
+
+Runs over **stdio** by default (compatible with all MCP clients). Pass `--port` to expose an HTTP server instead.
+
+```bash
+npx kubb mcp
+```
+
+#### Options
+
+| Flag                | Short | Type   | Default     | Description                               |
+| ------------------- | ----- | ------ | ----------- | ----------------------------------------- |
+| `--port <number>`   | `-p`  | string |             | Port for HTTP MCP server (omit for stdio) |
+| `--host <hostname>` |       | string | `localhost` | Hostname to bind to (HTTP mode only)      |
+
+#### Examples
 
 ```bash
+# stdio mode (recommended for Claude Desktop, Cursor, etc.)
 npx kubb mcp
+
+# HTTP mode
+npx kubb mcp --port 3001
+```
+
+#### MCP client configuration
+
+Add the following to your MCP client config (e.g. Claude Desktop's `claude_desktop_config.json`):
+
+```json
+{
+  "mcpServers": {
+    "kubb": {
+      "command": "npx",
+      "args": ["kubb", "mcp"]
+    }
+  }
+}
 ```
 
 ## Supporting Kubb
 
-Kubb uses an MIT-licensed open source project with its ongoing development made possible entirely by the support of Sponsors. If you would like to become a sponsor, please consider:
+Kubb is an open source project, and its development is funded entirely by sponsors. If you would like to become a sponsor, please consider:
 
 - [Become a Sponsor on GitHub](https://github.com/sponsors/stijnvanhulle)
+- [See sponsorship tiers and our sponsors](https://kubb.dev/sponsors)
 
 <p align="center">
   <a href="https://github.com/sponsors/stijnvanhulle">
@@ -97,19 +217,19 @@ Kubb uses an MIT-licensed open source project with its ongoing development made
   </a>
 </p>
 
+## License
+
+[MIT](https://github.com/kubb-labs/kubb/blob/main/licenses/LICENSE-MIT)
+
 <!-- Badges -->
 
-[npm-version-src]: https://img.shields.io/npm/v/@kubb/cli?flat&colorA=18181B&colorB=f58517
-[npm-version-href]: https://npmjs.com/package/@kubb/cli
-[npm-downloads-src]: https://img.shields.io/npm/dm/@kubb/cli?flat&colorA=18181B&colorB=f58517
-[npm-downloads-href]: https://npmjs.com/package/@kubb/cli
-[license-src]: https://img.shields.io/github/license/kubb-labs/kubb.svg?flat&colorA=18181B&colorB=f58517
+[npm-version-src]: https://shieldcn.dev/npm/v/@kubb/cli.svg?variant=secondary&size=xs&theme=zinc&mode=dark
+[npm-version-href]: https://npmx.dev/package/@kubb/cli
+[npm-downloads-src]: https://shieldcn.dev/npm/dm/@kubb/cli.svg?variant=secondary&size=xs&theme=zinc&mode=dark
+[npm-downloads-href]: https://npmx.dev/package/@kubb/cli
+[stars-src]: https://shieldcn.dev/github/stars/kubb-labs/kubb.svg?variant=secondary&size=xs&theme=zinc&mode=dark
+[stars-href]: https://github.com/kubb-labs/kubb
+[license-src]: https://shieldcn.dev/npm/license/@kubb/cli.svg?variant=secondary&size=xs&theme=zinc
 [license-href]: https://github.com/kubb-labs/kubb/blob/main/LICENSE
-[build-src]: https://img.shields.io/github/actions/workflow/status/kubb-labs/kubb/ci.yaml?style=flat&colorA=18181B&colorB=f58517
-[build-href]: https://www.npmjs.com/package/@kubb/cli
-[minified-src]: https://img.shields.io/bundlephobia/min/@kubb/cli?style=flat&colorA=18181B&colorB=f58517
-[minified-href]: https://www.npmjs.com/package/@kubb/cli
-[coverage-src]: https://img.shields.io/codecov/c/github/kubb-labs/kubb?style=flat&colorA=18181B&colorB=f58517
-[coverage-href]: https://www.npmjs.com/package/@kubb/cli
-[sponsors-src]: https://img.shields.io/github/sponsors/stijnvanhulle?style=flat&colorA=18181B&colorB=f58517
-[sponsors-href]: https://github.com/sponsors/stijnvanhulle/
+[node-src]: https://shieldcn.dev/npm/node/@kubb/cli.svg?variant=secondary&size=xs&theme=zinc&mode=dark
+[node-href]: https://npmx.dev/package/@kubb/cli

package/bin/kubb.js

@@ -1,6 +1,12 @@
 #!/usr/bin/env node
-process.setSourceMapsEnabled?.(true)
 
-const { run } = await import('../dist/index.js')
+process.setSourceMapsEnabled?.(true)
 process.title = 'Kubb'
-run(process.argv)
+
+try {
+  const { run } = await import('../dist/index.js')
+  await run(process.argv)
+} catch (err) {
+  console.error(err)
+  process.exit(1)
+}

package/dist/Telemetry-CxzkLSdD.js

@@ -0,0 +1,284 @@
+import "./rolldown-runtime-C0LytTxp.js";
+import { randomBytes } from "node:crypto";
+import os from "node:os";
+import process$1 from "node:process";
+//#region ../../internals/utils/src/env.ts
+/**
+* Returns `true` when the process is running in a CI environment.
+* Covers GitHub Actions, GitLab CI, CircleCI, Travis CI, Jenkins, Bitbucket,
+* TeamCity, Buildkite, and Azure Pipelines.
+*
+* @example
+* ```ts
+* if (isCIEnvironment()) {
+*   logger.level = 'error'
+* }
+* ```
+*/
+function isCIEnvironment() {
+	return !!(process.env.CI || process.env.GITHUB_ACTIONS || process.env.GITLAB_CI || process.env.BITBUCKET_BUILD_NUMBER || process.env.JENKINS_URL || process.env.CIRCLECI || process.env.TRAVIS || process.env.TEAMCITY_VERSION || process.env.BUILDKITE || process.env.TF_BUILD);
+}
+/**
+* Returns `true` when the process has an interactive TTY with a valid terminal
+* width and is not running in CI.
+*
+* Some IDE-embedded terminals report `isTTY = true` but set `columns` to `0`,
+* which breaks clack's box-drawing helpers (they call `String.prototype.repeat`
+* with a negative count and throw a `RangeError`).  We therefore require a
+* positive column count before declaring the TTY usable.
+*
+* @example
+* ```ts
+* if (canUseTTY()) {
+*   renderProgressBar()
+* }
+* ```
+*/
+function canUseTTY() {
+	return process.stdout.isTTY && (process.stdout.columns ?? 0) > 0 && !isCIEnvironment();
+}
+//#endregion
+//#region ../../internals/utils/src/runtime.ts
+/**
+* Detects the JavaScript runtime executing the current process and exposes its name and version.
+*
+* Prefer the shared {@link runtime} instance over constructing your own.
+*/
+var Runtime = class {
+	/**
+	* `true` when the current process is running under Bun.
+	*
+	* Detection keys off the global `Bun` object rather than `process.versions`,
+	* because Bun polyfills `process.versions.node` for Node compatibility and would
+	* otherwise look like Node.
+	*
+	* @example
+	* ```ts
+	* if (runtime.isBun) {
+	*   await Bun.write(path, data)
+	* }
+	* ```
+	*/
+	get isBun() {
+		return typeof Bun !== "undefined";
+	}
+	/**
+	* `true` when the current process is running under Deno.
+	*/
+	get isDeno() {
+		return typeof globalThis.Deno !== "undefined";
+	}
+	/**
+	* `true` when the current process is running under Node.
+	*
+	* Bun and Deno are excluded first so a polyfilled `process` does not register as Node.
+	*/
+	get isNode() {
+		return !this.isBun && !this.isDeno && typeof process !== "undefined" && process.versions?.node != null;
+	}
+	/**
+	* Name of the runtime executing the current process.
+	*
+	* @example
+	* ```ts
+	* runtime.name // 'bun' when run with `bun kubb`, 'node' otherwise
+	* ```
+	*/
+	get name() {
+		if (this.isBun) return "bun";
+		if (this.isDeno) return "deno";
+		return "node";
+	}
+	/**
+	* Version of the active runtime, or an empty string when it cannot be read.
+	*
+	* @example
+	* ```ts
+	* runtime.version // '1.3.11' under Bun, '22.22.2' under Node
+	* ```
+	*/
+	get version() {
+		if (this.isBun) return process.versions.bun ?? "";
+		if (this.isDeno) return globalThis.Deno?.version?.deno ?? "";
+		return process.versions?.node ?? "";
+	}
+};
+/**
+* Shared {@link Runtime} instance describing the JavaScript runtime executing the current process.
+*/
+const runtime = new Runtime();
+//#endregion
+//#region src/constants.ts
+/**
+* NPM registry endpoint used to check for @kubb/cli updates.
+*/
+const KUBB_NPM_PACKAGE_URL = "https://registry.npmjs.org/@kubb/cli/latest";
+/**
+* OpenTelemetry ingestion endpoint for anonymous usage telemetry.
+*/
+const OTLP_ENDPOINT = "https://otlp.kubb.dev";
+/**
+* Glob pattern for paths the file watcher ignores.
+*/
+const WATCHER_IGNORED_PATHS = "**/{.git,node_modules}/**";
+/**
+* Flags that short-circuit execution (help and version). The telemetry notice is suppressed for these.
+*/
+const QUIET_FLAGS = new Set([
+	"--help",
+	"-h",
+	"--version",
+	"-v"
+]);
+//#endregion
+//#region src/Telemetry.ts
+/**
+* Anonymous OTLP usage telemetry for a Kubb run. The API is static, so call it as `Telemetry.build(...)`
+* and `Telemetry.send(...)`. No file paths, OpenAPI specs, or secrets are sent, and sending fails
+* silently so a failed request never breaks the run.
+*/
+var Telemetry = class Telemetry {
+	/**
+	* Returns `true` when telemetry is disabled via `DO_NOT_TRACK` or `KUBB_DISABLE_TELEMETRY`.
+	*/
+	static get isDisabled() {
+		return process$1.env["DO_NOT_TRACK"] === "1" || process$1.env["DO_NOT_TRACK"] === "true" || process$1.env["KUBB_DISABLE_TELEMETRY"] === "1" || process$1.env["KUBB_DISABLE_TELEMETRY"] === "true";
+	}
+	/**
+	* Build an anonymous telemetry payload from a completed generation run.
+	*/
+	static build(options) {
+		const [seconds, nanoseconds] = process$1.hrtime(options.hrStart);
+		const duration = Math.round(seconds * 1e3 + nanoseconds / 1e6);
+		return {
+			command: options.command,
+			kubbVersion: options.kubbVersion,
+			nodeVersion: process$1.versions.node.split(".")[0],
+			runtime: runtime.name,
+			runtimeVersion: runtime.version.split(".")[0],
+			platform: os.platform(),
+			ci: isCIEnvironment(),
+			plugins: options.plugins ?? [],
+			duration,
+			filesCreated: options.filesCreated ?? 0,
+			status: options.status
+		};
+	}
+	/**
+	* Convert a {@link TelemetryEvent} into an OTLP-compatible JSON trace payload.
+	*
+	* @see https://opentelemetry.io/docs/languages/sdk-configuration/otlp-exporter/
+	*/
+	static buildOtlpPayload(event) {
+		const traceId = randomBytes(16).toString("hex");
+		const spanId = randomBytes(8).toString("hex");
+		const endTimeNs = BigInt(Date.now()) * 1000000n;
+		const startTimeNs = endTimeNs - BigInt(event.duration) * 1000000n;
+		const attributes = [
+			{
+				key: "kubb.command",
+				value: { stringValue: event.command }
+			},
+			{
+				key: "kubb.version",
+				value: { stringValue: event.kubbVersion }
+			},
+			{
+				key: "kubb.node_version",
+				value: { stringValue: event.nodeVersion }
+			},
+			{
+				key: "kubb.runtime",
+				value: { stringValue: event.runtime }
+			},
+			{
+				key: "kubb.runtime_version",
+				value: { stringValue: event.runtimeVersion }
+			},
+			{
+				key: "kubb.platform",
+				value: { stringValue: event.platform }
+			},
+			{
+				key: "kubb.ci",
+				value: { boolValue: event.ci }
+			},
+			{
+				key: "kubb.files_created",
+				value: { intValue: event.filesCreated }
+			},
+			{
+				key: "kubb.status",
+				value: { stringValue: event.status }
+			},
+			{
+				key: "kubb.plugins",
+				value: { arrayValue: { values: event.plugins.map((p) => ({ kvlistValue: { values: [{
+					key: "name",
+					value: { stringValue: p.name }
+				}, {
+					key: "options",
+					value: { stringValue: JSON.stringify({
+						...p.options,
+						usedEnumNames: void 0
+					}) }
+				}] } })) } }
+			}
+		];
+		return { resourceSpans: [{
+			resource: { attributes: [
+				{
+					key: "service.name",
+					value: { stringValue: "kubb-core" }
+				},
+				{
+					key: "service.version",
+					value: { stringValue: event.kubbVersion }
+				},
+				{
+					key: "telemetry.sdk.language",
+					value: { stringValue: "nodejs" }
+				}
+			] },
+			scopeSpans: [{
+				scope: {
+					name: "kubb-core",
+					version: event.kubbVersion
+				},
+				spans: [{
+					traceId,
+					spanId,
+					name: event.command,
+					kind: 1,
+					startTimeUnixNano: String(startTimeNs),
+					endTimeUnixNano: String(endTimeNs),
+					attributes,
+					status: { code: event.status === "success" ? 1 : 2 }
+				}]
+			}]
+		}] };
+	}
+	/**
+	* Send an anonymous telemetry event to the Kubb OTLP endpoint. Respects `DO_NOT_TRACK` and
+	* `KUBB_DISABLE_TELEMETRY`, and fails silently so telemetry never interrupts a run.
+	*/
+	static async send(event) {
+		if (Telemetry.isDisabled) return;
+		try {
+			await fetch(`${OTLP_ENDPOINT}/v1/traces`, {
+				method: "POST",
+				headers: {
+					"Content-Type": "application/json",
+					"Kubb-Telemetry-Version": "1",
+					"Kubb-Telemetry-Source": "kubb-core"
+				},
+				body: JSON.stringify(Telemetry.buildOtlpPayload(event)),
+				signal: AbortSignal.timeout(5e3)
+			});
+		} catch (_e) {}
+	}
+};
+//#endregion
+export { canUseTTY as a, WATCHER_IGNORED_PATHS as i, KUBB_NPM_PACKAGE_URL as n, QUIET_FLAGS as r, Telemetry as t };
+
+//# sourceMappingURL=Telemetry-CxzkLSdD.js.map

package/dist/Telemetry-CxzkLSdD.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Telemetry-CxzkLSdD.js","names":["process"],"sources":["../../../internals/utils/src/env.ts","../../../internals/utils/src/runtime.ts","../src/constants.ts","../src/Telemetry.ts"],"sourcesContent":["/**\n * Returns `true` when the process is running in a CI environment.\n * Covers GitHub Actions, GitLab CI, CircleCI, Travis CI, Jenkins, Bitbucket,\n * TeamCity, Buildkite, and Azure Pipelines.\n *\n * @example\n * ```ts\n * if (isCIEnvironment()) {\n *   logger.level = 'error'\n * }\n * ```\n */\nexport function isCIEnvironment(): boolean {\n  return !!(\n    process.env.CI ||\n    process.env.GITHUB_ACTIONS ||\n    process.env.GITLAB_CI ||\n    process.env.BITBUCKET_BUILD_NUMBER ||\n    process.env.JENKINS_URL ||\n    process.env.CIRCLECI ||\n    process.env.TRAVIS ||\n    process.env.TEAMCITY_VERSION ||\n    process.env.BUILDKITE ||\n    process.env.TF_BUILD\n  )\n}\n\n/**\n * Returns `true` when the process has an interactive TTY with a valid terminal\n * width and is not running in CI.\n *\n * Some IDE-embedded terminals report `isTTY = true` but set `columns` to `0`,\n * which breaks clack's box-drawing helpers (they call `String.prototype.repeat`\n * with a negative count and throw a `RangeError`).  We therefore require a\n * positive column count before declaring the TTY usable.\n *\n * @example\n * ```ts\n * if (canUseTTY()) {\n *   renderProgressBar()\n * }\n * ```\n */\nexport function canUseTTY(): boolean {\n  return process.stdout.isTTY && (process.stdout.columns ?? 0) > 0 && !isCIEnvironment()\n}\n","/**\n * Name of the JavaScript runtime executing the current process.\n */\ntype RuntimeName = 'bun' | 'deno' | 'node'\n\n/**\n * Detects the JavaScript runtime executing the current process and exposes its name and version.\n *\n * Prefer the shared {@link runtime} instance over constructing your own.\n */\nclass Runtime {\n  /**\n   * `true` when the current process is running under Bun.\n   *\n   * Detection keys off the global `Bun` object rather than `process.versions`,\n   * because Bun polyfills `process.versions.node` for Node compatibility and would\n   * otherwise look like Node.\n   *\n   * @example\n   * ```ts\n   * if (runtime.isBun) {\n   *   await Bun.write(path, data)\n   * }\n   * ```\n   */\n  get isBun(): boolean {\n    return typeof Bun !== 'undefined'\n  }\n\n  /**\n   * `true` when the current process is running under Deno.\n   */\n  get isDeno(): boolean {\n    return typeof (globalThis as { Deno?: unknown }).Deno !== 'undefined'\n  }\n\n  /**\n   * `true` when the current process is running under Node.\n   *\n   * Bun and Deno are excluded first so a polyfilled `process` does not register as Node.\n   */\n  get isNode(): boolean {\n    return !this.isBun && !this.isDeno && typeof process !== 'undefined' && process.versions?.node != null\n  }\n\n  /**\n   * Name of the runtime executing the current process.\n   *\n   * @example\n   * ```ts\n   * runtime.name // 'bun' when run with `bun kubb`, 'node' otherwise\n   * ```\n   */\n  get name(): RuntimeName {\n    if (this.isBun) return 'bun'\n    if (this.isDeno) return 'deno'\n\n    return 'node'\n  }\n\n  /**\n   * Version of the active runtime, or an empty string when it cannot be read.\n   *\n   * @example\n   * ```ts\n   * runtime.version // '1.3.11' under Bun, '22.22.2' under Node\n   * ```\n   */\n  get version(): string {\n    if (this.isBun) return process.versions.bun ?? ''\n    if (this.isDeno) return (globalThis as { Deno?: { version?: { deno?: string } } }).Deno?.version?.deno ?? ''\n\n    return process.versions?.node ?? ''\n  }\n}\n\n/**\n * Shared {@link Runtime} instance describing the JavaScript runtime executing the current process.\n */\nexport const runtime = new Runtime()\n","/**\n * NPM registry endpoint used to check for @kubb/cli updates.\n */\nexport const KUBB_NPM_PACKAGE_URL = 'https://registry.npmjs.org/@kubb/cli/latest' as const\n\n/**\n * OpenTelemetry ingestion endpoint for anonymous usage telemetry.\n */\nexport const OTLP_ENDPOINT = 'https://otlp.kubb.dev' as const\n\n/**\n * Glob pattern for paths the file watcher ignores.\n */\nexport const WATCHER_IGNORED_PATHS = '**/{.git,node_modules}/**' as const\n\n/**\n * Flags that short-circuit execution (help and version). The telemetry notice is suppressed for these.\n */\nexport const QUIET_FLAGS = new Set<string>(['--help', '-h', '--version', '-v'])\n","import { randomBytes } from 'node:crypto'\nimport os from 'node:os'\nimport process from 'node:process'\nimport { isCIEnvironment, runtime } from '@internals/utils'\nimport { OTLP_ENDPOINT } from './constants.ts'\n\n// OpenTelemetry OTLP JSON types\n// https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/trace/v1/trace.proto\n// https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/common/v1/common.proto\n\ntype OtlpStringValue = { stringValue: string }\ntype OtlpBoolValue = { boolValue: boolean }\ntype OtlpIntValue = { intValue: number }\ntype OtlpDoubleValue = { doubleValue: number }\ntype OtlpBytesValue = { bytesValue: string }\ntype OtlpArrayValue = { arrayValue: { values: Array<OtlpAnyValue> } }\ntype OtlpKvListValue = { kvlistValue: { values: Array<OtlpKeyValue> } }\n\ntype OtlpAnyValue = OtlpStringValue | OtlpBoolValue | OtlpIntValue | OtlpDoubleValue | OtlpBytesValue | OtlpArrayValue | OtlpKvListValue\n\ntype OtlpKeyValue = {\n  key: string\n  value: OtlpAnyValue\n}\n\ntype OtlpResource = {\n  attributes: Array<OtlpKeyValue>\n  droppedAttributesCount?: number\n}\n\ntype OtlpInstrumentationScope = {\n  name: string\n  version?: string\n  attributes?: Array<OtlpKeyValue>\n  droppedAttributesCount?: number\n}\n\n/**\n * @see https://github.com/open-telemetry/opentelemetry-proto/blob/main/opentelemetry/proto/trace/v1/trace.proto#L103\n */\ntype OtlpSpanKind = 0 | 1 | 2 | 3 | 4 | 5\n\n/**\n * Span status code.\n * - `0` is unset\n * - `1` is OK\n * - `2` is error\n */\ntype OtlpStatusCode = 0 | 1 | 2\n\ntype OtlpStatus = {\n  code: OtlpStatusCode\n  message?: string\n}\n\ntype OtlpSpan = {\n  traceId: string\n  spanId: string\n  traceState?: string\n  parentSpanId?: string\n  name: string\n  kind: OtlpSpanKind\n  startTimeUnixNano: string\n  endTimeUnixNano: string\n  attributes?: Array<OtlpKeyValue>\n  droppedAttributesCount?: number\n  events?: Array<OtlpSpanEvent>\n  droppedEventsCount?: number\n  links?: Array<OtlpSpanLink>\n  droppedLinksCount?: number\n  status?: OtlpStatus\n}\n\ntype OtlpSpanEvent = {\n  timeUnixNano: string\n  name: string\n  attributes?: Array<OtlpKeyValue>\n  droppedAttributesCount?: number\n}\n\ntype OtlpSpanLink = {\n  traceId: string\n  spanId: string\n  traceState?: string\n  attributes?: Array<OtlpKeyValue>\n  droppedAttributesCount?: number\n}\n\ntype OtlpScopeSpans = {\n  scope: OtlpInstrumentationScope\n  spans: Array<OtlpSpan>\n  schemaUrl?: string\n}\n\ntype OtlpResourceSpans = {\n  resource: OtlpResource\n  scopeSpans: Array<OtlpScopeSpans>\n  schemaUrl?: string\n}\n\n/**\n * Root payload sent to POST /v1/traces.\n */\ntype OtlpExportTraceServiceRequest = {\n  resourceSpans: Array<OtlpResourceSpans>\n}\n\n/**\n * Anonymous plugin name and options snapshot sent with each telemetry event.\n */\nexport type TelemetryPlugin = {\n  /**\n   * Plugin name as registered in the Kubb config, e.g. `'@kubb/plugin-ts'`.\n   */\n  name: string\n  /**\n   * Anonymized snapshot of the plugin options. Values are included but cannot be traced back to a user.\n   */\n  options: Record<string, unknown>\n}\n\n/**\n * Anonymous snapshot of a single Kubb run, built by {@link Telemetry.build} and sent by {@link Telemetry.send}.\n */\nexport type TelemetryEvent = {\n  command: string\n  kubbVersion: string\n  /**\n   * Major version of Node that executed the run, e.g. `'22'`.\n   */\n  nodeVersion: string\n  /**\n   * Name of the JavaScript runtime that executed the run, `'bun'`, `'deno'`, or `'node'`.\n   */\n  runtime: string\n  /**\n   * Major version of the active runtime, e.g. `'1'` under Bun or `'22'` under Node.\n   */\n  runtimeVersion: string\n  platform: string\n  ci: boolean\n  plugins: Array<TelemetryPlugin>\n  duration: number\n  filesCreated: number\n  status: 'success' | 'failed'\n}\n\n/**\n * Anonymous OTLP usage telemetry for a Kubb run. The API is static, so call it as `Telemetry.build(...)`\n * and `Telemetry.send(...)`. No file paths, OpenAPI specs, or secrets are sent, and sending fails\n * silently so a failed request never breaks the run.\n */\nexport class Telemetry {\n  /**\n   * Returns `true` when telemetry is disabled via `DO_NOT_TRACK` or `KUBB_DISABLE_TELEMETRY`.\n   */\n  static get isDisabled(): boolean {\n    return (\n      process.env['DO_NOT_TRACK'] === '1' ||\n      process.env['DO_NOT_TRACK'] === 'true' ||\n      process.env['KUBB_DISABLE_TELEMETRY'] === '1' ||\n      process.env['KUBB_DISABLE_TELEMETRY'] === 'true'\n    )\n  }\n\n  /**\n   * Build an anonymous telemetry payload from a completed generation run.\n   */\n  static build(options: {\n    command: 'generate' | 'mcp' | 'validate' | 'agent'\n    kubbVersion: string\n    plugins?: Array<TelemetryPlugin>\n    hrStart: [number, number]\n    filesCreated?: number\n    status: 'success' | 'failed'\n  }): TelemetryEvent {\n    const [seconds, nanoseconds] = process.hrtime(options.hrStart)\n    const duration = Math.round(seconds * 1000 + nanoseconds / 1e6)\n\n    return {\n      command: options.command,\n      kubbVersion: options.kubbVersion,\n      nodeVersion: process.versions.node.split('.')[0] as string,\n      runtime: runtime.name,\n      runtimeVersion: runtime.version.split('.')[0] as string,\n      platform: os.platform(),\n      ci: isCIEnvironment(),\n      plugins: options.plugins ?? [],\n      duration,\n      filesCreated: options.filesCreated ?? 0,\n      status: options.status,\n    }\n  }\n\n  /**\n   * Convert a {@link TelemetryEvent} into an OTLP-compatible JSON trace payload.\n   *\n   * @see https://opentelemetry.io/docs/languages/sdk-configuration/otlp-exporter/\n   */\n  static buildOtlpPayload(event: TelemetryEvent): OtlpExportTraceServiceRequest {\n    const traceId = randomBytes(16).toString('hex')\n    const spanId = randomBytes(8).toString('hex')\n    const endTimeNs = BigInt(Date.now()) * 1_000_000n\n    const startTimeNs = endTimeNs - BigInt(event.duration) * 1_000_000n\n\n    const attributes: Array<OtlpKeyValue> = [\n      { key: 'kubb.command', value: { stringValue: event.command } },\n      { key: 'kubb.version', value: { stringValue: event.kubbVersion } },\n      { key: 'kubb.node_version', value: { stringValue: event.nodeVersion } },\n      { key: 'kubb.runtime', value: { stringValue: event.runtime } },\n      { key: 'kubb.runtime_version', value: { stringValue: event.runtimeVersion } },\n      { key: 'kubb.platform', value: { stringValue: event.platform } },\n      { key: 'kubb.ci', value: { boolValue: event.ci } },\n      { key: 'kubb.files_created', value: { intValue: event.filesCreated } },\n      { key: 'kubb.status', value: { stringValue: event.status } },\n      {\n        key: 'kubb.plugins',\n        value: {\n          arrayValue: {\n            values: event.plugins.map(\n              (p): OtlpKvListValue => ({\n                kvlistValue: {\n                  values: [\n                    { key: 'name', value: { stringValue: p.name } },\n                    {\n                      key: 'options',\n                      value: {\n                        stringValue: JSON.stringify({\n                          ...p.options,\n                          usedEnumNames: undefined,\n                        }),\n                      },\n                    },\n                  ],\n                },\n              }),\n            ),\n          },\n        },\n      },\n    ]\n\n    return {\n      resourceSpans: [\n        {\n          resource: {\n            attributes: [\n              { key: 'service.name', value: { stringValue: 'kubb-core' } },\n              {\n                key: 'service.version',\n                value: { stringValue: event.kubbVersion },\n              },\n              { key: 'telemetry.sdk.language', value: { stringValue: 'nodejs' } },\n            ],\n          },\n          scopeSpans: [\n            {\n              scope: { name: 'kubb-core', version: event.kubbVersion },\n              spans: [\n                {\n                  traceId,\n                  spanId,\n                  name: event.command,\n                  kind: 1 satisfies OtlpSpanKind,\n                  startTimeUnixNano: String(startTimeNs),\n                  endTimeUnixNano: String(endTimeNs),\n                  attributes,\n                  status: {\n                    code: (event.status === 'success' ? 1 : 2) satisfies OtlpStatusCode,\n                  },\n                },\n              ],\n            },\n          ],\n        },\n      ],\n    }\n  }\n\n  /**\n   * Send an anonymous telemetry event to the Kubb OTLP endpoint. Respects `DO_NOT_TRACK` and\n   * `KUBB_DISABLE_TELEMETRY`, and fails silently so telemetry never interrupts a run.\n   */\n  static async send(event: TelemetryEvent): Promise<void> {\n    if (Telemetry.isDisabled) {\n      return\n    }\n\n    try {\n      await fetch(`${OTLP_ENDPOINT}/v1/traces`, {\n        method: 'POST',\n        headers: {\n          'Content-Type': 'application/json',\n          'Kubb-Telemetry-Version': '1',\n          'Kubb-Telemetry-Source': 'kubb-core',\n        },\n        body: JSON.stringify(Telemetry.buildOtlpPayload(event)),\n        signal: AbortSignal.timeout(5_000),\n      })\n    } catch (_e) {\n      // Fail silently, telemetry must never break the run\n    }\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;AAYA,SAAgB,kBAA2B;CACzC,OAAO,CAAC,EACN,QAAQ,IAAI,MACZ,QAAQ,IAAI,kBACZ,QAAQ,IAAI,aACZ,QAAQ,IAAI,0BACZ,QAAQ,IAAI,eACZ,QAAQ,IAAI,YACZ,QAAQ,IAAI,UACZ,QAAQ,IAAI,oBACZ,QAAQ,IAAI,aACZ,QAAQ,IAAI;AAEhB;;;;;;;;;;;;;;;;;AAkBA,SAAgB,YAAqB;CACnC,OAAO,QAAQ,OAAO,UAAU,QAAQ,OAAO,WAAW,KAAK,KAAK,CAAC,gBAAgB;AACvF;;;;;;;;ACnCA,IAAM,UAAN,MAAc;;;;;;;;;;;;;;;CAeZ,IAAI,QAAiB;EACnB,OAAO,OAAO,QAAQ;CACxB;;;;CAKA,IAAI,SAAkB;EACpB,OAAO,OAAQ,WAAkC,SAAS;CAC5D;;;;;;CAOA,IAAI,SAAkB;EACpB,OAAO,CAAC,KAAK,SAAS,CAAC,KAAK,UAAU,OAAO,YAAY,eAAe,QAAQ,UAAU,QAAQ;CACpG;;;;;;;;;CAUA,IAAI,OAAoB;EACtB,IAAI,KAAK,OAAO,OAAO;EACvB,IAAI,KAAK,QAAQ,OAAO;EAExB,OAAO;CACT;;;;;;;;;CAUA,IAAI,UAAkB;EACpB,IAAI,KAAK,OAAO,OAAO,QAAQ,SAAS,OAAO;EAC/C,IAAI,KAAK,QAAQ,OAAQ,WAA0D,MAAM,SAAS,QAAQ;EAE1G,OAAO,QAAQ,UAAU,QAAQ;CACnC;AACF;;;;AAKA,MAAa,UAAU,IAAI,QAAQ;;;;;;AC5EnC,MAAa,uBAAuB;;;;AAKpC,MAAa,gBAAgB;;;;AAK7B,MAAa,wBAAwB;;;;AAKrC,MAAa,cAAc,IAAI,IAAY;CAAC;CAAU;CAAM;CAAa;AAAI,CAAC;;;;;;;;ACsI9E,IAAa,YAAb,MAAa,UAAU;;;;CAIrB,WAAW,aAAsB;EAC/B,OACEA,UAAQ,IAAI,oBAAoB,OAChCA,UAAQ,IAAI,oBAAoB,UAChCA,UAAQ,IAAI,8BAA8B,OAC1CA,UAAQ,IAAI,8BAA8B;CAE9C;;;;CAKA,OAAO,MAAM,SAOM;EACjB,MAAM,CAAC,SAAS,eAAeA,UAAQ,OAAO,QAAQ,OAAO;EAC7D,MAAM,WAAW,KAAK,MAAM,UAAU,MAAO,cAAc,GAAG;EAE9D,OAAO;GACL,SAAS,QAAQ;GACjB,aAAa,QAAQ;GACrB,aAAaA,UAAQ,SAAS,KAAK,MAAM,GAAG,CAAC,CAAC;GAC9C,SAAS,QAAQ;GACjB,gBAAgB,QAAQ,QAAQ,MAAM,GAAG,CAAC,CAAC;GAC3C,UAAU,GAAG,SAAS;GACtB,IAAI,gBAAgB;GACpB,SAAS,QAAQ,WAAW,CAAC;GAC7B;GACA,cAAc,QAAQ,gBAAgB;GACtC,QAAQ,QAAQ;EAClB;CACF;;;;;;CAOA,OAAO,iBAAiB,OAAsD;EAC5E,MAAM,UAAU,YAAY,EAAE,CAAC,CAAC,SAAS,KAAK;EAC9C,MAAM,SAAS,YAAY,CAAC,CAAC,CAAC,SAAS,KAAK;EAC5C,MAAM,YAAY,OAAO,KAAK,IAAI,CAAC,IAAI;EACvC,MAAM,cAAc,YAAY,OAAO,MAAM,QAAQ,IAAI;EAEzD,MAAM,aAAkC;GACtC;IAAE,KAAK;IAAgB,OAAO,EAAE,aAAa,MAAM,QAAQ;GAAE;GAC7D;IAAE,KAAK;IAAgB,OAAO,EAAE,aAAa,MAAM,YAAY;GAAE;GACjE;IAAE,KAAK;IAAqB,OAAO,EAAE,aAAa,MAAM,YAAY;GAAE;GACtE;IAAE,KAAK;IAAgB,OAAO,EAAE,aAAa,MAAM,QAAQ;GAAE;GAC7D;IAAE,KAAK;IAAwB,OAAO,EAAE,aAAa,MAAM,eAAe;GAAE;GAC5E;IAAE,KAAK;IAAiB,OAAO,EAAE,aAAa,MAAM,SAAS;GAAE;GAC/D;IAAE,KAAK;IAAW,OAAO,EAAE,WAAW,MAAM,GAAG;GAAE;GACjD;IAAE,KAAK;IAAsB,OAAO,EAAE,UAAU,MAAM,aAAa;GAAE;GACrE;IAAE,KAAK;IAAe,OAAO,EAAE,aAAa,MAAM,OAAO;GAAE;GAC3D;IACE,KAAK;IACL,OAAO,EACL,YAAY,EACV,QAAQ,MAAM,QAAQ,KACnB,OAAwB,EACvB,aAAa,EACX,QAAQ,CACN;KAAE,KAAK;KAAQ,OAAO,EAAE,aAAa,EAAE,KAAK;IAAE,GAC9C;KACE,KAAK;KACL,OAAO,EACL,aAAa,KAAK,UAAU;MAC1B,GAAG,EAAE;MACL,eAAe,KAAA;KACjB,CAAC,EACH;IACF,CACF,EACF,EACF,EACF,EACF,EACF;GACF;EACF;EAEA,OAAO,EACL,eAAe,CACb;GACE,UAAU,EACR,YAAY;IACV;KAAE,KAAK;KAAgB,OAAO,EAAE,aAAa,YAAY;IAAE;IAC3D;KACE,KAAK;KACL,OAAO,EAAE,aAAa,MAAM,YAAY;IAC1C;IACA;KAAE,KAAK;KAA0B,OAAO,EAAE,aAAa,SAAS;IAAE;GACpE,EACF;GACA,YAAY,CACV;IACE,OAAO;KAAE,MAAM;KAAa,SAAS,MAAM;IAAY;IACvD,OAAO,CACL;KACE;KACA;KACA,MAAM,MAAM;KACZ,MAAM;KACN,mBAAmB,OAAO,WAAW;KACrC,iBAAiB,OAAO,SAAS;KACjC;KACA,QAAQ,EACN,MAAO,MAAM,WAAW,YAAY,IAAI,EAC1C;IACF,CACF;GACF,CACF;EACF,CACF,EACF;CACF;;;;;CAMA,aAAa,KAAK,OAAsC;EACtD,IAAI,UAAU,YACZ;EAGF,IAAI;GACF,MAAM,MAAM,GAAG,cAAc,aAAa;IACxC,QAAQ;IACR,SAAS;KACP,gBAAgB;KAChB,0BAA0B;KAC1B,yBAAyB;IAC3B;IACA,MAAM,KAAK,UAAU,UAAU,iBAAiB,KAAK,CAAC;IACtD,QAAQ,YAAY,QAAQ,GAAK;GACnC,CAAC;EACH,SAAS,IAAI,CAEb;CACF;AACF"}