@kubb/cli 5.10.1 → 5.10.3

package/dist/credentials-xOkTTDWj.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"credentials-xOkTTDWj.cjs","names":["process","path","hash","resolveKubbDir","kubbStorage","randomBytes"],"sources":["../src/runners/studio/credentials.ts"],"sourcesContent":["import { hash, randomBytes } from 'node:crypto'\nimport path from 'node:path'\nimport process from 'node:process'\nimport { kubbStorage, resolveKubbDir } from '@kubb/core'\n\nconst projectBase = (project = process.cwd()) => path.join('projects', hash('sha256', project))\n\n/**\n * Root for the credential and machine identity of the current project, inside `KUBB_HOME`.\n *\n * Studio agents are project connections, so two projects on one machine must not share the same\n * persisted token or machine secret.\n */\nexport function getProjectKubbHome(project = process.cwd()): string {\n  return resolveKubbDir(projectBase(project))\n}\n\nconst projectStorage = () => kubbStorage({ base: projectBase() })\n\nconst CREDENTIALS_FILENAME = 'credentials.json'\n\n/**\n * Absolute path of the stored credential, so callers can name it in output without rebuilding it.\n */\nexport function getCredentialsPath(): string {\n  return path.join(getProjectKubbHome(), CREDENTIALS_FILENAME)\n}\n\nexport type Credentials = {\n  /**\n   * The Studio instance this machine paired with. A different `--url` means re-pairing.\n   */\n  studioUrl: string\n  /**\n   * Bearer token for this machine. Never logged, never printed.\n   */\n  token: string\n  agentId: string\n  agentSlug: string\n  /**\n   * Permissions the user has already granted, keyed by absolute project path, so the CLI asks\n   * once per project instead of on every run.\n   */\n  projects?: Record<string, { allowRead?: boolean; allowReadAst?: boolean; allowWrite?: boolean; allowConfigEdit?: boolean; allowExec?: boolean }>\n}\n\n/**\n * Reads the stored credential, or null when this machine has not paired yet or the file is\n * unreadable or corrupt. A bad file is treated as \"not paired\" so `kubb studio login` can\n * overwrite it rather than the CLI dying on it.\n */\nexport async function readCredentials(): Promise<Credentials | null> {\n  const stored = await projectStorage()\n    .getItem<Credentials>(CREDENTIALS_FILENAME)\n    .catch(() => null)\n\n  return typeof stored?.token === 'string' && stored.token !== '' ? stored : null\n}\n\n/**\n * Writes the credential into the project folder, which only its owner can open.\n */\nexport async function writeCredentials(credentials: Credentials): Promise<void> {\n  await projectStorage().setItem(CREDENTIALS_FILENAME, credentials)\n}\n\n/**\n * Forgets the stored credential. Succeeds when there was nothing to forget.\n */\nexport async function clearCredentials(): Promise<void> {\n  await projectStorage().removeItem(CREDENTIALS_FILENAME)\n}\n\n/**\n * Reads this project's machine secret, creating it on first use. Pairing sends its hash, so pairing\n * the same project again rotates one agent's token instead of creating a second agent. It lives\n * apart from the credential, which {@link clearCredentials} deletes.\n */\nexport async function getMachineId(): Promise<string> {\n  const storage = projectStorage()\n  const stored = await storage.getItem('machine-secret').catch(() => null)\n  if (typeof stored === 'string' && stored.trim()) return stored.trim()\n\n  const secret = randomBytes(32).toString('hex')\n  await storage.setItem('machine-secret', secret)\n\n  return secret\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAKA,MAAM,eAAe,UAAUA,aAAAA,QAAQ,IAAI,MAAMC,UAAAA,QAAK,KAAK,aAAA,GAAYC,YAAAA,KAAAA,CAAK,UAAU,OAAO,CAAC;;;;;;;AAQ9F,SAAgB,mBAAmB,UAAUF,aAAAA,QAAQ,IAAI,GAAW;CAClE,QAAA,GAAOG,WAAAA,eAAAA,CAAe,YAAY,OAAO,CAAC;AAC5C;AAEA,MAAM,wBAAA,GAAuBC,WAAAA,YAAAA,CAAY,EAAE,MAAM,YAAY,EAAE,CAAC;AAEhE,MAAM,uBAAuB;;;;AAK7B,SAAgB,qBAA6B;CAC3C,OAAOH,UAAAA,QAAK,KAAK,mBAAmB,GAAG,oBAAoB;AAC7D;;;;;;AAyBA,eAAsB,kBAA+C;CACnE,MAAM,SAAS,MAAM,eAAe,CAAC,CAClC,QAAqB,oBAAoB,CAAC,CAC1C,YAAY,IAAI;CAEnB,OAAO,OAAO,QAAQ,UAAU,YAAY,OAAO,UAAU,KAAK,SAAS;AAC7E;;;;AAKA,eAAsB,iBAAiB,aAAyC;CAC9E,MAAM,eAAe,CAAC,CAAC,QAAQ,sBAAsB,WAAW;AAClE;;;;AAKA,eAAsB,mBAAkC;CACtD,MAAM,eAAe,CAAC,CAAC,WAAW,oBAAoB;AACxD;;;;;;AAOA,eAAsB,eAAgC;CACpD,MAAM,UAAU,eAAe;CAC/B,MAAM,SAAS,MAAM,QAAQ,QAAQ,gBAAgB,CAAC,CAAC,YAAY,IAAI;CACvE,IAAI,OAAO,WAAW,YAAY,OAAO,KAAK,GAAG,OAAO,OAAO,KAAK;CAEpE,MAAM,UAAA,GAASI,YAAAA,YAAAA,CAAY,EAAE,CAAC,CAAC,SAAS,KAAK;CAC7C,MAAM,QAAQ,QAAQ,kBAAkB,MAAM;CAE9C,OAAO;AACT"}

