@copilotkit/react-core 1.68.3 → 1.69.1

package/dist/index.cjs

@@ -1,7 +1,7 @@
 "use client";
 
 Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
-const require_copilotkit = require('./copilotkit-Bocmlr37.cjs');
+const require_copilotkit = require('./copilotkit-Dr0speVK.cjs');
 let react = require("react");
 react = require_copilotkit.__toESM(react);
 let _copilotkit_core = require("@copilotkit/core");
@@ -10,7 +10,7 @@ let _copilotkit_shared = require("@copilotkit/shared");
 let _copilotkit_runtime_client_gql = require("@copilotkit/runtime-client-gql");
 let _copilotkit_react_core_v2_context = require("@copilotkit/react-core/v2/context");
 
-//#region src/utils/suggestions-constants.ts
+//#region src/v1-deprecated/utils/suggestions-constants.ts
 /**
 * Constants for suggestions retry logic
 */
@@ -20,7 +20,7 @@ const SUGGESTION_RETRY_CONFIG = {
 };
 
 //#endregion
-//#region src/hooks/use-lazy-tool-renderer.tsx
+//#region src/v1-deprecated/hooks/use-lazy-tool-renderer.tsx
 function useLazyToolRenderer() {
 	const renderToolCall = require_copilotkit.useRenderToolCall();
 	return (0, react.useCallback)((message, messages) => {
@@ -36,7 +36,7 @@ function useLazyToolRenderer() {
 }
 
 //#endregion
-//#region src/hooks/use-copilot-chat_internal.ts
+//#region src/v1-deprecated/hooks/use-copilot-chat_internal.ts
 function useCopilotChatInternal({ suggestions, onInProgress, onSubmitMessage, onStopGeneration, onReloadMessages } = {}) {
 	const { copilotkit } = (0, _copilotkit_react_core_v2_context.useCopilotKit)();
 	const { threadId, agentSession } = require_copilotkit.useCopilotContext();
@@ -337,7 +337,7 @@ function useLegacyCoagentRenderer({ copilotkit, agent, agentId, threadId }) {
 }
 
 //#endregion
-//#region src/hooks/use-copilot-chat.ts
+//#region src/v1-deprecated/hooks/use-copilot-chat.ts
 /**
 * A lightweight React hook for headless chat interactions.
 * Perfect for programmatic messaging, background operations, and custom UI implementations.
@@ -361,12 +361,12 @@ function useCopilotChat(options = {}) {
 }
 
 //#endregion
-//#region src/hooks/use-copilot-chat-headless_c.ts
+//#region src/v1-deprecated/hooks/use-copilot-chat-headless_c.ts
 /**
 * `useCopilotChatHeadless_c` is for building fully custom UI (headless UI) implementations.
 *
-* <Callout title="This is an Enterprise Intelligence Platform feature">
-* Read more about <a href="/premium/overview">the Enterprise Intelligence Platform</a>.
+* <Callout title="This is a CopilotKit Intelligence feature">
+* Read more about <a href="/premium/overview">CopilotKit Intelligence</a>.
 *
 * Usage is generous and **free** to get started.
 * </Callout>
@@ -545,11 +545,11 @@ const createNonFunctionalReturn = () => ({
 	interrupt: null
 });
 /**
-* Enterprise Intelligence Platform React hook that provides complete chat functionality for fully custom UI implementations.
+* CopilotKit Intelligence React hook that provides complete chat functionality for fully custom UI implementations.
 * Includes all advanced features like direct message access, suggestions array, interrupt handling, and MCP support.
 *
 * @param options - Configuration options for the chat
-* @returns Complete chat interface with all Enterprise Intelligence Platform features
+* @returns Complete chat interface with all CopilotKit Intelligence features
 *
 * @example
 * ```tsx
@@ -563,7 +563,7 @@ function useCopilotChatHeadless_c(options = {}) {
 	(0, react.useEffect)(() => {
 		if (!hasPublicApiKey) {
 			setBannerError(new _copilotkit_shared.CopilotKitError({
-				message: "You're using useCopilotChatHeadless_c, an Enterprise Intelligence Platform feature that offers extensive headless chat capabilities. To continue, you'll need to provide a free public license key.",
+				message: "You're using useCopilotChatHeadless_c, a CopilotKit Intelligence feature that offers extensive headless chat capabilities. To continue, you'll need to provide a free public license key.",
 				code: _copilotkit_shared.CopilotKitErrorCode.MISSING_PUBLIC_API_KEY_ERROR,
 				severity: _copilotkit_shared.Severity.WARNING,
 				visibility: _copilotkit_shared.ErrorVisibility.BANNER
@@ -576,7 +576,26 @@ function useCopilotChatHeadless_c(options = {}) {
 }
 
 //#endregion
-//#region src/hooks/use-frontend-tool.ts
+//#region src/v1-deprecated/hooks/use-frontend-tool.ts
+/**
+* @deprecated The v1 SDK is deprecated. Use v2 instead. Use `useFrontendTool` from `@copilotkit/react-core/v2` instead.
+*
+* ```tsx
+* import { useFrontendTool } from "@copilotkit/react-core/v2";
+* import { z } from "zod";
+*
+* function MyComponent() {
+*   useFrontendTool({
+*     name: "myTool",
+*     description: "Run my tool",
+*     parameters: z.object({}),
+*     handler: async () => "done",
+*   });
+*   return null;
+* }
+* ```
+* See https://docs.copilotkit.ai/reference/v2/hooks/useFrontendTool
+*/
 function useFrontendTool(tool, dependencies) {
 	const { name, description, parameters, render, followUp, available } = tool;
 	const zodParameters = (0, _copilotkit_shared.getZodParameters)(parameters);
@@ -614,7 +633,27 @@ function useFrontendTool(tool, dependencies) {
 }
 
 //#endregion
-//#region src/hooks/use-render-tool-call.ts
+//#region src/v1-deprecated/hooks/use-render-tool-call.ts
+/**
+* @deprecated The v1 SDK is deprecated. Use v2 instead. Use `useRenderTool` from `@copilotkit/react-core/v2` instead.
+*
+* ```tsx
+* import { useRenderTool } from "@copilotkit/react-core/v2";
+* import { z } from "zod";
+*
+* function StatusTool() {
+*   useRenderTool({
+*     name: "showStatus",
+*     parameters: z.object({}),
+*     render: ({ status, result }) => (
+*       <div>{status === "complete" ? result : "Running..."}</div>
+*     ),
+*   });
+*   return null;
+* }
+* ```
+* See https://docs.copilotkit.ai/reference/v2/hooks/useRenderTool
+*/
 function useRenderToolCall(tool, dependencies) {
 	const { copilotkit } = (0, _copilotkit_react_core_v2_context.useCopilotKit)();
 	const hasAddedRef = (0, react.useRef)(false);
@@ -654,7 +693,28 @@ function useRenderToolCall(tool, dependencies) {
 }
 
 //#endregion
-//#region src/hooks/use-human-in-the-loop.ts
+//#region src/v1-deprecated/hooks/use-human-in-the-loop.ts
+/**
+* @deprecated The v1 SDK is deprecated. Use v2 instead. Use `useHumanInTheLoop` from `@copilotkit/react-core/v2` instead.
+*
+* ```tsx
+* import { useHumanInTheLoop } from "@copilotkit/react-core/v2";
+* import { z } from "zod";
+*
+* function Confirmation() {
+*   useHumanInTheLoop({
+*     name: "confirmAction",
+*     description: "Ask the user to confirm",
+*     parameters: z.object({}),
+*     render: ({ respond }) => (
+*       <button onClick={() => respond?.(true)}>Confirm</button>
+*     ),
+*   });
+*   return null;
+* }
+* ```
+* See https://docs.copilotkit.ai/reference/v2/hooks/useHumanInTheLoop
+*/
 function useHumanInTheLoop(tool, dependencies) {
 	const { render, ...toolRest } = tool;
 	const { name, description, parameters, followUp } = toolRest;
@@ -706,7 +766,7 @@ function useHumanInTheLoop(tool, dependencies) {
 }
 
 //#endregion
-//#region src/hooks/use-copilot-action.ts
+//#region src/v1-deprecated/hooks/use-copilot-action.ts
 /**
 * Example usage of useCopilotAction with complex parameters:
 *
@@ -905,7 +965,7 @@ function useCopilotAction(action, dependencies) {
 }
 
 //#endregion
-//#region src/hooks/use-coagent-state-render.ts
+//#region src/v1-deprecated/hooks/use-coagent-state-render.ts
 /**
 * The useCoAgentStateRender hook allows you to render UI or text based components on a Agentic Copilot's state in the chat.
 * This is particularly useful for showing intermediate state or progress during Agentic Copilot operations.
@@ -1013,7 +1073,7 @@ function useCoAgentStateRender(action, dependencies) {
 }
 
 //#endregion
-//#region src/hooks/use-make-copilot-document-readable.ts
+//#region src/v1-deprecated/hooks/use-make-copilot-document-readable.ts
 /**
 * Makes a document readable by Copilot.
 * @param document The document to make readable.
@@ -1039,7 +1099,7 @@ function useMakeCopilotDocumentReadable(document, categories, dependencies = [])
 }
 
 //#endregion
-//#region src/hooks/use-copilot-readable.ts
+//#region src/v1-deprecated/hooks/use-copilot-readable.ts
 /**
 * `useCopilotReadable` is a React hook that provides app-state and other information
 * to the Copilot.
@@ -1110,6 +1170,20 @@ function useMakeCopilotDocumentReadable(document, categories, dependencies = [])
 */
 /**
 * Adds the given information to the Copilot context to make it readable by Copilot.
+* @deprecated The v1 SDK is deprecated. Use v2 instead. Use `useAgentContext` from `@copilotkit/react-core/v2` instead.
+*
+* ```tsx
+* import { useAgentContext } from "@copilotkit/react-core/v2";
+*
+* function UserContext() {
+*   useAgentContext({
+*     description: "The current user",
+*     value: { name: "Ada" },
+*   });
+*   return null;
+* }
+* ```
+* See https://docs.copilotkit.ai/reference/v2/hooks/useAgentContext
 */
 function useCopilotReadable({ description, value, convert, available = "enabled" }, dependencies) {
 	const { copilotkit } = (0, _copilotkit_react_core_v2_context.useCopilotKit)();
@@ -1138,7 +1212,7 @@ function useCopilotReadable({ description, value, convert, available = "enabled"
 }
 
 //#endregion
-//#region src/hooks/use-agent-nodename.ts
+//#region src/v1-deprecated/hooks/use-agent-nodename.ts
 /**
 * Tracks the node the agent is currently executing.
 *
@@ -1173,7 +1247,7 @@ function useAgentNodeName(agentName) {
 }
 
 //#endregion
-//#region src/hooks/use-coagent.ts
+//#region src/v1-deprecated/hooks/use-coagent.ts
 /**
 * <Callout type="info">
 *   Usage of this hook assumes some additional setup in your application, for more information
@@ -1381,7 +1455,7 @@ const isExternalStateManagement = (options) => {
 };
 
 //#endregion
-//#region src/hooks/use-copilot-runtime-client.ts
+//#region src/v1-deprecated/hooks/use-copilot-runtime-client.ts
 const useCopilotRuntimeClient = (options) => {
 	const { setBannerError } = require_copilotkit.useToast();
 	const { showDevConsole, onError, ...runtimeOptions } = options;
@@ -1484,7 +1558,7 @@ function createStructuredError(gqlError) {
 }
 
 //#endregion
-//#region src/hooks/use-copilot-authenticated-action.ts
+//#region src/v1-deprecated/hooks/use-copilot-authenticated-action.ts
 /**
 * Hook to create an authenticated action that requires user sign-in before execution.
 *
@@ -1527,7 +1601,7 @@ function useCopilotAuthenticatedAction_c(action, dependencies) {
 }
 
 //#endregion
-//#region src/hooks/use-langgraph-interrupt.ts
+//#region src/v1-deprecated/hooks/use-langgraph-interrupt.ts
 /**
 * Transforms a v2 InterruptEvent into the v1 LangGraphInterruptEvent shape
 * expected by existing useLangGraphInterrupt callbacks.
@@ -1540,6 +1614,23 @@ function toV1Event(event) {
 		value
 	};
 }
+/**
+* @deprecated The v1 SDK is deprecated. Use v2 instead. Use `useInterrupt` from `@copilotkit/react-core/v2` instead.
+*
+* ```tsx
+* import { useInterrupt } from "@copilotkit/react-core/v2";
+*
+* function ApprovalInterrupt() {
+*   useInterrupt({
+*     render: ({ resolve }) => (
+*       <button onClick={() => resolve({ approved: true })}>Approve</button>
+*     ),
+*   });
+*   return null;
+* }
+* ```
+* See https://docs.copilotkit.ai/reference/v2/hooks/useInterrupt
+*/
 function useLangGraphInterrupt(action, _dependencies) {
 	const actionRef = (0, react.useRef)(action);
 	actionRef.current = action;
@@ -1587,7 +1678,7 @@ function useLangGraphInterrupt(action, _dependencies) {
 }
 
 //#endregion
-//#region src/hooks/use-copilot-additional-instructions.ts
+//#region src/v1-deprecated/hooks/use-copilot-additional-instructions.ts
 /**
 * `useCopilotAdditionalInstructions` is a React hook that provides additional instructions
 * to the Copilot.
@@ -1646,7 +1737,7 @@ function useCopilotAdditionalInstructions({ instructions, available = "enabled"
 }
 
 //#endregion
-//#region src/hooks/use-default-tool.ts
+//#region src/v1-deprecated/hooks/use-default-tool.ts
 function useDefaultTool(tool, dependencies) {
 	useCopilotAction({
 		...tool,
@@ -1655,7 +1746,7 @@ function useDefaultTool(tool, dependencies) {
 }
 
 //#endregion
-//#region src/hooks/use-copilot-chat-suggestions.tsx
+//#region src/v1-deprecated/hooks/use-copilot-chat-suggestions.tsx
 /**
 * <Callout type="warning">
 *   useCopilotChatSuggestions is experimental. The interface is not final and
@@ -1727,7 +1818,7 @@ function useCopilotChatSuggestions(config, dependencies = []) {
 }
 
 //#endregion
-//#region src/types/frontend-action.ts
+//#region src/v1-deprecated/types/frontend-action.ts
 function processActionsForRuntimeRequest(actions) {
 	return actions.filter((action) => action.available !== _copilotkit_runtime_client_gql.ActionInputAvailability.Disabled && action.disabled !== true && action.name !== "*" && action.available != "frontend" && !action.pairedAction).map((action) => {
 		let available = _copilotkit_runtime_client_gql.ActionInputAvailability.Enabled;
@@ -1744,54 +1835,7 @@ function processActionsForRuntimeRequest(actions) {
 }
 
 //#endregion
-//#region src/lib/copilot-task.ts
-/**
-* This class is used to execute one-off tasks, for example on button press. It can use the context available via [useCopilotReadable](/reference/v1/hooks/useCopilotReadable) and the actions provided by [useCopilotAction](/reference/v1/hooks/useCopilotAction), or you can provide your own context and actions.
-*
-* ## Example
-* In the simplest case, use CopilotTask in the context of your app by giving it instructions on what to do.
-*
-* ```tsx
-* import { CopilotTask, useCopilotContext } from "@copilotkit/react-core";
-*
-* export function MyComponent() {
-*   const context = useCopilotContext();
-*
-*   const task = new CopilotTask({
-*     instructions: "Set a random message",
-*     actions: [
-*       {
-*         name: "setMessage",
-*       description: "Set the message.",
-*       argumentAnnotations: [
-*         {
-*           name: "message",
-*           type: "string",
-*           description:
-*             "A message to display.",
-*           required: true,
-*         },
-*       ],
-*      }
-*     ]
-*   });
-*
-*   const executeTask = async () => {
-*     await task.run(context, action);
-*   }
-*
-*   return (
-*     <>
-*       <button onClick={executeTask}>
-*         Execute task
-*       </button>
-*     </>
-*   )
-* }
-* ```
-*
-* Have a look at the [Presentation Example App](https://github.com/CopilotKit/CopilotKit/blob/main/examples/v1/next-openai/src/app/presentation/page.tsx) for a more complete example.
-*/
+//#region src/v1-deprecated/lib/copilot-task.ts
 var CopilotTask = class {
 	constructor(config) {
 		this.instructions = config.instructions;