@copilotkit/react-core 1.61.1 → 1.61.2

package/dist/index.umd.js

@@ -2280,6 +2280,10 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 
 //#endregion
 //#region src/v2/providers/CopilotKitProvider.tsx
+	const zodToJsonSchemaAdapter = (schema, options) => {
+		const refStrategy = options?.$refStrategy;
+		return (0, zod_to_json_schema.zodToJsonSchema)(schema, refStrategy === "root" || refStrategy === "relative" || refStrategy === "none" || refStrategy === "seen" ? { $refStrategy: refStrategy } : {});
+	};
 	const HEADER_NAME = "X-CopilotCloud-Public-Api-Key";
 	const COPILOT_CLOUD_CHAT_URL$1 = "https://api.cloud.copilotkit.ai/copilotkit/v1";
 	const EMPTY_HEADERS = Object.freeze({});
@@ -2310,6 +2314,8 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 		const [runtimeA2UIEnabled, setRuntimeA2UIEnabled] = (0, react.useState)(false);
 		const [runtimeOpenGenUIEnabled, setRuntimeOpenGenUIEnabled] = (0, react.useState)(false);
 		const openGenUIActive = runtimeOpenGenUIEnabled || !!openGenerativeUI;
+		const a2uiCatalogProvided = !!a2ui?.catalog;
+		const a2uiActive = runtimeA2UIEnabled || a2uiCatalogProvided;
 		const [runtimeLicenseStatus, setRuntimeLicenseStatus] = (0, react.useState)(void 0);
 		(0, react.useEffect)(() => {
 			if (typeof window === "undefined") return;
@@ -2340,7 +2346,7 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 				content: OpenGenerativeUIContentSchema,
 				render: OpenGenerativeUIActivityRenderer
 			});
-			if (runtimeA2UIEnabled) renderers.unshift(createA2UIMessageRenderer({
+			if (a2uiActive) renderers.unshift(createA2UIMessageRenderer({
 				theme: a2ui?.theme ?? _copilotkit_a2ui_renderer.viewerTheme,
 				catalog: a2ui?.catalog,
 				loadingComponent: a2ui?.loadingComponent,
@@ -2348,7 +2354,7 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 			}));
 			return renderers;
 		}, [
-			runtimeA2UIEnabled,
+			a2uiActive,
 			openGenUIActive,
 			a2ui
 		]);
@@ -2535,7 +2541,10 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 			copilotkit.setRuntimeTransport(useSingleEndpoint === true ? "single" : useSingleEndpoint === false ? "rest" : "auto");
 			copilotkit.setHeaders(mergedHeaders);
 			copilotkit.setCredentials(credentials);
-			copilotkit.setProperties(properties);
+			copilotkit.setProperties(a2uiCatalogProvided ? {
+				...properties,
+				a2uiCatalogAvailable: true
+			} : properties);
 			copilotkit.setAgents__unsafe_dev_only(mergedAgents);
 			copilotkit.setDebug(debug);
 		}, [
@@ -2544,6 +2553,7 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 			mergedHeaders,
 			credentials,
 			properties,
+			a2uiCatalogProvided,
 			mergedAgents,
 			useSingleEndpoint,
 			debug
@@ -2591,7 +2601,7 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 			return JSON.stringify(sandboxFunctionsList.map((fn) => ({
 				name: fn.name,
 				description: fn.description,
-				parameters: (0, _copilotkit_shared.schemaToJsonSchema)(fn.parameters, { zodToJsonSchema: zod_to_json_schema.zodToJsonSchema })
+				parameters: (0, _copilotkit_shared.schemaToJsonSchema)(fn.parameters, { zodToJsonSchema: zodToJsonSchemaAdapter })
 			})));
 		}, [sandboxFunctionsList]);
 		(0, react.useLayoutEffect)(() => {
@@ -2612,7 +2622,7 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 			copilotkit,
 			executingToolCallIds
 		}), [copilotkit, executingToolCallIds]);
