@kubb/studio 5.12.2 → 5.12.4

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { A as InstalledExtensions, L as PublishedSnapshot, a as AgentConnectInfo, c as AgentPermissions, d as ConfigEditOutcome, q as SnapshotUploadMetadata, s as AgentPermission, u as ConfigEdit } from "./protocol-DhNrwhqp.cjs";
+import { Y as SnapshotUploadMetadata, a as AgentConnectInfo, c as AgentPermissions, f as ConfigEditOutcome, j as InstalledExtensions, s as AgentPermission, u as ConfigEdit, z as PublishedSnapshot } from "./protocol-C4loKcxw.cjs";
 import { Config, Hookable, KubbHooks } from "@kubb/core";
 //#region src/connect.d.ts
 /**

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { A as InstalledExtensions, L as PublishedSnapshot, a as AgentConnectInfo, c as AgentPermissions, d as ConfigEditOutcome, q as SnapshotUploadMetadata, s as AgentPermission, u as ConfigEdit } from "./protocol-DhNrwhqp.js";
+import { Y as SnapshotUploadMetadata, a as AgentConnectInfo, c as AgentPermissions, f as ConfigEditOutcome, j as InstalledExtensions, s as AgentPermission, u as ConfigEdit, z as PublishedSnapshot } from "./protocol-C4loKcxw.js";
 import { Config, Hookable, KubbHooks } from "@kubb/core";
 //#region src/connect.d.ts
 /**

package/dist/index.js

@@ -1,13 +1,13 @@
-import { AGENT_INSTANCE_HEADER, AGENT_SOCKET_PATH, AgentCloseCode, AgentMessage, AgentPermission, MAX_SNAPSHOT_BYTES, generationEventTypes } from "./protocol.js";
+import { AGENT_INSTANCE_HEADER, AGENT_SOCKET_PATH, AgentCloseCode, AgentMessage, AgentPermission, ConfigEditOperation, MAX_SNAPSHOT_BYTES, generationEventTypes } from "./protocol.js";
 import { createRequire } from "node:module";
 import { createHash, hash, randomUUID } from "node:crypto";
 import { existsSync } from "node:fs";
+import { mkdir, mkdir as mkdir$1, mkdtemp, readFile, rm, writeFile } from "node:fs/promises";
 import { tmpdir } from "node:os";
 import path, { dirname, isAbsolute, join, relative, resolve, sep } from "node:path";
 import process$1 from "node:process";
 import { setTimeout as setTimeout$1 } from "node:timers/promises";
 import { x } from "tinyexec";
-import { mkdir, mkdir as mkdir$1, mkdtemp, readFile, rm, writeFile } from "node:fs/promises";
 import { Diagnostics, Hookable, cacheStorage, checkoutGitInput, createKubb, fsStorage, getInputKind, isPackageName, isPublicAddress, readInstalledPackages, resolveCacheDir, resolveMeta } from "@kubb/core";
 import { RpcTarget, newWebSocketRpcSession } from "capnweb";
 import { detectCodeFormat, parseExpression, parseModule } from "magicast";
@@ -202,7 +202,7 @@ function getElapsedMs(hrStart) {
 }
 //#endregion
 //#region package.json
-var version = "5.12.2";
+var version = "5.12.4";
 //#endregion
 //#region src/resolveConfig.ts
 /**
@@ -558,6 +558,44 @@ async function rebuildExtension({ disk, studioOptions, kind, extensions }) {
 		});
 	}))(mergeOptions(disk.options ?? {}, studioOptions));
 }
+/** The root `output` members Studio may set, with the values each takes. The rest, `path` and `postGenerate` among them, stay with the config file. */
+const OUTPUT_VALUES = {
+	barrel: (value) => value === false || isPlainObject(value) && Object.keys(value).length === 1 && (value.type === "named" || value.type === "all"),
+	format: (value) => value === false || [
+		"auto",
+		"prettier",
+		"biome",
+		"oxfmt"
+	].includes(value),
+	lint: (value) => value === false || [
+		"auto",
+		"eslint",
+		"biome",
+		"oxlint"
+	].includes(value),
+	clean: (value) => typeof value === "boolean",
+	defaultBanner: (value) => value === false || value === "simple" || value === "full"
+};
+/** Whether Studio may set the root `output` member `key`. */
+function isOutputKey(key) {
+	return Object.hasOwn(OUTPUT_VALUES, key);
+}
+/** Whether Studio may set the root `output` member `key` to `value`. */
+function isOutputValue({ key, value }) {
+	return isOutputKey(key) && OUTPUT_VALUES[key](value);
+}
+/** The members of `output` Studio may see and set. */
+function pickOutput(output) {
+	return Object.fromEntries(Object.entries(output).filter(([key]) => isOutputKey(key)));
+}
+/** Merges Studio's valid `output` overrides, with `null` unsetting a member. */
+function mergeOutput({ output, studio }) {
+	if (!isPlainObject(studio)) return output;
+	return mergeOptions(output, Object.fromEntries(Object.entries(studio).filter(([key, value]) => value === null ? isOutputKey(key) : isOutputValue({
+		key,
+		value
+	}))));
+}
 /**
 * Merges Studio-provided adapter option overrides into the disk config's adapter, see {@link rebuildExtension}.
 */
