@copilotkit/runtime 1.55.0-next.7 → 1.55.0-next.8

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @copilotkit/runtime
 
+## 1.55.0-next.8
+
+### Patch Changes
+
+- 8aafcbe: fix(agent): harden BuiltInAgent reasoning lifecycle
+  - Skip empty reasoning deltas (violates @ag-ui/core schema)
+  - Auto-close reasoning lifecycle when SDK omits reasoning-end (on consecutive-start, phase transitions, abort, error, and fallback paths)
+  - Make reasoning-end idempotent to prevent duplicate close events when auto-close already fired
+  - Regenerate reasoningMessageId for consecutive reasoning blocks when SDK provides no id
+  - Close reasoning in outer catch block so exceptions mid-reasoning emit proper lifecycle events
+  - @copilotkit/shared@1.55.0-next.8
+
 ## 1.55.0-next.7
 
 ### Minor Changes

package/dist/agent/index.cjs

@@ -320,6 +320,23 @@ This is state from the application that you can edit by calling AGUISendStateSna
 				const abortController = new AbortController();
 				this.abortController = abortController;
 				let terminalEventEmitted = false;
+				let messageId = (0, crypto.randomUUID)();
+				let reasoningMessageId = (0, crypto.randomUUID)();
+				let isInReasoning = false;
+				const closeReasoningIfOpen = () => {
+					if (!isInReasoning) return;
+					isInReasoning = false;
+					const reasoningMsgEnd = {
+						type: _ag_ui_client.EventType.REASONING_MESSAGE_END,
+						messageId: reasoningMessageId
+					};
+					subscriber.next(reasoningMsgEnd);
+					const reasoningEnd = {
+						type: _ag_ui_client.EventType.REASONING_END,
+						messageId: reasoningMessageId
+					};
+					subscriber.next(reasoningEnd);
+				};
 				try {
 					streamTextParams.tools = {
 						...streamTextParams.tools,
@@ -377,8 +394,6 @@ This is state from the application that you can edit by calling AGUISendStateSna
 						...streamTextParams,
 						abortSignal: abortController.signal
 					});
-					let messageId = (0, crypto.randomUUID)();
-					let reasoningMessageId = (0, crypto.randomUUID)();
 					const toolCallStates = /* @__PURE__ */ new Map();
 					const ensureToolCallState = (toolCallId) => {
 						let state = toolCallStates.get(toolCallId);
@@ -392,194 +407,189 @@ This is state from the application that you can edit by calling AGUISendStateSna
 						}
 						return state;
 					};
