@kubb/studio 5.2.5 → 5.2.7

package/README.md

@@ -96,6 +96,38 @@ nothing can read it back.
 member can approve. A host that pairs a shared or tier-limited agent passes `clientId: 'kubb-agent'`
 and an `agentKind`, whose codes only an admin can approve.
 
+## Asynchronous jobs
+
+CI and automation queue work with `createJob` and poll with `waitForJob`. Both send the
+organization CI API key as `x-api-key`. They do not open a WebSocket.
+
+| Step   | Call                 | What it does                                                          |
+| ------ | -------------------- | --------------------------------------------------------------------- |
+| Queue  | `POST /api/jobs`     | Accepts a `generation` or `snapshot` job and returns `202` with an id |
+| Status | `GET /api/jobs/{id}` | Returns the job until `success` or `failed`                           |
+
+```typescript
+import { createJob, waitForJob } from '@kubb/studio'
+
+const job = await createJob({
+  studioUrl: 'https://kubb.studio',
+  token: process.env.KUBB_TOKEN!,
+  type: 'snapshot',
+  agentId: agent.id,
+  name: '@scope/package',
+  version: '1.0.0',
+})
+
+const finished = await waitForJob({
+  studioUrl: 'https://kubb.studio',
+  token: process.env.KUBB_TOKEN!,
+  id: job.id,
+})
+
+if (finished.status === 'failed') throw new Error(finished.error)
+const snapshot = finished.snapshot
+```
+
 ## Protocol
 
 `@kubb/studio/protocol` holds the WebSocket message types shared by both ends, so the agent and

package/dist/index.cjs

@@ -564,12 +564,62 @@ async function disconnect({ sessionId, token, studioUrl, slug }) {
 		});
 		console.log((0, node_util.styleText)("green", `[${tag}] Disconnected from Studio`));
 	} catch (error) {
+		const statusCode = error?.statusCode;
+		if (statusCode !== void 0 && statusCode >= 400 && statusCode < 500) return;
 		console.warn((0, node_util.styleText)("yellow", `[${tag}] Failed to notify Studio of disconnection: ${getErrorMessage(error)}`));
 	}
 }
+/**
+* Queues a generation or snapshot job on Studio (`POST /api/jobs`).
+*
+* Returns as soon as Studio accepts the job (`202`). Poll with {@link waitForJob} until it finishes.
+* Authenticates with the organization CI API key via `x-api-key`.
+*
+* @example Snapshot job
+* ```ts
+* const job = await createJob({
+*   studioUrl: 'https://kubb.studio',
+*   token: process.env.KUBB_TOKEN!,
+*   type: 'snapshot',
+*   agentId: agent.id,
+*   name: '@kubb/demo',
+*   version: '1.0.0',
+* })
+* const finished = await waitForJob({ studioUrl, token, id: job.id })
+* ```
+*/
+async function createJob({ studioUrl, token, type, agentId, name, version, config }) {
+	const { job } = await (0, ofetch.ofetch)(`${studioUrl}/api/jobs`, {
+		method: "POST",
+		headers: { "x-api-key": token },
+		body: {
+			type,
+			agentId,
+			name,
+			version,
+			config
+		}
+	});
+	return job;
+}
+/**
+* Polls `GET /api/jobs/{id}` until the job reaches `success` or `failed`.
+*
+* A `failed` job resolves normally. Check `job.status` and `job.error`. Throws only when the
+* deadline passes before Studio finishes.
+*/
+async function waitForJob({ studioUrl, token, id, timeoutMs = 6e4 }) {
+	const deadline = Date.now() + timeoutMs;
+	for (;;) {
+		const { job } = await (0, ofetch.ofetch)(`${studioUrl}/api/jobs/${id}`, { headers: { "x-api-key": token } });
+		if (job.status === "success" || job.status === "failed") return job;
+		if (Date.now() >= deadline) throw new Error("Timed out waiting for the Studio job");
+		await new Promise((resolve) => setTimeout(resolve, 1e3));
+	}
+}
 //#endregion
 //#region package.json
-var version = "5.2.5";
+var version = "5.2.7";
 //#endregion
 //#region src/hooks.ts
 /**
@@ -1522,6 +1572,9 @@ const CONNECT_TIMEOUT_MS = 5e3;
 */
 const eventSeqCounters = /* @__PURE__ */ new WeakMap();
 const require$1 = (0, node_module.createRequire)(require("url").pathToFileURL(__filename).href);
