@copilotkit/react-core 1.57.3 → 1.58.0

package/src/context/__tests__/threads-context.test.tsx

@@ -1,141 +0,0 @@
-import React from "react";
-import { render, screen, act } from "@testing-library/react";
-import { describe, it, expect } from "vitest";
-import { ThreadsProvider, useThreads } from "../threads-context";
-
-function ThreadIdViewer() {
-  const { threadId, isThreadIdExplicit } = useThreads();
-  return (
-    <>
-      <div data-testid="threadId">{threadId}</div>
-      <div data-testid="isExplicit">{String(isThreadIdExplicit)}</div>
-    </>
-  );
-}
-
-// Exposes setThreadId to the test so it can trigger the auto→explicit flip.
-function ThreadIdController({ nextId }: { nextId: string }) {
-  const { setThreadId } = useThreads();
-  return (
-    <button data-testid="setThread" onClick={() => setThreadId(nextId)}>
-      set
-    </button>
-  );
-}
-
-describe("ThreadsProvider", () => {
-  it("updates threadId when explicit prop becomes available", () => {
-    const { rerender } = render(
-      <ThreadsProvider>
-        <ThreadIdViewer />
-      </ThreadsProvider>,
-    );
-
-    expect(screen.getByTestId("threadId").textContent).toBe("mock-thread-id");
-
-    rerender(
-      <ThreadsProvider threadId="customer-thread">
-        <ThreadIdViewer />
-      </ThreadsProvider>,
-    );
-
-    expect(screen.getByTestId("threadId").textContent).toBe("customer-thread");
-  });
-
-  describe("isThreadIdExplicit", () => {
-    it("is false on first mount when no threadId prop is supplied", () => {
-      // Auto-minted UUID — the backend has never seen it, so downstream
-      // consumers (e.g. /connect) must NOT treat this as a real thread.
-      render(
-        <ThreadsProvider>
-          <ThreadIdViewer />
-        </ThreadsProvider>,
-      );
-
-      expect(screen.getByTestId("threadId").textContent).toBe("mock-thread-id");
-      expect(screen.getByTestId("isExplicit").textContent).toBe("false");
-    });
-
-    it("is true when threadId prop is supplied on mount", () => {
-      render(
-        <ThreadsProvider threadId="customer-thread">
-          <ThreadIdViewer />
-        </ThreadsProvider>,
-      );
-
-      expect(screen.getByTestId("threadId").textContent).toBe(
-        "customer-thread",
-      );
-      expect(screen.getByTestId("isExplicit").textContent).toBe("true");
-    });
-
-    it("flips from false to true after setThreadId() is called", () => {
-      render(
-        <ThreadsProvider>
-          <ThreadIdViewer />
-          <ThreadIdController nextId="user-picked-thread" />
-        </ThreadsProvider>,
-      );
-
-      expect(screen.getByTestId("isExplicit").textContent).toBe("false");
-
-      act(() => {
-        screen.getByTestId("setThread").click();
-      });
-
-      expect(screen.getByTestId("threadId").textContent).toBe(
-        "user-picked-thread",
-      );
-      expect(screen.getByTestId("isExplicit").textContent).toBe("true");
-    });
-
-    it("reverts to false when an explicit prop is removed and setThreadId was never called", () => {
-      // Current contract: explicitness via the `threadId` prop is prop-derived,
-      // so removing the prop returns the provider to its auto-minted state.
-      // Pinning this guards against an accidental "sticky explicit" regression.
-      const { rerender } = render(
-        <ThreadsProvider threadId="customer-thread">
-          <ThreadIdViewer />
-        </ThreadsProvider>,
-      );
-
-      expect(screen.getByTestId("isExplicit").textContent).toBe("true");
-
-      rerender(
-        <ThreadsProvider>
-          <ThreadIdViewer />
-        </ThreadsProvider>,
-      );
-
-      expect(screen.getByTestId("threadId").textContent).toBe("mock-thread-id");
-      expect(screen.getByTestId("isExplicit").textContent).toBe("false");
-    });
-
-    it("stays true after prop is removed if setThreadId was called while prop was present", () => {
-      // Once the caller has touched setThreadId, explicitness is sticky —
-      // the internal "user picked a thread" flag outlives any prop churn.
-      const { rerender } = render(
-        <ThreadsProvider threadId="customer-thread">
-          <ThreadIdViewer />
-          <ThreadIdController nextId="user-picked-thread" />
-        </ThreadsProvider>,
-      );
-
-      act(() => {
-        screen.getByTestId("setThread").click();
-      });
-
-      rerender(
-        <ThreadsProvider>
-          <ThreadIdViewer />
-          <ThreadIdController nextId="user-picked-thread" />
-        </ThreadsProvider>,
-      );
-
-      expect(screen.getByTestId("threadId").textContent).toBe(
-        "user-picked-thread",
-      );
-      expect(screen.getByTestId("isExplicit").textContent).toBe("true");
-    });
-  });
-});

