@kubb/studio 5.2.3 → 5.2.5

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { t as __name } from "./rolldown-runtime-CRm0XQPb.js";
-import { a as AgentPermissions, c as ClientInfo } from "./index-V3fjg2mj.js";
+import { a as AgentPermissions, c as ClientInfo } from "./index-Dq2uq38g.js";
 import { Storage } from "unstorage";
 import { Config, Hookable, KubbHooks } from "@kubb/core";
 //#region src/api.d.ts
@@ -147,6 +147,11 @@ type StudioConnectedContext = {
     agent: string;
   };
 };
+/**
+ * Fired once Studio confirms the `agent:connect` handshake was received and the session is fully
+ * registered. Distinct from `studio:connected`, which only means the socket is open.
+ */
+type StudioReadyContext = Record<string, never>;
 type StudioDisconnectedContext = {
   /**
    * Why Studio ended the session.
@@ -187,6 +192,7 @@ declare global {
     interface KubbHooksRegistry {
       'studio:connecting': [ctx: StudioConnectingContext];
       'studio:connected': [ctx: StudioConnectedContext];
+      'studio:ready': [ctx: StudioReadyContext];
       'studio:disconnected': [ctx: StudioDisconnectedContext];
       'studio:command:start': [ctx: StudioCommandStartContext];
       'studio:command:end': [ctx: StudioCommandEndContext];

package/dist/index.js

@@ -1,5 +1,5 @@
 import { t as __name } from "./rolldown-runtime-CRm0XQPb.js";
-import { isCommandMessage, isDisconnectMessage, isStudioPingMessage } from "./protocol.js";
+import { isCommandMessage, isDisconnectMessage, isStudioPingMessage, isStudioReadyMessage } from "./protocol.js";
 import { createRequire } from "node:module";
 import { styleText } from "node:util";
 import { readFile, writeFile } from "node:fs/promises";
@@ -564,7 +564,7 @@ async function disconnect({ sessionId, token, studioUrl, slug }) {
 }
 //#endregion
 //#region package.json
-var version = "5.2.3";
+var version = "5.2.5";
 //#endregion
 //#region src/hooks.ts
 /**
@@ -670,6 +670,20 @@ function toPluginName(packageName) {
 	return packageName.split("/").pop() ?? packageName;
 }
 /**
+* Adds the `@kubb/` scope a plugin's package carries but its `name` does not, the inverse of
+* {@link toPluginName}. A name outside the `plugin-` convention is left alone, so a third-party
+* plugin is not reported as one of Kubb's.
+*
+* @example
+* ```ts
+* toPackageName('plugin-ts')       // '@kubb/plugin-ts'
+* toPackageName('@acme/my-plugin') // '@acme/my-plugin'
+* ```
+*/
+function toPackageName(name) {
+	return name.startsWith("plugin-") ? `@kubb/${name}` : name;
+}
+/**
 * Derives the conventional named export for a `@kubb/*` plugin package from its package name.
 *
 * @example
@@ -1504,7 +1518,7 @@ const CONNECT_TIMEOUT_MS = 5e3;
 const eventSeqCounters = /* @__PURE__ */ new WeakMap();
 const require = createRequire(import.meta.url);
 async function resolvePeerDependencies(names) {
-	const uniqueNames = [...new Set(names)];
+	const uniqueNames = [...new Set(names.map(toPackageName))];
 	const peerDependencies = {};
 	const missingDependencies = [];
 	const versions = await Promise.all(uniqueNames.map(async (name) => {
@@ -1772,6 +1786,12 @@ function setupEventsStream(ws, hooks) {
 //#endregion
 //#region src/StudioSession.ts
 /**
+* How long the `agent:connect` handshake may go unacknowledged before `studio:ready` is given up
+* on for this open. A Studio that predates the ack never sends one, so this only ever produces a
+* warning, not a reconnect.
+*/
+const READY_TIMEOUT_MS = 1e4;
+/**
 * Fills in a host's options: the hosted Studio URL, the current working directory, and every
 * permission off unless granted. Idempotent, so a reconnect can pass an already-resolved bag
 * back in.
@@ -1842,6 +1862,7 @@ var StudioSession = class {
 	#disposed = false;
 	#isGenerating = false;
 	#heartbeatTimer;
+	#readyTimer;
 	#lastPongAt = Date.now();
 	constructor(options) {
 		this.#options = applyStudioDefaults(options);
@@ -1950,7 +1971,7 @@ var StudioSession = class {
 					path: configPath,
 					file: await this.#readConfigFileView(),
 					plugins: config.plugins.map((plugin) => ({
-						name: `@kubb/${plugin.name}`,
+						name: toPackageName(plugin.name),
 						options: plugin.options ?? {}
 					}))
 				},
@@ -1975,10 +1996,24 @@ var StudioSession = class {
 		});
 		try {
 			await this.#sendConnectedPayload();
+			this.#waitForReady();
 		} catch (error) {
 			await this.#warn(`Failed to send the connect payload: ${getErrorMessage(error)}`);
 		}
 	}
+	/**
+	* Arms the timeout for Studio's `studio:ready` acknowledgement. Re-armed on every open, since a
+	* command sent while the agent is not attached is lost either way (see `#sendConnectedPayload`),
+	* so each reconnect needs its own fresh wait.
+	*/
+	#waitForReady() {
+		if (this.#disposed) return;
+		clearTimeout(this.#readyTimer);
+		this.#readyTimer = setTimeout(() => {
+			this.#readyTimer = void 0;
+			Promise.resolve(this.#warn(`Kubb Studio did not confirm the connection was ready within ${READY_TIMEOUT_MS}ms`)).catch(() => {});
+		}, READY_TIMEOUT_MS);
+	}
 	#onOpen = () => void this.#handleOpen().catch(() => {});
 	#onAbort = () => void this.#end({
 		reason: "shutdown",
@@ -1998,6 +2033,8 @@ var StudioSession = class {
 	dispose(reason = "cleanup") {
 		clearInterval(this.#heartbeatTimer);
 		this.#heartbeatTimer = void 0;
+		clearTimeout(this.#readyTimer);
+		this.#readyTimer = void 0;
 		try {
 			this.#ws?.close(1e3, reason);
 		} catch {}
@@ -2032,6 +2069,12 @@ var StudioSession = class {
 				this.#lastPongAt = Date.now();
 				return;
 			}
+			if (isStudioReadyMessage(data)) {
+				clearTimeout(this.#readyTimer);
+				this.#readyTimer = void 0;
+				await this.#hooks.callHook("studio:ready", {});
+				return;
+			}
 			if (isDisconnectMessage(data)) {
 				await this.#handleDisconnect(data.reason);
 				return;