package/dist/index.cjs

@@ -1,8 +1,8 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 const require_rolldown_runtime = require("./rolldown-runtime-CPE0t6oh.cjs");
-const require_Telemetry = require("./Telemetry-BfdvvZus.cjs");
-const require_output = require("./output-DLrxGtuN.cjs");
-const require_registry = require("./registry-x-_nbYR6.cjs");
+const require_Telemetry = require("./Telemetry-BV4GonCV.cjs");
+const require_output = require("./output-nieBFDgM.cjs");
+const require_registry = require("./registry-C8E_G7Xc.cjs");
 let node_util = require("node:util");
 let _gunshi_plugin_dryrun = require("@gunshi/plugin-dryrun");
 _gunshi_plugin_dryrun = require_rolldown_runtime.__toESM(_gunshi_plugin_dryrun, 1);
@@ -12,11 +12,11 @@ node_process = require_rolldown_runtime.__toESM(node_process, 1);
 let tinyexec = require("tinyexec");
 let node_path = require("node:path");
 node_path = require_rolldown_runtime.__toESM(node_path, 1);
+let _kubb_core = require("@kubb/core");
 let _clack_prompts = require("@clack/prompts");
 _clack_prompts = require_rolldown_runtime.__toESM(_clack_prompts, 1);
 let node_fs = require("node:fs");
 node_fs = require_rolldown_runtime.__toESM(node_fs, 1);
