@kubb/studio 5.12.1 → 5.12.2

package/dist/index.cjs

@@ -23,20 +23,20 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 //#endregion
 const require_protocol = require("./protocol.cjs");
 let node_crypto = require("node:crypto");
+let node_fs = require("node:fs");
+let node_module = require("node:module");
 let node_os = require("node:os");
 let node_path = require("node:path");
 node_path = __toESM(node_path, 1);
 let node_process = require("node:process");
 node_process = __toESM(node_process, 1);
 let node_timers_promises = require("node:timers/promises");
-let node_url = require("node:url");
-let node_stream = require("node:stream");
-let node_fs = require("node:fs");
+let tinyexec = require("tinyexec");
 let node_fs_promises = require("node:fs/promises");
 let _kubb_core = require("@kubb/core");
 let capnweb = require("capnweb");
 let magicast = require("magicast");
-let node_module = require("node:module");
+let node_url = require("node:url");
 let diff = require("diff");
 let node_util = require("node:util");
 let _kubb_ast = require("@kubb/ast");
@@ -48,6 +48,7 @@ let node_https = require("node:https");
 node_https = __toESM(node_https, 1);
 let node_net = require("node:net");
 node_net = __toESM(node_net, 1);
+let node_stream = require("node:stream");
 let ofetch = require("ofetch");
 let node_zlib = require("node:zlib");
 //#region ../../internals/utils/src/casing.ts
@@ -229,7 +230,7 @@ function getElapsedMs(hrStart) {
 }
 //#endregion
 //#region package.json
-var version = "5.12.1";
+var version = "5.12.2";
 //#endregion
 //#region src/resolveConfig.ts
 /**
@@ -2041,6 +2042,43 @@ var IncompatibleAgentError = class extends Error {
 		this.name = "IncompatibleAgentError";
 	}
 };
+const INSTALL_TIMEOUT_MS = 3e5;
+/** `owner/slug` or `slug`, as `kubb add` takes it. Checked before it becomes an argument. */
+const REGISTRY_ID = /^[a-z0-9]+(?:-[a-z0-9]+)*(?:\/[a-z0-9]+(?:-[a-z0-9]+)*)?$/;
+/** The CLI the project depends on, so `kubb add` installs next to what the config imports. */
+function findKubbBin(root) {
+	const require$1 = (0, node_module.createRequire)(node_path.default.resolve(root, "package.json"));
+	const names = ["kubb", "@kubb/cli"];
+	return (require$1.resolve.paths("kubb") ?? []).flatMap((dir) => names.map((name) => node_path.default.join(dir, name, "bin", "kubb.js"))).find((bin) => (0, node_fs.existsSync)(bin));
+}
+/** Runs a `kubb` command without a shell, and keeps the end of its output for the failure reason. */
+async function runKubb({ bin, args, cwd, signal }) {
+	try {
+		const { stdout, stderr, exitCode } = await (0, tinyexec.x)(node_process.default.execPath, [bin, ...args], {
+			signal,
+			timeout: INSTALL_TIMEOUT_MS,
+			throwOnError: false,
+			nodeOptions: {
+				cwd,
+				env: {
+					...node_process.default.env,
+					NO_COLOR: "1",
+					FORCE_COLOR: "0"
+				}
+			}
+		});
+		const output = `${stdout}\n${stderr}`.trim().split("\n").slice(-20).join("\n");
+		return {
+			failed: exitCode !== 0,
+			output: output || `kubb ${args[0]} exited with ${exitCode ?? "a signal"}`
+		};
+	} catch (error) {
+		return {
+			failed: true,
+			output: `kubb ${args[0]} did not run: ${getErrorMessage(error)}`
+		};
+	}
+}
 function emit(hooks, name, ...args) {
 	return Promise.resolve(hooks.callHook(name, ...args)).catch(() => {});
 }
@@ -2111,6 +2149,8 @@ var Agent = class extends capnweb.RpcTarget {
 			...permissions,
 			allowWrite: false,
 			allowConfigEdit: false,
+			allowInstall: false,
+			allowUpdate: false,
 			allowRead: true,
 			allowReadAst: true
 		} : permissions;
