@kubb/studio 5.12.0 → 5.12.2

package/dist/index.cjs

@@ -23,22 +23,32 @@ 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_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");
+let node_dns = require("node:dns");
+node_dns = __toESM(node_dns, 1);
+let node_http = require("node:http");
+node_http = __toESM(node_http, 1);
+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
@@ -220,7 +230,7 @@ function getElapsedMs(hrStart) {
 }
 //#endregion
 //#region package.json
-var version = "5.12.0";
+var version = "5.12.2";
 //#endregion
 //#region src/resolveConfig.ts
 /**
@@ -1866,6 +1876,106 @@ function createGenerationStream(hooks, jobId) {
 	};
 }
 //#endregion
+//#region src/publicFetch.ts
+const MAX_REDIRECTS = 5;
+const MAX_BYTES = 52428800;
+const REDIRECTS = /* @__PURE__ */ new Set([
+	301,
+	302,
+	303,
+	307,
+	308
+]);
+const NO_BODY = /* @__PURE__ */ new Set([
+	204,
+	205,
+	304
+]);
+function notPublic(host) {
+	return /* @__PURE__ */ new Error(`${host} is not a public address, so a managed agent does not fetch from it`);
+}
+function createLookup(blocked) {
+	return (hostname, options, callback) => {
+		node_dns.default.lookup(hostname, {
+			...options,
+			all: true
+		}, (error, addresses) => {
+			if (error) return callback(error, "", 0);
+			const found = addresses;
+			if (!found.length || found.some(({ address }) => !(0, _kubb_core.isPublicAddress)(address, blocked))) return callback(notPublic(hostname), "", 0);
+			return options.all ? callback(null, found) : callback(null, found[0].address, found[0].family);
+		});
+	};
+}
+function request({ url, blocked, signal }) {
+	if (url.protocol !== "http:" && url.protocol !== "https:") return Promise.reject(/* @__PURE__ */ new Error(`Only http and https URLs are fetched, not ${url.protocol}`));
+	const host = url.hostname.replace(/^\[|\]$/g, "");
+	if (node_net.default.isIP(host) && !(0, _kubb_core.isPublicAddress)(host, blocked)) return Promise.reject(notPublic(host));
+	return new Promise((resolve, reject) => {
+		const req = (url.protocol === "https:" ? node_https.default.request : node_http.default.request)(url, {
+			method: "GET",
+			lookup: createLookup(blocked),
+			signal: signal ?? void 0,
+			headers: { "accept-encoding": "identity" }
+		}, (res) => {
+			const headers = new Headers();
+			for (const [key, value] of Object.entries(res.headers)) for (const item of [value].flat()) if (item !== void 0) headers.append(key, item);
+			let total = 0;
+			const limit = new node_stream.Transform({ transform(chunk, _encoding, done) {
+				total += chunk.length;
+				done(total > MAX_BYTES ? /* @__PURE__ */ new Error("The response is larger than 50 MB") : null, chunk);
+			} });
+			res.on("error", (error) => limit.destroy(error));
+			res.pipe(limit);
+			const body = NO_BODY.has(res.statusCode ?? 0) ? null : node_stream.Readable.toWeb(limit);
+			resolve(new Response(body, {
+				status: res.statusCode,
+				statusText: res.statusMessage,
+				headers
+			}));
+		});
+		req.on("error", reject);
+		req.end();
+	});
+}
+/**
+* Builds a `fetch` that only reaches addresses `blocked` does not list. It follows redirects itself
+* and checks every hop, and takes GET requests only, since that is all a spec load needs.
+*/
+function createPublicFetch(blocked) {
+	const publicFetch = async (input, init) => {
+		if (typeof input !== "string" && !(input instanceof URL)) throw new TypeError("A managed agent fetches by URL only");
+		if (init?.method && init.method.toUpperCase() !== "GET") throw new TypeError("A managed agent only sends GET requests");
+		let url = new URL(input);
+		for (let hop = 0; hop <= MAX_REDIRECTS; hop++) {
+			const response = await request({
+				url,
+				blocked,
+				signal: init?.signal
+			});
+			const location = response.headers.get("location");
+			if (!REDIRECTS.has(response.status) || !location) return response;
+			await response.body?.cancel();
+			url = new URL(location, url);
+		}
+		throw new Error(`Stopped after ${MAX_REDIRECTS} redirects from ${String(input)}`);
+	};
+	return publicFetch;
+}
+/**
+* Runs `run` with the global `fetch` limited to public addresses, then puts the original back.
+* A managed agent runs one job at a time, so nothing else shares the window.
+*/
+async function withPublicFetch(run) {
+	const original = globalThis.fetch;
+	globalThis.fetch = createPublicFetch();
+	try {
+		return await run();
+	} finally {
+		globalThis.fetch = original;
+	}
+}
+//#endregion
 //#region src/url.ts
 /**
 * Hosted Kubb Studio URL, used when a host passes none.
@@ -1902,6 +2012,11 @@ const OPEN_TIMEOUT_MS = 5e3;
 const MAX_RETRY_DELAY_MS = 3e4;
 const DISK_SNAPSHOT_MAX_FILES = 1e4;
 const SANDBOX_GENERATION_TTL_MS = 9e5;
+const MANAGED_INPUT_KINDS = /* @__PURE__ */ new Set([
+	"inline",
+	"url",
+	"git"
+]);
 /** Extensions `kubb` ships with, so they count as installed without being a direct dependency. */
 const BUILT_IN_PACKAGES = [
 	"@kubb/adapter-oas",
@@ -1927,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(() => {});
 }