package/src/context/coagent-state-renders-context.tsx

@@ -1,89 +0,0 @@
-import React, {
-  createContext,
-  useContext,
-  useCallback,
-  useState,
-  useRef,
-  ReactNode,
-  RefObject,
-} from "react";
-import { CoAgentStateRender } from "../types/coagent-action";
-
-interface StateRenderClaim {
-  stateRenderId: string;
-  stateSnapshot?: any;
-  runId?: string;
-  messageIndex?: number;
-  locked?: boolean;
-}
-
-type ClaimsRef = Record<string, StateRenderClaim>;
-
-export interface CoAgentStateRendersContextValue {
-  coAgentStateRenders: Record<string, CoAgentStateRender<any>>;
-  setCoAgentStateRender: (
-    id: string,
-    stateRender: CoAgentStateRender<any>,
-  ) => void;
-  removeCoAgentStateRender: (id: string) => void;
-  claimsRef: RefObject<ClaimsRef>;
-}
-
-const CoAgentStateRendersContext = createContext<
-  CoAgentStateRendersContextValue | undefined
->(undefined);
-
-export function CoAgentStateRendersProvider({
-  children,
-}: {
-  children: ReactNode;
-}) {
-  const [coAgentStateRenders, setCoAgentStateRenders] = useState<
-    Record<string, CoAgentStateRender<any>>
-  >({});
-
-  const setCoAgentStateRender = useCallback(
-    (id: string, stateRender: CoAgentStateRender<any>) => {
-      setCoAgentStateRenders((prevPoints) => ({
-        ...prevPoints,
-        [id]: stateRender,
-      }));
-    },
-    [],
-  );
-
-  const removeCoAgentStateRender = useCallback((id: string) => {
-    setCoAgentStateRenders((prevPoints) => {
-      const newPoints = { ...prevPoints };
-      delete newPoints[id];
-      return newPoints;
-    });
-  }, []);
-
-  const claimsRef = useRef<ClaimsRef>({});
-
-  return (
-    <CoAgentStateRendersContext.Provider
-      value={{
-        coAgentStateRenders,
-        setCoAgentStateRender,
-        removeCoAgentStateRender,
-        claimsRef,
-      }}
-    >
-      {children}
-    </CoAgentStateRendersContext.Provider>
-  );
-}
-
-export function useCoAgentStateRenders() {
-  const context = useContext(CoAgentStateRendersContext);
-  if (!context) {
-    throw new Error(
-      "useCoAgentStateRenders must be used within CoAgentStateRendersProvider",
-    );
-  }
-  return context;
-}
-
-export { CoAgentStateRendersContext };

package/src/context/copilot-context.tsx