+function relativeStoragePath(root, filePath) {
+	return ((0, node_path.isAbsolute)(filePath) ? (0, node_path.relative)((0, node_path.resolve)(root), filePath) : filePath).replaceAll("\\", "/");
+}
 async function resolvePeerDependencies(names) {
 	const uniqueNames = [...new Set(names.map(toPackageName))];
 	const peerDependencies = {};
@@ -1576,9 +1629,10 @@ function sendAgentMessage(ws$3, message) {
 * Sends a single `kubb:error` payload to Studio, stamped from the same per-socket counter the event stream
 * uses so Studio can still order it against the generation events around it.
 */
-function sendErrorMessage(ws$4, error) {
+function sendErrorMessage(ws$4, error, jobId) {
 	sendAgentMessage(ws$4, {
 		type: "agent:data",
+		jobId,
 		payload: {
 			type: "kubb:error",
 			data: [{
@@ -1593,7 +1647,7 @@ function sendErrorMessage(ws$4, error) {
 /**
 * Forwards selected Kubb lifecycle events to Studio as data messages for the active session.
 */
-function setupEventsStream(ws$5, hooks) {
+function setupEventsStream(ws$5, hooks, jobId) {
 	const unhooks = [];
 	/**
 	* Registers a listener and keeps its remover, so one generation's listeners come off the session
@@ -1605,6 +1659,7 @@ function setupEventsStream(ws$5, hooks) {
 	function sendDataMessage(payload) {
 		sendAgentMessage(ws$5, {
 			type: "agent:data",
+			jobId,
 			payload: {
 				...payload,
 				timestamp: Date.now(),
@@ -1703,7 +1758,7 @@ function setupEventsStream(ws$5, hooks) {
 			limit: FILE_READ_CONCURRENCY,
 			run: async (path) => {
 				const content = await storage.readItem(path);
-				if (content !== null) files[path] = content;
+				if (content !== null) files[relativeStoragePath(config.root, path)] = content;
 			}
 		});
 		sendDataMessage({
@@ -1864,6 +1919,7 @@ var StudioSession = class {
 	#session;
 	#ws;
 	#studioVersion;
+	#activeJobId = null;
 	#disposed = false;
 	#isGenerating = false;
 	#heartbeatTimer;
@@ -1911,7 +1967,7 @@ var StudioSession = class {
 			signal?.addEventListener("abort", this.#onAbort, { once: true });
 			this.#unhooks.push(() => signal?.removeEventListener("abort", this.#onAbort));
 			this.#heartbeatTimer = setInterval(() => this.#sendHeartbeat(), heartbeatInterval);
-			this.#unhooks.push(this.#hooks.hook("kubb:error", ({ error }) => sendErrorMessage(ws, error)));
+			this.#unhooks.push(this.#hooks.hook("kubb:error", ({ error }) => sendErrorMessage(ws, error, this.#activeJobId ?? "connection")));
 		} catch (error) {
 			await this.#hooks.callHook("studio:error", { error: toError(error) });
 			if (error instanceof InvalidAgentTokenError) throw error;
@@ -2132,6 +2188,7 @@ var StudioSession = class {
 			return;
 		}
 		this.#isGenerating = true;
+		this.#activeJobId = data.jobId;
 		try {
 			const config = await loadConfig();
 			const patch = data.payload;
@@ -2144,7 +2201,7 @@ var StudioSession = class {
 				await this.#warn(`Ignored the spec from Studio; set ${remedy} to generate from it`);
 			}
 			const resolvedPlugins = plugins ?? config.plugins;
-			const detach = [setupHookListener(this.#hooks, root), setupEventsStream(ws, this.#hooks)];
+			const detach = [setupHookListener(this.#hooks, root), setupEventsStream(ws, this.#hooks, data.jobId)];
 			try {
 				await generate({
 					config: {
@@ -2172,6 +2229,7 @@ var StudioSession = class {
 			});
 		} finally {
 			this.#isGenerating = false;
+			this.#activeJobId = null;
 		}
 	}
 	async #handleSave(ws, data, command) {
@@ -2180,6 +2238,7 @@ var StudioSession = class {
 			await this.#warn("Ignored save: the message carried no edits");
 			sendAgentMessage(ws, {
 				type: "agent:save",
+				jobId: data.jobId,
 				payload: {
 					outcomes: [],
 					changed: false
@@ -2190,6 +2249,7 @@ var StudioSession = class {
 		const edits = data.edits;
 		const refuse = (reason) => sendAgentMessage(ws, {
 			type: "agent:save",
+			jobId: data.jobId,
 			payload: {
 				outcomes: edits.map((edit) => ({
 					edit,
@@ -2213,6 +2273,7 @@ var StudioSession = class {
 			if (changed) await (0, node_fs_promises.writeFile)(configFile, patched, "utf-8");
 			sendAgentMessage(ws, {
 				type: "agent:save",
+				jobId: data.jobId,
 				payload: {
 					outcomes,
 					changed,
@@ -2438,10 +2499,13 @@ exports.InvalidAgentTokenError = InvalidAgentTokenError;
 exports.PairingCanceledError = PairingCanceledError;
 exports.createClient = createClient;
 exports.createFileStorage = createFileStorage;
+exports.createJob = createJob;
+exports.createJobId = require_protocol.createJobId;
 exports.defaultStudioUrl = defaultStudioUrl;
 exports.pollForPairingToken = pollForPairingToken;
 exports.runConnection = runConnection;
 exports.setStorage = setStorage;
 exports.startPairing = startPairing;
+exports.waitForJob = waitForJob;
 
 //# sourceMappingURL=index.cjs.map