@copilotkit/react-core 1.69.3 → 1.70.0

package/dist/index.umd.js

@@ -2363,6 +2363,8 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 		const a2uiCatalogProvided = !!a2ui?.catalog;
 		const a2uiActive = runtimeA2UIEnabled || a2uiCatalogProvided;
 		const [runtimeLicenseStatus, setRuntimeLicenseStatus] = (0, react.useState)(void 0);
+		const [runtimeEntitlements, setRuntimeEntitlements] = (0, react.useState)(void 0);
+		const [runtimeEntitlementRetryPending, setRuntimeEntitlementRetryPending] = (0, react.useState)(false);
 		const requestInspectorOpen = (0, react.useCallback)((request) => {
 			setInspectorOpenRequest({ ...request });
 		}, []);
@@ -2553,6 +2555,8 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 				setRuntimeA2UIEnabled(copilotkit.a2uiEnabled);
 				setRuntimeOpenGenUIEnabled(copilotkit.openGenerativeUIEnabled);
 				setRuntimeLicenseStatus(copilotkit.licenseStatus);
+				setRuntimeEntitlements(copilotkit.runtimeEntitlements);
+				setRuntimeEntitlementRetryPending(copilotkit.runtimeEntitlementRetryPending);
 			};
 			const subscription = copilotkit.subscribe({ onRuntimeConnectionStatusChanged: syncRuntimeInfo });
 			syncRuntimeInfo();
@@ -2693,7 +2697,26 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 			copilotkit,
 			executingToolCallIds
 		}), [copilotkit, executingToolCallIds]);
-		const licenseContextValue = (0, react.useMemo)(() => (0, _copilotkit_shared.createLicenseContextValue)(runtimeLicenseStatus), [runtimeLicenseStatus]);
+		const retryableRuntimeEntitlementFailure = runtimeEntitlements?.status !== "ready" && runtimeEntitlements?.error.retryable === true;
+		const hasNonReadyRuntimeEntitlement = runtimeEntitlements !== void 0 && runtimeEntitlements.status !== "ready";
+		const hasLegacyRuntimeEntitlementFallback = runtimeLicenseStatus === "valid" || runtimeLicenseStatus === "expiring";
+		const runtimeEntitlementRetryInProgress = retryableRuntimeEntitlementFailure && runtimeEntitlementRetryPending && !hasLegacyRuntimeEntitlementFallback;
+		const runtimeEntitlementFailureSettled = hasNonReadyRuntimeEntitlement && !runtimeEntitlementRetryInProgress && !hasLegacyRuntimeEntitlementFallback;
+		const licenseContextValue = (0, react.useMemo)(() => {
+			const runtimeLicenseContext = (0, _copilotkit_shared.createLicenseContextValue)(runtimeEntitlementRetryInProgress ? void 0 : runtimeLicenseStatus, runtimeEntitlements);
+			if (!runtimeEntitlementFailureSettled) return runtimeLicenseContext;
+			return {
+				...runtimeLicenseContext,
+				checkFeature: () => false,
+				getLimit: () => null
+			};
+		}, [
+			runtimeEntitlementFailureSettled,
+			runtimeEntitlementRetryInProgress,
+			runtimeEntitlements,
+			runtimeLicenseStatus
+		]);
+		const runtimeLicenseWarningStatus = runtimeEntitlementRetryInProgress ? void 0 : licenseContextValue.status ?? void 0;
 		return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(SandboxFunctionsContext.Provider, {
 			value: sandboxFunctionsList,
 			children: /* @__PURE__ */ (0, react_jsx_runtime.jsx)(CopilotKitContext.Provider, {
@@ -2713,10 +2736,10 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 								openRequest: inspectorOpenRequest
 							}) : null]
 						}),
-						runtimeLicenseStatus === "none" && !resolvedPublicKey && /* @__PURE__ */ (0, react_jsx_runtime.jsx)(LicenseWarningBanner, { type: "no_license" }),
-						runtimeLicenseStatus === "expired" && /* @__PURE__ */ (0, react_jsx_runtime.jsx)(LicenseWarningBanner, { type: "expired" }),
-						runtimeLicenseStatus === "invalid" && /* @__PURE__ */ (0, react_jsx_runtime.jsx)(LicenseWarningBanner, { type: "invalid" }),
-						runtimeLicenseStatus === "expiring" && /* @__PURE__ */ (0, react_jsx_runtime.jsx)(LicenseWarningBanner, { type: "expiring" })
+						runtimeLicenseWarningStatus === "none" && !resolvedPublicKey && /* @__PURE__ */ (0, react_jsx_runtime.jsx)(LicenseWarningBanner, { type: "no_license" }),
+						runtimeLicenseWarningStatus === "expired" && /* @__PURE__ */ (0, react_jsx_runtime.jsx)(LicenseWarningBanner, { type: "expired" }),
+						runtimeLicenseWarningStatus === "invalid" && /* @__PURE__ */ (0, react_jsx_runtime.jsx)(LicenseWarningBanner, { type: "invalid" }),
+						runtimeLicenseWarningStatus === "expiring" && /* @__PURE__ */ (0, react_jsx_runtime.jsx)(LicenseWarningBanner, { type: "expiring" })
 					]
 				})
 			})