@@ -1,365 +0,0 @@
-import {
-  CopilotCloudConfig,
-  FunctionCallHandler,
-  CopilotErrorHandler,
-  CopilotKitError,
-} from "@copilotkit/shared";
-import {
-  ActionRenderProps,
-  CatchAllActionRenderProps,
-  FrontendAction,
-} from "../types/frontend-action";
-import React from "react";
-import { TreeNodeId, Tree } from "../hooks/use-tree";
-import { DocumentPointer } from "../types";
-import { CopilotChatSuggestionConfiguration } from "../types/chat-suggestion-configuration";
-import {
-  CoAgentStateRender,
-  CoAgentStateRenderProps,
-} from "../types/coagent-action";
-import { CoagentState } from "../types/coagent-state";
-import {
-  CopilotRuntimeClient,
-  ExtensionsInput,
-  ForwardedParametersInput,
-} from "@copilotkit/runtime-client-gql";
-import { Agent } from "@copilotkit/runtime-client-gql";
-import {
-  LangGraphInterruptRender,
-  LangGraphInterruptActionSetter,
-  QueuedInterruptEvent,
-} from "../types/interrupt-action";
-
-/**
- * Interface for the configuration of the Copilot API.
- */
-export interface CopilotApiConfig {
-  /**
-   * The public API key for Copilot Cloud.
-   */
-  publicApiKey?: string;
-
-  /**
-   * The configuration for Copilot Cloud.
-   */
-  cloud?: CopilotCloudConfig;
-
-  /**
-   * The endpoint for the chat API.
-   */
-  chatApiEndpoint: string;
-
-  /**
-   * The endpoint for the Copilot transcribe audio service.
-   */
-  transcribeAudioUrl?: string;
-
-  /**
-   * The endpoint for the Copilot text to speech service.
-   */
-  textToSpeechUrl?: string;
-
-  /**
-   * additional headers to be sent with the request
-   * @default {}
-   * @example
-   * ```
-   * {
-   *   'Authorization': 'Bearer your_token_here'
-   * }
-   * ```
-   */
-  headers: Record<string, string>;
-
-  /**
-   * Custom properties to be sent with the request
-   * @default {}
-   * @example
-   * ```
-   * {
-   *   'user_id': 'user_id'
-   * }
-   * ```
-   */
-  properties?: Record<string, any>;
-
-  /**
-   * Indicates whether the user agent should send or receive cookies from the other domain
-   * in the case of cross-origin requests.
-   */
-  credentials?: RequestCredentials;
-
-  /**
-   * Optional configuration for connecting to Model Context Protocol (MCP) servers.
-   * This is typically derived from the CopilotKitProps and used internally.
-   * @experimental
-   */
-  mcpServers?: Array<{ endpoint: string; apiKey?: string }>;
-}
-
-export type InChatRenderFunction<
-  TProps = ActionRenderProps<any> | CatchAllActionRenderProps<any>,
-> = (props: TProps) => string | React.JSX.Element;
-export type CoagentInChatRenderFunction = (
-  props: CoAgentStateRenderProps<any>,
-) => string | React.JSX.Element | undefined | null;
-
-export interface ChatComponentsCache {
-  actions: Record<string, InChatRenderFunction | string>;
-  coAgentStateRenders: Record<string, CoagentInChatRenderFunction | string>;
-}
-
-export interface AgentSession {
-  agentName: string;
-  threadId?: string;
-  nodeName?: string;
-}
-
-export interface AuthState {
-  status: "authenticated" | "unauthenticated";
-  authHeaders: Record<string, string>;
-  userId?: string;
-  metadata?: Record<string, any>;
-}
-
-export type ActionName = string;
-export type ContextTree = Tree;
-
-export interface CopilotContextParams {
-  // function-calling
-  actions: Record<string, FrontendAction<any>>;
-  setAction: (id: string, action: FrontendAction<any>) => void;
-  removeAction: (id: string) => void;
-
-  // registered actions for component-based rendering
-  setRegisteredActions: (actionConfig: any) => string;
-  removeRegisteredAction: (actionKey: string) => void;
-
-  chatComponentsCache: React.RefObject<ChatComponentsCache>;
-
-  getFunctionCallHandler: (
-    customEntryPoints?: Record<string, FrontendAction<any>>,
-  ) => FunctionCallHandler;
-
-  // text context
-  addContext: (
-    context: string,
-    parentId?: string,
-    categories?: string[],
-  ) => TreeNodeId;
-  removeContext: (id: TreeNodeId) => void;
-  getAllContext: () => Tree;
-  getContextString: (
-    documents: DocumentPointer[],
-    categories: string[],
-  ) => string;
-
-  // document context
-  addDocumentContext: (
-    documentPointer: DocumentPointer,
-    categories?: string[],
-  ) => TreeNodeId;
-  removeDocumentContext: (documentId: string) => void;
-  getDocumentsContext: (categories: string[]) => DocumentPointer[];
-
-  isLoading: boolean;
-  setIsLoading: React.Dispatch<React.SetStateAction<boolean>>;
-
-  chatSuggestionConfiguration: {
-    [key: string]: CopilotChatSuggestionConfiguration;
-  };
-  addChatSuggestionConfiguration: (
-    id: string,
-    suggestion: CopilotChatSuggestionConfiguration,
-  ) => void;
-  removeChatSuggestionConfiguration: (id: string) => void;
-
-  chatInstructions: string;
-  setChatInstructions: React.Dispatch<React.SetStateAction<string>>;
-
-  additionalInstructions?: string[];
-  setAdditionalInstructions: React.Dispatch<React.SetStateAction<string[]>>;
-
-  // api endpoints
-  copilotApiConfig: CopilotApiConfig;
-
-  showDevConsole: boolean;
-
-  // agents
-  coagentStates: Record<string, CoagentState>;
-  setCoagentStates: React.Dispatch<
-    React.SetStateAction<Record<string, CoagentState>>
-  >;
-  coagentStatesRef: React.RefObject<Record<string, CoagentState>>;
-  setCoagentStatesWithRef: (
-    value:
-      | Record<string, CoagentState>
-      | ((prev: Record<string, CoagentState>) => Record<string, CoagentState>),
-  ) => void;
-
-  agentSession: AgentSession | null;
-  setAgentSession: React.Dispatch<React.SetStateAction<AgentSession | null>>;
-
-  agentLock: string | null;
-
-  threadId: string;
-  setThreadId: React.Dispatch<React.SetStateAction<string>>;
-
-  runId: string | null;
-  setRunId: React.Dispatch<React.SetStateAction<string | null>>;
-
-  // The chat abort controller can be used to stop generation globally,
-  // i.e. when using `stop()` from `useChat`
-  chatAbortControllerRef: React.MutableRefObject<AbortController | null>;
-
-  /**
-   * The forwarded parameters to use for the task.
-   */
-  forwardedParameters?: Partial<Pick<ForwardedParametersInput, "temperature">>;
-  availableAgents: Agent[];
-
-  /**
-   * The auth states for the CopilotKit.
-   */
-  authStates_c?: Record<ActionName, AuthState>;
-  setAuthStates_c?: React.Dispatch<
-    React.SetStateAction<Record<ActionName, AuthState>>
-  >;
-
-  /**
-   * The auth config for the CopilotKit.
-   */
-  authConfig_c?: {
-    SignInComponent: React.ComponentType<{
-      onSignInComplete: (authState: AuthState) => void;
-    }>;
-  };
-
-  extensions: ExtensionsInput;
-  setExtensions: React.Dispatch<React.SetStateAction<ExtensionsInput>>;
-  interruptActions: Record<string, LangGraphInterruptRender>;
-  setInterruptAction: LangGraphInterruptActionSetter;
-  removeInterruptAction: (actionId: string) => void;
-  interruptEventQueue: Record<string, QueuedInterruptEvent[]>;
-  addInterruptEvent: (queuedEvent: QueuedInterruptEvent) => void;
-  resolveInterruptEvent: (
-    threadId: string,
-    eventId: string,
-    response: string,
-  ) => void;
-
-  /**
-   * Optional trace handler for comprehensive debugging and observability.
-   */
-  onError: CopilotErrorHandler;
-
-  // banner error state
-  bannerError: CopilotKitError | null;
-  setBannerError: React.Dispatch<React.SetStateAction<CopilotKitError | null>>;
-  // Internal error handlers
-  // These are used to handle errors that occur during the execution of the chat.
-  // They are not intended for use by the developer. A component can register itself an error listener to be activated somewhere else as needed
-  internalErrorHandlers: Record<string, CopilotErrorHandler>;
-  setInternalErrorHandler: (
-    handler: Record<string, CopilotErrorHandler>,
-  ) => void;
-  removeInternalErrorHandler: (id: string) => void;
-}
-
-const emptyCopilotContext: CopilotContextParams = {
-  actions: {},
-  setAction: () => {},
-  removeAction: () => {},
-
-  setRegisteredActions: () => "",
-  removeRegisteredAction: () => {},
-
-  chatComponentsCache: { current: { actions: {}, coAgentStateRenders: {} } },
-  getContextString: (documents: DocumentPointer[], categories: string[]) =>
-    returnAndThrowInDebug(""),
-  addContext: () => "",
-  removeContext: () => {},
-  getAllContext: () => [],
-
-  getFunctionCallHandler: () => returnAndThrowInDebug(async () => {}),
-
-  isLoading: false,
-  setIsLoading: () => returnAndThrowInDebug(false),
-
-  chatInstructions: "",
-  setChatInstructions: () => returnAndThrowInDebug(""),
-
-  additionalInstructions: [],
-  setAdditionalInstructions: () => returnAndThrowInDebug([]),
-
-  getDocumentsContext: (categories: string[]) => returnAndThrowInDebug([]),
-  addDocumentContext: () => returnAndThrowInDebug(""),
-  removeDocumentContext: () => {},
-
-  copilotApiConfig: new (class implements CopilotApiConfig {
-    get chatApiEndpoint(): string {
-      throw new Error(
-        "Remember to wrap your app in a `<CopilotKit> {...} </CopilotKit>` !!!",
-      );
-    }
-
-    get headers(): Record<string, string> {
-      return {};
-    }
-    get body(): Record<string, any> {
-      return {};
-    }
-  })(),
-
-  chatSuggestionConfiguration: {},
-  addChatSuggestionConfiguration: () => {},
-  removeChatSuggestionConfiguration: () => {},
-  showDevConsole: false,
-  coagentStates: {},
-  setCoagentStates: () => {},
-  coagentStatesRef: { current: {} },
-  setCoagentStatesWithRef: () => {},
-  agentSession: null,
-  setAgentSession: () => {},
-  forwardedParameters: {},
-  agentLock: null,
-  threadId: "",
-  setThreadId: () => {},
-  runId: null,
-  setRunId: () => {},
-  chatAbortControllerRef: { current: null },
-  availableAgents: [],
-  extensions: {},
-  setExtensions: () => {},
-  interruptActions: {},
-  setInterruptAction: () => {},
-  removeInterruptAction: () => {},
-  interruptEventQueue: {},
-  addInterruptEvent: () => {},
-  resolveInterruptEvent: () => {},
-  onError: () => {},
-  bannerError: null,
-  setBannerError: () => {},
-  internalErrorHandlers: {},
-  setInternalErrorHandler: () => {},
-  removeInternalErrorHandler: () => {},
-};
-
-export const CopilotContext =
-  React.createContext<CopilotContextParams>(emptyCopilotContext);
-
-export function useCopilotContext(): CopilotContextParams {
-  const context = React.useContext(CopilotContext);
-  if (context === emptyCopilotContext) {
-    throw new Error(
-      "Remember to wrap your app in a `<CopilotKit> {...} </CopilotKit>` !!!",
-    );
-  }
-  return context;
-}
-
-function returnAndThrowInDebug<T>(_value: T): T {
-  throw new Error(
-    "Remember to wrap your app in a `<CopilotKit> {...} </CopilotKit>` !!!",
-  );
-}