@@ -600,13 +638,7 @@ const IDENTIFIER = /^[A-Za-z_$][\w$]*$/;
 * line count, so `enable-plugin` restores exactly those lines and not whatever comments follow.
 */
 const DISABLED_MARKER = /^\/\/ kubb:disabled (.+)\s+(\d+)$/;
-const OPERATIONS = /* @__PURE__ */ new Set([
-	"set",
-	"remove",
-	"add-plugin",
-	"disable-plugin",
-	"enable-plugin"
-]);
+const OPERATIONS = new Set(Object.values(ConfigEditOperation));
 const KINDS = /* @__PURE__ */ new Set([
 	"plugin",
 	"adapter",
@@ -617,17 +649,20 @@ const KINDS = /* @__PURE__ */ new Set([
 * The edit crossed the wire, so its declared type is a promise the sender may not have kept.
 */
 function invalidEdit(edit) {
-	const { operation, plugin, config, path, kind } = typeof edit === "object" && edit !== null ? edit : {};
+	const { operation, plugin, config, path, kind, input } = typeof edit === "object" && edit !== null ? edit : {};
 	if (typeof operation !== "string" || !OPERATIONS.has(operation)) return `unknown operation ${JSON.stringify(operation)}`;
-	if (typeof plugin !== "string" || !plugin) return "the edit names no plugin";
-	if (kind !== void 0 && (typeof kind !== "string" || !KINDS.has(kind))) return `unknown kind ${JSON.stringify(kind)}`;
-	if (kind !== void 0 && operation !== "set" && operation !== "remove") return `${operation} edits the plugins array, so it takes no kind`;
 	if (config !== void 0 && typeof config !== "string" && !Number.isSafeInteger(config)) return "config must name an entry or give its index";
-	if (operation === "set" || operation === "remove") {
+	if (operation === ConfigEditOperation.SET_INPUT) return typeof input === "string" && input.trim() ? void 0 : "the edit names no input";
+	const isOutput = operation === ConfigEditOperation.SET_OUTPUT || operation === ConfigEditOperation.REMOVE_OUTPUT;
+	if (!isOutput && (typeof plugin !== "string" || !plugin)) return "the edit names no plugin";
+	if (kind !== void 0 && (typeof kind !== "string" || !KINDS.has(kind))) return `unknown kind ${JSON.stringify(kind)}`;
+	if (kind !== void 0 && operation !== ConfigEditOperation.SET && operation !== ConfigEditOperation.REMOVE) return `${operation} edits the plugins array, so it takes no kind`;
+	if (isOutput || operation === ConfigEditOperation.SET || operation === ConfigEditOperation.REMOVE) {
 		if (!Array.isArray(path) || !path.every((key) => typeof key === "string" && key)) return "path must be a list of option names";
 		if (!path.length) return "no option path given";
 		const unsafe = path.find((key) => !isSafeKey(key));
 		if (unsafe !== void 0) return `${unsafe} cannot be used as an option name`;
+		if (isOutput && !isOutputKey(path[0])) return `output.${path[0]} can only be changed in the config file`;
 	}
 }
 /** Where a node sits in the source text. */
@@ -928,9 +963,12 @@ function readPartial(node, prefix = []) {
 }
 /** The top-level options of a plugin call, each flagged with whether Studio may write it. */
 function readOptions(call) {
-	const entries = {};
 	const options = call.arguments[0];
-	if (options?.type !== "ObjectExpression") return entries;
+	return options?.type === "ObjectExpression" ? readObject(options) : {};
+}
+/** The members of an object literal, each flagged with whether Studio may write it. */
+function readObject(options) {
+	const entries = {};
 	for (const [index, entry] of options.properties.entries()) {
 		const key = memberKey(entry);
 		if (key === void 0 || !isSafeKey(key)) continue;
@@ -1003,11 +1041,13 @@ function readConfig(source) {
 			});
 			const [adapter] = factoryCalls(mod, config, "adapter").map(toView);
 			const parsers = factoryCalls(mod, config, "parser").map(toView);
+			const output = outputObject(config);
 			return {
 				name: configName(config),
 				plugins,
 				...adapter && { adapter },
-				...parsers.length ? { parsers } : {}
+				...parsers.length ? { parsers } : {},
+				...!("reason" in output) && { output: pickOutput(readObject(output.object)) }
 			};
 		})
 	};
@@ -1056,6 +1096,16 @@ function applySet(source, call, path, value, quote) {
 		return { source: splice(source, closing, closing, printValue(nest(path, value), quote)) };
 	}
 	if (options.type !== "ObjectExpression") return { reason: "the factory was not called with an object literal" };
+	return setIn({
+		source,
+		options,
+		path,
+		value,
+		quote
+	});
+}
+/** Writes the literal `value` at `path` inside `options`, adding any intermediate object it needs. */
+function setIn({ source, options, path, value, quote }) {
 	const target = walk(options, path);
 	if ("reason" in target) return target;
 	if ("missing" in target) {
@@ -1064,6 +1114,43 @@ function applySet(source, call, path, value, quote) {
 	}
 	return { source: splice(source, rangeOf(target.value).start, rangeOf(target.value).end, printValue(value, quote)) };
 }
+/** Writes the config's top-level `input` as a string literal, replacing what it held. */
+function applySetInput(source, config, input, quote) {
+	const value = printValue(input, quote);
+	const found = findMember(config, "input");
+	if (!found) return { source: insertItem(source, config, `input: ${value}`) };
+	if (found.member.type !== "ObjectProperty") return { reason: "input is not a plain property" };
+	if (isShadowed(config, found.index)) return { reason: "a spread after input could override it" };
+	return { source: splice(source, rangeOf(found.member.value).start, rangeOf(found.member.value).end, value) };
+}
+/** The config's root `output` object literal, or why Studio cannot edit inside it. */
+function outputObject(config) {
+	const found = findMember(config, "output");
+	if (found?.member.type !== "ObjectProperty" || found.member.value.type !== "ObjectExpression") return { reason: "output is not an object literal" };
+	if (isShadowed(config, found.index)) return { reason: "a spread after output could override it" };
+	return { object: found.member.value };
+}
+/** Writes or drops a member of the config's root `output` object. */
+function applyOutputEdit({ source, config, edit, quote }) {
+	const output = outputObject(config);
+	if ("reason" in output) return output;
+	if (edit.operation === ConfigEditOperation.REMOVE_OUTPUT) return removeIn({
+		source,
+		options: output.object,
+		path: edit.path
+	});
+	if (!isOptionValue(edit.value) || !isOutputValue({
+		key: edit.path[0],
+		value: nest(edit.path.slice(1), edit.value)
+	})) return { reason: `the value is not one output.${edit.path[0]} takes` };
+	return setIn({
+		source,
+		options: output.object,
+		path: edit.path,
+		value: edit.value,
+		quote
+	});
+}
 /**
 * Deletes the option at `path`, falling the plugin back to its default for it. An option the file
 * does not set already has its default, so removing it changes nothing.
@@ -1072,6 +1159,14 @@ function applyRemove(source, call, path) {
 	const options = call.arguments[0];
 	if (!options) return { source };
 	if (options.type !== "ObjectExpression") return { reason: "the factory was not called with an object literal" };
+	return removeIn({
+		source,
+		options,
+		path
+	});
+}
+/** Deletes the member at `path` inside `options`. A path that is not there already holds its default. */
+function removeIn({ source, options, path }) {
 	const target = walk(options, path);
 	if ("reason" in target) return target;
 	if ("missing" in target) return { source };
@@ -1160,7 +1255,14 @@ function applyEdit({ source, edit, quote, extensions }) {
 	const findConfig = (entries) => typeof ref === "string" ? entries.configs.find((entry) => configName(entry) === ref) : entries.configs[ref ?? 0];
 	const config = findConfig(parsed);
 	if (!config) return { reason: `no config entry found for ${JSON.stringify(ref)}` };
-	if (edit.operation === "disable-plugin") {
+	if (edit.operation === ConfigEditOperation.SET_INPUT) return applySetInput(source, config, edit.input, quote);
+	if (edit.operation === ConfigEditOperation.SET_OUTPUT || edit.operation === ConfigEditOperation.REMOVE_OUTPUT) return applyOutputEdit({
+		source,
+		config,
+		edit,
+		quote
+	});
+	if (edit.operation === ConfigEditOperation.DISABLE_PLUGIN) {
 		const result = disablePlugin(source, parsed.mod, config, edit.plugin);
 		if (!("reason" in result) || !result.reason.includes("shares a line")) return result;
 		const expanded = expandPluginsArray(source, config);
@@ -1168,8 +1270,8 @@ function applyEdit({ source, edit, quote, extensions }) {
 		const reparsedConfig = reparsed && !("reason" in reparsed) ? findConfig(reparsed) : void 0;
 		return expanded !== void 0 && reparsed && !("reason" in reparsed) && reparsedConfig ? disablePlugin(expanded, reparsed.mod, reparsedConfig, edit.plugin) : result;
 	}
-	if (edit.operation === "enable-plugin") return enablePlugin(source, config, edit.plugin);
-	if (edit.operation === "add-plugin") return applyAddPlugin({
+	if (edit.operation === ConfigEditOperation.ENABLE_PLUGIN) return enablePlugin(source, config, edit.plugin);
+	if (edit.operation === ConfigEditOperation.ADD_PLUGIN) return applyAddPlugin({
 		source,
 		parsed,
 		config,
@@ -1185,7 +1287,7 @@ function applyEdit({ source, edit, quote, extensions }) {
 		if (kind === "adapter") return { reason: `${edit.plugin} is not the config's adapter` };
 		return { reason: kind === "plugin" && disabledBlocks(source, config).some((block) => block.packageName === edit.plugin) ? `${edit.plugin} is disabled, enable it first` : `${edit.plugin} is not in the ${kind}s array` };
 	}
-	return edit.operation === "set" ? applySet(source, call, edit.path, edit.value, quote) : applyRemove(source, call, edit.path);
+	return edit.operation === ConfigEditOperation.SET ? applySet(source, call, edit.path, edit.value, quote) : applyRemove(source, call, edit.path);
 }
 /**
 * Applies edits to a `kubb.config.ts` in place. Each edit rewrites only the text it targets, so
@@ -2123,6 +2225,7 @@ var Agent = class extends RpcTarget {
 			allowConfigEdit: false,
 			allowInstall: false,
 			allowUpdate: false,
+			allowSaveInput: false,
 			allowRead: true,
 			allowReadAst: true
 		} : permissions;
@@ -2148,13 +2251,13 @@ var Agent = class extends RpcTarget {
 			permission
 		});
 	}
-	async #refuse({ message, permission }) {
+	async #refuse({ message, permission, code = Diagnostics.code.unknown }) {
 		await this.#warn({
 			message,
 			permission
 		});
 		throw new Diagnostics.Error({
-			code: Diagnostics.code.unknown,
+			code,
 			severity: "error",
 			message
 		});
@@ -2346,12 +2449,22 @@ var Agent = class extends RpcTarget {
 		});
 		const activePlugins = plugins ?? config.plugins;
 		if (patch?.input && !this.#sandbox && !this.#managed) await emit(this.#options.hooks, "kubb:warn", { message: "Ignored the spec from Studio: generating from a Studio spec is only available to a sandbox or managed agent" });
-		const checkout = this.#managed && studioInput !== void 0 && getInputKind(studioInput) === "git" ? await checkoutGitInput(studioInput, signal, { publicOnly: true }).catch((error) => this.#refuse({ message: getErrorMessage(error) })) : void 0;
+		const checkout = this.#managed && studioInput !== void 0 && getInputKind(studioInput) === "git" ? await checkoutGitInput(studioInput, signal, {
+			publicOnly: true,
+			authorization: input.gitAuth?.authorization
+		}).catch((error) => this.#refuse({
+			message: getErrorMessage(error),
+			code: Diagnostics.code.gitInputFailed
+		})) : void 0;
 		const run = () => generate({
 			config: {
 				...config,
 				root,
 				input: checkout?.path ?? studioInput ?? config.input,
+				output: mergeOutput({
+					output: config.output,
+					studio: patch?.output
+				}),
 				storage: outputRoot ? stagingStorage({
 					root,
 					directory: outputRoot
@@ -2420,11 +2533,29 @@ var Agent = class extends RpcTarget {
 		if (busy) return refuse(busy);
 		this.#session.saving = true;
 		try {
-			const { outcomes, changed } = await writeConfigEdits({
+			const kept = [];
+			for (const edit of edits) kept.push(await this.#keepInput(edit));
+			const written = await writeConfigEdits({
 				filePath: configFile,
-				edits,
+				edits: kept.flatMap((edit) => "reason" in edit ? [] : [edit]),
 				extensions: await this.#installedExtensions()
 			});
+			let next = 0;
+			const outcomes = kept.map((edit, index) => "reason" in edit ? {
+				edit: edits[index],
+				applied: false,
+				reason: edit.reason
+			} : {
+				...written.outcomes[next++],
+				edit: edits[index]
+			});
+			let wroteDocument = false;
+			for (const [index, edit] of kept.entries()) {
+				if (!("document" in edit) || !edit.document || !outcomes[index].applied) continue;
+				await writeFile(path.join(this.#options.root, edit.document.fileName), edit.document.text, "utf-8");
+				wroteDocument = true;
+			}
+			const changed = written.changed || wroteDocument;
 			const applied = outcomes.filter((outcome) => outcome.applied).length;
 			await this.#logCommand("saveConfig", `applied ${applied}/${outcomes.length} edits to ${configPath}`, input.requestedBy);
 			return {
@@ -2439,6 +2570,33 @@ var Agent = class extends RpcTarget {
 		}
 	}
 	/**
+	* Readies a `set-input` edit for the config file: a document is pointed at `openapi.yaml` (`openapi.json`
+	* for JSON) in the project, one file per config entry, for `saveConfig` to write once the edit applies.
+	* A managed agent refuses a file path, as in a generation.
+	*/
+	async #keepInput(edit) {
+		if (edit?.operation !== ConfigEditOperation.SET_INPUT || typeof edit.input !== "string" || !edit.input.trim()) return edit;
+		if (!this.#permissions.allowSaveInput) {
+			await this.#warn({
+				message: "Ignored the spec to save: saving the input was not granted",
+				permission: AgentPermission.SAVE_INPUT
+			});
+			return { reason: "the agent was not granted permission to save the input" };
+		}
+		const kind = getInputKind(edit.input);
+		if (this.#managed && !MANAGED_INPUT_KINDS.has(kind)) return { reason: AgentMessage.MANAGED_INPUT_KIND };
+		if (kind !== "inline") return edit;
+		const fileName = `openapi${edit.config === void 0 || edit.config === 0 ? "" : `-${String(edit.config).replace(/[^\w.-]/g, "-")}`}.${isJson(edit.input) ? "json" : "yaml"}`;
+		return {
+			...edit,
+			input: `./${fileName}`,
+			document: {
+				fileName,
+				text: edit.input
+			}
+		};
+	}
+	/**
 	* Installs a registry extension into the project with `kubb add <id> --yes`, which also adds a
 	* plugin to `kubb.config.ts`. Studio calls `connect()` again afterwards to see the result.
 	*/
@@ -2739,6 +2897,15 @@ function pickConfig(configs, ref) {
 	if (ref !== void 0 && !Number.isSafeInteger(ref)) return void 0;
 	return configs[ref ?? 0];
 }
+/** Whether `text` parses as JSON, so a pasted document is saved under the matching extension. */
+function isJson(text) {
+	try {
+		JSON.parse(text);
+		return true;
+	} catch {
+		return false;
+	}
+}
 /** The input path or URL Studio may show: no inline document, and no credentials from a URL. */
 function reportedInput(input) {
 	if (typeof input !== "string") return void 0;
@@ -2757,6 +2924,7 @@ function toEntryView(config, extensions) {
 		...config.name !== void 0 && { name: config.name },
 		...input !== void 0 && { input },
 		output: config.output.path,
+		outputOptions: toJSONOptions(pickOutput(config.output)),
 		plugins: config.plugins.map((plugin) => ({
 			name: toStudioName({
 				name: resolveMeta(plugin).name,
@@ -2794,6 +2962,7 @@ async function runAgent({ options, openRpc }) {
 			allowConfigEdit: false,
 			allowInstall: false,
 			allowUpdate: false,
+			allowSaveInput: false,
 			allowExec: false,
 			allowRead: false,
 			allowReadAst: false,