@copilotkit/react-core 1.9.2-next.9 → 1.9.3-next.0

package/dist/components/copilot-provider/copilotkit-props.d.ts

@@ -1,7 +1,7 @@
 import { ForwardedParametersInput } from '@copilotkit/runtime-client-gql';
 import { ReactNode } from 'react';
-import { f as AuthState } from '../../copilot-context-3da805ab.js';
-import { CopilotTraceHandler } from '@copilotkit/shared';
+import { f as AuthState } from '../../copilot-context-3ab4fdf5.js';
+import { CopilotErrorHandler } from '@copilotkit/shared';
 import '../../types/frontend-action.js';
 import '../../hooks/use-tree.js';
 import '../../types/document-pointer.js';
@@ -63,11 +63,16 @@ interface CopilotKitProps {
      */
     children: ReactNode;
     /**
-     * Custom properties to be sent with the request
+     * Custom properties to be sent with the request.
+     * Can include threadMetadata for thread creation.
      * For example:
      * ```js
      * {
      *   'user_id': 'users_id',
+     *   threadMetadata: {
+     *     'account_id': '123',
+     *     'user_type': 'premium'
+     *   }
      * }
      * ```
      */
@@ -108,24 +113,24 @@ interface CopilotKitProps {
      */
     threadId?: string;
     /**
-     * Optional trace handler for comprehensive debugging and observability.
+     * Optional error handler for comprehensive debugging and observability.
      *
-     * **Requires publicApiKey**: Tracing only works when publicApiKey is provided.
+     * **Requires publicApiKey**: Error handling only works when publicApiKey is provided.
      * This is a premium CopilotKit Cloud feature.
      *
-     * @param traceEvent - Structured trace event with rich debugging context
+     * @param errorEvent - Structured error event with rich debugging context
      *
      * @example
      * ```typescript
      * <CopilotKit
      *   publicApiKey="ck_pub_your_key"
-     *   onTrace={(traceEvent) => {
-     *     debugDashboard.capture(traceEvent);
+     *   onError={(errorEvent) => {
+     *     debugDashboard.capture(errorEvent);
      *   }}
      * >
      * ```
      */
-    onTrace?: CopilotTraceHandler;
+    onError?: CopilotErrorHandler;
 }
 
 export { CopilotKitProps };

package/dist/components/copilot-provider/copilotkit-props.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/components/copilot-provider/copilotkit-props.tsx"],"sourcesContent":["import { ForwardedParametersInput } from \"@copilotkit/runtime-client-gql\";\nimport { ReactNode } from \"react\";\nimport { AuthState } from \"../../context/copilot-context\";\nimport { CopilotTraceHandler } from \"@copilotkit/shared\";\n/**\n * Props for CopilotKit.\n */\n\nexport interface CopilotKitProps {\n  /**\n   *  Your Copilot Cloud API key. Don't have it yet? Go to https://cloud.copilotkit.ai and get one for free.\n   */\n  publicApiKey?: string;\n\n  /**\n   * Restrict input to a specific topic.\n   * @deprecated Use `guardrails_c` instead to control input restrictions\n   */\n  cloudRestrictToTopic?: {\n    validTopics?: string[];\n    invalidTopics?: string[];\n  };\n\n  /**\n   * Restrict input to specific topics using guardrails.\n   * @remarks\n   *\n   * 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. The feature allows restricting chat conversations to specific topics.\n   */\n  guardrails_c?: {\n    validTopics?: string[];\n    invalidTopics?: string[];\n  };\n\n  /**\n   * The endpoint for the Copilot Runtime instance. [Click here for more information](/concepts/copilot-runtime).\n   */\n  runtimeUrl?: string;\n\n  /**\n   * The endpoint for the Copilot transcribe audio service.\n   */\n  transcribeAudioUrl?: string;\n\n  /**\n   * The endpoint for the Copilot text to speech service.\n   */\n  textToSpeechUrl?: string;\n\n  /**\n   * Additional headers to be sent with the request.\n   *\n   * For example:\n   * ```json\n   * {\n   *   \"Authorization\": \"Bearer X\"\n   * }\n   * ```\n   */\n  headers?: Record<string, string>;\n\n  /**\n   * The children to be rendered within the CopilotKit.\n   */\n  children: ReactNode;\n\n  /**\n   * Custom properties to be sent with the request\n   * For example:\n   * ```js\n   * {\n   *   'user_id': 'users_id',\n   * }\n   * ```\n   */\n  properties?: Record<string, any>;\n\n  /**\n   * Indicates whether the user agent should send or receive cookies from the other domain\n   * in the case of cross-origin requests.\n   */\n  credentials?: RequestCredentials;\n\n  /**\n   * Whether to show the dev console.\n   *\n   * Set to `true` to show error banners and toasts, `false` to hide all error UI.\n   * Defaults to `false` for production safety.\n   */\n  showDevConsole?: boolean;\n\n  /**\n   * The name of the agent to use.\n   */\n  agent?: string;\n\n  /**\n   * The forwarded parameters to use for the task.\n   */\n  forwardedParameters?: Pick<ForwardedParametersInput, \"temperature\">;\n\n  /**\n   * The auth config to use for the CopilotKit.\n   * @remarks\n   *\n   * 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. The feature allows restricting chat conversations to specific topics.\n   */\n  authConfig_c?: {\n    SignInComponent: React.ComponentType<{\n      onSignInComplete: (authState: AuthState) => void;\n    }>;\n  };\n\n  /**\n   * The thread id to use for the CopilotKit.\n   */\n  threadId?: string;\n\n  /**\n   * Optional trace handler for comprehensive debugging and observability.\n   *\n   * **Requires publicApiKey**: Tracing only works when publicApiKey is provided.\n   * This is a premium CopilotKit Cloud feature.\n   *\n   * @param traceEvent - Structured trace event with rich debugging context\n   *\n   * @example\n   * ```typescript\n   * <CopilotKit\n   *   publicApiKey=\"ck_pub_your_key\"\n   *   onTrace={(traceEvent) => {\n   *     debugDashboard.capture(traceEvent);\n   *   }}\n   * >\n   * ```\n   */\n  onTrace?: CopilotTraceHandler;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
+{"version":3,"sources":["../../../src/components/copilot-provider/copilotkit-props.tsx"],"sourcesContent":["import { ForwardedParametersInput } from \"@copilotkit/runtime-client-gql\";\nimport { ReactNode } from \"react\";\nimport { AuthState } from \"../../context/copilot-context\";\nimport { CopilotErrorHandler } from \"@copilotkit/shared\";\n/**\n * Props for CopilotKit.\n */\n\nexport interface CopilotKitProps {\n  /**\n   *  Your Copilot Cloud API key. Don't have it yet? Go to https://cloud.copilotkit.ai and get one for free.\n   */\n  publicApiKey?: string;\n\n  /**\n   * Restrict input to a specific topic.\n   * @deprecated Use `guardrails_c` instead to control input restrictions\n   */\n  cloudRestrictToTopic?: {\n    validTopics?: string[];\n    invalidTopics?: string[];\n  };\n\n  /**\n   * Restrict input to specific topics using guardrails.\n   * @remarks\n   *\n   * 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. The feature allows restricting chat conversations to specific topics.\n   */\n  guardrails_c?: {\n    validTopics?: string[];\n    invalidTopics?: string[];\n  };\n\n  /**\n   * The endpoint for the Copilot Runtime instance. [Click here for more information](/concepts/copilot-runtime).\n   */\n  runtimeUrl?: string;\n\n  /**\n   * The endpoint for the Copilot transcribe audio service.\n   */\n  transcribeAudioUrl?: string;\n\n  /**\n   * The endpoint for the Copilot text to speech service.\n   */\n  textToSpeechUrl?: string;\n\n  /**\n   * Additional headers to be sent with the request.\n   *\n   * For example:\n   * ```json\n   * {\n   *   \"Authorization\": \"Bearer X\"\n   * }\n   * ```\n   */\n  headers?: Record<string, string>;\n\n  /**\n   * The children to be rendered within the CopilotKit.\n   */\n  children: ReactNode;\n\n  /**\n   * Custom properties to be sent with the request.\n   * Can include threadMetadata for thread creation.\n   * For example:\n   * ```js\n   * {\n   *   'user_id': 'users_id',\n   *   threadMetadata: {\n   *     'account_id': '123',\n   *     'user_type': 'premium'\n   *   }\n   * }\n   * ```\n   */\n  properties?: Record<string, any>;\n\n  /**\n   * Indicates whether the user agent should send or receive cookies from the other domain\n   * in the case of cross-origin requests.\n   */\n  credentials?: RequestCredentials;\n\n  /**\n   * Whether to show the dev console.\n   *\n   * Set to `true` to show error banners and toasts, `false` to hide all error UI.\n   * Defaults to `false` for production safety.\n   */\n  showDevConsole?: boolean;\n\n  /**\n   * The name of the agent to use.\n   */\n  agent?: string;\n\n  /**\n   * The forwarded parameters to use for the task.\n   */\n  forwardedParameters?: Pick<ForwardedParametersInput, \"temperature\">;\n\n  /**\n   * The auth config to use for the CopilotKit.\n   * @remarks\n   *\n   * 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. The feature allows restricting chat conversations to specific topics.\n   */\n  authConfig_c?: {\n    SignInComponent: React.ComponentType<{\n      onSignInComplete: (authState: AuthState) => void;\n    }>;\n  };\n\n  /**\n   * The thread id to use for the CopilotKit.\n   */\n  threadId?: string;\n\n  /**\n   * Optional error handler for comprehensive debugging and observability.\n   *\n   * **Requires publicApiKey**: Error handling only works when publicApiKey is provided.\n   * This is a premium CopilotKit Cloud feature.\n   *\n   * @param errorEvent - Structured error event with rich debugging context\n   *\n   * @example\n   * ```typescript\n   * <CopilotKit\n   *   publicApiKey=\"ck_pub_your_key\"\n   *   onError={(errorEvent) => {\n   *     debugDashboard.capture(errorEvent);\n   *   }}\n   * >\n   * ```\n   */\n  onError?: CopilotErrorHandler;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}

package/dist/components/copilot-provider/copilotkit.d.ts

@@ -2,7 +2,7 @@ import { CopilotKitProps } from './copilotkit-props.js';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import '@copilotkit/runtime-client-gql';
 import 'react';
-import '../../copilot-context-3da805ab.js';
+import '../../copilot-context-3ab4fdf5.js';
 import '@copilotkit/shared';
 import '../../types/frontend-action.js';
 import '../../hooks/use-tree.js';

package/dist/components/copilot-provider/copilotkit.js

@@ -161,7 +161,7 @@ var emptyCopilotContext = {
   langGraphInterruptAction: null,
   setLangGraphInterruptAction: () => null,
   removeLangGraphInterruptAction: () => null,
-  onTrace: void 0
+  onError: void 0
 };
 var CopilotContext = import_react.default.createContext(emptyCopilotContext);
 function useCopilotContext() {
@@ -706,11 +706,11 @@ function CopilotMessages({ children }) {
   const lastLoadedThreadId = (0, import_react6.useRef)();
   const lastLoadedAgentName = (0, import_react6.useRef)();
   const lastLoadedMessages = (0, import_react6.useRef)();
-  const { threadId, agentSession, runtimeClient, showDevConsole, onTrace, copilotApiConfig } = useCopilotContext();
+  const { threadId, agentSession, runtimeClient, showDevConsole, onError, copilotApiConfig } = useCopilotContext();
   const { setBannerError } = useToast();
   const traceUIError = (0, import_react6.useCallback)(
     (error, originalError) => __async(this, null, function* () {
-      if (!onTrace || !copilotApiConfig.publicApiKey)
+      if (!onError || !copilotApiConfig.publicApiKey)
         return;
       try {
         const traceEvent = {
@@ -731,12 +731,12 @@ function CopilotMessages({ children }) {
           },
           error
         };
-        yield onTrace(traceEvent);
+        yield onError(traceEvent);
       } catch (traceError) {
-        console.error("Error in CopilotMessages onTrace handler:", traceError);
+        console.error("Error in CopilotMessages onError handler:", traceError);
       }
     }),
-    [onTrace, copilotApiConfig.publicApiKey, copilotApiConfig.chatApiEndpoint]
+    [onError, copilotApiConfig.publicApiKey, copilotApiConfig.chatApiEndpoint]
   );
   const createStructuredError2 = (gqlError) => {
     const extensions = gqlError.extensions;
@@ -841,7 +841,7 @@ function CopilotMessages({ children }) {
       }
     });
     void fetchMessages();
-  }, [threadId, agentSession == null ? void 0 : agentSession.agentName, runtimeClient]);
+  }, [threadId, agentSession == null ? void 0 : agentSession.agentName]);
   const memoizedChildren = (0, import_react6.useMemo)(() => children, [children]);
   return /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(
     CopilotMessagesContext.Provider,
@@ -861,13 +861,13 @@ var import_react7 = require("react");
 var import_shared5 = require("@copilotkit/shared");
 var useCopilotRuntimeClient = (options) => {
   const { setBannerError } = useToast();
-  const _a = options, { showDevConsole, onTrace } = _a, runtimeOptions = __objRest(_a, ["showDevConsole", "onTrace"]);
+  const _a = options, { showDevConsole, onError } = _a, runtimeOptions = __objRest(_a, ["showDevConsole", "onError"]);
   const lastStructuredErrorRef = (0, import_react7.useRef)(null);
   const traceUIError = (error, originalError) => __async(void 0, null, function* () {
-    if (!onTrace || !runtimeOptions.publicApiKey)
+    if (!onError || !runtimeOptions.publicApiKey)
       return;
     try {
-      const traceEvent = {
+      const errorEvent = {
         type: "error",
         timestamp: Date.now(),
         context: {
@@ -885,9 +885,9 @@ var useCopilotRuntimeClient = (options) => {
         },
         error
       };
-      yield onTrace(traceEvent);
-    } catch (traceError) {
-      console.error("Error in onTrace handler:", traceError);
+      yield onError(errorEvent);
+    } catch (error2) {
+      console.error("Error in onError handler:", error2);
     }
   });
   const runtimeClient = (0, import_react7.useMemo)(() => {
@@ -951,7 +951,7 @@ var useCopilotRuntimeClient = (options) => {
         setBannerError(warningError);
       }
     }));
-  }, [runtimeOptions, setBannerError, showDevConsole, onTrace]);
+  }, [runtimeOptions, setBannerError, showDevConsole, onError]);
   return runtimeClient;
 };
 function createStructuredError(gqlError) {
@@ -1721,18 +1721,24 @@ ${nonDocumentStrings}`;
     headers,
     credentials: copilotApiConfig.credentials,
     showDevConsole: (_b = props.showDevConsole) != null ? _b : false,
-    onTrace: props.onTrace
+    onError: props.onError
   });
   const [chatSuggestionConfiguration, setChatSuggestionConfiguration] = (0, import_react10.useState)({});
-  const addChatSuggestionConfiguration = (id, suggestion) => {
-    setChatSuggestionConfiguration((prev) => __spreadProps(__spreadValues({}, prev), { [id]: suggestion }));
-  };
-  const removeChatSuggestionConfiguration = (id) => {
-    setChatSuggestionConfiguration((prev) => {
-      const _a2 = prev, { [id]: _ } = _a2, rest = __objRest(_a2, [__restKey(id)]);
-      return rest;
-    });
-  };
+  const addChatSuggestionConfiguration = (0, import_react10.useCallback)(
+    (id, suggestion) => {
+      setChatSuggestionConfiguration((prev) => __spreadProps(__spreadValues({}, prev), { [id]: suggestion }));
+    },
+    [setChatSuggestionConfiguration]
+  );
+  const removeChatSuggestionConfiguration = (0, import_react10.useCallback)(
+    (id) => {
+      setChatSuggestionConfiguration((prev) => {
+        const _a2 = prev, { [id]: _ } = _a2, rest = __objRest(_a2, [__restKey(id)]);
+        return rest;
+      });
+    },
+    [setChatSuggestionConfiguration]
+  );
   const [availableAgents, setAvailableAgents] = (0, import_react10.useState)([]);
   const [coagentStates, setCoagentStates] = (0, import_react10.useState)({});
   const coagentStatesRef = (0, import_react10.useRef)({});
@@ -1812,6 +1818,41 @@ ${nonDocumentStrings}`;
     setLangGraphInterruptAction(null);
   }, []);
   const memoizedChildren = (0, import_react10.useMemo)(() => children, [children]);