-					for await (const part of response.fullStream) switch (part.type) {
-						case "abort": {
-							const abortEndEvent = {
-								type: _ag_ui_client.EventType.RUN_FINISHED,
-								threadId: input.threadId,
-								runId: input.runId
-							};
-							subscriber.next(abortEndEvent);
-							terminalEventEmitted = true;
-							subscriber.complete();
-							break;
-						}
-						case "reasoning-start": {
-							const providedId = "id" in part ? part.id : void 0;
-							if (providedId && providedId !== "0") reasoningMessageId = providedId;
-							const reasoningStartEvent = {
-								type: _ag_ui_client.EventType.REASONING_START,
-								messageId: reasoningMessageId
-							};
-							subscriber.next(reasoningStartEvent);
-							const reasoningMessageStart = {
-								type: _ag_ui_client.EventType.REASONING_MESSAGE_START,
-								messageId: reasoningMessageId,
-								role: "reasoning"
-							};
-							subscriber.next(reasoningMessageStart);
-							break;
-						}
-						case "reasoning-delta": {
-							const reasoningDeltaEvent = {
-								type: _ag_ui_client.EventType.REASONING_MESSAGE_CONTENT,
-								messageId: reasoningMessageId,
-								delta: ("text" in part ? part.text : part.delta) ?? ""
-							};
-							subscriber.next(reasoningDeltaEvent);
-							break;
-						}
-						case "reasoning-end": {
-							const reasoningMessageEnd = {
-								type: _ag_ui_client.EventType.REASONING_MESSAGE_END,
-								messageId: reasoningMessageId
-							};
-							subscriber.next(reasoningMessageEnd);
-							const reasoningEndEvent = {
-								type: _ag_ui_client.EventType.REASONING_END,
-								messageId: reasoningMessageId
-							};
-							subscriber.next(reasoningEndEvent);
-							break;
-						}
-						case "tool-input-start": {
-							const toolCallId = part.id;
-							const state = ensureToolCallState(toolCallId);
-							state.toolName = part.toolName;
-							if (!state.started) {
-								state.started = true;
-								const startEvent = {
-									type: _ag_ui_client.EventType.TOOL_CALL_START,
-									parentMessageId: messageId,
-									toolCallId,
-									toolCallName: part.toolName
+					for await (const part of response.fullStream) {
+						if (part.type !== "reasoning-delta") closeReasoningIfOpen();
+						switch (part.type) {
+							case "abort": {
+								const abortEndEvent = {
+									type: _ag_ui_client.EventType.RUN_FINISHED,
+									threadId: input.threadId,
+									runId: input.runId
 								};
-								subscriber.next(startEvent);
+								subscriber.next(abortEndEvent);
+								terminalEventEmitted = true;
+								subscriber.complete();
+								break;
 							}
-							break;
-						}
-						case "tool-input-delta": {
-							const toolCallId = part.id;
-							const state = ensureToolCallState(toolCallId);
-							state.hasArgsDelta = true;
-							const argsEvent = {
-								type: _ag_ui_client.EventType.TOOL_CALL_ARGS,
-								toolCallId,
-								delta: part.delta
-							};
-							subscriber.next(argsEvent);
-							break;
-						}
-						case "tool-input-end": break;
-						case "text-start": {
-							const providedId = "id" in part ? part.id : void 0;
-							messageId = providedId && providedId !== "0" ? providedId : (0, crypto.randomUUID)();
-							break;
-						}
-						case "text-delta": {
-							const textDelta = "text" in part ? part.text : "";
-							const textEvent = {
-								type: _ag_ui_client.EventType.TEXT_MESSAGE_CHUNK,
-								role: "assistant",
-								messageId,
-								delta: textDelta
-							};
-							subscriber.next(textEvent);
-							break;
-						}
-						case "tool-call": {
-							const toolCallId = part.toolCallId;
-							const state = ensureToolCallState(toolCallId);
-							state.toolName = part.toolName ?? state.toolName;
-							if (!state.started) {
-								state.started = true;
-								const startEvent = {
-									type: _ag_ui_client.EventType.TOOL_CALL_START,
-									parentMessageId: messageId,
-									toolCallId,
-									toolCallName: part.toolName
+							case "reasoning-start": {
+								const providedId = "id" in part ? part.id : void 0;
+								reasoningMessageId = providedId && providedId !== "0" ? providedId : (0, crypto.randomUUID)();
+								const reasoningStartEvent = {
+									type: _ag_ui_client.EventType.REASONING_START,
+									messageId: reasoningMessageId
+								};
+								subscriber.next(reasoningStartEvent);
+								const reasoningMessageStart = {
+									type: _ag_ui_client.EventType.REASONING_MESSAGE_START,
+									messageId: reasoningMessageId,
+									role: "reasoning"
+								};
+								subscriber.next(reasoningMessageStart);
+								isInReasoning = true;
+								break;
+							}
+							case "reasoning-delta": {
+								const delta = part.text ?? "";
+								if (!delta) break;
+								const reasoningDeltaEvent = {
+									type: _ag_ui_client.EventType.REASONING_MESSAGE_CONTENT,
+									messageId: reasoningMessageId,
+									delta
 								};
-								subscriber.next(startEvent);
+								subscriber.next(reasoningDeltaEvent);
+								break;
 							}
-							if (!state.hasArgsDelta && "input" in part && part.input !== void 0) {
-								let serializedInput = "";
-								if (typeof part.input === "string") serializedInput = part.input;
-								else try {
-									serializedInput = JSON.stringify(part.input);
-								} catch {
-									serializedInput = String(part.input);
+							case "reasoning-end": break;
+							case "tool-input-start": {
+								const toolCallId = part.id;
+								const state = ensureToolCallState(toolCallId);
+								state.toolName = part.toolName;
+								if (!state.started) {
+									state.started = true;
+									const startEvent = {
+										type: _ag_ui_client.EventType.TOOL_CALL_START,
+										parentMessageId: messageId,
+										toolCallId,
+										toolCallName: part.toolName
+									};
+									subscriber.next(startEvent);
 								}
-								if (serializedInput.length > 0) {
-									const argsEvent = {
-										type: _ag_ui_client.EventType.TOOL_CALL_ARGS,
+								break;
+							}
+							case "tool-input-delta": {
+								const toolCallId = part.id;
+								const state = ensureToolCallState(toolCallId);
+								state.hasArgsDelta = true;
+								const argsEvent = {
+									type: _ag_ui_client.EventType.TOOL_CALL_ARGS,
+									toolCallId,
+									delta: part.delta
+								};
+								subscriber.next(argsEvent);
+								break;
+							}
+							case "tool-input-end": break;
+							case "text-start": {
+								const providedId = "id" in part ? part.id : void 0;
+								messageId = providedId && providedId !== "0" ? providedId : (0, crypto.randomUUID)();
+								break;
+							}
+							case "text-delta": {
+								const textDelta = "text" in part ? part.text : "";
+								const textEvent = {
+									type: _ag_ui_client.EventType.TEXT_MESSAGE_CHUNK,
+									role: "assistant",
+									messageId,
+									delta: textDelta
+								};
+								subscriber.next(textEvent);
+								break;
+							}
+							case "tool-call": {
+								const toolCallId = part.toolCallId;
+								const state = ensureToolCallState(toolCallId);
+								state.toolName = part.toolName ?? state.toolName;
+								if (!state.started) {
+									state.started = true;
+									const startEvent = {
+										type: _ag_ui_client.EventType.TOOL_CALL_START,
+										parentMessageId: messageId,
 										toolCallId,
-										delta: serializedInput
+										toolCallName: part.toolName
 									};
-									subscriber.next(argsEvent);
-									state.hasArgsDelta = true;
+									subscriber.next(startEvent);
 								}
+								if (!state.hasArgsDelta && "input" in part && part.input !== void 0) {
+									let serializedInput = "";
+									if (typeof part.input === "string") serializedInput = part.input;
+									else try {
+										serializedInput = JSON.stringify(part.input);
+									} catch {
+										serializedInput = String(part.input);
+									}
+									if (serializedInput.length > 0) {
+										const argsEvent = {
+											type: _ag_ui_client.EventType.TOOL_CALL_ARGS,
+											toolCallId,
+											delta: serializedInput
+										};
+										subscriber.next(argsEvent);
+										state.hasArgsDelta = true;
+									}
+								}
+								if (!state.ended) {
+									state.ended = true;
+									const endEvent = {
+										type: _ag_ui_client.EventType.TOOL_CALL_END,
+										toolCallId
+									};
+									subscriber.next(endEvent);
+								}
+								break;
 							}
-							if (!state.ended) {
-								state.ended = true;
-								const endEvent = {
-									type: _ag_ui_client.EventType.TOOL_CALL_END,
-									toolCallId
+							case "tool-result": {
+								const toolResult = "output" in part ? part.output : null;
+								const toolName = "toolName" in part ? part.toolName : "";
+								toolCallStates.delete(part.toolCallId);
+								if (toolName === "AGUISendStateSnapshot" && toolResult && typeof toolResult === "object") {
+									const stateSnapshotEvent = {
+										type: _ag_ui_client.EventType.STATE_SNAPSHOT,
+										snapshot: toolResult.snapshot
+									};
+									subscriber.next(stateSnapshotEvent);
+								} else if (toolName === "AGUISendStateDelta" && toolResult && typeof toolResult === "object") {
+									const stateDeltaEvent = {
+										type: _ag_ui_client.EventType.STATE_DELTA,
+										delta: toolResult.delta
+									};
+									subscriber.next(stateDeltaEvent);
+								}
+								const resultEvent = {
+									type: _ag_ui_client.EventType.TOOL_CALL_RESULT,
+									role: "tool",
+									messageId: (0, crypto.randomUUID)(),
+									toolCallId: part.toolCallId,
+									content: JSON.stringify(toolResult)
 								};
-								subscriber.next(endEvent);
+								subscriber.next(resultEvent);
+								break;
 							}
-							break;
-						}
-						case "tool-result": {
-							const toolResult = "output" in part ? part.output : null;
-							const toolName = "toolName" in part ? part.toolName : "";
-							toolCallStates.delete(part.toolCallId);
-							if (toolName === "AGUISendStateSnapshot" && toolResult && typeof toolResult === "object") {
-								const stateSnapshotEvent = {
-									type: _ag_ui_client.EventType.STATE_SNAPSHOT,
-									snapshot: toolResult.snapshot
+							case "finish": {
+								const finishedEvent = {
+									type: _ag_ui_client.EventType.RUN_FINISHED,
+									threadId: input.threadId,
+									runId: input.runId
 								};
-								subscriber.next(stateSnapshotEvent);
-							} else if (toolName === "AGUISendStateDelta" && toolResult && typeof toolResult === "object") {
-								const stateDeltaEvent = {
-									type: _ag_ui_client.EventType.STATE_DELTA,
-									delta: toolResult.delta
+								subscriber.next(finishedEvent);
+								terminalEventEmitted = true;
+								subscriber.complete();
+								break;
+							}
+							case "error": {
+								if (abortController.signal.aborted) break;
+								const runErrorEvent = {
+									type: _ag_ui_client.EventType.RUN_ERROR,
+									message: part.error + ""
 								};
-								subscriber.next(stateDeltaEvent);
+								subscriber.next(runErrorEvent);
+								terminalEventEmitted = true;
+								subscriber.error(part.error);
+								break;
 							}
-							const resultEvent = {
-								type: _ag_ui_client.EventType.TOOL_CALL_RESULT,
-								role: "tool",
-								messageId: (0, crypto.randomUUID)(),
-								toolCallId: part.toolCallId,
-								content: JSON.stringify(toolResult)
-							};
-							subscriber.next(resultEvent);
-							break;
-						}
-						case "finish": {
-							const finishedEvent = {
-								type: _ag_ui_client.EventType.RUN_FINISHED,
-								threadId: input.threadId,
-								runId: input.runId
-							};
-							subscriber.next(finishedEvent);
-							terminalEventEmitted = true;
-							subscriber.complete();
-							break;
-						}
-						case "error": {
-							if (abortController.signal.aborted) break;
-							const runErrorEvent = {
-								type: _ag_ui_client.EventType.RUN_ERROR,
-								message: part.error + ""
-							};
-							subscriber.next(runErrorEvent);
-							terminalEventEmitted = true;
-							subscriber.error(part.error);
-							break;
 						}
 					}
 					if (!terminalEventEmitted) {
+						closeReasoningIfOpen();
 						if (abortController.signal.aborted) {} else {
 							const finishedEvent = {
 								type: _ag_ui_client.EventType.RUN_FINISHED,
@@ -592,6 +602,7 @@ This is state from the application that you can edit by calling AGUISendStateSna
 						subscriber.complete();
 					}
 				} catch (error) {
+					closeReasoningIfOpen();
 					if (abortController.signal.aborted) subscriber.complete();
 					else {
 						const runErrorEvent = {