@kubb/studio 5.12.1 → 5.12.2

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-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-CG1bPO_H.cjs";
+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 { Config, Hookable, KubbHooks } from "@kubb/core";
 //#region src/connect.d.ts
 /**
@@ -45,7 +45,7 @@ declare global {
        * A finished command and what it did, such as `applied 2/3 edits to kubb.config.ts`.
        */
       'studio:command': [ctx: {
-        command: 'generate' | 'saveConfig' | 'readFiles' | 'readInput' | 'readDiff';
+        command: 'generate' | 'saveConfig' | 'installExtension' | 'updateExtensions' | 'readFiles' | 'readInput' | 'readDiff';
         info: string;
         /**
          * The Studio user who asked for the command, when Studio names one.
@@ -97,6 +97,8 @@ type ConnectAgentOptions = {
    * What Studio may do in this project. Every permission is off unless granted.
    */
   permissions?: Partial<AgentPermissions>;
+  /** The CLI entry `installExtension` runs `kubb add` with. Found through the project's `kubb` or `@kubb/cli` dependency when omitted. */
+  kubbBin?: string;
   /**
    * Receives the `studio:*` hooks and the `kubb:*` hooks of every generation.
    */

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-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-CG1bPO_H.js";
+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 { Config, Hookable, KubbHooks } from "@kubb/core";
 //#region src/connect.d.ts
 /**
@@ -45,7 +45,7 @@ declare global {
        * A finished command and what it did, such as `applied 2/3 edits to kubb.config.ts`.
        */
       'studio:command': [ctx: {
-        command: 'generate' | 'saveConfig' | 'readFiles' | 'readInput' | 'readDiff';
+        command: 'generate' | 'saveConfig' | 'installExtension' | 'updateExtensions' | 'readFiles' | 'readInput' | 'readDiff';
         info: string;
         /**
          * The Studio user who asked for the command, when Studio names one.
@@ -97,6 +97,8 @@ type ConnectAgentOptions = {
    * What Studio may do in this project. Every permission is off unless granted.
    */
   permissions?: Partial<AgentPermissions>;
+  /** The CLI entry `installExtension` runs `kubb add` with. Found through the project's `kubb` or `@kubb/cli` dependency when omitted. */
+  kubbBin?: string;
   /**
    * Receives the `studio:*` hooks and the `kubb:*` hooks of every generation.
    */

package/dist/index.js

@@ -1,17 +1,17 @@
 import { AGENT_INSTANCE_HEADER, AGENT_SOCKET_PATH, AgentCloseCode, AgentMessage, AgentPermission, 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 { 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 { pathToFileURL } from "node:url";
-import { Readable, Transform } from "node:stream";
-import { existsSync } from "node:fs";
+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";
+import { pathToFileURL } from "node:url";
 import { structuredPatch } from "diff";
 import { stripVTControlCharacters } from "node:util";
 import { ast } from "@kubb/ast";
@@ -19,6 +19,7 @@ import dns from "node:dns";
 import http from "node:http";
 import https from "node:https";
 import net from "node:net";
+import { Readable, Transform } from "node:stream";
 import { ofetch } from "ofetch";
 import { gzipSync } from "node:zlib";
 //#endregion
@@ -201,7 +202,7 @@ function getElapsedMs(hrStart) {
 }
 //#endregion
 //#region package.json
-var version = "5.12.1";
+var version = "5.12.2";
 //#endregion
 //#region src/resolveConfig.ts
 /**
@@ -2013,6 +2014,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 = createRequire(path.resolve(root, "package.json"));
+	const names = ["kubb", "@kubb/cli"];
+	return (require.resolve.paths("kubb") ?? []).flatMap((dir) => names.map((name) => path.join(dir, name, "bin", "kubb.js"))).find((bin) => 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 x(process$1.execPath, [bin, ...args], {
+			signal,
+			timeout: INSTALL_TIMEOUT_MS,
+			throwOnError: false,
+			nodeOptions: {
+				cwd,
+				env: {
+					...process$1.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(() => {});
 }
@@ -2083,6 +2121,8 @@ var Agent = class extends RpcTarget {
 			...permissions,
 			allowWrite: false,
 			allowConfigEdit: false,
+			allowInstall: false,
+			allowUpdate: false,
 			allowRead: true,
 			allowReadAst: true
 		} : permissions;
@@ -2234,6 +2274,8 @@ var Agent = class extends RpcTarget {
 			message: "Connection is closed"
 		});
 		if (this.#session.active) return this.#refuse({ message: AgentMessage.GENERATION_IN_PROGRESS });
+		if (this.#session.install) return this.#refuse({ message: AgentMessage.INSTALL_IN_PROGRESS });
+		if (this.#session.saving) return this.#refuse({ message: AgentMessage.SAVE_IN_PROGRESS });
 		const settled = Promise.withResolvers();
 		this.#session.active = {
 			jobId: input.jobId,
@@ -2374,7 +2416,9 @@ var Agent = class extends 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,
@@ -2390,6 +2434,110 @@ var Agent = class extends 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", AgentPermission.INSTALL);
+		if (!this.#permissions.allowConfigEdit) return refuse("editing kubb.config.ts was not granted", 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", 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();
 		}
 	}
 	/**
@@ -2574,6 +2722,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,
@@ -2642,6 +2792,8 @@ async function runAgent({ options, openRpc }) {
 		permissions: {
 			allowWrite: false,
 			allowConfigEdit: false,
+			allowInstall: false,
+			allowUpdate: false,
 			allowExec: false,
 			allowRead: false,
 			allowReadAst: false,