+  const agentLock = (0, import_react10.useMemo)(() => {
+    var _a2;
+    return (_a2 = props.agent) != null ? _a2 : null;
+  }, [props.agent]);
+  const forwardedParameters = (0, import_react10.useMemo)(
+    () => {
+      var _a2;
+      return (_a2 = props.forwardedParameters) != null ? _a2 : {};
+    },
+    [props.forwardedParameters]
+  );
+  const updateExtensions = (0, import_react10.useCallback)(
+    (newExtensions) => {
+      setExtensions((prev) => {
+        const resolved = typeof newExtensions === "function" ? newExtensions(prev) : newExtensions;
+        const isSameLength = Object.keys(resolved).length === Object.keys(prev).length;
+        const isEqual = isSameLength && // @ts-ignore
+        Object.entries(resolved).every(([key, value]) => prev[key] === value);
+        return isEqual ? prev : resolved;
+      });
+    },
+    [setExtensions]
+  );
+  const updateAuthStates = (0, import_react10.useCallback)(
+    (newAuthStates) => {
+      setAuthStates((prev) => {
+        const resolved = typeof newAuthStates === "function" ? newAuthStates(prev) : newAuthStates;
+        const isSameLength = Object.keys(resolved).length === Object.keys(prev).length;
+        const isEqual = isSameLength && // @ts-ignore
+        Object.entries(resolved).every(([key, value]) => prev[key] === value);
+        return isEqual ? prev : resolved;
+      });
+    },
+    [setAuthStates]
+  );
   return /* @__PURE__ */ (0, import_jsx_runtime7.jsx)(
     CopilotContext.Provider,
     {
@@ -1849,8 +1890,8 @@ ${nonDocumentStrings}`;
         agentSession,
         setAgentSession,
         runtimeClient,
-        forwardedParameters: props.forwardedParameters || {},
-        agentLock: props.agent || null,
+        forwardedParameters,
+        agentLock,
         threadId: internalThreadId,
         setThreadId,
         runId,
@@ -1859,13 +1900,13 @@ ${nonDocumentStrings}`;
         availableAgents,
         authConfig_c: props.authConfig_c,
         authStates_c: authStates,
-        setAuthStates_c: setAuthStates,
+        setAuthStates_c: updateAuthStates,
         extensions,
-        setExtensions,
+        setExtensions: updateExtensions,
         langGraphInterruptAction,
         setLangGraphInterruptAction,
         removeLangGraphInterruptAction,
-        onTrace: props.onTrace
+        onError: props.onError
       },
       children: /* @__PURE__ */ (0, import_jsx_runtime7.jsx)(CopilotMessages, { children: memoizedChildren })
     }