-let _kubb_core = require("@kubb/core");
 //#region src/commands/shared.ts
 const configArg = { config: {
 	type: "string",
@@ -96,7 +96,12 @@ const REPORTER_NAMES = [
 */
 function parseReporters(value) {
 	const names = value.split(",").map((name) => name.trim()).filter(Boolean);
-	for (const name of names) if (!REPORTER_NAMES.includes(name)) throw new Error(`must be one of cli, json, file, html (got "${name}")`);
+	for (const name of names) if (!REPORTER_NAMES.includes(name)) throw new _kubb_core.Diagnostics.Error({
+		code: _kubb_core.Diagnostics.code.unknown,
+		severity: "error",
+		message: `must be one of cli, json, file, html (got "${name}")`,
+		help: "Use one of cli, json, file, html."
+	});
 	return names;
 }
 /**
@@ -157,7 +162,7 @@ const command$13 = (0, gunshi.defineWithTypes)()({
 	async run(ctx) {
 		const { values } = ctx;
 		const logLevel = resolveLogLevel(values);
-		const { run } = await Promise.resolve().then(() => require("./run-CUyhuGlK.cjs"));
+		const { run } = await Promise.resolve().then(() => require("./run-hyi91b22.cjs"));
 		await run({
 			input: values.input,
 			configPath: values.config,
@@ -181,7 +186,7 @@ const command$12 = (0, gunshi.define)({
 	].join("\n"),
 	rendering: { header: null },
 	async run() {
-		const { run } = await Promise.resolve().then(() => require("./run-B13e9GQz.cjs"));
+		const { run } = await Promise.resolve().then(() => require("./run-CvE8ZdKG.cjs"));
 		await run();
 	}
 });
@@ -196,7 +201,7 @@ function studioCommand({ action, block, ...definition }) {
 		...definition,
 		toKebab: true,
 		async run({ values }) {
-			const { runStudio } = await Promise.resolve().then(() => require("./run-DHiVlG37.cjs"));
+			const { runStudio } = await Promise.resolve().then(() => require("./run-BnLba1gt.cjs"));
 			await runStudio(values, action, { block });
 		}
 	});
@@ -226,7 +231,7 @@ const command$11 = studioCommand({
 	},
 	block: true,
 	async action(options) {
-		const { connect } = await Promise.resolve().then(() => require("./run-DHiVlG37.cjs"));
+		const { connect } = await Promise.resolve().then(() => require("./run-BnLba1gt.cjs"));
 		await connect(options);
 	}
 });
@@ -238,7 +243,7 @@ const command$10 = studioCommand({
 	examples: ["kubb studio login", "kubb studio login --url http://localhost:3000"].join("\n"),
 	args: command$11.args,
 	async action(options) {
-		const { login } = await Promise.resolve().then(() => require("./run-DHiVlG37.cjs"));
+		const { login } = await Promise.resolve().then(() => require("./run-BnLba1gt.cjs"));
 		await login(options);
 	}
 });
@@ -250,7 +255,7 @@ const command$9 = studioCommand({
 	examples: "kubb studio logout",
 	args: {},
 	async action() {
-		const { stopWorker } = await Promise.resolve().then(() => require("./background-obsD4Gj2.cjs"));
+		const { stopWorker } = await Promise.resolve().then(() => require("./background-DVZB1n4j.cjs"));
 		const { clearCredentials } = await Promise.resolve().then(() => require("./credentials-DDaKqtJn.cjs")).then((n) => n.credentials_exports);
 		await stopWorker();
 		await clearCredentials();
@@ -293,7 +298,7 @@ const command$8 = (0, gunshi.define)({
 		...logLevelArg
 	},
 	async run(ctx) {
-		const { runner } = await Promise.resolve().then(() => require("./snapshot-C5cthCuU.cjs"));
+		const { runner } = await Promise.resolve().then(() => require("./snapshot-D_F4XkYQ.cjs"));
 		await runner(ctx);
 	}
 });
@@ -304,7 +309,7 @@ const command$7 = studioCommand({
 	description: "Keep this project connected to Kubb Studio in the background.",
 	args: command$11.args,
 	async action(options) {
-		const { startWorker } = await Promise.resolve().then(() => require("./background-obsD4Gj2.cjs"));
+		const { startWorker } = await Promise.resolve().then(() => require("./background-DVZB1n4j.cjs"));
 		await startWorker(options);
 	}
 });
@@ -312,7 +317,7 @@ const stopCommand = (0, gunshi.define)({
 	name: "stop",
 	description: "Stop this project's background connection and keep its pairing.",
 	async run() {
-		const { stopWorker } = await Promise.resolve().then(() => require("./background-obsD4Gj2.cjs"));
+		const { stopWorker } = await Promise.resolve().then(() => require("./background-DVZB1n4j.cjs"));
 		await stopWorker();
 		console.log("Background connection stopped.");
 	}
@@ -325,9 +330,9 @@ const command$6 = studioCommand({
 	examples: "kubb studio status",
 	args: { url: studioConnectionArgs.url },
 	async action(options) {
-		const { getWorkerLogPath, getWorkerStatus } = await Promise.resolve().then(() => require("./background-obsD4Gj2.cjs"));
+		const { getWorkerLogPath, getWorkerStatus } = await Promise.resolve().then(() => require("./background-DVZB1n4j.cjs"));
 		const { readCredentials } = await Promise.resolve().then(() => require("./credentials-DDaKqtJn.cjs")).then((n) => n.credentials_exports);
-		const { formatPermissionRows } = await Promise.resolve().then(() => require("./run-DHiVlG37.cjs"));
+		const { formatPermissionRows } = await Promise.resolve().then(() => require("./run-BnLba1gt.cjs"));
 		const worker = await getWorkerStatus();
 		console.log(`Background connection: ${worker.state}${worker.running ? ` (PID ${worker.pid})` : ""}`);
 		console.log(`Logs: ${getWorkerLogPath()}`);
@@ -403,7 +408,7 @@ const command$4 = (0, gunshi.define)({
 		required: true
 	} },
 	async run({ values }) {
-		const { run } = await Promise.resolve().then(() => require("./run-1MJA0P5x.cjs"));
+		const { run } = await Promise.resolve().then(() => require("./run-MFjzBB_M.cjs"));
 		await run({ input: values.input });
 	}
 });
@@ -572,7 +577,12 @@ async function selectExtension(registry) {
 		label: entry.manifest.displayName,
 		hint: `${entry.id} · ${entry.kind} ${entry.artifact.version} · ${entry.manifest.description}`
 	}));
-	if (!options.length) throw new Error(`The registry at ${registry} lists no extensions.`);
+	if (!options.length) throw new _kubb_core.Diagnostics.Error({
+		code: _kubb_core.Diagnostics.code.unknown,
+		severity: "error",
+		message: `The registry at ${registry} lists no extensions.`,
+		help: "Check that `KUBB_REGISTRY` points at a Kubb registry, or unset it to use https://kubb.dev/registry."
+	});
 	const id = await _clack_prompts.autocomplete({
 		message: "Select an extension to add:",
 		options,
@@ -590,7 +600,12 @@ async function run$4({ id: input, configPath, yes, install }) {
 	require_output.logIntro({ title: (0, node_util.styleText)("bgCyan", (0, node_util.styleText)("black", " Kubb Add ")) });
 	try {
 		const registry = require_registry.registryUrl();
-		if (!input && yes) throw new Error("Pass a registry id, such as plugin-zod, when using --yes.");
+		if (!input && yes) throw new _kubb_core.Diagnostics.Error({
+			code: _kubb_core.Diagnostics.code.unknown,
+			severity: "error",
+			message: "Pass a registry id, such as plugin-zod, when using --yes.",
+			help: "Run `kubb add plugin-zod --yes`, or drop `--yes` to pick from a list."
+		});
 		const id = input ? require_registry.toRegistryId(input) : await selectExtension(registry);
 		if (!id) {
 			_clack_prompts.cancel("Operation canceled.");
@@ -602,10 +617,20 @@ async function run$4({ id: input, configPath, yes, install }) {
 		});
 		const { artifact, manifest } = detail;
 		const problem = require_registry.incompatibility(manifest);
-		if (problem) throw new Error(problem);
+		if (problem) throw new _kubb_core.Diagnostics.Error({
+			code: _kubb_core.Diagnostics.code.incompatibleExtension,
+			severity: "error",
+			message: problem,
+			help: "Upgrade Kubb or Node.js to a version the extension supports."
+		});
 		const spec = require_registry.installSpec(artifact);
 		const configFile = manifest.kind === "plugin" ? configPath ? node_path.default.resolve(configPath) : require_output.findConfigFile(cwd) : void 0;
-		if (manifest.kind === "plugin" && !configFile) throw new Error("No kubb.config.ts found. Run `kubb init` first, or pass --config.");
+		if (manifest.kind === "plugin" && !configFile) throw new _kubb_core.Diagnostics.Error({
+			code: _kubb_core.Diagnostics.code.unknown,
+			severity: "error",
+			message: "No kubb.config.ts found. Run `kubb init` first, or pass --config.",
+			help: "Run `kubb init` to create a config, or pass its path with `--config`."
+		});
 		require_output.logInfo(`${(0, node_util.styleText)("cyan", manifest.displayName)} (${manifest.kind}): ${manifest.description}`);
 		require_output.logBlock([install ? `Install ${(0, node_util.styleText)("cyan", spec)} as a dev dependency` : `Skip installing ${spec}`, configFile ? `Add ${(0, node_util.styleText)("cyan", `${manifest.export}()`)} to ${node_path.default.relative(cwd, configFile) || configFile}` : `Print the ${manifest.kind} snippet to add`]);
 		const confirmed = yes || await _clack_prompts.confirm({
@@ -747,7 +772,12 @@ async function run$3({ yes, input: inputFlag, output: outputFlag, plugins: plugi
 			if (pluginsFlag) {
 				const ids = pluginsFlag.split(",").map((id) => id.trim()).filter(Boolean);
 				const unknown = ids.filter((id) => !byId.has(require_registry.toRegistryId(id)));
-				if (unknown.length) throw new Error(`Not in the Kubb registry: ${unknown.join(", ")}. Browse the plugins at https://kubb.dev/extensions.`);
+				if (unknown.length) throw new _kubb_core.Diagnostics.Error({
+					code: _kubb_core.Diagnostics.code.pluginNotFound,
+					severity: "error",
+					message: `Not in the Kubb registry: ${unknown.join(", ")}. Browse the plugins at https://kubb.dev/extensions.`,
+					help: "Use plugin ids from https://kubb.dev/extensions, such as plugin-ts."
+				});
 				const entries = ids.map((id) => byId.get(require_registry.toRegistryId(id)));
 				require_output.logInfo(`Using plugins: ${pluginLabel(entries)}`);
 				return entries;
@@ -773,7 +803,11 @@ async function run$3({ yes, input: inputFlag, output: outputFlag, plugins: plugi
 			selected: selectedPlugins.map((entry) => entry.manifest.name),
 			manifests: selectedPlugins.map((entry) => entry.manifest)
 		});
-		if (missing.length) throw new Error(`${missing.join("\n")}\nAdd the missing plugins and run kubb init again.`);
+		if (missing.length) throw new _kubb_core.Diagnostics.Error({
+			code: _kubb_core.Diagnostics.code.missingDependency,
+			severity: "error",
+			message: `${missing.join("\n")}\nAdd the missing plugins and run kubb init again.`
+		});
 		const packagesToInstall = [`${require_output.KUBB_PACKAGE_NAME}@${require_Telemetry.version}`, ...selectedPlugins.map((entry) => require_registry.installSpec(entry.artifact))];
 		const spinner = require_output.createSpinner();
 		spinner.start(`Installing ${packagesToInstall.length} packages with ${packageManager.name}`);
@@ -811,7 +845,12 @@ async function run$3({ yes, input: inputFlag, output: outputFlag, plugins: plugi
 				message: `add ${entry.manifest.export}() to ${require_output.KUBB_CONFIG_FILENAME}`,
 				resolve: () => void 0
 			});
-			if (reason) throw new Error(`Could not add ${entry.manifest.export}() to ${require_output.KUBB_CONFIG_FILENAME}: ${reason}`);
+			if (reason) throw new _kubb_core.Diagnostics.Error({
+				code: _kubb_core.Diagnostics.code.unknown,
+				severity: "error",
+				message: `Could not add ${entry.manifest.export}() to ${require_output.KUBB_CONFIG_FILENAME}: ${reason}`,
+				help: `Add ${entry.manifest.export}() to the plugins array in ${require_output.KUBB_CONFIG_FILENAME} by hand.`
+			});
 		}
 		configSpinner.stop(`Created ${require_output.KUBB_CONFIG_FILENAME}`);
 		require_output.logOutro((0, node_util.styleText)("green", "✓ All set!") + "\n\n" + (0, node_util.styleText)("dim", "Next steps:") + "\n" + (0, node_util.styleText)("cyan", `  1. Make sure your OpenAPI spec is at: ${inputPath}`) + "\n" + (0, node_util.styleText)("cyan", "  2. Generate code with: npx kubb generate") + "\n" + (0, node_util.styleText)("cyan", `  3. Find generated files in: ${outputPath}`) + "\n\n" + (0, node_util.styleText)("dim", `Using ${packageManager.name} • Kubb v${require_Telemetry.version}`));
@@ -1044,6 +1083,7 @@ const QUIET_FLAGS = /* @__PURE__ */ new Set([
 async function run(argv = process.argv.slice(2)) {
 	const args = routeStudioFlags(resolveDeprecatedFlags(argv));
 	const isQuietFlag = args.some((arg) => QUIET_FLAGS.has(arg));
+	const isJsonReporter = args.some((arg, index) => /^--reporter=.*\bjson\b/.test(arg) || arg === "--reporter" && /\bjson\b/.test(args[index + 1] ?? ""));
 	if (!require_Telemetry.isDisabled() && !isQuietFlag) console.error(`${(0, node_util.styleText)("yellow", "Notice:")} Kubb collects anonymous telemetry data to help improve the tool. No personal data or file contents are collected. \nTo disable, set ${(0, node_util.styleText)("cyan", "KUBB_DISABLE_TELEMETRY=1")}.\n`);
 	await (0, gunshi.cli)(args, command$13, {
 		name: "kubb",
@@ -1060,6 +1100,7 @@ async function run(argv = process.argv.slice(2)) {
 			list: command$1
 		},
 		fallbackToEntry: true,
+		...isJsonReporter ? { renderHeader: null } : {},
 		strict: true,
 		plugins: [(0, _gunshi_plugin_dryrun.default)({ name: "dry-run" })],
 		onErrorCommand: async (_ctx, error) => {