@copilotkit/runtime 1.61.0 → 1.61.2

package/dist/agent/index.cjs

@@ -42,6 +42,18 @@ function resolveModel(spec, apiKey) {
 	}
 }
 /**
+* Thrown by `AgentFactoryContext.interrupt()` on a fresh (non-resume) run to
+* pause the factory. Caught in `runFactory` and translated into a RUN_FINISHED
+* event carrying `outcome:{type:"interrupt",interrupts}`. Not a real error.
+*/
+var InterruptSignal = class extends Error {
+	constructor(interrupts) {
+		super("CopilotKit interrupt: run paused awaiting human input");
+		this.interrupts = interrupts;
+		this.name = "InterruptSignal";
+	}
+};
+/**
 * Define a tool for use with BuiltInAgent
 * @param name - The name of the tool
 * @param description - Description of what the tool does
@@ -54,7 +66,10 @@ function defineTool(config) {
 		name: config.name,
 		description: config.description,
 		parameters: config.parameters,
-		execute: config.execute
+		execute: config.execute,
+		interrupt: config.interrupt,
+		interruptReason: config.interruptReason,
+		interruptMessage: config.interruptMessage
 	};
 }
 /**
@@ -270,6 +285,19 @@ function isJsonSchema(obj) {
 		"array"
 	].includes(schema.type);
 }
+/**
+* Type-only pass-through for handing a Zod schema to the AI SDK's `tool()`.
+* The raw Zod schema is returned unchanged at runtime — the SDK's `asSchema()`
+* converts and validates it internally exactly as before.
+*
+* The Zod type is erased through `unknown` deliberately: letting tsc relate
+* Zod schema types to the AI SDK's `FlexibleSchema` union (conditional types
+* spanning zod v3/v4) makes type instantiation explode (TS2589 / compiler
+* OOM) under this package's `moduleResolution: node`.
+*/
+function toLanguageModelSchema(schema) {
+	return schema;
+}
 function convertToolsToVercelAITools(tools) {
 	const result = {};
 	for (const tool of tools) {
@@ -277,7 +305,7 @@ function convertToolsToVercelAITools(tools) {
 		const zodSchema = convertJsonSchemaToZodSchema(tool.parameters, true);
 		result[tool.name] = (0, ai.tool)({
 			description: tool.description,
-			inputSchema: zodSchema
+			inputSchema: toLanguageModelSchema(zodSchema)
 		});
 	}
 	return result;
@@ -336,16 +364,19 @@ var BuiltInAgent = class BuiltInAgent extends _ag_ui_client.AbstractAgent {
 				supported: true,
 				clientProvided: true
 			},
-			transport: { streaming: true }
+			transport: { streaming: true },
+			humanInTheLoop: { interrupts: true }
 		};
-		if (!this.config.capabilities) return inferred;
+		const capabilities = isFactoryConfig(this.config) ? void 0 : this.config.capabilities;
+		if (!capabilities) return inferred;
 		return {
 			...inferred,
-			...this.config.capabilities
+			...capabilities
 		};
 	}
 	run(input) {
 		if (isFactoryConfig(this.config)) return this.runFactory(input, this.config);
+		const config = this.config;
 		if (this.abortController) throw new Error("Agent is already running. Call abortRun() first or create a new instance.");
 		this.abortController = new AbortController();
 		const abortController = this.abortController;
@@ -356,14 +387,14 @@ var BuiltInAgent = class BuiltInAgent extends _ag_ui_client.AbstractAgent {
 				runId: input.runId
 			};
 			subscriber.next(startEvent);
-			const model = resolveModel(this.config.model, this.config.apiKey);
+			const model = resolveModel(config.model, config.apiKey);
 			let systemPrompt = void 0;
-			const hasPrompt = !!this.config.prompt;
+			const hasPrompt = !!config.prompt;
 			const hasContext = input.context && input.context.length > 0;
 			const hasState = input.state !== void 0 && input.state !== null && !(typeof input.state === "object" && Object.keys(input.state).length === 0);
 			if (hasPrompt || hasContext || hasState) {
 				const parts = [];
-				if (hasPrompt) parts.push(this.config.prompt);
+				if (hasPrompt) parts.push(config.prompt);
 				if (hasContext) {
 					parts.push("\n## Context from the application\n");
 					for (const ctx of input.context) parts.push(`${ctx.description}:\n${ctx.value}\n`);
@@ -375,16 +406,46 @@ This is state from the application that you can edit by calling AGUISendStateSna
 				systemPrompt = parts.join("");
 			}
 			const messages = convertMessagesToVercelAISDKMessages(input.messages, {
-				forwardSystemMessages: this.config.forwardSystemMessages,
-				forwardDeveloperMessages: this.config.forwardDeveloperMessages
+				forwardSystemMessages: config.forwardSystemMessages,
+				forwardDeveloperMessages: config.forwardDeveloperMessages
 			});
 			if (systemPrompt) messages.unshift({
 				role: "system",
 				content: systemPrompt
 			});
+			const resumeEntries = input.resume ?? [];
+			if (resumeEntries.length > 0) {
+				const toolNameById = /* @__PURE__ */ new Map();
+				for (const m of input.messages) {
+					if (m.role !== "assistant") continue;
+					for (const tc of m.toolCalls ?? []) if (tc.id && tc.function?.name) toolNameById.set(tc.id, tc.function.name);
+				}
+				const alreadyAnswered = /* @__PURE__ */ new Set();
+				for (const m of messages) {
+					if (m.role !== "tool" || !Array.isArray(m.content)) continue;
+					for (const part of m.content) if (part && typeof part === "object" && "toolCallId" in part) alreadyAnswered.add(part.toolCallId);
+				}
+				for (const entry of resumeEntries) {
+					if (alreadyAnswered.has(entry.interruptId)) continue;
+					const value = entry.status === "cancelled" ? { status: "cancelled" } : entry.payload ?? { status: "resolved" };
+					const toolResultMessage = {
+						role: "tool",
+						content: [{
+							type: "tool-result",
+							toolCallId: entry.interruptId,
+							toolName: toolNameById.get(entry.interruptId) ?? "",
+							output: {
+								type: "json",
+								value
+							}
+						}]
+					};
+					messages.push(toolResultMessage);
+				}
+			}
 			let allTools = convertToolsToVercelAITools(input.tools);
-			if (this.config.tools && this.config.tools.length > 0) {
-				const configTools = convertToolDefinitionsToVercelAITools(this.config.tools);
+			if (config.tools && config.tools.length > 0) {
+				const configTools = convertToolDefinitionsToVercelAITools(config.tools);
 				allTools = {
 					...allTools,
 					...configTools
@@ -394,23 +455,23 @@ This is state from the application that you can edit by calling AGUISendStateSna
 				model,
 				messages,
 				tools: allTools,
-				toolChoice: this.config.toolChoice,
-				stopWhen: this.config.maxSteps ? (0, ai.stepCountIs)(this.config.maxSteps) : void 0,
-				maxOutputTokens: this.config.maxOutputTokens,
-				temperature: this.config.temperature,
-				topP: this.config.topP,
-				topK: this.config.topK,
-				presencePenalty: this.config.presencePenalty,
-				frequencyPenalty: this.config.frequencyPenalty,
-				stopSequences: this.config.stopSequences,
-				seed: this.config.seed,
-				providerOptions: this.config.providerOptions,
-				maxRetries: this.config.maxRetries
+				toolChoice: config.toolChoice,
+				stopWhen: config.maxSteps ? (0, ai.stepCountIs)(config.maxSteps) : void 0,
+				maxOutputTokens: config.maxOutputTokens,
+				temperature: config.temperature,
+				topP: config.topP,
+				topK: config.topK,
+				presencePenalty: config.presencePenalty,
+				frequencyPenalty: config.frequencyPenalty,
+				stopSequences: config.stopSequences,
+				seed: config.seed,
+				providerOptions: config.providerOptions,
+				maxRetries: config.maxRetries
 			};
 			if (input.forwardedProps && typeof input.forwardedProps === "object") {
 				const props = input.forwardedProps;
 				if (props.model !== void 0 && this.canOverride("model")) {
-					if (typeof props.model === "string" || typeof props.model === "object") streamTextParams.model = resolveModel(props.model, this.config.apiKey);
+					if (typeof props.model === "string" || typeof props.model === "object") streamTextParams.model = resolveModel(props.model, config.apiKey);
 				}
 				if (props.toolChoice !== void 0 && this.canOverride("toolChoice")) {
 					const toolChoice = props.toolChoice;
@@ -456,7 +517,7 @@ This is state from the application that you can edit by calling AGUISendStateSna
 						...streamTextParams.tools,
 						AGUISendStateSnapshot: (0, ai.tool)({
 							description: "Replace the entire application state with a new snapshot",
-							inputSchema: zod.z.object({ snapshot: zod.z.any().describe("The complete new state object") }),
+							inputSchema: toLanguageModelSchema(zod.z.object({ snapshot: zod.z.any().describe("The complete new state object") })),
 							execute: async ({ snapshot }) => {
 								return {
 									success: true,
@@ -466,7 +527,7 @@ This is state from the application that you can edit by calling AGUISendStateSna
 						}),
 						AGUISendStateDelta: (0, ai.tool)({
 							description: "Apply incremental updates to application state using JSON Patch operations",
-							inputSchema: zod.z.object({ delta: zod.z.array(zod.z.object({
+							inputSchema: toLanguageModelSchema(zod.z.object({ delta: zod.z.array(zod.z.object({
 								op: zod.z.enum([
 									"add",
 									"replace",
@@ -474,7 +535,7 @@ This is state from the application that you can edit by calling AGUISendStateSna
 								]).describe("The operation to perform"),
 								path: zod.z.string().describe("JSON Pointer path (e.g., '/foo/bar')"),
 								value: zod.z.any().optional().describe("The value to set. Required for 'add' and 'replace' operations, ignored for 'remove'.")
-							})).describe("Array of JSON Patch operations") }),
+							})).describe("Array of JSON Patch operations") })),
 							execute: async ({ delta }) => {
 								return {
 									success: true,
@@ -483,14 +544,14 @@ This is state from the application that you can edit by calling AGUISendStateSna
 							}
 						})
 					};
-					if (this.config.mcpClients && this.config.mcpClients.length > 0) for (const client of this.config.mcpClients) {
+					if (config.mcpClients && config.mcpClients.length > 0) for (const client of config.mcpClients) {
 						const mcpTools = await client.tools();
 						streamTextParams.tools = {
 							...streamTextParams.tools,
 							...mcpTools
 						};
 					}
-					const allMcpServers = [...this.config.mcpServers ?? []];
+					const allMcpServers = [...config.mcpServers ?? []];
 					if (allMcpServers.length > 0) for (const serverConfig of allMcpServers) {
 						let transport;
 						if (serverConfig.type === "http") transport = new _modelcontextprotocol_sdk_client_streamableHttp_js.StreamableHTTPClientTransport(new URL(serverConfig.url), serverConfig.options);
@@ -519,6 +580,12 @@ This is state from the application that you can edit by calling AGUISendStateSna
 						...streamTextParams,
 						abortSignal: abortController.signal
 					});
+					const interruptToolNames = new Set((isFactoryConfig(this.config) ? [] : this.config.tools ?? []).filter((t) => t.interrupt).map((t) => t.name));
+					const interruptToolMeta = new Map((isFactoryConfig(this.config) ? [] : this.config.tools ?? []).filter((t) => t.interrupt).map((t) => [t.name, {
+						reason: t.interruptReason ?? "tool_call",
+						message: t.interruptMessage
+					}]));
+					const pendingInterrupts = [];
 					const toolCallStates = /* @__PURE__ */ new Map();
 					const ensureToolCallState = (toolCallId) => {
 						let state = toolCallStates.get(toolCallId);
@@ -660,11 +727,25 @@ This is state from the application that you can edit by calling AGUISendStateSna
 									};
 									subscriber.next(endEvent);
 								}
+								if (state.toolName && interruptToolNames.has(state.toolName)) {
+									const meta = interruptToolMeta.get(state.toolName);
+									pendingInterrupts.push({
+										id: toolCallId,
+										toolCallId,
+										reason: meta?.reason ?? "tool_call",
+										...meta?.message ? { message: meta.message } : {}
+									});
+								}
 								break;
 							}
 							case "tool-result": {
-								const toolResult = "output" in part ? part.output : "result" in part ? part.result : null;
-								const toolName = "toolName" in part ? part.toolName : "";
+								const toolName = "toolName" in part && part.toolName || toolCallStates.get(part.toolCallId)?.toolName || "";
+								if (toolName && interruptToolNames.has(toolName)) {
+									toolCallStates.delete(part.toolCallId);
+									break;
+								}
+								const legacyPart = part;
+								const toolResult = "output" in part ? part.output : "result" in legacyPart ? legacyPart.result : null;
 								toolCallStates.delete(part.toolCallId);
 								if (toolName === "AGUISendStateSnapshot" && toolResult && typeof toolResult === "object") {
 									const snapshot = toolResult.snapshot;
@@ -705,7 +786,11 @@ This is state from the application that you can edit by calling AGUISendStateSna
 								const finishedEvent = {
 									type: _ag_ui_client.EventType.RUN_FINISHED,
 									threadId: input.threadId,
-									runId: input.runId
+									runId: input.runId,
+									...pendingInterrupts.length > 0 ? { outcome: {
+										type: "interrupt",
+										interrupts: pendingInterrupts
+									} } : {}
 								};
 								subscriber.next(finishedEvent);
 								terminalEventEmitted = true;
@@ -714,7 +799,7 @@ This is state from the application that you can edit by calling AGUISendStateSna
 							}
 							case "error": {
 								if (abortController.signal.aborted) break;
-								const err = part.error ?? part.message ?? part.cause;
+								const err = part.error ?? ("message" in part ? part.message : void 0) ?? ("cause" in part ? part.cause : void 0);
 								const runErrorEvent = {
 									type: _ag_ui_client.EventType.RUN_ERROR,
 									message: err instanceof Error ? err.message : typeof err === "string" ? err : `AI SDK stream error: ${JSON.stringify(part)}`,
@@ -735,7 +820,11 @@ This is state from the application that you can edit by calling AGUISendStateSna
 							const finishedEvent = {
 								type: _ag_ui_client.EventType.RUN_FINISHED,
 								threadId: input.threadId,
-								runId: input.runId
+								runId: input.runId,
+								...pendingInterrupts.length > 0 ? { outcome: {
+									type: "interrupt",
+									interrupts: pendingInterrupts
+								} } : {}
 							};
 							subscriber.next(finishedEvent);
 						}
@@ -780,17 +869,40 @@ This is state from the application that you can edit by calling AGUISendStateSna
 			const ctx = {
 				input,
 				abortController: controller,
-				abortSignal: controller.signal
+				abortSignal: controller.signal,
+				interrupt: async (interrupts) => {
+					const resume = input.resume ?? [];
+					const ids = new Set(interrupts.map((i) => i.id));
+					const matching = resume.filter((r) => ids.has(r.interruptId));
+					if (interrupts.length > 0 && matching.length === interrupts.length) return matching;
+					throw new InterruptSignal(interrupts);
+				}
+			};
+			const answeredToolCallIds = new Set(input.messages.filter((m) => m.role === "tool").map((m) => m.toolCallId).filter((id) => typeof id === "string"));
+			const resumeToolMessages = (input.resume ?? []).filter((entry) => !answeredToolCallIds.has(entry.interruptId)).map((entry) => ({
+				id: (0, _copilotkit_shared.randomUUID)(),
+				role: "tool",
+				toolCallId: entry.interruptId,
+				content: JSON.stringify(entry.status === "cancelled" ? { status: "cancelled" } : entry.payload ?? { status: "resolved" })
+			}));
+			const factoryInput = resumeToolMessages.length > 0 && config.type !== "custom" ? {
+				...input,
+				messages: [...input.messages, ...resumeToolMessages]
+			} : input;
+			const factoryCtx = {
+				...ctx,
+				input: factoryInput
 			};
 			(async () => {
 				try {
 					let events;
+					const pendingInterrupts = [];
 					switch (config.type) {
 						case "aisdk":
-							events = require_aisdk.convertAISDKStream((await config.factory(ctx)).fullStream, controller.signal);
+							events = require_aisdk.convertAISDKStream((await config.factory(factoryCtx)).fullStream, controller.signal, pendingInterrupts);
 							break;
 						case "tanstack":
-							events = require_tanstack.convertTanStackStream(await config.factory(ctx), controller.signal);
+							events = require_tanstack.convertTanStackStream(await config.factory(factoryCtx), controller.signal, pendingInterrupts);
 							break;
 						case "custom":
 							events = await config.factory(ctx);
@@ -801,6 +913,7 @@ This is state from the application that you can edit by calling AGUISendStateSna
 						}
 					}
 					for await (const event of events) subscriber.next(event);
+					if (pendingInterrupts.length > 0 && !controller.signal.aborted) throw new InterruptSignal(pendingInterrupts);
 					if (!controller.signal.aborted) {
 						const finishedEvent = {
 							type: _ag_ui_client.EventType.RUN_FINISHED,
@@ -811,7 +924,19 @@ This is state from the application that you can edit by calling AGUISendStateSna
 					}
 					subscriber.complete();
 				} catch (error) {
-					if (controller.signal.aborted) subscriber.complete();
+					if (error instanceof InterruptSignal) {
+						const finishedEvent = {
+							type: _ag_ui_client.EventType.RUN_FINISHED,
+							threadId: input.threadId,
+							runId: input.runId,
+							outcome: {
+								type: "interrupt",
+								interrupts: error.interrupts
+							}
+						};
+						subscriber.next(finishedEvent);
+						subscriber.complete();
+					} else if (controller.signal.aborted) subscriber.complete();
 					else {
 						const runErrorEvent = {
 							type: _ag_ui_client.EventType.RUN_ERROR,
@@ -853,6 +978,7 @@ var BasicAgent = class extends BuiltInAgent {
 //#endregion
 exports.BasicAgent = BasicAgent;
 exports.BuiltInAgent = BuiltInAgent;
+exports.InterruptSignal = InterruptSignal;
 exports.convertJsonSchemaToZodSchema = convertJsonSchemaToZodSchema;
 exports.convertMessagesToVercelAISDKMessages = convertMessagesToVercelAISDKMessages;
 exports.convertToolDefinitionsToVercelAITools = convertToolDefinitionsToVercelAITools;