@kubb/studio 5.2.4 → 5.2.5

package/dist/{index-V3fjg2mj.d.ts → index-Dq2uq38g.d.ts}

@@ -327,9 +327,10 @@ declare const commandTypes: readonly ["studio:generate", "studio:connect", "stud
  */
 type ClientInfo = {
   /**
-   * `cli` for a `kubb studio` connection from a developer's machine, `docker` for the agent image.
+   * `cli` for a `kubb studio` connection from a developer's machine, `docker` for the agent image,
+   * `ci` for a client embedded directly in an automated pipeline (no `kubb studio` process).
    */
-  kind: 'cli' | 'docker';
+  kind: 'cli' | 'docker' | 'ci';
 };
 /**
  * Payload of the `agent:connect` handshake, sent when the agent attaches to a session. Carries only
@@ -458,6 +459,14 @@ type AgentPingMessage = {
 type StudioPingMessage = {
   type: 'studio:ping';
 };
+/**
+ * Studio's acknowledgement that an `agent:connect` handshake was received and the session is
+ * fully registered: the connection now counts as available for job dispatch. Distinct from the
+ * socket merely being open, which is not yet the same thing.
+ */
+type StudioReadyMessage = {
+  type: 'studio:ready';
+};
 /**
  * Disconnect message sent from Studio to Agent when the session is expired or revoked.
  * The agent should close the connection without reconnecting.
@@ -548,7 +557,7 @@ type AgentConnectResponse = {
  * Every message that can cross the agent WebSocket, in either direction. Narrow it with the
  * `is*Message` guards below before reading a variant's fields.
  */
-type AgentMessage = CommandMessage | DataMessage | AgentConnectMessage | AgentSaveMessage | AgentPingMessage | AgentDisconnectMessage | StudioErrorMessage | StudioPingMessage | StudioDisconnectMessage;
+type AgentMessage = CommandMessage | DataMessage | AgentConnectMessage | AgentSaveMessage | AgentPingMessage | AgentDisconnectMessage | StudioErrorMessage | StudioPingMessage | StudioReadyMessage | StudioDisconnectMessage;
 declare function isCommandMessage(msg: AgentMessage): msg is CommandMessage;
 /**
  * Type guard to narrow a data message to a specific event type.
@@ -563,7 +572,8 @@ declare function isCommandMessage(msg: AgentMessage): msg is CommandMessage;
  */
 declare function isDataMessage<T extends KubbHook>(msg: AgentMessage, type?: T): msg is DataMessage<T>;
 declare function isStudioPingMessage(msg: AgentMessage): msg is StudioPingMessage;
+declare function isStudioReadyMessage(msg: AgentMessage): msg is StudioReadyMessage;
 declare function isDisconnectMessage(msg: AgentMessage): msg is StudioDisconnectMessage;
 //#endregion
-export { isCommandMessage as A, StudioConnectMessage as C, StudioPingMessage as D, StudioGenerateMessage as E, isDisconnectMessage as M, isStudioPingMessage as N, StudioSaveMessage as O, PluginView as S, StudioErrorMessage as T, DataMessagePayload as _, AgentPermissions as a, KubbHooks$1 as b, ClientInfo as c, ConfigEditOutcome as d, ConfigFileView as f, DataMessage as g, ConnectMessagePayload as h, AgentMessage as i, isDataMessage as j, commandTypes as k, CommandMessage as l, ConfigView as m, AgentConnectResponse as n, AgentPingMessage as o, ConfigRef as p, AgentDisconnectMessage as r, AgentSaveMessage as s, AgentConnectMessage as t, ConfigEdit as u, JSONKubbConfig as v, StudioDisconnectMessage as w, OptionValue as x, KubbHook as y };
-//# sourceMappingURL=index-V3fjg2mj.d.ts.map
+export { commandTypes as A, StudioConnectMessage as C, StudioPingMessage as D, StudioGenerateMessage as E, isStudioReadyMessage as F, isDataMessage as M, isDisconnectMessage as N, StudioReadyMessage as O, isStudioPingMessage as P, PluginView as S, StudioErrorMessage as T, DataMessagePayload as _, AgentPermissions as a, KubbHooks$1 as b, ClientInfo as c, ConfigEditOutcome as d, ConfigFileView as f, DataMessage as g, ConnectMessagePayload as h, AgentMessage as i, isCommandMessage as j, StudioSaveMessage as k, CommandMessage as l, ConfigView as m, AgentConnectResponse as n, AgentPingMessage as o, ConfigRef as p, AgentDisconnectMessage as r, AgentSaveMessage as s, AgentConnectMessage as t, ConfigEdit as u, JSONKubbConfig as v, StudioDisconnectMessage as w, OptionValue as x, KubbHook as y };
+//# sourceMappingURL=index-Dq2uq38g.d.ts.map

package/dist/index.cjs

@@ -569,7 +569,7 @@ async function disconnect({ sessionId, token, studioUrl, slug }) {
 }
 //#endregion
 //#region package.json
-var version = "5.2.4";
+var version = "5.2.5";
 //#endregion
 //#region src/hooks.ts
 /**
@@ -1791,6 +1791,12 @@ function setupEventsStream(ws$5, 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.
@@ -1861,6 +1867,7 @@ var StudioSession = class {
 	#disposed = false;
 	#isGenerating = false;
 	#heartbeatTimer;
+	#readyTimer;
 	#lastPongAt = Date.now();
 	constructor(options) {
 		this.#options = applyStudioDefaults(options);
@@ -1994,10 +2001,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",
@@ -2017,6 +2038,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 {}
@@ -2051,6 +2074,12 @@ var StudioSession = class {
 				this.#lastPongAt = Date.now();
 				return;
 			}
+			if (require_protocol.isStudioReadyMessage(data)) {
+				clearTimeout(this.#readyTimer);
+				this.#readyTimer = void 0;
+				await this.#hooks.callHook("studio:ready", {});
+				return;
+			}
 			if (require_protocol.isDisconnectMessage(data)) {
 				await this.#handleDisconnect(data.reason);
 				return;