@@ -1988,12 +2140,17 @@ var Agent = class extends capnweb.RpcTarget {
 	get #sandbox() {
 		return this.#session.info?.sandbox === true;
 	}
+	get #managed() {
+		return this.#session.info?.managed === true;
+	}
 	get #permissions() {
 		const { permissions } = this.#options;
 		return this.#sandbox ? {
 			...permissions,
 			allowWrite: false,
 			allowConfigEdit: false,
+			allowInstall: false,
+			allowUpdate: false,
 			allowRead: true,
 			allowReadAst: true
 		} : permissions;
@@ -2145,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,
@@ -2183,8 +2342,9 @@ var Agent = class extends capnweb.RpcTarget {
 	*/
 	async #generate({ input, root, outputRoot, signal }) {
 		const { jobId, config: patch } = input;
-		const studioInput = this.#sandbox ? patch?.input : void 0;
+		const studioInput = this.#sandbox || this.#managed ? patch?.input : void 0;
 		if (this.#sandbox && (typeof studioInput !== "string" || !studioInput.trim() || (0, _kubb_core.getInputKind)(studioInput) !== "inline")) return this.#refuse({ message: require_protocol.AgentMessage.SANDBOX_INPUT_ONLY });
+		if (this.#managed && studioInput !== void 0 && !MANAGED_INPUT_KINDS.has((0, _kubb_core.getInputKind)(studioInput))) return this.#refuse({ message: require_protocol.AgentMessage.MANAGED_INPUT_KIND });
 		const [configs, extensions] = await Promise.all([this.#options.loadConfigs(), this.#installedExtensions()]);
 		const config = pickConfig(configs, patch?.config);
 		if (!config) return this.#refuse({ message: require_protocol.AgentMessage.CONFIG_ENTRY_NOT_FOUND });
@@ -2213,12 +2373,13 @@ var Agent = class extends capnweb.RpcTarget {
 			throw error;
 		});
 		const activePlugins = plugins ?? config.plugins;
-		if (patch?.input && !this.#sandbox) await emit(this.#options.hooks, "kubb:warn", { message: "Ignored the spec from Studio: generating from a Studio spec is only available to a sandbox agent" });
-		const files = await generate({
+		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 && (0, _kubb_core.getInputKind)(studioInput) === "git" ? await (0, _kubb_core.checkoutGitInput)(studioInput, signal, { publicOnly: true }).catch((error) => this.#refuse({ message: getErrorMessage(error) })) : void 0;
+		const run = () => generate({
 			config: {
 				...config,
 				root,
-				input: studioInput ?? config.input,
+				input: checkout?.path ?? studioInput ?? config.input,
 				storage: outputRoot ? stagingStorage({
 					root,
 					directory: outputRoot
@@ -2230,11 +2391,12 @@ var Agent = class extends capnweb.RpcTarget {
 			hooks: this.#options.hooks,
 			signal,
 			allowExec: this.#permissions.allowWrite && this.#permissions.allowExec
-		}).catch(async (error) => {
+		});
+		const files = await (this.#managed ? withPublicFetch(run) : run()).catch(async (error) => {
 			await this.#generations.drop(jobId);
 			await this.#logCommand("generate", getErrorMessage(error), input.requestedBy, true);
 			throw error;
-		});
+		}).finally(() => checkout?.dispose());
 		const output = await this.#generations.keep({
 			jobId,
 			files,
@@ -2282,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,
@@ -2298,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();
 		}
 	}
 	/**
@@ -2482,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,
@@ -2550,6 +2820,8 @@ async function runAgent({ options, openRpc }) {
 		permissions: {
 			allowWrite: false,
 			allowConfigEdit: false,
+			allowInstall: false,
+			allowUpdate: false,
 			allowExec: false,
 			allowRead: false,
 			allowReadAst: false,