package/src/context/copilot-messages-context.tsx

@@ -1,35 +0,0 @@
-/**
- * An internal context to separate the messages state (which is constantly changing) from the rest of CopilotKit context
- */
-
-import { Message } from "@copilotkit/runtime-client-gql";
-import React from "react";
-import { Suggestion } from "@copilotkit/core";
-
-export interface CopilotMessagesContextParams {
-  messages: Message[];
-  setMessages: React.Dispatch<React.SetStateAction<Message[]>>; // suggestions state
-  suggestions: Suggestion[];
-  setSuggestions: React.Dispatch<React.SetStateAction<Suggestion[]>>;
-}
-
-const emptyCopilotContext: CopilotMessagesContextParams = {
-  messages: [],
-  setMessages: () => [],
-  // suggestions state
-  suggestions: [],
-  setSuggestions: () => [],
-};
-
-export const CopilotMessagesContext =
-  React.createContext<CopilotMessagesContextParams>(emptyCopilotContext);
-
-export function useCopilotMessagesContext(): CopilotMessagesContextParams {
-  const context = React.useContext(CopilotMessagesContext);
-  if (context === emptyCopilotContext) {
-    throw new Error(
-      "A messages consuming component was not wrapped with `<CopilotMessages> {...} </CopilotMessages>`",
-    );
-  }
-  return context;
-}

package/src/context/index.ts

@@ -1,22 +0,0 @@
-export { CopilotContext, useCopilotContext } from "./copilot-context";
-export {
-  CopilotMessagesContext,
-  useCopilotMessagesContext,
-} from "./copilot-messages-context";
-export {
-  CoAgentStateRendersContext,
-  CoAgentStateRendersProvider,
-  useCoAgentStateRenders,
-} from "./coagent-state-renders-context";
-export { ThreadsContext, ThreadsProvider, useThreads } from "./threads-context";
-export type {
-  CopilotContextParams,
-  CoagentInChatRenderFunction,
-  CopilotApiConfig,
-} from "./copilot-context";
-export type { CopilotMessagesContextParams } from "./copilot-messages-context";
-export type { CoAgentStateRendersContextValue } from "./coagent-state-renders-context";
-export type {
-  ThreadsContextValue,
-  ThreadsProviderProps,
-} from "./threads-context";