-		const licenseContextValue = (0, react.useMemo)(() => (0, _copilotkit_shared.createLicenseContextValue)(null), []);
+		const licenseContextValue = (0, react.useMemo)(() => (0, _copilotkit_shared.createLicenseContextValue)(runtimeLicenseStatus), [runtimeLicenseStatus]);
 		return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(SandboxFunctionsContext.Provider, {
 			value: sandboxFunctionsList,
 			children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(CopilotKitContext.Provider, {
@@ -2620,8 +2630,8 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 				children: /* @__PURE__ */ (0, react_jsx_runtime.jsxs)(LicenseContext.Provider, {
 					value: licenseContextValue,
 					children: [
-						runtimeA2UIEnabled && /* @__PURE__ */ (0, react_jsx_runtime.jsx)(A2UIBuiltInToolCallRenderer, {}),
-						runtimeA2UIEnabled && /* @__PURE__ */ (0, react_jsx_runtime.jsx)(A2UICatalogContext, {
+						a2uiActive && /* @__PURE__ */ (0, react_jsx_runtime.jsx)(A2UIBuiltInToolCallRenderer, {}),
+						a2uiActive && /* @__PURE__ */ (0, react_jsx_runtime.jsx)(A2UICatalogContext, {
 							catalog: a2ui?.catalog,
 							includeSchema: a2ui?.includeSchema
 						}),
@@ -2838,7 +2848,7 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 			if (isRuntimeConfigured && (status === _copilotkit_core.CopilotKitCoreRuntimeConnectionStatus.Disconnected || status === _copilotkit_core.CopilotKitCoreRuntimeConnectionStatus.Connecting)) {
 				const cached = provisionalAgentCache.current.get(agentId);
 				if (cached) {
-					cached.headers = { ...copilotkit.headers };
+					copilotkit.applyHeadersToAgent(cached);
 					return cached;
 				}
 				const provisional = new _copilotkit_core.ProxiedCopilotRuntimeAgent({
@@ -2847,14 +2857,14 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 					transport: copilotkit.runtimeTransport,
 					runtimeMode: "pending"
 				});
-				provisional.headers = { ...copilotkit.headers };
+				copilotkit.applyHeadersToAgent(provisional);
 				provisionalAgentCache.current.set(agentId, provisional);
 				return provisional;
 			}
 			if (isRuntimeConfigured && status === _copilotkit_core.CopilotKitCoreRuntimeConnectionStatus.Error) {
 				const cached = provisionalAgentCache.current.get(agentId);
 				if (cached) {
-					cached.headers = { ...copilotkit.headers };
+					copilotkit.applyHeadersToAgent(cached);
 					return cached;
 				}
 				const provisional = new _copilotkit_core.ProxiedCopilotRuntimeAgent({
@@ -2863,7 +2873,7 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 					transport: copilotkit.runtimeTransport,
 					runtimeMode: "pending"
 				});
-				provisional.headers = { ...copilotkit.headers };
+				copilotkit.applyHeadersToAgent(provisional);
 				provisionalAgentCache.current.set(agentId, provisional);
 				return provisional;
 			}
@@ -2914,7 +2924,7 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 			updateFlags
 		]);
 		(0, react.useEffect)(() => {
-			if (agent instanceof _ag_ui_client.HttpAgent) agent.headers = { ...copilotkit.headers };
+			if (agent instanceof _ag_ui_client.HttpAgent) copilotkit.applyHeadersToAgent(agent);
 		}, [agent, JSON.stringify(copilotkit.headers)]);
 		const chatConfig = useCopilotChatConfiguration();
 		const configThreadId = chatConfig?.threadId;
@@ -3148,114 +3158,165 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 	function isPromiseLike(value) {
 		return (typeof value === "object" || typeof value === "function") && value !== null && typeof Reflect.get(value, "then") === "function";
 	}
+	/** Derive the legacy-compatible `event` for any pending interrupt. */
+	function toLegacyEvent(pending) {
+		if (pending.kind === "legacy") return pending.event;
+		return {
+			name: INTERRUPT_EVENT_NAME,
+			value: pending.interrupts[0]
+		};
+	}
 	/**
-	* Handles agent interrupts (`on_interrupt`) with optional filtering, preprocessing, and resume behavior.
-	*
-	* The hook listens to custom events on the active agent, stores interrupt payloads per run,
-	* and surfaces a render callback once the run finalizes. Call `resolve` from your UI to resume
-	* execution with user-provided data.
-	*
-	* - `renderInChat: true` (default): the element is published into `<CopilotChat>` and this hook returns `void`.
-	* - `renderInChat: false`: the hook returns the interrupt element so you can place it anywhere in your component tree.
+	* Handles agent interrupts with optional filtering, preprocessing, and resume behavior.
 	*
-	* `event.value` is typed as `any` since the interrupt payload shape depends on your agent.
-	* Type-narrow it in your callbacks (e.g. `handler`, `enabled`, `render`) as needed.
-	*
-	* @typeParam TResult - Inferred from `handler` return type. Exposed as `result` in `render`.
-	* @param config - Interrupt configuration (renderer, optional handler/filter, and render mode).
-	* @returns When `renderInChat` is `false`, returns the interrupt element (or `null` when idle).
-	* Otherwise returns `void` and publishes the element into chat. In `render`, `result` is always
-	* either the handler's resolved return value or `null` (including when no handler is provided,
-	* when filtering skips the interrupt, or when handler execution fails).
-	*
-	* @example
-	* ```tsx
-	* import { useInterrupt } from "@copilotkit/react-core/v2";
-	*
-	* function InterruptUI() {
-	*   useInterrupt({
-	*     render: ({ event, resolve }) => (
-	*       <div>
-	*         <p>{event.value.question}</p>
-	*         <button onClick={() => resolve({ approved: true })}>Approve</button>
-	*         <button onClick={() => resolve({ approved: false })}>Reject</button>
-	*       </div>
-	*     ),
-	*   });
+	* Supports both the AG-UI standard interrupt flow (`RUN_FINISHED` with
+	* `outcome.type === "interrupt"`) and the legacy custom-event flow
+	* (`on_interrupt`). For standard interrupts, `render` receives `interrupt`
+	* (the primary one) and `interrupts` (the full open set); call `resolve(payload)`
+	* to resume or `cancel()` to cancel. Resuming addresses the targeted interrupt
+	* and, once every open interrupt is addressed, submits a single spec `resume`
+	* array via `copilotkit.runAgent`.
 	*
-	*   return null;
-	* }
-	* ```
+	* - `renderInChat: true` (default): the element is published into `<CopilotChat>`; returns `void`.
+	* - `renderInChat: false`: the hook returns the interrupt element for manual placement.
 	*
 	* @example
 	* ```tsx
-	* import { useInterrupt } from "@copilotkit/react-core/v2";
-	*
-	* function CustomPanel() {
-	*   const interruptElement = useInterrupt({
-	*     renderInChat: false,
-	*     enabled: (event) => event.value.startsWith("approval:"),
-	*     handler: async ({ event }) => ({ label: event.value.toUpperCase() }),
-	*     render: ({ event, result, resolve }) => (
-	*       <aside>
-	*         <strong>{result?.label ?? ""}</strong>
-	*         <button onClick={() => resolve({ value: event.value })}>Continue</button>
-	*       </aside>
-	*     ),
-	*   });
-	*
-	*   return <>{interruptElement}</>;
-	* }
+	* useInterrupt({
+	*   render: ({ interrupt, resolve, cancel }) => (
+	*     <div>
+	*       <p>{interrupt?.message}</p>
+	*       <button onClick={() => resolve({ approved: true })}>Approve</button>
+	*       <button onClick={() => cancel()}>Cancel</button>
+	*     </div>
+	*   ),
+	* });
 	* ```
 	*/
 	function useInterrupt(config) {
 		const { copilotkit } = useCopilotKit();
 		const { agent } = useAgent({ agentId: config.agentId });
-		const [pendingEvent, setPendingEvent] = (0, react.useState)(null);
-		const pendingEventRef = (0, react.useRef)(pendingEvent);
-		pendingEventRef.current = pendingEvent;
+		const [pending, setPending] = (0, react.useState)(null);
+		const pendingRef = (0, react.useRef)(pending);
+		pendingRef.current = pending;
 		const [handlerResult, setHandlerResult] = (0, react.useState)(null);
+		const responsesRef = (0, react.useRef)({});
 		(0, react.useEffect)(() => {
-			let localInterrupt = null;
+			let localLegacy = null;
+			let localStandard = null;
 			const subscription = agent.subscribe({
 				onCustomEvent: ({ event }) => {
-					if (event.name === INTERRUPT_EVENT_NAME) localInterrupt = {
+					if (event.name === INTERRUPT_EVENT_NAME) localLegacy = {
 						name: event.name,
 						value: event.value
 					};
 				},
+				onRunFinishedEvent: (params) => {
+					if (params.outcome === "interrupt") localStandard = params.interrupts;
+				},
 				onRunStartedEvent: () => {
-					localInterrupt = null;
-					setPendingEvent(null);
+					localLegacy = null;
+					localStandard = null;
+					responsesRef.current = {};
+					setPending(null);
 				},
 				onRunFinalized: () => {
-					if (localInterrupt) {
-						setPendingEvent(localInterrupt);
-						localInterrupt = null;
-					}
+					if (localStandard && localStandard.length > 0) setPending({
+						kind: "standard",
+						interrupts: localStandard
+					});
+					else if (localLegacy) setPending({
+						kind: "legacy",
+						event: localLegacy
+					});
+					localLegacy = null;
+					localStandard = null;
 				},
 				onRunFailed: () => {
-					localInterrupt = null;
-					setPendingEvent(null);
+					localLegacy = null;
+					localStandard = null;
+					responsesRef.current = {};
+					setPending(null);
 				}
 			});
 			return () => subscription.unsubscribe();
 		}, [agent]);
-		const resolve = (0, react.useCallback)(async (response) => {
+		const submitStandardIfComplete = (0, react.useCallback)(async (interrupts) => {
+			if (!interrupts.every((i) => responsesRef.current[i.id])) return;
+			const expired = interrupts.find((i) => (0, _ag_ui_client.isInterruptExpired)(i));
+			if (expired) {
+				console.error(`[CopilotKit] useInterrupt: interrupt ${expired.id} expired at ${expired.expiresAt}; not resuming.`);
+				responsesRef.current = {};
+				setPending(null);
+				return;
+			}
+			const resume = (0, _ag_ui_client.buildResumeArray)(interrupts, responsesRef.current);
+			for (const i of interrupts) {
+				if (!i.toolCallId) continue;
+				const response = responsesRef.current[i.id];
+				const content = response.status === "cancelled" ? { status: "cancelled" } : response.payload ?? { status: "resolved" };
+				agent.addMessage({
+					id: (0, _ag_ui_client.randomUUID)(),
+					role: "tool",
+					toolCallId: i.toolCallId,
+					content: JSON.stringify(content)
+				});
+			}
+			responsesRef.current = {};
 			try {
+				return await copilotkit.runAgent({
+					agent,
+					resume
+				});
+			} catch (err) {
+				console.error("[CopilotKit] useInterrupt resolve: runAgent rejected; clearing pending + rethrowing", err);
+				setPending(null);
+				throw err;
+			}
+		}, [agent, copilotkit]);
+		const resolve = (0, react.useCallback)(async (payload, interruptId) => {
+			const current = pendingRef.current;
+			if (!current) return;
+			if (current.kind === "legacy") try {
 				return await copilotkit.runAgent({
 					agent,
 					forwardedProps: { command: {
-						resume: response,
-						interruptEvent: pendingEventRef.current?.value
+						resume: payload,
+						interruptEvent: current.event.value
 					} }
 				});
 			} catch (err) {
 				console.error("[CopilotKit] useInterrupt resolve: runAgent rejected; clearing pending + rethrowing", err);
-				setPendingEvent(null);
+				setPending(null);
 				throw err;
 			}
-		}, [agent, copilotkit]);
+			if (current.interrupts.length > 1 && interruptId === void 0) console.warn(`[CopilotKit] useInterrupt: resolve()/cancel() called without an interruptId while ${current.interrupts.length} interrupts are open; defaulting to the first. Pass an interruptId to address a specific interrupt.`);
+			const id = interruptId ?? current.interrupts[0]?.id;
+			if (!id) return;
+			responsesRef.current[id] = {
+				status: "resolved",
+				payload
+			};
+			return submitStandardIfComplete(current.interrupts);
+		}, [
+			agent,
+			copilotkit,
+			submitStandardIfComplete
+		]);
+		const cancel = (0, react.useCallback)(async (interruptId) => {
+			const current = pendingRef.current;
+			if (!current) return;
+			if (current.kind === "legacy") {
+				console.warn("[CopilotKit] useInterrupt: cancel() is not supported for legacy on_interrupt interrupts; dismissing.");
+				setPending(null);
+				return;
+			}
+			if (current.interrupts.length > 1 && interruptId === void 0) console.warn(`[CopilotKit] useInterrupt: resolve()/cancel() called without an interruptId while ${current.interrupts.length} interrupts are open; defaulting to the first. Pass an interruptId to address a specific interrupt.`);
+			const id = interruptId ?? current.interrupts[0]?.id;
+			if (!id) return;
+			responsesRef.current[id] = { status: "cancelled" };
+			return submitStandardIfComplete(current.interrupts);
+		}, [submitStandardIfComplete]);
 		const renderRef = (0, react.useRef)(config.render);
 		renderRef.current = config.render;
 		const enabledRef = (0, react.useRef)(config.enabled);
@@ -3264,6 +3325,8 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 		handlerRef.current = config.handler;
 		const resolveRef = (0, react.useRef)(resolve);
 		resolveRef.current = resolve;
+		const cancelRef = (0, react.useRef)(cancel);
+		cancelRef.current = cancel;
 		const isEnabled = (event) => {
 			const predicate = enabledRef.current;
 			if (!predicate) return true;
@@ -3275,11 +3338,12 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 			}
 		};
 		(0, react.useEffect)(() => {
-			if (!pendingEvent) {
+			if (!pending) {
 				setHandlerResult(null);
 				return;
 			}
-			if (!isEnabled(pendingEvent)) {
+			const legacyEvent = toLegacyEvent(pending);
+			if (!isEnabled(legacyEvent)) {
 				setHandlerResult(null);
 				return;
 			}
@@ -3292,8 +3356,11 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 			let maybePromise;
 			try {
 				maybePromise = handler({
-					event: pendingEvent,
-					resolve: resolveRef.current
+					event: legacyEvent,
+					interrupt: pending.kind === "standard" ? pending.interrupts[0] : null,
+					interrupts: pending.kind === "standard" ? pending.interrupts : [],
+					resolve: resolveRef.current,
+					cancel: cancelRef.current
 				});
 			} catch (err) {
 				console.error("[CopilotKit] useInterrupt handler threw; result will be null:", err);
@@ -3312,19 +3379,24 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 			return () => {
 				cancelled = true;
 			};
-		}, [pendingEvent]);
+		}, [pending]);
 		const element = (0, react.useMemo)(() => {
-			if (!pendingEvent) return null;
-			if (!isEnabled(pendingEvent)) return null;
+			if (!pending) return null;
+			const legacyEvent = toLegacyEvent(pending);
+			if (!isEnabled(legacyEvent)) return null;
 			return renderRef.current({
-				event: pendingEvent,
+				event: legacyEvent,
+				interrupt: pending.kind === "standard" ? pending.interrupts[0] : null,
+				interrupts: pending.kind === "standard" ? pending.interrupts : [],
 				result: handlerResult,
-				resolve
+				resolve,
+				cancel
 			});
 		}, [
-			pendingEvent,
+			pending,
 			handlerResult,
-			resolve
+			resolve,
+			cancel
 		]);
 		(0, react.useEffect)(() => {
 			if (config.renderInChat === false) return;
@@ -4982,6 +5054,7 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 		const showInspector = shouldShowDevConsole(props.enableInspector);
 		const publicApiKey = props.publicApiKey || props.publicLicenseKey;
 		const renderArr = (0, react.useMemo)(() => [{ render: CoAgentStateRenderBridge }], []);
+		const { onError: _onError, ...v2Props } = props;
 		return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(ToastProvider, {
 			enabled,
 			children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(CopilotErrorBoundary, {
@@ -4990,7 +5063,7 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 				children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(ThreadsProvider, {
 					threadId: props.threadId,
 					children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(CopilotKitProvider, {
-						...props,
+						...v2Props,
 						showDevConsole: showInspector,
 						renderCustomMessages: renderArr,
 						useSingleEndpoint: props.useSingleEndpoint ?? true,