@copilotkit/react-core 1.70.3 → 1.71.1

package/dist/index.umd.js

@@ -36,6 +36,133 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 react = __toESM(react);
 react_markdown = __toESM(react_markdown);
 
+//#region src/v2/lib/react-core.ts
+	var CopilotKitCoreReact = class extends _copilotkit_core.CopilotKitCore {
+		constructor(config) {
+			super(config);
+			this._renderToolCalls = [];
+			this._hookRenderToolCalls = /* @__PURE__ */ new Map();
+			this._cachedMergedRenderToolCalls = null;
+			this._renderCustomMessages = [];
+			this._renderActivityMessages = [];
+			this._interruptElement = null;
+			this._renderToolCalls = config.renderToolCalls ?? [];
+			this._renderCustomMessages = config.renderCustomMessages ?? [];
+			this._renderActivityMessages = config.renderActivityMessages ?? [];
+		}
+		get renderCustomMessages() {
+			return this._renderCustomMessages;
+		}
+		get renderActivityMessages() {
+			return this._renderActivityMessages;
+		}
+		get renderToolCalls() {
+			if (this._hookRenderToolCalls.size === 0) return this._renderToolCalls;
+			if (this._cachedMergedRenderToolCalls) return this._cachedMergedRenderToolCalls;
+			const merged = /* @__PURE__ */ new Map();
+			for (const rc of this._renderToolCalls) merged.set(`${rc.agentId ?? ""}:${rc.name}`, rc);
+			for (const [key, rc] of this._hookRenderToolCalls) merged.set(key, rc);
+			this._cachedMergedRenderToolCalls = Array.from(merged.values());
+			return this._cachedMergedRenderToolCalls;
+		}
+		setRenderActivityMessages(renderers) {
+			this._renderActivityMessages = renderers;
+		}
+		setRenderCustomMessages(renderers) {
+			this._renderCustomMessages = renderers;
+		}
+		setRenderToolCalls(renderToolCalls) {
+			this._renderToolCalls = renderToolCalls;
+			this._cachedMergedRenderToolCalls = null;
+			this._notifyRenderToolCallsChanged();
+		}
+		addHookRenderToolCall(entry) {
+			const key = `${entry.agentId ?? ""}:${entry.name}`;
+			this._hookRenderToolCalls.set(key, entry);
+			this._cachedMergedRenderToolCalls = null;
+			this._notifyRenderToolCallsChanged();
+		}
+		removeHookRenderToolCall(name, agentId) {
+			const key = `${agentId ?? ""}:${name}`;
+			if (this._hookRenderToolCalls.delete(key)) {
+				this._cachedMergedRenderToolCalls = null;
+				this._notifyRenderToolCallsChanged();
+			}
+		}
+		_notifyRenderToolCallsChanged() {
+			this.notifySubscribers((subscriber) => {
+				const reactSubscriber = subscriber;
+				if (reactSubscriber.onRenderToolCallsChanged) reactSubscriber.onRenderToolCallsChanged({
+					copilotkit: this,
+					renderToolCalls: this.renderToolCalls
+				});
+			}, "Subscriber onRenderToolCallsChanged error:");
+		}
+		get interruptElement() {
+			return this._interruptElement;
+		}
+		setInterruptElement(element) {
+			this._interruptElement = element;
+			this.notifySubscribers((subscriber) => {
+				subscriber.onInterruptElementChanged?.({
+					copilotkit: this,
+					interruptElement: this._interruptElement
+				});
+			}, "Subscriber onInterruptElementChanged error:");
+		}
+		subscribe(subscriber) {
+			return super.subscribe(subscriber);
+		}
+		/**
+		* Wait for pending React state updates before the follow-up agent run.
+		*
+		* When a frontend tool handler calls setState(), React 18 batches the update
+		* and schedules a commit via its internal scheduler (MessageChannel). The
+		* useAgentContext hook registers context via useLayoutEffect, which runs
+		* synchronously after React commits that batch.
+		*
+		* Awaiting a zero-delay timeout yields to the macrotask queue. React's
+		* MessageChannel task runs first, committing the pending state and running
+		* useLayoutEffect (which updates the context store). The follow-up runAgent
+		* call then reads fresh context.
+		*/
+		async waitForPendingFrameworkUpdates() {
+			await new Promise((resolve) => setTimeout(resolve, 0));
+		}
+	};
+
+//#endregion
+//#region src/v2/context.ts
+	const CopilotKitContext = (0, react.createContext)(null);
+	const useCopilotKit = () => {
+		const context = (0, react.useContext)(CopilotKitContext);
+		const [, forceUpdate] = (0, react.useReducer)((x) => x + 1, 0);
+		if (!context) throw new Error("useCopilotKit must be used within CopilotKitProvider");
+		(0, react.useEffect)(() => {
+			const subscription = context.copilotkit.subscribe({
+				onRuntimeConnectionStatusChanged: () => {
+					forceUpdate();
+				},
+				onHeadersChanged: () => {
+					forceUpdate();
+				}
+			});
+			return () => {
+				subscription.unsubscribe();
+			};
+		}, []);
+		return context;
+	};
+	const LicenseContext = (0, react.createContext)({
+		status: null,
+		license: null,
+		checkFeature: () => true,
+		getLimit: () => null
+	});
+	const CopilotKitAgentIdContext = (0, react.createContext)(void 0);
+	const useDefaultAgentId = () => (0, react.useContext)(CopilotKitAgentIdContext);
+
+//#endregion
 //#region src/v2/lib/shallow-stable-ref.ts
 /**
 	* Shallow equality comparison for objects.
@@ -90,7 +217,12 @@ react_markdown = __toESM(react_markdown);
 		assistantMessageToolbarCopyCodeCopiedLabel: "Copied",
 		assistantMessageToolbarCopyMessageLabel: "Copy",
 		assistantMessageToolbarInspectorLabel: "View in Inspector",
-		assistantMessageToolbarInspectorLocalOnlyLabel: "Development Only",
+		assistantMessageToolbarInspectorDescription: "Open this message in the Inspector",
+		assistantMessageToolbarInspectorLocalOnlyLabel: "Local only",
+		assistantMessageToolbarInspectorLocalOnlyDescription: "Only visible on localhost or loopback hosts in development. Never shown in production.",
+		assistantMessageToolbarInspectorTitle: "CopilotKit Inspector",
+		assistantMessageToolbarInspectorHideLabel: "Hide this icon",
+		assistantMessageToolbarInspectorHideDescription: "Until you reload this page",
 		assistantMessageToolbarThumbsUpLabel: "Good response",
 		assistantMessageToolbarThumbsDownLabel: "Bad response",
 		assistantMessageToolbarReadAloudLabel: "Read aloud",
@@ -131,7 +263,8 @@ react_markdown = __toESM(react_markdown);
 			...parentConfig?.labels,
 			...stableLabels
 		}), [stableLabels, parentConfig?.labels]);
-		const resolvedAgentId = agentId ?? parentConfig?.agentId ?? _copilotkit_shared.DEFAULT_AGENT_ID;
+		const providerAgentId = useDefaultAgentId();
+		const resolvedAgentId = agentId ?? parentConfig?.agentId ?? providerAgentId ?? _copilotkit_shared.DEFAULT_AGENT_ID;
 		const threadIdPropIsAuthoritative = threadId !== void 0 && hasExplicitThreadId !== false;
 		const isThreadIdControlled = threadIdPropIsAuthoritative;
 		const [activeThreadOverride, setActiveThreadOverride] = (0, react.useState)(null);
@@ -339,131 +472,6 @@ react_markdown = __toESM(react_markdown);
 	};
 	ControlledModalOpenScope.displayName = "ControlledModalOpenScope";
 
-//#endregion
-//#region src/v2/lib/react-core.ts
-	var CopilotKitCoreReact = class extends _copilotkit_core.CopilotKitCore {
-		constructor(config) {
-			super(config);
-			this._renderToolCalls = [];
-			this._hookRenderToolCalls = /* @__PURE__ */ new Map();
-			this._cachedMergedRenderToolCalls = null;
-			this._renderCustomMessages = [];
-			this._renderActivityMessages = [];
-			this._interruptElement = null;
-			this._renderToolCalls = config.renderToolCalls ?? [];
-			this._renderCustomMessages = config.renderCustomMessages ?? [];
-			this._renderActivityMessages = config.renderActivityMessages ?? [];
-		}
-		get renderCustomMessages() {
-			return this._renderCustomMessages;
-		}
-		get renderActivityMessages() {
-			return this._renderActivityMessages;
-		}
-		get renderToolCalls() {
-			if (this._hookRenderToolCalls.size === 0) return this._renderToolCalls;
-			if (this._cachedMergedRenderToolCalls) return this._cachedMergedRenderToolCalls;
-			const merged = /* @__PURE__ */ new Map();
-			for (const rc of this._renderToolCalls) merged.set(`${rc.agentId ?? ""}:${rc.name}`, rc);
-			for (const [key, rc] of this._hookRenderToolCalls) merged.set(key, rc);
-			this._cachedMergedRenderToolCalls = Array.from(merged.values());
-			return this._cachedMergedRenderToolCalls;
-		}
-		setRenderActivityMessages(renderers) {
-			this._renderActivityMessages = renderers;
-		}
-		setRenderCustomMessages(renderers) {
-			this._renderCustomMessages = renderers;
-		}
-		setRenderToolCalls(renderToolCalls) {
-			this._renderToolCalls = renderToolCalls;
-			this._cachedMergedRenderToolCalls = null;
-			this._notifyRenderToolCallsChanged();
-		}
-		addHookRenderToolCall(entry) {
-			const key = `${entry.agentId ?? ""}:${entry.name}`;
-			this._hookRenderToolCalls.set(key, entry);
-			this._cachedMergedRenderToolCalls = null;
-			this._notifyRenderToolCallsChanged();
-		}
-		removeHookRenderToolCall(name, agentId) {
-			const key = `${agentId ?? ""}:${name}`;
-			if (this._hookRenderToolCalls.delete(key)) {
-				this._cachedMergedRenderToolCalls = null;
-				this._notifyRenderToolCallsChanged();
-			}
-		}
-		_notifyRenderToolCallsChanged() {
-			this.notifySubscribers((subscriber) => {
-				const reactSubscriber = subscriber;
-				if (reactSubscriber.onRenderToolCallsChanged) reactSubscriber.onRenderToolCallsChanged({
-					copilotkit: this,
-					renderToolCalls: this.renderToolCalls
-				});
-			}, "Subscriber onRenderToolCallsChanged error:");
-		}
-		get interruptElement() {
-			return this._interruptElement;
-		}
-		setInterruptElement(element) {
-			this._interruptElement = element;
-			this.notifySubscribers((subscriber) => {
-				subscriber.onInterruptElementChanged?.({
-					copilotkit: this,
-					interruptElement: this._interruptElement
-				});
-			}, "Subscriber onInterruptElementChanged error:");
-		}
-		subscribe(subscriber) {
-			return super.subscribe(subscriber);
-		}
-		/**
-		* Wait for pending React state updates before the follow-up agent run.
-		*
-		* When a frontend tool handler calls setState(), React 18 batches the update
-		* and schedules a commit via its internal scheduler (MessageChannel). The
-		* useAgentContext hook registers context via useLayoutEffect, which runs
-		* synchronously after React commits that batch.
-		*
-		* Awaiting a zero-delay timeout yields to the macrotask queue. React's
-		* MessageChannel task runs first, committing the pending state and running
-		* useLayoutEffect (which updates the context store). The follow-up runAgent
-		* call then reads fresh context.
-		*/
-		async waitForPendingFrameworkUpdates() {
-			await new Promise((resolve) => setTimeout(resolve, 0));
-		}
-	};
-
-//#endregion
-//#region src/v2/context.ts
-	const CopilotKitContext = (0, react.createContext)(null);
-	const useCopilotKit = () => {
-		const context = (0, react.useContext)(CopilotKitContext);
-		const [, forceUpdate] = (0, react.useReducer)((x) => x + 1, 0);
-		if (!context) throw new Error("useCopilotKit must be used within CopilotKitProvider");
-		(0, react.useEffect)(() => {
-			const subscription = context.copilotkit.subscribe({
-				onRuntimeConnectionStatusChanged: () => {
-					forceUpdate();
-				},
-				onHeadersChanged: () => {
-					forceUpdate();
-				}
-			});
-			return () => {
-				subscription.unsubscribe();
-			};
-		}, []);
-		return context;
-	};
-	const LicenseContext = (0, react.createContext)({
-		status: null,
-		license: null,
-		checkFeature: () => true,
-		getLimit: () => null
-	});
-
 //#endregion
 //#region src/v2/hooks/use-render-tool-call.tsx
 /**
@@ -575,21 +583,28 @@ react_markdown = __toESM(react_markdown);
 
 //#endregion
 //#region src/v2/components/CopilotKitInspector.tsx
-	const CopilotKitInspector = ({ core, openRequest }) => {
+	const CopilotKitInspector = ({ core, openRequest, onVisibilityChange }) => {
 		const mountRef = react.useRef(null);
 		const inspectorRef = react.useRef(null);
 		const latestCoreRef = react.useRef(core ?? null);
 		const latestOpenRequestRef = react.useRef(openRequest);
+		const visibilityCallbackRef = react.useRef(onVisibilityChange);
+		visibilityCallbackRef.current = onVisibilityChange;
 		latestCoreRef.current = core ?? null;
 		latestOpenRequestRef.current = openRequest;
 		react.useEffect(() => {
 			let mounted = true;
 			let inspector = null;
+			const handleVisibilityChange = (event) => {
+				const visible = event.detail?.visible;
+				visibilityCallbackRef.current?.(visible === true);
+			};
 			import("@copilotkit/web-inspector").then((mod) => {
 				if (!mounted || !mountRef.current) return;
 				mod.defineWebInspector?.();
 				inspector = mountRef.current.ownerDocument.createElement(mod.WEB_INSPECTOR_TAG);
 				mod.configureWebInspectorElement(inspector, latestCoreRef.current);
+				inspector.addEventListener("cpk-inspector-visibility-change", handleVisibilityChange);
 				mountRef.current.appendChild(inspector);
 				inspectorRef.current = inspector;
 				const request = latestOpenRequestRef.current;
@@ -599,7 +614,9 @@ react_markdown = __toESM(react_markdown);
 			});
 			return () => {
 				mounted = false;
+				inspector?.removeEventListener("cpk-inspector-visibility-change", handleVisibilityChange);
 				inspector?.remove();
+				visibilityCallbackRef.current?.(false);
 				if (inspectorRef.current === inspector) inspectorRef.current = null;
 			};
 		}, []);
@@ -2500,14 +2517,19 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 		}, [value, warningMessage]);
 		return value;
 	}
-	const CopilotKitProvider = ({ children, runtimeUrl, headers: headersProp = EMPTY_HEADERS, credentials, publicApiKey, publicLicenseKey, licenseToken, properties = EMPTY_PROPERTIES, agents__unsafe_dev_only: agents = EMPTY_AGENTS, selfManagedAgents = EMPTY_AGENTS, renderToolCalls, renderActivityMessages, renderCustomMessages, frontendTools, humanInTheLoop, openGenerativeUI, enableInspector, useSingleEndpoint, onError, a2ui, defaultThrottleMs, debug }) => {
+	const CopilotKitProvider = ({ children, runtimeUrl, headers: headersProp = EMPTY_HEADERS, credentials, publicApiKey, publicLicenseKey, licenseToken, properties = EMPTY_PROPERTIES, agents__unsafe_dev_only: agents = EMPTY_AGENTS, selfManagedAgents = EMPTY_AGENTS, renderToolCalls, renderActivityMessages, renderCustomMessages, frontendTools, humanInTheLoop, openGenerativeUI, enableInspector, agentId, useSingleEndpoint, onError, a2ui, defaultThrottleMs, debug }) => {
 		const [shouldRenderInspector, setShouldRenderInspector] = (0, react.useState)(false);
+		const [inspectorVisible, setInspectorVisible] = (0, react.useState)(false);
 		(0, react.useEffect)(() => {
 			setShouldRenderInspector((0, _copilotkit_shared.shouldEnableInspector)({
 				enableInspector,
 				isBrowser: true,
 				isDevelopment: process.env.NODE_ENV === "development"
-			}));
+			}) && [
+				"localhost",
+				"127.0.0.1",
+				"[::1]"
+			].includes(window.location.hostname));
 		}, [enableInspector]);
 		const [inspectorOpenRequest, setInspectorOpenRequest] = (0, react.useState)(null);
 		const [runtimeA2UIEnabled, setRuntimeA2UIEnabled] = (0, react.useState)(false);
@@ -2523,9 +2545,15 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 			setInspectorOpenRequest({ ...request });
 		}, []);
 		const inspectorContextValue = (0, react.useMemo)(() => ({
-			isInspectorEnabled: shouldRenderInspector,
+			providerEnableInspector: enableInspector,
+			isInspectorEnabled: shouldRenderInspector && inspectorVisible,
 			openInspector: requestInspectorOpen
-		}), [shouldRenderInspector, requestInspectorOpen]);
+		}), [
+			enableInspector,
+			shouldRenderInspector,
+			inspectorVisible,
+			requestInspectorOpen
+		]);
 		const renderToolCallsList = useStableArrayProp(renderToolCalls, "renderToolCalls must be a stable array. If you want to dynamically add or remove tools, use `useFrontendTool` instead.", (initial, next) => {
 			const key = (rc) => `${rc?.agentId ?? ""}:${rc?.name ?? ""}`;
 			const setFrom = (arr) => new Set(arr.map(key));
@@ -2922,9 +2950,13 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 						}),
 						/* @__PURE__ */ (0, react_jsx_runtime.jsxs)(CopilotKitInspectorContextProvider, {
 							value: inspectorContextValue,
-							children: [children, shouldRenderInspector ? /* @__PURE__ */ (0, react_jsx_runtime.jsx)(CopilotKitInspector, {
+							children: [/* @__PURE__ */ (0, react_jsx_runtime.jsx)(CopilotKitAgentIdContext.Provider, {
+								value: agentId,
+								children
+							}), shouldRenderInspector ? /* @__PURE__ */ (0, react_jsx_runtime.jsx)(CopilotKitInspector, {
 								core: copilotkit,
-								openRequest: inspectorOpenRequest
+								openRequest: inspectorOpenRequest,
+								onVisibilityChange: setInspectorVisible
 							}) : null]
 						}),
 						runtimeLicenseWarningStatus === "none" && !resolvedPublicKey && /* @__PURE__ */ (0, react_jsx_runtime.jsx)(LicenseWarningBanner, { type: "no_license" }),
@@ -3126,7 +3158,8 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 		if (runtimeAgentId != null && threadId == null) throw new Error(`useAgent: \`runtimeAgentId\` requires \`threadId\`. A proxied agent exists to scope a thread to a private instance; without a threadId it behaves like the shared agent while adding a registration and a local agentId to keep unique. Either pass the thread, e.g. useAgent({ agentId: "${agentId ?? "chat-1"}", runtimeAgentId: "${runtimeAgentId}", threadId }), or bind to the agent directly with useAgent({ agentId: "${runtimeAgentId}" }).`);
 		if (runtimeAgentId != null && agentId == null) throw new Error(`useAgent: \`runtimeAgentId\` requires an explicit \`agentId\`. The proxied agent is registered under \`agentId\`, and the usual fallbacks (chat configuration, then "${_copilotkit_shared.DEFAULT_AGENT_ID}") name agents that already exist — registering over one throws or shadows it. Pick a local id for this hook, e.g. useAgent({ agentId: "chat-1", runtimeAgentId: "${runtimeAgentId}", threadId }).`);
 		const chatConfig = useCopilotChatConfiguration();
-		const resolvedAgentId = agentId ?? chatConfig?.agentId ?? _copilotkit_shared.DEFAULT_AGENT_ID;
+		const providerAgentId = useDefaultAgentId();
+		const resolvedAgentId = agentId ?? chatConfig?.agentId ?? providerAgentId ?? _copilotkit_shared.DEFAULT_AGENT_ID;
 		const { copilotkit } = useCopilotKit();
 		const providerThrottleMs = copilotkit.defaultThrottleMs;
 		const [, forceUpdate] = (0, react.useReducer)((x) => x + 1, 0);
@@ -3309,7 +3342,12 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 	function useSuggestions({ agentId } = {}) {
 		const { copilotkit } = useCopilotKit();
 		const config = useCopilotChatConfiguration();
-		const resolvedAgentId = (0, react.useMemo)(() => agentId ?? config?.agentId ?? _copilotkit_shared.DEFAULT_AGENT_ID, [agentId, config?.agentId]);
+		const providerAgentId = useDefaultAgentId();
+		const resolvedAgentId = (0, react.useMemo)(() => agentId ?? config?.agentId ?? providerAgentId ?? _copilotkit_shared.DEFAULT_AGENT_ID, [
+			agentId,
+			config?.agentId,
+			providerAgentId
+		]);
 		const [suggestions, setSuggestions] = (0, react.useState)(() => {
 			return copilotkit.getSuggestions(resolvedAgentId).suggestions;
 		});
@@ -3563,7 +3601,10 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 	*/
 	function useInterrupt(config) {
 		const { copilotkit } = useCopilotKit();
-		const { agent } = useAgent({ agentId: config.agentId });
+		const { agent } = useAgent({
+			agentId: config.agentId,
+			updates: []
+		});
 		const [pending, setPending] = (0, react.useState)(null);
 		const pendingRef = (0, react.useRef)(pending);
 		pendingRef.current = pending;
@@ -6971,7 +7012,7 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 	*
 	* ### Example
 	* A great example of this is in our Perplexity Clone where we render the progress of an agent's internet search as it is happening.
-	* You can play around with it below or learn how to build it with its [demo](/coagents/videos/perplexity-clone).
+	* You can play around with it below or learn how to build it with the [state rendering guide](/generative-ui/state-rendering).
 	*
 	* <Callout type="info">
 	*   This example is hosted on Vercel and may take a few seconds to load.
@@ -7159,7 +7200,7 @@ window.parent.postMessage({jsonrpc:"2.0",method:"ui/notifications/sandbox-proxy-
 	function useCopilotReadable({ description, value, convert, available = "enabled" }, dependencies) {
 		const { copilotkit } = useCopilotKit();
 		const ctxIdRef = (0, react.useRef)(void 0);
-		(0, react.useEffect)(() => {
+		(0, react.useLayoutEffect)(() => {
 			if (!copilotkit) return;
 			if (available === "disabled") return;
 			const id = copilotkit.addContext({