@@ -2262,6 +2302,8 @@ var Agent = class extends capnweb.RpcTarget {
 			message: "Connection is closed"
 		});
 		if (this.#session.active) return this.#refuse({ message: require_protocol.AgentMessage.GENERATION_IN_PROGRESS });
+		if (this.#session.install) return this.#refuse({ message: require_protocol.AgentMessage.INSTALL_IN_PROGRESS });
+		if (this.#session.saving) return this.#refuse({ message: require_protocol.AgentMessage.SAVE_IN_PROGRESS });
 		const settled = Promise.withResolvers();
 		this.#session.active = {
 			jobId: input.jobId,
@@ -2402,7 +2444,9 @@ var Agent = class extends capnweb.RpcTarget {
 			await this.#warn({ message: "Ignored save: editing kubb.config.ts was not granted" });
 			return refuse("the agent was not granted permission to edit kubb.config.ts");
 		}
-		if (this.#session.active) return refuse("a generation is in progress");
+		const busy = this.#busy();
+		if (busy) return refuse(busy);
+		this.#session.saving = true;
 		try {
 			const { outcomes, changed } = await writeConfigEdits({
 				filePath: configFile,
@@ -2418,6 +2462,110 @@ var Agent = class extends capnweb.RpcTarget {
 		} catch (error) {
 			await emit(this.#options.hooks, "studio:error", { error: toError(error) });
 			return refuse(getErrorMessage(error));
+		} finally {
+			this.#session.saving = false;
+		}
+	}
+	/**
+	* 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.
+	*/
+	async installExtension(input) {
+		this.#assertConnected();
+		const { root, configFile, kubbBin = findKubbBin(root) } = this.#options;
+		const refuse = async (reason, permission) => {
+			await this.#warn({
+				message: `Ignored install: ${reason}`,
+				permission
+			});
+			return {
+				installed: false,
+				reason
+			};
+		};
+		if (typeof input?.id !== "string" || !REGISTRY_ID.test(input.id)) return refuse("the message carried no registry id");
+		if (!this.#permissions.allowInstall) return refuse("installing extensions was not granted", require_protocol.AgentPermission.INSTALL);
+		if (!this.#permissions.allowConfigEdit) return refuse("editing kubb.config.ts was not granted", require_protocol.AgentPermission.CONFIG_EDIT);
+		const busy = this.#busy();
+		if (busy) return refuse(busy);
+		if (!kubbBin) return refuse("kubb is not installed in the project");
+		const { failed, output } = await this.#runKubb({
+			bin: kubbBin,
+			args: [
+				"add",
+				input.id,
+				"--yes",
+				"--config",
+				configFile
+			]
+		});
+		await this.#logCommand("installExtension", `${failed ? "failed to install" : "installed"} ${input.id}`, input.requestedBy, failed);
+		return failed ? {
+			installed: false,
+			reason: output
+		} : { installed: true };
+	}
+	/**
+	* Moves installed extensions to the registry's version with `kubb update [ids] --yes`, which
+	* installs packages and leaves `kubb.config.ts` alone. Studio calls `connect()` again afterwards.
+	*/
+	async updateExtensions(input) {
+		this.#assertConnected();
+		const { root, kubbBin = findKubbBin(root) } = this.#options;
+		const refuse = async (reason, permission) => {
+			await this.#warn({
+				message: `Ignored update: ${reason}`,
+				permission
+			});
+			return {
+				updated: false,
+				reason
+			};
+		};
+		const ids = input?.ids ?? [];
+		if (!Array.isArray(ids) || !ids.every((id) => typeof id === "string" && REGISTRY_ID.test(id))) return refuse("the message carried an invalid registry id");
+		if (!this.#permissions.allowUpdate) return refuse("updating extensions was not granted", require_protocol.AgentPermission.UPDATE);
+		const busy = this.#busy();
+		if (busy) return refuse(busy);
+		if (!kubbBin) return refuse("kubb is not installed in the project");
+		const { failed, output } = await this.#runKubb({
+			bin: kubbBin,
+			args: [
+				"update",
+				...ids,
+				"--yes"
+			]
+		});
+		await this.#logCommand("updateExtensions", `${failed ? "failed to update" : "updated"} ${ids.join(", ") || "all extensions"}`, input?.requestedBy, failed);
+		return failed ? {
+			updated: false,
+			reason: output
+		} : { updated: true };
+	}
+	/** Why a command that touches the project cannot start right now. */
+	#busy() {
+		if (this.#session.active) return "a generation is in progress";
+		if (this.#session.install) return "an install or update is in progress";
+		if (this.#session.saving) return "a save is in progress";
+	}
+	/** Runs `kubb` in the project while holding off saves and generations, and ends it when the socket closes. */
+	async #runKubb({ bin, args }) {
+		const controller = new AbortController();
+		const settled = Promise.withResolvers();
+		this.#session.install = {
+			abort: () => controller.abort(),
+			settled: settled.promise
+		};
+		try {
+			return await runKubb({
+				bin,
+				args,
+				cwd: this.#options.root,
+				signal: controller.signal
+			});
+		} finally {
+			this.#session.install = void 0;
+			settled.resolve();
 		}
 	}
 	/**
@@ -2602,6 +2750,8 @@ 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;
+	session.install?.abort();
+	await session.install?.settled;
 	await agent.clear();
 	return {
 		...close,
@@ -2670,6 +2820,8 @@ async function runAgent({ options, openRpc }) {
 		permissions: {
 			allowWrite: false,
 			allowConfigEdit: false,
+			allowInstall: false,
+			allowUpdate: false,
 			allowExec: false,
 			allowRead: false,
 			allowReadAst: false,