@kubb/studio 5.11.4 → 5.11.6

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { E as InstalledExtensions, N as PublishedSnapshot, U as SnapshotUploadMetadata, a as AgentConnectInfo, c as AgentPermissions, d as ConfigEditOutcome, s as AgentPermission, u as ConfigEdit } from "./protocol-a_DcTFba.cjs";
+import { F as PublishedSnapshot, G as SnapshotUploadMetadata, O as InstalledExtensions, a as AgentConnectInfo, c as AgentPermissions, d as ConfigEditOutcome, s as AgentPermission, u as ConfigEdit } from "./protocol-dCzUP4dH.cjs";
 import { Config, Hookable, KubbHooks } from "@kubb/core";
 //#region src/connect.d.ts
 /**
@@ -47,6 +47,14 @@ declare global {
       'studio:command': [ctx: {
         command: 'generate' | 'saveConfig' | 'readFiles' | 'readInput' | 'readDiff';
         info: string;
+        /**
+         * The Studio user who asked for the command, when Studio names one.
+         */
+        requestedBy?: string;
+        /**
+         * Set when a generation failed. Its diagnostics went out through `kubb:generation:end`.
+         */
+        failed?: boolean;
       }];
       /**
        * A refused or ignored request, with the missing permission so the host can add a remedy.
@@ -72,9 +80,10 @@ type ConnectAgentOptions = {
    */
   configPath: string;
   /**
-   * Called for every handshake and every generation, so edits on disk show up.
+   * Called for every handshake and every generation, so edits on disk show up. One entry per
+   * `defineConfig(...)` entry, and a generation names the one it runs.
    */
-  loadConfig: () => Promise<Config>;
+  loadConfigs: () => Promise<Array<Config>>;
   /**
    * The host's own version, reported to Studio next to the runtime's.
    */