@@ -2774,7 +2797,7 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 	function useFrontendTool$1(tool, deps) {
 		const { copilotkit } = useCopilotKit();
 		const extraDeps = deps ?? EMPTY_DEPS;
-		(0, react.useEffect)(() => {
+		(0, react.useLayoutEffect)(() => {
 			const name = tool.name;
 			if (copilotkit.getTool({
 				toolName: name,
@@ -2803,6 +2826,8 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 
 //#endregion
 //#region src/v2/hooks/use-human-in-the-loop.tsx
+/** Registration name of a catch-all tool: handles any otherwise-unhandled call. */
+	const WILDCARD_TOOL_NAME = "*";
 	function useHumanInTheLoop$1(tool, deps) {
 		const { copilotkit } = useCopilotKit();
 		const resolvePromiseRef = (0, react.useRef)(null);
@@ -2838,10 +2863,11 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 		}, []);
 		const RenderComponent = (0, react.useCallback)((props) => {
 			const ToolComponent = tool.render;
+			const name = tool.name === WILDCARD_TOOL_NAME ? props.name : tool.name;
 			if (props.status === _copilotkit_core.ToolCallStatus.InProgress) {
 				const enhancedProps = {
 					...props,
-					name: tool.name,
+					name,
 					description: tool.description || "",
 					agentId: tool.agentId,
 					respond: void 0
@@ -2850,7 +2876,7 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 			} else if (props.status === _copilotkit_core.ToolCallStatus.Executing) {
 				const enhancedProps = {
 					...props,
-					name: tool.name,
+					name,
 					description: tool.description || "",
 					agentId: tool.agentId,
 					respond
@@ -2859,7 +2885,7 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 			} else if (props.status === _copilotkit_core.ToolCallStatus.Complete) {
 				const enhancedProps = {
 					...props,
-					name: tool.name,
+					name,
 					description: tool.description || "",
 					agentId: tool.agentId,
 					respond: void 0
@@ -2879,7 +2905,7 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 			handler,
 			render: RenderComponent
 		}, deps);
-		(0, react.useEffect)(() => {
+		(0, react.useLayoutEffect)(() => {
 			return () => {
 				copilotkit.removeHookRenderToolCall(tool.name, tool.agentId);
 			};
@@ -3299,8 +3325,12 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 	}
 
 //#endregion
-//#region src/v2/hooks/use-interrupt.tsx
+//#region src/v2/types/interrupt.ts
+/** Name of the legacy custom event agents emit to signal an interrupt. */
 	const INTERRUPT_EVENT_NAME = "on_interrupt";
+
+//#endregion
+//#region src/v2/hooks/use-interrupt.tsx
 	function isPromiseLike(value) {
 		return (typeof value === "object" || typeof value === "function") && value !== null && typeof Reflect.get(value, "then") === "function";
 	}
@@ -5753,13 +5783,18 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 		const renderToolCall = useRenderToolCall$1();
 		return (0, react.useCallback)((message, messages) => {
 			if (!message?.toolCalls?.length) return null;
-			const toolCall = message.toolCalls[0];
-			if (!toolCall) return null;
-			const toolMessage = messages?.find((m) => m.role === "tool" && m.toolCallId === toolCall.id);
-			return () => renderToolCall({
-				toolCall,
-				toolMessage
-			});
+			const toolCalls = message.toolCalls;
+			return () => {
+				const renderedToolCalls = toolCalls.map((toolCall) => {
+					const toolMessage = messages?.find((m) => m.role === "tool" && m.toolCallId === toolCall.id);
+					return renderToolCall({
+						toolCall,
+						toolMessage
+					});
+				}).filter((renderedToolCall) => renderedToolCall !== null);
+				if (!renderedToolCalls.length) return null;
+				return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(react_jsx_runtime.Fragment, { children: renderedToolCalls });
+			};
 		}, [renderToolCall]);
 	}
 
@@ -6454,20 +6489,24 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 				if (!render) return null;
 				const rendered = render((() => {
 					const mappedArgs = args.args;
+					const toolCallName = args.name;
 					switch (args.status) {
 						case _copilotkit_core.ToolCallStatus.InProgress: return {
+							name: toolCallName,
 							args: mappedArgs,
 							respond: args.respond,
 							status: args.status,
 							handler: void 0
 						};
 						case _copilotkit_core.ToolCallStatus.Executing: return {
+							name: toolCallName,
 							args: mappedArgs,
 							respond: args.respond,
 							status: args.status,
 							handler: () => {}
 						};
 						case _copilotkit_core.ToolCallStatus.Complete: return {
+							name: toolCallName,
 							args: mappedArgs,
 							respond: args.respond,
 							status: args.status,
@@ -6627,10 +6666,21 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 	* This hooks enables you to dynamically generate UI elements and render them in the copilot chat. For more information, check out the [Generative UI](/guides/generative-ui) page.
 	*/
 	function getActionConfig(action) {
-		if (action.name === "*") return {
-			type: "render",
-			action
-		};
+		if (action.name === "*") {
+			const catchAll = action;
+			const waitRender = catchAll.renderAndWaitForResponse ?? catchAll.renderAndWait;
+			if (waitRender) return {
+				type: "hitl",
+				action: {
+					...catchAll,
+					render: waitRender
+				}
+			};
+			return {
+				type: "render",
+				action
+			};
+		}
 		if ("renderAndWaitForResponse" in action || "renderAndWait" in action) {
 			let render = action.render;
 			if (!render && "renderAndWaitForResponse" in action) render = action.renderAndWaitForResponse;
@@ -6941,37 +6991,87 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 
 //#endregion
 //#region src/v1-deprecated/hooks/use-agent-nodename.ts
-/**
+	const initialAgentNodeNameState = {
+		nodeName: "start",
+		lastActiveNodeName: "start",
+		hasLegacyInterrupt: false
+	};
+	const transitionAgentNodeName = (state, event) => {
+		switch (event.type) {
+			case "reset":
+			case "runStarted": return initialAgentNodeNameState;
+			case "stepStarted": return {
+				...state,
+				nodeName: event.nodeName,
+				lastActiveNodeName: event.nodeName
+			};
+			case "legacyInterruptReceived": return {
+				...state,
+				hasLegacyInterrupt: true
+			};
+			case "runFinished":
+				if (event.outcome === "interrupt" || state.hasLegacyInterrupt) return {
+					...state,
+					nodeName: state.lastActiveNodeName,
+					hasLegacyInterrupt: false
+				};
+				return {
+					...state,
+					nodeName: "end",
+					hasLegacyInterrupt: false
+				};
+			case "runError": return {
+				...state,
+				nodeName: "end",
+				hasLegacyInterrupt: false
+			};
+		}
+	};
+	/**
 	* Tracks the node the agent is currently executing.
 	*
 	* Backed by state rather than a ref: mutating a ref schedules no render, so
 	* consumers such as `useCoAgent().nodeName` kept reporting whichever node was
-	* current at their last render and never updated on their own.
+	* current at their last render and never updated on their own. Interrupt-aware
+	* transitions keep the last active node available while an interrupt is pending.
 	*/
 	function useAgentNodeName(agentName) {
 		const { agent } = useAgent({ agentId: agentName });
-		const [nodeName, setNodeName] = (0, react.useState)("start");
+		const [nodeNameState, setNodeNameState] = (0, react.useState)(initialAgentNodeNameState);
 		(0, react.useEffect)(() => {
+			const transition = (event) => {
+				setNodeNameState((state) => transitionAgentNodeName(state, event));
+			};
+			transition({ type: "reset" });
 			if (!agent) return;
 			const subscription = agent.subscribe({
 				onStepStartedEvent: ({ event }) => {
-					setNodeName(event.stepName);
+					transition({
+						type: "stepStarted",
+						nodeName: event.stepName
+					});
 				},
 				onRunStartedEvent: () => {
-					setNodeName("start");
+					transition({ type: "runStarted" });
 				},
-				onRunFinishedEvent: () => {
-					setNodeName("end");
+				onRunFinishedEvent: ({ outcome }) => {
+					transition({
+						type: "runFinished",
+						outcome
+					});
 				},
 				onRunErrorEvent: () => {
-					setNodeName("end");
+					transition({ type: "runError" });
+				},
+				onCustomEvent: ({ event }) => {
+					if (event.name === INTERRUPT_EVENT_NAME) transition({ type: "legacyInterruptReceived" });
 				}
 			});
 			return () => {
 				subscription.unsubscribe();
 			};
-		}, [agent]);
-		return nodeName;
+		}, [agent, agentName]);
+		return nodeNameState.nodeName;
 	}
 
 //#endregion
@@ -7174,6 +7274,7 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 			agent?.threadId,
 			agent?.isRunning,
 			agent?.agentId,
+			nodeName,
 			handleStateUpdate,
 			options.name
 		]);