@copilotkit/react-core 2.0.0-rc.7 → 2.0.0-rc.9

package/dist/headless.cjs

@@ -30,10 +30,9 @@ let _copilotkit_react_core_context = require("@copilotkit/react-core/context");
 let react = require("react");
 react = __toESM(react);
 let _copilotkit_shared = require("@copilotkit/shared");
-let react_jsx_runtime = require("react/jsx-runtime");
 let _copilotkit_core = require("@copilotkit/core");
+let react_jsx_runtime = require("react/jsx-runtime");
 let _ag_ui_client = require("@ag-ui/client");
-let zod = require("zod");
 let _ag_ui_core = require("@ag-ui/core");
 
 //#region src/lib/shallow-stable-ref.ts
@@ -79,51 +78,6 @@ function useShallowStableRef(value) {
 
 //#endregion
 //#region src/providers/CopilotChatConfigurationProvider.tsx
-const CopilotChatDefaultLabels = {
-	chatInputPlaceholder: "Type a message...",
-	chatInputToolbarStartTranscribeButtonLabel: "Transcribe",
-	chatInputToolbarCancelTranscribeButtonLabel: "Cancel",
-	chatInputToolbarFinishTranscribeButtonLabel: "Finish",
-	chatInputToolbarAddButtonLabel: "Add attachments",
-	chatInputToolbarToolsButtonLabel: "Tools",
-	chatInputToolbarSendButtonLabel: "Send message",
-	chatInputToolbarStopButtonLabel: "Stop",
-	assistantMessageToolbarCopyCodeLabel: "Copy",
-	assistantMessageToolbarCopyCodeCopiedLabel: "Copied",
-	assistantMessageToolbarCopyMessageLabel: "Copy",
-	assistantMessageToolbarInspectorLabel: "View in Inspector",
-	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",
-	assistantMessageFeedbackCommentPlaceholder: "Add a comment (optional)",
-	assistantMessageFeedbackCommentSubmitLabel: "Send comment",
-	assistantMessageToolbarReadAloudLabel: "Read aloud",
-	assistantMessageToolbarRegenerateLabel: "Regenerate",
-	userMessageToolbarCopyMessageLabel: "Copy",
-	userMessageToolbarEditMessageLabel: "Edit",
-	userMessageToolbarPreviousBranchLabel: "Previous branch",
-	userMessageToolbarNextBranchLabel: "Next branch",
-	chatDisclaimerText: "AI can make mistakes. Please verify important information.",
-	chatToggleOpenLabel: "Open chat",
-	chatToggleCloseLabel: "Close chat",
-	chatScrollToBottomLabel: "Scroll to bottom",
-	modalHeaderTitle: "CopilotKit Chat",
-	welcomeMessageText: "How can I help you today?",
-	reasoningMessageThinkingLabel: "Thinking…",
-	chatInputSlashMenuLabel: "Slash commands",
-	chatInputSlashMenuEmptyText: "No commands found",
-	attachmentRemoveButtonLabel: "Remove attachment",
-	attachmentPlayVideoButtonLabel: "Play video",
-	attachmentPreviewCloseButtonLabel: "Close preview",
-	modalHeaderCloseButtonLabel: "Close",
-	modalHeaderThreadsButtonLabel: "Open threads",
-	sidebarLabel: "Copilot chat sidebar"
-};
 /**
 * Mobile breakpoint below which the chat modal and the thread-list drawer are
 * mutually exclusive. At or above this width both surfaces may coexist. This
@@ -148,7 +102,7 @@ const CopilotChatConfigurationProvider = ({ children, labels, agentId, threadId,
 	const parentConfig = (0, react.useContext)(CopilotChatConfiguration);
 	const stableLabels = useShallowStableRef(labels);
 	const mergedLabels = (0, react.useMemo)(() => ({
-		...CopilotChatDefaultLabels,
+		..._copilotkit_core.CopilotChatDefaultLabels,
 		...parentConfig?.labels,
 		...stableLabels
 	}), [stableLabels, parentConfig?.labels]);
@@ -655,6 +609,30 @@ function useDepsVersion(deps) {
 
 //#endregion
 //#region src/hooks/use-frontend-tool.tsx
+/**
+* Register a frontend tool while the component is mounted. The agent can
+* call it, and its `render` component draws the call in the chat.
+*
+* A tool with the same name and agentId as a tool that is already registered
+* (for example one from the provider's `tools`) overrides it while this
+* component is mounted. When the component unmounts, the overridden tool is
+* active again. The renderer stays registered after unmount, so past tool
+* calls still render in the chat history.
+*
+* @param tool - The tool to register.
+* @param deps - Extra values that re-register the tool when they change. Use
+*   it when the handler closes over a value that is not part of the tool.
+*
+* @example
+* ```tsx
+* useFrontendTool({
+*   name: "showWeather",
+*   description: "Show the weather for a city",
+*   parameters: z.object({ city: z.string() }),
+*   handler: async ({ city }) => `Sunny in ${city}`,
+* });
+* ```
+*/
 function useFrontendTool(tool, deps) {
 	const { copilotkit } = (0, _copilotkit_react_core_context.useCopilotKit)();
 	const depsVersion = useDepsVersion(deps);
@@ -663,11 +641,8 @@ function useFrontendTool(tool, deps) {
 		if (copilotkit.getTool({
 			toolName: name,
 			agentId: tool.agentId
-		})) {
-			console.warn(`Tool '${name}' already exists for agent '${tool.agentId || "global"}'. Overriding with latest registration.`);
-			copilotkit.removeTool(name, tool.agentId);
-		}
-		copilotkit.addTool(tool);
+		})) console.warn(`Tool '${name}' already exists for agent '${tool.agentId || "global"}'. Overriding with latest registration.`);
+		const unregister = copilotkit.addTool(tool);
 		if (tool.render) copilotkit.addHookRenderToolCall({
 			name,
 			args: tool.parameters,
@@ -675,7 +650,7 @@ function useFrontendTool(tool, deps) {
 			render: tool.render
 		});
 		return () => {
-			copilotkit.removeTool(name, tool.agentId);
+			unregister();
 		};
 	}, [
 		tool.name,
@@ -700,8 +675,10 @@ const EMPTY_TOOLS = [];
 *
 * Tools are keyed by `name` plus `agentId`, the same as `useFrontendTool`. A
 * tool that disappears from the array is unregistered on the next render, and
-* every tool is unregistered on unmount. Renderers stay registered after
-* unmount so past tool calls still render in the chat history.
+* every tool is unregistered on unmount. A listed tool hides a tool with the
+* same name and agentId (for example one from the provider's `tools`) until it
+* is unregistered, and then the hidden tool is active again. Renderers stay
+* registered after unmount so past tool calls still render in the chat history.
 *
 * @param tools - The tools to register. May be empty and may change length.
 * @param deps - Extra dependencies that force re-registration, compared by
@@ -751,15 +728,13 @@ function useFrontendTools(tools, deps) {
 			deduped.set(key, tool);
 		}
 		const registered = [...deduped.values()];
+		const unregisters = [];
 		for (const tool of registered) {
 			if (copilotkit.getTool({
 				toolName: tool.name,
 				agentId: tool.agentId
-			})) {
-				console.warn(`Tool '${tool.name}' already exists for agent '${tool.agentId || "global"}'. Overriding with latest registration.`);
-				copilotkit.removeTool(tool.name, tool.agentId);
-			}
-			copilotkit.addTool(tool);
+			})) console.warn(`Tool '${tool.name}' already exists for agent '${tool.agentId || "global"}'. Overriding with latest registration.`);
+			unregisters.push(copilotkit.addTool(tool));
 			if (tool.render) copilotkit.addHookRenderToolCall({
 				name: tool.name,
 				args: tool.parameters,
@@ -768,7 +743,7 @@ function useFrontendTools(tools, deps) {
 			});
 		}
 		return () => {
-			for (const tool of registered) copilotkit.removeTool(tool.name, tool.agentId);
+			for (const unregister of unregisters) unregister();
 		};
 	}, [
 		JSON.stringify(toolList.map((tool) => [
@@ -944,11 +919,6 @@ function useHumanInTheLoop(tool, deps) {
 	]);
 }
 
-//#endregion
-//#region src/types/interrupt.ts
-/** Name of the legacy custom event agents emit to signal an interrupt. */
-const INTERRUPT_EVENT_NAME = "on_interrupt";
-
 //#endregion
 //#region src/hooks/use-interrupt.tsx
 /** Recognize thenables returned by interrupt preprocessing handlers. */
@@ -959,7 +929,7 @@ function isPromiseLike(value) {
 function toLegacyEvent(pending) {
 	if (pending.kind === "legacy") return pending.event;
 	return {
-		name: INTERRUPT_EVENT_NAME,
+		name: _copilotkit_core.INTERRUPT_EVENT_NAME,
 		value: pending.interrupts[0]
 	};
 }
@@ -1006,7 +976,7 @@ function useInterrupt(config) {
 		let localStandard = null;
 		const subscription = agent.subscribe({
 			onCustomEvent: ({ event }) => {
-				if (event.name === INTERRUPT_EVENT_NAME) localLegacy = {
+				if (event.name === _copilotkit_core.INTERRUPT_EVENT_NAME) localLegacy = {
 					name: event.name,
 					value: event.value
 				};
@@ -1664,7 +1634,7 @@ function useThreads({ agentId, includeArchived, limit, enabled = true }) {
 //#endregion
 //#region src/types/defineToolCallRenderer.ts
 function defineToolCallRenderer(def) {
-	const argsSchema = def.name === "*" && !def.args ? zod.z.any() : def.args;
+	const argsSchema = def.name === "*" && !def.args ? _copilotkit_shared.ɵanySchema : def.args;
 	return {
 		name: def.name,
 		args: argsSchema,
@@ -1842,18 +1812,17 @@ function useRenderToolCall() {
 	const warnedToolNames = (0, react.useRef)(/* @__PURE__ */ new Set());
 	const renderToolCalls = useToolCallRenderers();
 	const renderToolCall = (0, react.useCallback)(({ toolCall, toolMessage }) => {
-		const exactMatches = renderToolCalls.filter((rc) => rc.name === toolCall.function.name);
-		const renderConfig = exactMatches.find((rc) => rc.agentId === agentId) || exactMatches.find((rc) => !rc.agentId) || exactMatches[0] || renderToolCalls.find((rc) => rc.name === "*");
+		const renderConfig = (0, _copilotkit_core.ɵresolveToolCallRenderer)(renderToolCalls, toolCall.function.name, agentId);
 		if (!renderConfig) {
 			if (IS_DEVELOPMENT) unrenderedToolNames.current.add(toolCall.function.name);
 			return null;
 		}
-		const RenderComponent = renderConfig.render;
+		const isExecuting = executingToolCallIds.has(toolCall.id);
 		return /* @__PURE__ */ (0, react_jsx_runtime.jsx)(ToolCallRenderer, {
 			toolCall,
 			toolMessage,
-			RenderComponent,
-			isExecuting: executingToolCallIds.has(toolCall.id)
+			RenderComponent: renderConfig.render,
+			isExecuting
 		}, toolCall.id);
 	}, [
 		renderToolCalls,
@@ -1895,7 +1864,12 @@ function useCapabilities(agentId) {
 
 //#endregion
 exports.CopilotChatConfigurationProvider = CopilotChatConfigurationProvider;
-exports.CopilotChatDefaultLabels = CopilotChatDefaultLabels;
+Object.defineProperty(exports, 'CopilotChatDefaultLabels', {
+  enumerable: true,
+  get: function () {
+    return _copilotkit_core.CopilotChatDefaultLabels;
+  }
+});
 Object.defineProperty(exports, 'CopilotKitCoreReact', {
   enumerable: true,
   get: function () {