@@ -114,7 +123,7 @@ type ConnectAgentOptions = {
  * const hooks = new Hookable<KubbHooks>()
  * hooks.hook('studio:connected', ({ agentSlug }) => console.log(`Connected as ${agentSlug}`))
  *
- * await connectAgent({ token, configPath: 'kubb.config.ts', loadConfig, version: '1.0.0', hooks, signal })
+ * await connectAgent({ token, configPath: 'kubb.config.ts', loadConfigs, version: '1.0.0', hooks, signal })
  * ```
  */
 export declare function connectAgent(options: ConnectAgentOptions): Promise<void>;
@@ -242,6 +251,29 @@ export declare function createSnapshot({ studioUrl, apiKey, config, hooks, signa
 export declare const defaultStudioUrl = "https://kubb.studio";
 //#endregion
 //#region src/configFile.d.ts
+/**
+ * Applies edits to a `kubb.config.ts` in place. Each edit rewrites only the text it targets, so
+ * comments, formatting, and hand-written code around the config survive.
+ *
+ * Edits are independent: one that cannot be applied is reported in `outcomes` and the rest still run.
+ *
+ * @example
+ * ```ts
+ * const { source, outcomes } = applyConfigEdits({
+ *   source: current,
+ *   edits: [{ operation: 'set', plugin: '@kubb/plugin-ts', path: ['enum', 'type'], value: 'enum' }],
+ * })
+ * ```
+ */
+export declare function applyConfigEdits({ source, edits, extensions }: {
+  source: string;
+  edits: Array<ConfigEdit>;
+  extensions?: InstalledExtensions;
+}): {
+  source: string;
+  outcomes: Array<ConfigEditOutcome>;
+  changed: boolean;
+};
 /**
  * Applies `edits` to the config file at `filePath`, writing it only when something changed.
  * `add-plugin` accepts `@kubb/plugin-*` packages and the plugins in `extensions`.

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { E as InstalledExtensions, N as PublishedSnapshot, U as SnapshotUploadMetadata, a as AgentConnectInfo, c as AgentPermissions, d as ConfigEditOutcome, s as AgentPermission, u as ConfigEdit } from "./protocol-a_DcTFba.js";
+import { F as PublishedSnapshot, G as SnapshotUploadMetadata, O as InstalledExtensions, a as AgentConnectInfo, c as AgentPermissions, d as ConfigEditOutcome, s as AgentPermission, u as ConfigEdit } from "./protocol-dCzUP4dH.js";
 import { Config, Hookable, KubbHooks } from "@kubb/core";
 //#region src/connect.d.ts
 /**
@@ -47,6 +47,14 @@ declare global {
       'studio:command': [ctx: {
         command: 'generate' | 'saveConfig' | 'readFiles' | 'readInput' | 'readDiff';
         info: string;
+        /**
+         * The Studio user who asked for the command, when Studio names one.
+         */
+        requestedBy?: string;
+        /**
+         * Set when a generation failed. Its diagnostics went out through `kubb:generation:end`.
+         */
+        failed?: boolean;
       }];
       /**
        * A refused or ignored request, with the missing permission so the host can add a remedy.
@@ -72,9 +80,10 @@ type ConnectAgentOptions = {
    */
   configPath: string;
   /**
-   * Called for every handshake and every generation, so edits on disk show up.
+   * Called for every handshake and every generation, so edits on disk show up. One entry per
+   * `defineConfig(...)` entry, and a generation names the one it runs.
    */
-  loadConfig: () => Promise<Config>;
+  loadConfigs: () => Promise<Array<Config>>;
   /**
    * The host's own version, reported to Studio next to the runtime's.
    */
@@ -114,7 +123,7 @@ type ConnectAgentOptions = {
  * const hooks = new Hookable<KubbHooks>()
  * hooks.hook('studio:connected', ({ agentSlug }) => console.log(`Connected as ${agentSlug}`))
  *
- * await connectAgent({ token, configPath: 'kubb.config.ts', loadConfig, version: '1.0.0', hooks, signal })
+ * await connectAgent({ token, configPath: 'kubb.config.ts', loadConfigs, version: '1.0.0', hooks, signal })
  * ```
  */
 export declare function connectAgent(options: ConnectAgentOptions): Promise<void>;
@@ -242,6 +251,29 @@ export declare function createSnapshot({ studioUrl, apiKey, config, hooks, signa
 export declare const defaultStudioUrl = "https://kubb.studio";
 //#endregion
 //#region src/configFile.d.ts
+/**
+ * Applies edits to a `kubb.config.ts` in place. Each edit rewrites only the text it targets, so
+ * comments, formatting, and hand-written code around the config survive.
+ *
+ * Edits are independent: one that cannot be applied is reported in `outcomes` and the rest still run.
+ *
+ * @example
+ * ```ts
+ * const { source, outcomes } = applyConfigEdits({
+ *   source: current,
+ *   edits: [{ operation: 'set', plugin: '@kubb/plugin-ts', path: ['enum', 'type'], value: 'enum' }],
+ * })
+ * ```
+ */
+export declare function applyConfigEdits({ source, edits, extensions }: {
+  source: string;
+  edits: Array<ConfigEdit>;
+  extensions?: InstalledExtensions;
+}): {
+  source: string;
+  outcomes: Array<ConfigEditOutcome>;
+  changed: boolean;
+};
 /**
  * Applies `edits` to the config file at `filePath`, writing it only when something changed.
  * `add-plugin` accepts `@kubb/plugin-*` packages and the plugins in `extensions`.

package/dist/index.js

@@ -196,7 +196,7 @@ function getElapsedMs(hrStart) {
 }
 //#endregion
 //#region package.json
-var version = "5.11.4";
+var version = "5.11.6";
 //#endregion
 //#region src/resolveConfig.ts
 /**
@@ -1058,13 +1058,17 @@ function applySet(source, call, path, value, quote) {
 	}
 	return { source: splice(source, rangeOf(target.value).start, rangeOf(target.value).end, printValue(value, quote)) };
 }
-/** Deletes the option at `path`, falling the plugin back to its default for it. */
+/**
+* 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.
+*/
 function applyRemove(source, call, path) {
 	const options = call.arguments[0];
-	if (options?.type !== "ObjectExpression") return { reason: "the factory call has no options to remove" };
+	if (!options) return { source };
+	if (options.type !== "ObjectExpression") return { reason: "the factory was not called with an object literal" };
 	const target = walk(options, path);
 	if ("reason" in target) return target;
-	if ("missing" in target) return { reason: `${path.join(".")} is not set` };
+	if ("missing" in target) return { source };
 	return { source: removeMember(source, target.object, target.index) };
 }
 /**
@@ -1104,6 +1108,22 @@ function applyAddPlugin({ source, parsed, config, edit, quote, extensions }) {
 	const next = insertItem(source, plugins, `${importName}(${Object.keys(options).length ? printValue(options, quote) : ""})`);
 	return { source: taken ? next : insertImport(next, parsed, importName, edit.plugin) };
 }
+/**
+* Rewrites the config's `plugins` array with one item per line, so a call can be commented out without
+* taking its neighbors with it. Not done when a comment sits between the items, which would have to move.
+*/
+function expandPluginsArray(source, config) {
+	const array = property(config, "plugins");
+	if (array?.type !== "ArrayExpression") return void 0;
+	const items = array.elements.flatMap((element) => element ? [element] : []);
+	const { start, end } = rangeOf(array);
+	const ranges = items.map(rangeOf);
+	const gaps = [source.slice(start + 1, ranges[0]?.start ?? end - 1), ...ranges.map((range, index) => source.slice(range.end, ranges[index + 1]?.start ?? end - 1))];
+	if (!items.length || gaps.some((gap) => !/^[\s,]*$/.test(gap))) return void 0;
+	const lineStart = source.lastIndexOf("\n", start - 1) + 1;
+	const indent = source.slice(lineStart).match(/^[ \t]*/)?.[0] ?? "";
+	return splice(source, start, end, `[\n${ranges.map((range) => `${indent}  ${source.slice(range.start, range.end)},`).join("\n")}\n${indent}]`);
+}
 /** Comments out a plugin call in place, keeping its options on disk so `enable-plugin` can restore them exactly. */
 function disablePlugin(source, mod, config, plugin) {
 	const loc = factoryCalls(mod, config).find((entry) => entry.packageName === plugin)?.call.loc;
@@ -1131,9 +1151,17 @@ function applyEdit({ source, edit, quote, extensions }) {
 	const parsed = parseConfigs(source);
 	if ("reason" in parsed) return parsed;
 	const ref = edit.config;
-	const config = typeof ref === "string" ? parsed.configs.find((entry) => configName(entry) === ref) : parsed.configs[ref ?? 0];
+	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") return disablePlugin(source, parsed.mod, config, edit.plugin);
+	if (edit.operation === "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);
+		const reparsed = expanded === void 0 ? void 0 : parseConfigs(expanded);
+		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({
 		source,
@@ -1955,7 +1983,7 @@ var Agent = class extends RpcTarget {
 		});
 		return this.#store;
 	}
-	async [Symbol.asyncDispose]() {
+	async clear() {
 		if (this.#sandbox) await rm(resolveCacheDir(this.#sandboxCacheRoot), {
 			recursive: true,
 			force: true
@@ -1985,10 +2013,12 @@ var Agent = class extends RpcTarget {
 			message: "Studio must call connect() before any other command"
 		});
 	}
-	#logCommand(command, info) {
+	#logCommand(command, info, requestedBy, failed) {
 		return emit(this.#options.hooks, "studio:command", {
 			command,
-			info
+			info,
+			requestedBy,
+			failed
 		});
 	}
 	async #readConfigFileView(source) {
@@ -2015,19 +2045,25 @@ var Agent = class extends RpcTarget {
 	}
 	async connect(info) {
 		this.#session.info = info;
-		const { configPath, root, version: version$1, loadConfig, configFile } = this.#options;
+		const { configPath, root, version: version$1, loadConfigs, configFile } = this.#options;
 		const source = read(configFile);
-		const [config, file, extensions] = await Promise.all([
-			loadConfig(),
+		const [configs, file, extensions] = await Promise.all([
+			loadConfigs(),
 			this.#readConfigFileView(source),
 			this.#installedExtensions(source)
 		]);
-		const output = await this.#readDiskOutput(config).catch(async (error) => {
-			await this.#warn({ message: `Could not read the output directory: ${getErrorMessage(error)}` });
-		});
+		const entries = [];
+		for (const config of configs) {
+			const disk = await this.#readDiskOutput(config).catch(async (error) => {
+				await this.#warn({ message: `Could not read the output directory: ${getErrorMessage(error)}` });
+			});
+			entries.push({
+				...toEntryView(config, extensions),
+				...disk && { disk }
+			});
+		}
 		this.#session.connected.resolve(info);
 		return {
-			output,
 			versions: {
 				kubb: version,
 				agent: version$1
@@ -2036,30 +2072,8 @@ var Agent = class extends RpcTarget {
 			config: {
 				path: configPath,
 				file,
-				plugins: config.plugins.map((plugin) => ({
-					name: toStudioName({
-						name: resolveMeta(plugin).name,
-						extensions
-					}),
-					options: toJSONOptions(plugin.options)
-				})),
-				adapter: config.adapter && {
-					name: toStudioName({
-						name: resolveMeta(config.adapter).name,
-						extensions,
-						kind: "adapter"
-					}),
-					options: toJSONOptions(config.adapter.options)
-				},
-				parsers: config.parsers.map((parser) => ({
-					name: toStudioName({
-						name: resolveMeta(parser).name,
-						extensions,
-						kind: "parser"
-					}),
-					options: toJSONOptions(parser.options)
-				})),
-				extensions: [...extensions.values()]
+				extensions: [...extensions.values()],
+				configs: entries
 			},
 			permissions: this.#permissions
 		};
@@ -2147,7 +2161,9 @@ var Agent = class extends RpcTarget {
 		const { jobId, config: patch } = input;
 		const studioInput = this.#sandbox ? patch?.input : void 0;
 		if (this.#sandbox && (typeof studioInput !== "string" || !studioInput.trim() || getInputKind(studioInput) !== "inline")) return this.#refuse({ message: AgentMessage.SANDBOX_INPUT_ONLY });
-		const [config, extensions] = await Promise.all([this.#options.loadConfig(), this.#installedExtensions()]);
+		const [configs, extensions] = await Promise.all([this.#options.loadConfigs(), this.#installedExtensions()]);
+		const config = pickConfig(configs, patch?.config);
+		if (!config) return this.#refuse({ message: AgentMessage.CONFIG_ENTRY_NOT_FOUND });
 		const [plugins, adapter, parsers] = await Promise.all([
 			mergePlugins({
 				diskPlugins: config.plugins,
@@ -2192,6 +2208,7 @@ var Agent = class extends RpcTarget {
 			allowExec: this.#permissions.allowWrite && this.#permissions.allowExec
 		}).catch(async (error) => {
 			await this.#generations.drop(jobId);
+			await this.#logCommand("generate", getErrorMessage(error), input.requestedBy, true);
 			throw error;
 		});
 		const output = await this.#generations.keep({
@@ -2210,7 +2227,7 @@ var Agent = class extends RpcTarget {
 			output,
 			inputBytes
 		});
-		await this.#logCommand("generate", `${activePlugins.length} plugin${activePlugins.length === 1 ? "" : "s"}, ${this.#permissions.allowWrite ? "written to disk" : "staged on disk"}${studioInput !== void 0 ? ", from a Studio spec" : ""}`);
+		await this.#logCommand("generate", `${activePlugins.length} plugin${activePlugins.length === 1 ? "" : "s"}, ${this.#permissions.allowWrite ? "written to disk" : "staged on disk"}${studioInput !== void 0 ? ", from a Studio spec" : ""}`, input.requestedBy);
 		return {
 			status: "success",
 			files: [...files.paths],
@@ -2249,7 +2266,7 @@ var Agent = class extends RpcTarget {
 				extensions: await this.#installedExtensions()
 			});
 			const applied = outcomes.filter((outcome) => outcome.applied).length;
-			await this.#logCommand("saveConfig", `applied ${applied}/${outcomes.length} edits to ${configPath}`);
+			await this.#logCommand("saveConfig", `applied ${applied}/${outcomes.length} edits to ${configPath}`, input.requestedBy);
 			return {
 				outcomes,
 				changed
@@ -2441,7 +2458,7 @@ async function runSession({ options, openRpc, url, instanceId }) {
 		await emit(hooks, "studio:warn", { message: "Canceled the running generation: the connection to Kubb Studio closed" });
 	}
 	await active?.settled;
-	await agent[Symbol.asyncDispose]();
+	await agent.clear();
 	return {
 		...close,
 		connected: session.info !== void 0
@@ -2450,6 +2467,55 @@ async function runSession({ options, openRpc, url, instanceId }) {
 /**
 * The connection loop with a swappable transport. {@link connectAgent} passes a real WebSocket.
 */
+/** The entry Studio named by position or `name`, else the first. `undefined` for one the file does not have. */
+function pickConfig(configs, ref) {
+	if (typeof ref === "string") return configs.find((config) => config.name === ref);
+	if (ref !== void 0 && !Number.isSafeInteger(ref)) return void 0;
+	return configs[ref ?? 0];
+}
+/** 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;
+	const kind = getInputKind(input);
+	if (kind === "inline") return void 0;
+	if (kind !== "url") return input;
+	const url = new URL(input);
+	url.username = "";
+	url.password = "";
+	return url.href;
+}
+/** A JSON copy of one resolved entry, each extension named by the package its manifest is in. */
+function toEntryView(config, extensions) {
+	const input = reportedInput(config.input);
+	return {
+		...config.name !== void 0 && { name: config.name },
+		...input !== void 0 && { input },
+		output: config.output.path,
+		plugins: config.plugins.map((plugin) => ({
+			name: toStudioName({
+				name: resolveMeta(plugin).name,
+				extensions
+			}),
+			options: toJSONOptions(plugin.options)
+		})),
+		adapter: config.adapter && {
+			name: toStudioName({
+				name: resolveMeta(config.adapter).name,
+				extensions,
+				kind: "adapter"
+			}),
+			options: toJSONOptions(config.adapter.options)
+		},
+		parsers: config.parsers.map((parser) => ({
+			name: toStudioName({
+				name: resolveMeta(parser).name,
+				extensions,
+				kind: "parser"
+			}),
+			options: toJSONOptions(parser.options)
+		}))
+	};
+}
 async function runAgent({ options, openRpc }) {
 	const root = options.root ?? process$1.cwd();
 	const resolved = {
@@ -2511,7 +2577,7 @@ async function runAgent({ options, openRpc }) {
 * const hooks = new Hookable<KubbHooks>()
 * hooks.hook('studio:connected', ({ agentSlug }) => console.log(`Connected as ${agentSlug}`))
 *
-* await connectAgent({ token, configPath: 'kubb.config.ts', loadConfig, version: '1.0.0', hooks, signal })
+* await connectAgent({ token, configPath: 'kubb.config.ts', loadConfigs, version: '1.0.0', hooks, signal })
 * ```
 */
 function connectAgent(options) {
@@ -2904,6 +2970,6 @@ async function createSnapshot({ studioUrl = defaultStudioUrl, apiKey, config, ho
 	return _data.snapshot;
 }
 //#endregion
-export { IncompatibleAgentError, InvalidAgentTokenError, PairingCanceledError, PairingDeniedError, PairingExpiredError, connectAgent, createSnapshot, defaultStudioUrl, pairAgent, writeConfigEdits };
+export { IncompatibleAgentError, InvalidAgentTokenError, PairingCanceledError, PairingDeniedError, PairingExpiredError, applyConfigEdits, connectAgent, createSnapshot, defaultStudioUrl, pairAgent, writeConfigEdits };
 
 //# sourceMappingURL=index.js.map