@copilotkit/react-core 0.0.0-main-20260402184302 → 0.0.0-main-20260403195251

package/dist/index.d.ts

@@ -0,0 +1,667 @@
+import { $t as CrewsAgentState, Bt as CoagentInChatRenderFunction, Gt as CoAgentStateRender, Ht as CopilotContext, Jt as LangGraphInterruptActionSetterArgs, Kt as LangGraphInterruptAction, Qt as QueuedInterruptEvent, T as useAgent, U as useRenderToolCall$1, Ut as CopilotContextParams, Vt as CopilotApiConfig, Wt as useCopilotContext, Xt as LangGraphInterruptRenderHandlerProps, Yt as LangGraphInterruptRender, Zt as LangGraphInterruptRenderProps, _n as FrontendActionAvailability, an as CopilotChatSuggestionConfiguration, cn as Tree, dn as ActionRenderPropsNoArgs, en as CrewsResponse, fn as ActionRenderPropsNoArgsWait, gn as FrontendAction, hn as CatchAllFrontendAction, in as CrewsToolStateItem, ln as TreeNode, mn as CatchAllActionRenderProps, n as defaultCopilotContextCategories, nn as CrewsStateItem, on as SystemMessageFunction, pn as ActionRenderPropsWait, qt as LangGraphInterruptActionSetter, r as CopilotKitProps, rn as CrewsTaskStateItem, sn as DocumentPointer, t as CopilotKit, tn as CrewsResponseStatus, un as ActionRenderProps, vn as RenderFunctionStatus } from "./copilotkit-BYNyIuE7.cjs";
+import "./v2/index.cjs";
+import * as react_jsx_runtime0 from "react/jsx-runtime";
+import { CopilotRuntimeClient, CopilotRuntimeClientOptions, ForwardedParametersInput, Message } from "@copilotkit/runtime-client-gql";
+import React, { ReactNode, RefObject, SetStateAction } from "react";
+import { AIMessage, CopilotErrorHandler, Message as Message$1, Parameter } from "@copilotkit/shared";
+import { StaticSuggestionsConfig, Suggestion } from "@copilotkit/core";
+
+//#region src/context/copilot-messages-context.d.ts
+interface CopilotMessagesContextParams {
+  messages: Message[];
+  setMessages: React.Dispatch<React.SetStateAction<Message[]>>;
+  suggestions: Suggestion[];
+  setSuggestions: React.Dispatch<React.SetStateAction<Suggestion[]>>;
+}
+declare const CopilotMessagesContext: React.Context<CopilotMessagesContextParams>;
+declare function useCopilotMessagesContext(): CopilotMessagesContextParams;
+//#endregion
+//#region src/context/coagent-state-renders-context.d.ts
+interface StateRenderClaim {
+  stateRenderId: string;
+  stateSnapshot?: any;
+  runId?: string;
+  messageIndex?: number;
+  locked?: boolean;
+}
+type ClaimsRef = Record<string, StateRenderClaim>;
+interface CoAgentStateRendersContextValue {
+  coAgentStateRenders: Record<string, CoAgentStateRender<any>>;
+  setCoAgentStateRender: (id: string, stateRender: CoAgentStateRender<any>) => void;
+  removeCoAgentStateRender: (id: string) => void;
+  claimsRef: RefObject<ClaimsRef>;
+}
+declare const CoAgentStateRendersContext: React.Context<CoAgentStateRendersContextValue | undefined>;
+declare function CoAgentStateRendersProvider({
+  children
+}: {
+  children: ReactNode;
+}): react_jsx_runtime0.JSX.Element;
+declare function useCoAgentStateRenders(): CoAgentStateRendersContextValue;
+//#endregion
+//#region src/context/threads-context.d.ts
+interface ThreadsContextValue {
+  threadId: string;
+  setThreadId: (value: SetStateAction<string>) => void;
+}
+declare const ThreadsContext: React.Context<ThreadsContextValue | undefined>;
+interface ThreadsProviderProps {
+  children: ReactNode;
+  threadId?: string;
+}
+declare function ThreadsProvider({
+  children,
+  threadId: explicitThreadId
+}: ThreadsProviderProps): react_jsx_runtime0.JSX.Element;
+declare function useThreads(): ThreadsContextValue;
+//#endregion
+//#region src/hooks/use-copilot-chat_internal.d.ts
+/**
+ * The type of suggestions to use in the chat.
+ *
+ * `auto` - Suggestions are generated automatically.
+ * `manual` - Suggestions are controlled programmatically.
+ * `SuggestionItem[]` - Static suggestions array.
+ */
+type ChatSuggestions = "auto" | "manual" | Omit<Suggestion, "isLoading">[];
+interface AppendMessageOptions {
+  /**
+   * Whether to run the chat completion after appending the message. Defaults to `true`.
+   */
+  followUp?: boolean;
+  /**
+   * Whether to clear the suggestions after appending the message. Defaults to `true`.
+   */
+  clearSuggestions?: boolean;
+}
+interface OnStopGenerationArguments {
+  /**
+   * The name of the currently executing agent.
+   */
+  currentAgentName: string | undefined;
+  /**
+   * The messages in the chat.
+   */
+  messages: Message$1[];
+}
+type OnReloadMessagesArguments = OnStopGenerationArguments & {
+  /**
+   * The message on which "regenerate" was pressed
+   */
+  messageId: string;
+};
+type OnStopGeneration = (args: OnStopGenerationArguments) => void;
+type OnReloadMessages = (args: OnReloadMessagesArguments) => void;
+interface UseCopilotChatOptions {
+  /**
+   * A unique identifier for the chat. If not provided, a random one will be
+   * generated. When provided, the `useChat` hook with the same `id` will
+   * have shared states across components.
+   */
+  id?: string;
+  /**
+   * HTTP headers to be sent with the API request.
+   */
+  headers?: Record<string, string> | Headers;
+  /**
+   * Initial messages to populate the chat with.
+   */
+  initialMessages?: Message$1[];
+  /**
+   * A function to generate the system message. Defaults to `defaultSystemMessage`.
+   */
+  makeSystemMessage?: SystemMessageFunction;
+  /**
+   * Disables inclusion of CopilotKit’s default system message. When true, no system message is sent (this also suppresses any custom message from <code>makeSystemMessage</code>).
+   */
+  disableSystemMessage?: boolean;
+  /**
+   * Controls the behavior of suggestions in the chat interface.
+   *
+   * `auto` (default) - Suggestions are generated automatically:
+   *   - When the chat is first opened (empty state)
+   *   - After each message exchange completes
+   *   - Uses configuration from `useCopilotChatSuggestions` hooks
+   *
+   * `manual` - Suggestions are controlled programmatically:
+   *   - Use `setSuggestions()` to set custom suggestions
+   *   - Use `generateSuggestions()` to trigger AI generation
+   *   - Access via `useCopilotChat` hook
+   *
+   * `SuggestionItem[]` - Static suggestions array:
+   *   - Always shows the same suggestions
+   *   - No AI generation involved
+   */
+  suggestions?: ChatSuggestions;
+  onInProgress?: (isLoading: boolean) => void;
+  onSubmitMessage?: (messageContent: string) => Promise<void> | void;
+  onStopGeneration?: OnStopGeneration;
+  onReloadMessages?: OnReloadMessages;
+}
+interface MCPServerConfig {
+  endpoint: string;
+  apiKey?: string;
+}
+interface UseCopilotChatReturn$1 {
+  /**
+   * @deprecated use `messages` instead, this is an old non ag-ui version of the messages
+   * Array of messages currently visible in the chat interface
+   *
+   * This is the visible messages, not the raw messages from the runtime client.
+   */
+  visibleMessages: Message[];
+  /**
+   * The messages that are currently in the chat in AG-UI format.
+   */
+  messages: Message$1[];
+  /** @deprecated use `sendMessage` in `useCopilotChatHeadless_c` instead. This will be removed in a future major version. */
+  appendMessage: (message: Message, options?: AppendMessageOptions) => Promise<void>;
+  /**
+   * Send a new message to the chat
+   *
+   * ```tsx
+   * await sendMessage({
+   *   id: "123",
+   *   role: "user",
+   *   content: "Hello, process this request",
+   * });
+   * ```
+   */
+  sendMessage: (message: Message$1, options?: AppendMessageOptions) => Promise<void>;
+  /**
+   * Replace all messages in the chat
+   *
+   * ```tsx
+   * setMessages([
+   *   { id: "123", role: "user", content: "Hello, process this request" },
+   *   { id: "456", role: "assistant", content: "Hello, I'm the assistant" },
+   * ]);
+   * ```
+   *
+   * **Deprecated** non-ag-ui version:
+   *
+   * ```tsx
+   * setMessages([
+   *   new TextMessage({
+   *     content: "Hello, process this request",
+   *     role: gqlRole.User,
+   *   }),
+   *   new TextMessage({
+   *     content: "Hello, I'm the assistant",
+   *     role: gqlRole.Assistant,
+   * ]);
+   * ```
+   *
+   */
+  setMessages: (messages: Message$1[] | Message[]) => void;
+  /**
+   * Remove a specific message by ID
+   *
+   * ```tsx
+   * deleteMessage("123");
+   * ```
+   */
+  deleteMessage: (messageId: string) => void;
+  /**
+   * Regenerate the response for a specific message
+   *
+   * ```tsx
+   * reloadMessages("123");
+   * ```
+   */
+  reloadMessages: (messageId: string) => Promise<void>;
+  /**
+   * Stop the current message generation
+   *
+   * ```tsx
+   * if (isLoading) {
+   *   stopGeneration();
+   * }
+   * ```
+   */
+  stopGeneration: () => void;
+  /**
+   * Clear all messages and reset chat state
+   *
+   * ```tsx
+   * reset();
+   * console.log(messages); // []
+   * ```
+   */
+  reset: () => void;
+  /**
+   * Whether the chat is currently generating a response
+   *
+   * ```tsx
+   * if (isLoading) {
+   *   console.log("Loading...");
+   * } else {
+   *   console.log("Not loading");
+   * }
+   */
+  isLoading: boolean;
+  /**
+   * Whether the chat agent is available to generate responses
+   *
+   * ```tsx
+   * if (isAvailable) {
+   *   console.log("Loading...");
+   * } else {
+   *   console.log("Not loading");
+   * }
+   */
+  isAvailable: boolean;
+  /** Manually trigger chat completion (advanced usage) */
+  runChatCompletion: () => Promise<Message$1[]>;
+  /** MCP (Model Context Protocol) server configurations */
+  mcpServers: MCPServerConfig[];
+  /** Update MCP server configurations */
+  setMcpServers: (mcpServers: MCPServerConfig[]) => void;
+  /**
+   * Current suggestions array
+   * Use this to read the current suggestions or in conjunction with setSuggestions for manual control
+   */
+  suggestions: Suggestion[];
+  /**
+   * Manually set suggestions
+   * Useful for manual mode or custom suggestion workflows
+   */
+  setSuggestions: (suggestions: Omit<Suggestion, "isLoading">[]) => void;
+  /**
+   * Trigger AI-powered suggestion generation
+   * Uses configurations from useCopilotChatSuggestions hooks
+   * Respects global debouncing - only one generation can run at a time
+   *
+   * ```tsx
+   * generateSuggestions();
+   * console.log(suggestions); // [suggestion1, suggestion2, suggestion3]
+   * ```
+   */
+  generateSuggestions: () => Promise<void>;
+  /**
+   * Clear all current suggestions
+   * Also resets suggestion generation state
+   */
+  resetSuggestions: () => void;
+  /** Whether suggestions are currently being generated */
+  isLoadingSuggestions: boolean;
+  /** Interrupt content for human-in-the-loop workflows */
+  interrupt: string | React.ReactElement | null;
+  agent?: ReturnType<typeof useAgent>["agent"];
+  threadId?: string;
+}
+declare function useCopilotChatInternal({
+  suggestions,
+  onInProgress,
+  onSubmitMessage,
+  onStopGeneration,
+  onReloadMessages
+}?: UseCopilotChatOptions): UseCopilotChatReturn$1;
+//#endregion
+//#region src/hooks/use-copilot-chat.d.ts
+type UseCopilotChatReturn = Omit<UseCopilotChatReturn$1, "messages" | "sendMessage" | "suggestions" | "setSuggestions" | "generateSuggestions" | "isLoadingSuggestions" | "resetSuggestions" | "interrupt" | "setMessages" | "deleteMessage">;
+/**
+ * A lightweight React hook for headless chat interactions.
+ * Perfect for programmatic messaging, background operations, and custom UI implementations.
+ *
+ * **Open Source Friendly** - Works without requiring a `publicApiKey`.
+ */
+declare function useCopilotChat(options?: UseCopilotChatOptions): UseCopilotChatReturn;
+//#endregion
+//#region src/hooks/use-copilot-chat-headless_c.d.ts
+/**
+ * Enterprise 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.
+ *
+ * **Requires a publicApiKey** - Sign up for free at https://cloud.copilotkit.ai/
+ *
+ * @param options - Configuration options for the chat
+ * @returns Complete chat interface with all enterprise features
+ *
+ * @example
+ * ```tsx
+ * const { messages, sendMessage, suggestions, interrupt } = useCopilotChatHeadless_c();
+ * ```
+ */
+declare function useCopilotChatHeadless_c(options?: UseCopilotChatOptions): UseCopilotChatReturn$1;
+//#endregion
+//#region src/hooks/use-copilot-action.d.ts
+/**
+ * useCopilotAction is a legacy hook maintained for backwards compatibility.
+ *
+ * To avoid violating React's Rules of Hooks (which prohibit conditional hook calls),
+ * we use a registration pattern:
+ * 1. This hook registers the action configuration with the CopilotContext
+ * 2. A renderer component in CopilotKit actually renders the appropriate hook wrapper
+ * 3. React properly manages hook state since components are rendered, not conditionally called
+ *
+ * This allows action types to change between renders without corrupting React's hook state.
+ */
+declare function useCopilotAction<const T extends Parameter[] | [] = []>(action: FrontendAction<T> | CatchAllFrontendAction, dependencies?: any[]): void;
+//#endregion
+//#region src/hooks/use-coagent-state-render.d.ts
+/**
+ * This hook is used to render agent state with custom UI components or text. This is particularly
+ * useful for showing intermediate state or progress during Agentic Copilot operations.
+ * To get started using rendering intermediate state through this hook, checkout the documentation.
+ *
+ * https://docs.copilotkit.ai/coagents/shared-state/predictive-state-updates
+ */
+declare function useCoAgentStateRender<T = any>(action: CoAgentStateRender<T>, dependencies?: any[]): void;
+//#endregion
+//#region src/hooks/use-make-copilot-document-readable.d.ts
+/**
+ * Makes a document readable by Copilot.
+ * @param document The document to make readable.
+ * @param categories The categories to associate with the document.
+ * @param dependencies The dependencies to use for the effect.
+ * @returns The id of the document.
+ */
+declare function useMakeCopilotDocumentReadable(document: DocumentPointer, categories?: string[], dependencies?: any[]): string | undefined;
+//#endregion
+//#region src/hooks/use-copilot-readable.d.ts
+/**
+ * Options for the useCopilotReadable hook.
+ */
+interface UseCopilotReadableOptions {
+  /**
+   * The description of the information to be added to the Copilot context.
+   */
+  description: string;
+  /**
+   * The value to be added to the Copilot context. Object values are automatically stringified.
+   */
+  value: any;
+  /**
+   * The ID of the parent context, if any.
+   */
+  parentId?: string;
+  /**
+   * An array of categories to control which context are visible where. Particularly useful
+   * with CopilotTextarea (see `useMakeAutosuggestionFunction`)
+   */
+  categories?: string[];
+  /**
+   * Whether the context is available to the Copilot.
+   */
+  available?: "enabled" | "disabled";
+  /**
+   * A custom conversion function to use to serialize the value to a string. If not provided, the value
+   * will be serialized using `JSON.stringify`.
+   */
+  convert?: (description: string, value: any) => string;
+}
+/**
+ * Adds the given information to the Copilot context to make it readable by Copilot.
+ */
+declare function useCopilotReadable({
+  description,
+  value,
+  convert,
+  available
+}: UseCopilotReadableOptions, dependencies?: any[]): string | undefined;
+//#endregion
+//#region src/hooks/use-coagent.d.ts
+interface UseCoagentOptionsBase {
+  /**
+   * The name of the agent being used.
+   */
+  name: string;
+  /**
+   * @deprecated - use "config.configurable"
+   * Config to pass to a LangGraph Agent
+   */
+  configurable?: Record<string, any>;
+  /**
+   * Config to pass to a LangGraph Agent
+   */
+  config?: {
+    configurable?: Record<string, any>;
+    [key: string]: any;
+  };
+}
+interface WithInternalStateManagementAndInitial<T> extends UseCoagentOptionsBase {
+  /**
+   * The initial state of the agent.
+   */
+  initialState: T;
+}
+interface WithInternalStateManagement extends UseCoagentOptionsBase {
+  /**
+   * Optional initialState with default type any
+   */
+  initialState?: any;
+}
+interface WithExternalStateManagement<T> extends UseCoagentOptionsBase {
+  /**
+   * The current state of the agent.
+   */
+  state: T;
+  /**
+   * A function to update the state of the agent.
+   */
+  setState: (newState: T | ((prevState: T | undefined) => T)) => void;
+}
+type UseCoagentOptions<T> = WithInternalStateManagementAndInitial<T> | WithInternalStateManagement | WithExternalStateManagement<T>;
+interface UseCoagentReturnType<T> {
+  /**
+   * The name of the agent being used.
+   */
+  name: string;
+  /**
+   * The name of the current LangGraph node.
+   */
+  nodeName?: string;
+  /**
+   * The ID of the thread the agent is running in.
+   */
+  threadId?: string;
+  /**
+   * A boolean indicating if the agent is currently running.
+   */
+  running: boolean;
+  /**
+   * The current state of the agent.
+   */
+  state: T;
+  /**
+   * A function to update the state of the agent.
+   */
+  setState: (newState: T | ((prevState: T | undefined) => T)) => void;
+  /**
+   * A function to start the agent.
+   */
+  start: () => void;
+  /**
+   * A function to stop the agent.
+   */
+  stop: () => void;
+  /**
+   * A function to re-run the agent. The hint function can be used to provide a hint to the agent
+   * about why it is being re-run again.
+   */
+  run: (...args: any[]) => Promise<any>;
+}
+interface HintFunctionParams {
+  /**
+   * The previous state of the agent.
+   */
+  previousState: any;
+  /**
+   * The current state of the agent.
+   */
+  currentState: any;
+}
+type HintFunction = (params: HintFunctionParams) => Message$1 | undefined;
+/**
+ * This hook is used to integrate an agent into your application. With its use, you can
+ * render and update the state of the agent, allowing for a dynamic and interactive experience.
+ * We call these shared state experiences "agentic copilots". To get started using agentic copilots, which
+ * we refer to as CoAgents, checkout the documentation at https://docs.copilotkit.ai/coagents/quickstart/langgraph.
+ */
+declare function useCoAgent<T = any>(options: UseCoagentOptions<T>): UseCoagentReturnType<T>;
+//#endregion
+//#region src/hooks/use-copilot-runtime-client.d.ts
+interface CopilotRuntimeClientHookOptions extends CopilotRuntimeClientOptions {
+  showDevConsole?: boolean;
+  onError: CopilotErrorHandler;
+}
+declare const useCopilotRuntimeClient: (options: CopilotRuntimeClientHookOptions) => CopilotRuntimeClient;
+//#endregion
+//#region src/hooks/use-copilot-authenticated-action.d.ts
+/**
+ * Hook to create an authenticated action that requires user sign-in before execution.
+ *
+ * @remarks
+ * This feature is only available when using CopilotKit's hosted cloud service.
+ * To use this feature, sign up at https://cloud.copilotkit.ai to get your publicApiKey.
+ *
+ * @param action - The frontend action to be wrapped with authentication
+ * @param dependencies - Optional array of dependencies that will trigger recreation of the action when changed
+ */
+declare function useCopilotAuthenticatedAction_c<T extends Parameter[]>(action: FrontendAction<T>, dependencies?: any[]): void;
+//#endregion
+//#region src/hooks/use-langgraph-interrupt.d.ts
+declare function useLangGraphInterrupt<TEventValue = any>(action: Omit<LangGraphInterruptRender<TEventValue>, "id">, _dependencies?: any[]): void;
+//#endregion
+//#region src/hooks/use-copilot-additional-instructions.d.ts
+/**
+ * Options for the useCopilotAdditionalInstructions hook.
+ */
+interface UseCopilotAdditionalInstructionsOptions {
+  /**
+   * The instructions to be added to the Copilot. Will be added to the instructions like so:
+   *
+   * ```txt
+   * You are a helpful assistant.
+   * Additionally, follow these instructions:
+   * - Do not answer questions about the weather.
+   * - Do not answer questions about the stock market.
+   * ```
+   */
+  instructions: string;
+  /**
+   * Whether the instructions are available to the Copilot.
+   */
+  available?: "enabled" | "disabled";
+}
+/**
+ * Adds the given instructions to the Copilot context.
+ */
+declare function useCopilotAdditionalInstructions({
+  instructions,
+  available
+}: UseCopilotAdditionalInstructionsOptions, dependencies?: any[]): void;
+//#endregion
+//#region src/hooks/use-frontend-tool.d.ts
+type UseFrontendToolArgs<T extends Parameter[] | [] = []> = {
+  available?: "disabled" | "enabled";
+} & Pick<FrontendAction<T>, "name" | "description" | "parameters" | "handler" | "followUp" | "render">;
+declare function useFrontendTool<const T extends Parameter[] = []>(tool: UseFrontendToolArgs<T>, dependencies?: any[]): void;
+//#endregion
+//#region src/hooks/use-human-in-the-loop.d.ts
+type UseHumanInTheLoopArgs<T extends Parameter[] | [] = []> = {
+  available?: "disabled" | "enabled";
+  render: FrontendAction<T>["renderAndWaitForResponse"];
+  followUp?: FrontendAction<T>["followUp"];
+} & Pick<FrontendAction<T>, "name" | "description" | "parameters">;
+declare function useHumanInTheLoop<const T extends Parameter[] | [] = []>(tool: UseHumanInTheLoopArgs<T>, dependencies?: any[]): void;
+//#endregion
+//#region src/hooks/use-render-tool-call.d.ts
+type UseRenderToolCallArgs<T extends Parameter[] | [] = []> = Pick<FrontendAction<T>, "name" | "description" | "parameters"> & {
+  available?: "disabled" | "enabled";
+  render: T extends [] ? (props: ActionRenderPropsNoArgs<T>) => React.ReactElement : (props: ActionRenderProps<T>) => React.ReactElement;
+};
+declare function useRenderToolCall<const T extends Parameter[] | [] = []>(tool: UseRenderToolCallArgs<T>, dependencies?: any[]): void;
+//#endregion
+//#region src/hooks/use-default-tool.d.ts
+declare function useDefaultTool(tool: Omit<CatchAllFrontendAction, "name">, dependencies?: any[]): void;
+//#endregion
+//#region src/hooks/use-lazy-tool-renderer.d.ts
+declare function useLazyToolRenderer(): (message?: AIMessage, messages?: Message$1[]) => null | (() => ReturnType<ReturnType<typeof useRenderToolCall$1>> | null);
+//#endregion
+//#region src/hooks/use-copilot-chat-suggestions.d.ts
+type StaticSuggestionInput = Omit<Suggestion, "isLoading"> & Partial<Pick<Suggestion, "isLoading">>;
+type StaticSuggestionsConfigInput = Omit<StaticSuggestionsConfig, "suggestions"> & {
+  suggestions: StaticSuggestionInput[];
+};
+type DynamicSuggestionsConfigInput = {
+  /**
+   * A prompt or instructions for the GPT to generate suggestions.
+   */
+  instructions: string;
+  /**
+   * The minimum number of suggestions to generate. Defaults to `1`.
+   * @default 1
+   */
+  minSuggestions?: number;
+  /**
+   * The maximum number of suggestions to generate. Defaults to `3`.
+   * @default 1
+   */
+  maxSuggestions?: number;
+  /**
+   * Whether the suggestions are available. Defaults to `enabled`.
+   * @default enabled
+   */
+  available?: "enabled" | "disabled" | "always" | "before-first-message" | "after-first-message";
+  /**
+   * An optional class name to apply to the suggestions.
+   */
+  className?: string;
+};
+type UseCopilotChatSuggestionsConfiguration = DynamicSuggestionsConfigInput | StaticSuggestionsConfigInput;
+declare function useCopilotChatSuggestions(config: UseCopilotChatSuggestionsConfiguration, dependencies?: any[]): void;
+//#endregion
+//#region src/lib/copilot-task.d.ts
+interface CopilotTaskConfig {
+  /**
+   * The instructions to be given to the assistant.
+   */
+  instructions: string;
+  /**
+   * An array of action definitions that can be called.
+   */
+  actions?: FrontendAction<any>[];
+  /**
+   * Whether to include the copilot readable context in the task.
+   */
+  includeCopilotReadable?: boolean;
+  /**
+   * Whether to include actions defined via useCopilotAction in the task.
+   */
+  includeCopilotActions?: boolean;
+  /**
+   * The forwarded parameters to use for the task.
+   */
+  forwardedParameters?: ForwardedParametersInput;
+}
+declare class CopilotTask<T = any> {
+  private instructions;
+  private actions;
+  private includeCopilotReadable;
+  private includeCopilotActions;
+  private forwardedParameters?;
+  constructor(config: CopilotTaskConfig);
+  /**
+   * Run the task.
+   * @param context The CopilotContext to use for the task. Use `useCopilotContext` to obtain the current context.
+   * @param data The data to use for the task.
+   */
+  run(context: CopilotContextParams, data?: T): Promise<void>;
+}
+//#endregion
+//#region src/utils/suggestions-constants.d.ts
+/**
+ * Constants for suggestions retry logic
+ */
+declare const SUGGESTION_RETRY_CONFIG: {
+  readonly MAX_RETRIES: 3;
+  readonly COOLDOWN_MS: 5000;
+};
+//#endregion
+//#region src/utils/dev-console.d.ts
+declare function shouldShowDevConsole(showDevConsole?: boolean): boolean;
+//#endregion
+export { ActionRenderProps, ActionRenderPropsNoArgs, ActionRenderPropsNoArgsWait, ActionRenderPropsWait, CatchAllActionRenderProps, CatchAllFrontendAction, type ChatSuggestions, CoAgentStateRendersContext, type CoAgentStateRendersContextValue, CoAgentStateRendersProvider, type CoagentInChatRenderFunction, type CopilotApiConfig, CopilotChatSuggestionConfiguration, CopilotContext, type CopilotContextParams, CopilotKit, type CopilotKitProps, CopilotMessagesContext, type CopilotMessagesContextParams, CopilotTask, CopilotTaskConfig, CrewsAgentState, CrewsResponse, CrewsResponseStatus, CrewsStateItem, CrewsTaskStateItem, CrewsToolStateItem, DocumentPointer, FrontendAction, FrontendActionAvailability, type HintFunction, LangGraphInterruptAction, LangGraphInterruptActionSetter, LangGraphInterruptActionSetterArgs, LangGraphInterruptRender, LangGraphInterruptRenderHandlerProps, LangGraphInterruptRenderProps, type OnReloadMessages, type OnStopGeneration, QueuedInterruptEvent, RenderFunctionStatus, SUGGESTION_RETRY_CONFIG, SystemMessageFunction, ThreadsContext, type ThreadsContextValue, ThreadsProvider, type ThreadsProviderProps, type Tree, type TreeNode, type UseCopilotChatOptions, type UseCopilotChatOptions as UseCopilotChatOptions_c, type UseCopilotChatReturn, type UseCopilotChatReturn$1 as UseCopilotChatReturn_c, type UseCopilotChatSuggestionsConfiguration, defaultCopilotContextCategories, shouldShowDevConsole, useCoAgent, useCoAgentStateRender, useCoAgentStateRenders, useCopilotAction, useCopilotAdditionalInstructions, useCopilotAuthenticatedAction_c, useCopilotChat, useCopilotChatHeadless_c, useCopilotChatInternal, useCopilotChatSuggestions, useCopilotContext, useCopilotMessagesContext, useCopilotReadable, useCopilotRuntimeClient, useDefaultTool, useFrontendTool, useHumanInTheLoop, useLangGraphInterrupt, useLazyToolRenderer, useMakeCopilotDocumentReadable, useRenderToolCall, useThreads };
+//# sourceMappingURL=index.d.cts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/context/copilot-messages-context.tsx","../src/context/coagent-state-renders-context.tsx","../src/context/threads-context.tsx","../src/hooks/use-copilot-chat_internal.ts","../src/hooks/use-copilot-chat.ts","../src/hooks/use-copilot-chat-headless_c.ts","../src/hooks/use-copilot-action.ts","../src/hooks/use-coagent-state-render.ts","../src/hooks/use-make-copilot-document-readable.ts","../src/hooks/use-copilot-readable.ts","../src/hooks/use-coagent.ts","../src/hooks/use-copilot-runtime-client.ts","../src/hooks/use-copilot-authenticated-action.ts","../src/hooks/use-langgraph-interrupt.ts","../src/hooks/use-copilot-additional-instructions.ts","../src/hooks/use-frontend-tool.ts","../src/hooks/use-human-in-the-loop.ts","../src/hooks/use-render-tool-call.ts","../src/hooks/use-default-tool.ts","../src/hooks/use-lazy-tool-renderer.tsx","../src/hooks/use-copilot-chat-suggestions.tsx","../src/lib/copilot-task.ts","../src/utils/suggestions-constants.ts","../src/utils/dev-console.ts"],"mappings":";;;;;;;;;UAQiB,4BAAA;EACf,QAAA,EAAU,OAAA;EACV,WAAA,EAAa,KAAA,CAAM,QAAA,CAAS,KAAA,CAAM,cAAA,CAAe,OAAA;EACjD,WAAA,EAAa,UAAA;EACb,cAAA,EAAgB,KAAA,CAAM,QAAA,CAAS,KAAA,CAAM,cAAA,CAAe,UAAA;AAAA;AAAA,cAWzC,sBAAA,EAAsB,KAAA,CAAA,OAAA,CAAA,4BAAA;AAAA,iBAGnB,yBAAA,CAAA,GAA6B,4BAAA;;;UCfnC,gBAAA;EACR,aAAA;EACA,aAAA;EACA,KAAA;EACA,YAAA;EACA,MAAA;AAAA;AAAA,KAGG,SAAA,GAAY,MAAA,SAAe,gBAAA;AAAA,UAEf,+BAAA;EACf,mBAAA,EAAqB,MAAA,SAAe,kBAAA;EACpC,qBAAA,GACE,EAAA,UACA,WAAA,EAAa,kBAAA;EAEf,wBAAA,GAA2B,EAAA;EAC3B,SAAA,EAAW,SAAA,CAAU,SAAA;AAAA;AAAA,cAGjB,0BAAA,EAA0B,KAAA,CAAA,OAAA,CAAA,+BAAA;AAAA,iBAIhB,2BAAA,CAAA;EACd;AAAA;EAEA,QAAA,EAAU,SAAA;AAAA,IACX,kBAAA,CAAA,GAAA,CAAA,OAAA;AAAA,iBAuCe,sBAAA,CAAA,GAAsB,+BAAA;;;UCrErB,mBAAA;EACf,QAAA;EACA,WAAA,GAAc,KAAA,EAAO,cAAA;AAAA;AAAA,cAGjB,cAAA,EAAc,KAAA,CAAA,OAAA,CAAA,mBAAA;AAAA,UAIH,oBAAA;EACf,QAAA,EAAU,SAAA;EACV,QAAA;AAAA;AAAA,iBAGc,eAAA,CAAA;EACd,QAAA;EACA,QAAA,EAAU;AAAA,GACT,oBAAA,GAAoB,kBAAA,CAAA,GAAA,CAAA,OAAA;AAAA,iBAiBP,UAAA,CAAA,GAAU,mBAAA;;;;;;AFnC1B;;;;KGqCY,eAAA,uBAGR,IAAA,CAAK,UAAA;AAAA,UAEQ,oBAAA;EHxCF;;;EG4Cb,QAAA;EH1CgB;;;EG8ChB,gBAAA;AAAA;AAAA,UAGe,yBAAA;EHnDF;;;EGuDb,gBAAA;EHvDiD;;;EG4DjD,QAAA,EAAU,SAAA;AAAA;AAAA,KAGA,yBAAA,GAA4B,yBAAA;EH7DP;;;EGiE/B,SAAA;AAAA;AAAA,KAGU,gBAAA,IAAoB,IAAA,EAAM,yBAAA;AAAA,KAE1B,gBAAA,IAAoB,IAAA,EAAM,yBAAA;AAAA,UAErB,qBAAA;EH7DkB;;;;;EGmEjC,EAAA;EHhEc;;;EGqEd,OAAA,GAAU,MAAA,mBAAyB,OAAA;EHrEoC;;;EG0EvE,eAAA,GAAkB,SAAA;EFzFV;;;EE8FR,iBAAA,GAAoB,qBAAA;EF7FpB;;;EEkGA,oBAAA;EF9FA;;;AAAM;;;;;AAKR;;;;;;;;;EE2GE,WAAA,GAAc,eAAA;EAEd,YAAA,IAAgB,SAAA;EAChB,eAAA,IAAmB,cAAA,aAA2B,OAAA;EAC9C,gBAAA,GAAmB,gBAAA;EACnB,gBAAA,GAAmB,gBAAA;AAAA;AAAA,UAGJ,eAAA;EACf,QAAA;EACA,MAAA;AAAA;AAAA,UAWe,sBAAA;EFzHJ;;;;AACZ;;EE+HC,eAAA,EAAiB,OAAA;EF7Ha;;;EEkI9B,QAAA,EAAU,SAAA;EFlIoB;EEqI9B,aAAA,GACE,OAAA,EAAS,OAAA,EACT,OAAA,GAAU,oBAAA,KACP,OAAA;EFpIS;;;;;;;;;;;EEiJd,WAAA,GACE,OAAA,EAAS,SAAA,EACT,OAAA,GAAU,oBAAA,KACP,OAAA;EFjJc;;;;AAwCrB;;;;;;;;ACrEA;;;;;;;;;;AAGC;;;ECsMC,WAAA,GAAc,QAAA,EAAU,SAAA,KAAY,OAAA;EDpMlB;;;;;AAIpB;;ECyME,aAAA,GAAgB,SAAA;EDxMG;;;;;;AAIrB;EC6ME,cAAA,GAAiB,SAAA,aAAsB,OAAA;;;;;;;;;;EAWvC,cAAA;EDtNU;;;;;;AAkBZ;;EC8ME,KAAA;ED9MwB;;;;;ACE1B;;;;;EAwNE,SAAA;EAnNmC;;;;AAWrC;;;;;;EAoNE,WAAA;EA3MiB;EA8MjB,iBAAA,QAAyB,OAAA,CAAQ,SAAA;EA3MvB;EA8MV,UAAA,EAAY,eAAA;;EAGZ,aAAA,GAAgB,UAAA,EAAY,eAAA;EA7MnB;AAGX;;;EAgNE,WAAA,EAAa,UAAA;EAhNgD;AAE/D;;;EAoNE,cAAA,GAAiB,WAAA,EAAa,IAAA,CAAK,UAAA;EApN0B;AAE/D;;;;;;;;;EA8NE,mBAAA,QAA2B,OAAA;EA7KR;;;;EAmLnB,gBAAA;EAzNU;EA4NV,oBAAA;EAvNA;EA0NA,SAAA,WAAoB,KAAA,CAAM,YAAA;EAE1B,KAAA,GAAQ,UAAA,QAAkB,QAAA;EAE1B,QAAA;AAAA;AAAA,iBAGc,sBAAA,CAAA;EACd,WAAA;EACA,YAAA;EACA,eAAA;EACA,gBAAA;EACA;AAAA,IACC,qBAAA,GAA6B,sBAAA;;;KCzPpB,oBAAA,GAAuB,IAAA,CACjC,sBAAA;;;;;;;iBAoBc,cAAA,CACd,OAAA,GAAS,qBAAA,GACR,oBAAA;;;;;;;;;;;AJjGH;;;;;;iBK+MS,wBAAA,CACP,OAAA,GAAS,qBAAA,GACR,sBAAA;;;;;;;;;;;;;;iBCJa,gBAAA,iBAAiC,SAAA,aAAA,CAC/C,MAAA,EAAQ,cAAA,CAAe,CAAA,IAAK,sBAAA,EAC5B,YAAA;;;;;;;;;AN7LF;iBOmCgB,qBAAA,SAAA,CACd,MAAA,EAAQ,kBAAA,CAAmB,CAAA,GAC3B,YAAA;;;;;;;;;;iBCpDc,8BAAA,CACd,QAAA,EAAU,eAAA,EACV,UAAA,aACA,YAAA;;;;;;UCuDe,yBAAA;;;;EAIf,WAAA;;ATjEF;;ESqEE,KAAA;ETpEU;;;ESwEV,QAAA;ETtEa;;;;ES2Eb,UAAA;ET1E8B;;;ES+E9B,SAAA;ETjFa;;;;ESuFb,OAAA,IAAW,WAAA,UAAqB,KAAA;AAAA;;;;iBAMlB,kBAAA,CAAA;EACZ,WAAA;EAAa,KAAA;EAAO,OAAA;EAAS;AAAA,GAAa,yBAAA,EAC5C,YAAA;;;UCTQ,qBAAA;ETrEmB;;;ESyE3B,IAAA;ETxE8B;;AAC/B;;ES4EC,YAAA,GAAe,MAAA;ET1Ee;;;ES8E9B,MAAA;IACE,YAAA,GAAe,MAAA;IAAA,CACd,GAAA;EAAA;AAAA;AAAA,UAIK,qCAAA,YAEA,qBAAA;ETjFR;;;ESqFA,YAAA,EAAc,CAAA;AAAA;AAAA,UAGN,2BAAA,SAAoC,qBAAA;ETxF5C;;;ES4FA,YAAA;AAAA;AAAA,UAGQ,2BAAA,YAAuC,qBAAA;ET5FhD;AAuCD;;ESyDE,KAAA,EAAO,CAAA;ETzD6B;;;ES6DpC,QAAA,GAAW,QAAA,EAAU,CAAA,KAAM,SAAA,EAAW,CAAA,iBAAkB,CAAA;AAAA;AAAA,KAGrD,iBAAA,MACD,qCAAA,CAAsC,CAAA,IACtC,2BAAA,GACA,2BAAA,CAA4B,CAAA;AAAA,UAEf,oBAAA;;;;EAIf,IAAA;ER5IqB;;;EQgJrB,QAAA;ER7II;;;EQiJJ,QAAA;ERjJkB;;;EQqJlB,OAAA;ERrJkB;AAIpB;;EQqJE,KAAA,EAAO,CAAA;ERpJY;;;EQwJnB,QAAA,GAAW,QAAA,EAAU,CAAA,KAAM,SAAA,EAAW,CAAA,iBAAkB,CAAA;ERvJhD;;AAGV;EQwJE,KAAA;;;;EAIA,IAAA;ERzJqB;;;;EQ8JrB,GAAA,MAAS,IAAA,YAAgB,OAAA;AAAA;AAAA,UAGV,kBAAA;ERjKd;;;EQqKD,aAAA;ERrKqB;AAiBvB;;EQwJE,YAAA;AAAA;AAAA,KAGU,YAAA,IAAgB,MAAA,EAAQ,kBAAA,KAAuB,SAAA;;;;APzJ3D;;;iBOiKgB,UAAA,SAAA,CACd,OAAA,EAAS,iBAAA,CAAkB,CAAA,IAC1B,oBAAA,CAAqB,CAAA;;;UC7LP,+BAAA,SAAwC,2BAAA;EACvD,cAAA;EACA,OAAA,EAAS,mBAAA;AAAA;AAAA,cAGE,uBAAA,GACX,OAAA,EAAS,+BAAA,KAA+B,oBAAA;;;;;;;;;;AXjB1C;;;iBYSgB,+BAAA,WAA0C,SAAA,GAAA,CACxD,MAAA,EAAQ,cAAA,CAAe,CAAA,GACvB,YAAA;;;iBCUc,qBAAA,mBAAA,CACd,MAAA,EAAQ,IAAA,CAAK,wBAAA,CAAyB,WAAA,UACtC,aAAA;;;;;;UCae,uCAAA;;;;;;AdpCjB;;;;;Ec+CE,YAAA;Ed7Ca;;;EckDb,SAAA;AAAA;;;;iBAMc,gCAAA,CAAA;EAEZ,YAAA;EACA;AAAA,GACC,uCAAA,EACH,YAAA;;;KClCU,mBAAA,WAA8B,SAAA;EACxC,SAAA;AAAA,IACE,IAAA,CACF,cAAA,CAAe,CAAA;AAAA,iBAID,eAAA,iBAAgC,SAAA,QAAA,CAC9C,IAAA,EAAM,mBAAA,CAAoB,CAAA,GAC1B,YAAA;;;KChBU,qBAAA,WAAgC,SAAA;EAC1C,SAAA;EACA,MAAA,EAAQ,cAAA,CAAe,CAAA;EACvB,QAAA,GAAW,cAAA,CAAe,CAAA;AAAA,IACxB,IAAA,CAAK,cAAA,CAAe,CAAA;AAAA,iBA6BR,iBAAA,iBAAkC,SAAA,aAAA,CAChD,IAAA,EAAM,qBAAA,CAAsB,CAAA,GAC5B,YAAA;;;KCnDU,qBAAA,WAAgC,SAAA,gBAAyB,IAAA,CACnE,cAAA,CAAe,CAAA;EAGf,SAAA;EACA,MAAA,EAAQ,CAAA,eACH,KAAA,EAAO,uBAAA,CAAwB,CAAA,MAAO,KAAA,CAAM,YAAA,IAC5C,KAAA,EAAO,iBAAA,CAAkB,CAAA,MAAO,KAAA,CAAM,YAAA;AAAA;AAAA,iBAG7B,iBAAA,iBAAkC,SAAA,aAAA,CAChD,IAAA,EAAM,qBAAA,CAAsB,CAAA,GAC5B,YAAA;;;iBCvBc,cAAA,CACd,IAAA,EAAM,IAAA,CAAK,sBAAA,WACX,YAAA;;;iBCDc,mBAAA,CAAA,IACd,OAAA,GAAU,SAAA,EACV,QAAA,GAAW,SAAA,qBACM,UAAA,CAAW,UAAA,QAAkB,mBAAA;;;KC8D3C,qBAAA,GAAwB,IAAA,CAAK,UAAA,iBAChC,OAAA,CAAQ,IAAA,CAAK,UAAA;AAAA,KAEV,4BAAA,GAA+B,IAAA,CAClC,uBAAA;EAGA,WAAA,EAAa,qBAAA;AAAA;AAAA,KAGV,6BAAA;;;;EAIH,YAAA;EpB3E2C;;;;EoBgF3C,cAAA;EpB9Ea;;;;EoBmFb,cAAA;EpBjF8B;;;;EoBuF9B,SAAA;EpBzFa;;;EoBmGb,SAAA;AAAA;AAAA,KAGU,sCAAA,GACR,6BAAA,GACA,4BAAA;AAAA,iBAEY,yBAAA,CACd,MAAA,EAAQ,sCAAA,EACR,YAAA;;;UCnDe,iBAAA;;;;EAIf,YAAA;;;ApB9D2D;EoBkE3D,OAAA,GAAU,cAAA;;;;EAIV,sBAAA;EpBjEA;;;EoBsEA,qBAAA;EpBpEM;AAAA;;EoByEN,mBAAA,GAAsB,wBAAA;AAAA;AAAA,cAGX,WAAA;EAAA,QACH,YAAA;EAAA,QACA,OAAA;EAAA,QACA,sBAAA;EAAA,QACA,qBAAA;EAAA,QACA,mBAAA;cACI,MAAA,EAAQ,iBAAA;EpBtEC;;;;;EoBmFf,GAAA,CAAI,OAAA,EAAS,oBAAA,EAAsB,IAAA,GAAO,CAAA,GAAI,OAAA;AAAA;;;;;;cC3GzC,uBAAA;EAAA,SAGH,WAAA;EAAA,SAAA,WAAA;AAAA;;;iBCGM,oBAAA,CAAqB,cAAA"}