@copilotkit/react-core 1.50.0-beta.7 → 1.50.0-beta.8

package/CHANGELOG.md

@@ -1,14 +1,19 @@
 # ui
 
-## 1.50.0-beta.7
+## 1.50.0-beta.8
 
-### Minor Changes
+### Patch Changes
 
-- Updating package versions for consistency
+- @copilotkit/runtime-client-gql@1.50.0-beta.8
+- @copilotkit/shared@1.50.0-beta.8
+
+## 1.50.0-beta.7
 
 ### Patch Changes
 
-- Updated dependencies
+- 6ce0edc: - fix: refrain from re-setting context infinitely if it hasnt changed
+  - fix: pass only strings to context value
+  - fix: allow custom convert and availability setup
   - @copilotkit/runtime-client-gql@1.50.0-beta.7
   - @copilotkit/shared@1.50.0-beta.7
 

package/dist/chunk-RQ6LWR6S.mjs

@@ -0,0 +1,37 @@
+// src/hooks/use-copilot-readable.ts
+import { useCopilotKit } from "@copilotkitnext/react";
+import { useEffect, useRef } from "react";
+function useCopilotReadable({ description, value, convert, available }, dependencies) {
+  const { copilotkit } = useCopilotKit();
+  const ctxIdRef = useRef(void 0);
+  useEffect(() => {
+    if (!copilotkit)
+      return;
+    const found = Object.entries(copilotkit.context).find(([id, ctxItem]) => {
+      return JSON.stringify({ description, value }) == JSON.stringify(ctxItem);
+    });
+    if (found) {
+      ctxIdRef.current = found[0];
+      if (available === "disabled")
+        copilotkit.removeContext(ctxIdRef.current);
+      return;
+    }
+    if (!found && available === "disabled")
+      return;
+    ctxIdRef.current = copilotkit.addContext({
+      description,
+      value: (convert != null ? convert : JSON.stringify)(value)
+    });
+    return () => {
+      if (!ctxIdRef.current)
+        return;
+      copilotkit.removeContext(ctxIdRef.current);
+    };
+  }, [description, value, convert]);
+  return ctxIdRef.current;
+}
+
+export {
+  useCopilotReadable
+};
+//# sourceMappingURL=chunk-RQ6LWR6S.mjs.map

package/dist/chunk-RQ6LWR6S.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/hooks/use-copilot-readable.ts"],"sourcesContent":["/**\n * `useCopilotReadable` is a React hook that provides app-state and other information\n * to the Copilot. Optionally, the hook can also handle hierarchical state within your\n * application, passing these parent-child relationships to the Copilot.\n *\n * ## Usage\n *\n * ### Simple Usage\n *\n * In its most basic usage, useCopilotReadable accepts a single string argument\n * representing any piece of app state, making it available for the Copilot to use\n * as context when responding to user input.\n *\n * ```tsx\n * import { useCopilotReadable } from \"@copilotkit/react-core\";\n *\n * export function MyComponent() {\n *   const [employees, setEmployees] = useState([]);\n *\n *   useCopilotReadable({\n *     description: \"The list of employees\",\n *     value: employees,\n *   });\n * }\n * ```\n *\n * ### Nested Components\n *\n * Optionally, you can maintain the hierarchical structure of information by passing\n * `parentId`. This allows you to use `useCopilotReadable` in nested components:\n *\n * ```tsx /employeeContextId/1 {17,23}\n * import { useCopilotReadable } from \"@copilotkit/react-core\";\n *\n * function Employee(props: EmployeeProps) {\n *   const { employeeName, workProfile, metadata } = props;\n *\n *   // propagate any information to copilot\n *   const employeeContextId = useCopilotReadable({\n *     description: \"Employee name\",\n *     value: employeeName\n *   });\n *\n *   // Pass a parentID to maintain a hierarchical structure.\n *   // Especially useful with child React components, list elements, etc.\n *   useCopilotReadable({\n *     description: \"Work profile\",\n *     value: workProfile.description(),\n *     parentId: employeeContextId\n *   });\n *\n *   useCopilotReadable({\n *     description: \"Employee metadata\",\n *     value: metadata.description(),\n *     parentId: employeeContextId\n *   });\n *\n *   return (\n *     // Render as usual...\n *   );\n * }\n * ```\n */\nimport { useCopilotKit } from \"@copilotkitnext/react\";\nimport { useEffect, useRef } from \"react\";\n\ntype DataType = object | number | string | boolean | null | undefined;\n\n/**\n * Options for the useCopilotReadable hook.\n */\nexport interface UseCopilotReadableOptions {\n  /**\n   * The description of the information to be added to the Copilot context.\n   */\n  description: string;\n  /**\n   * The value to be added to the Copilot context. Object values are automatically stringified.\n   */\n  value: DataType | Record<string, any> | DataType[];\n  /**\n   * The ID of the parent context, if any.\n   */\n  parentId?: string;\n  /**\n   * An array of categories to control which context are visible where. Particularly useful\n   * with CopilotTextarea (see `useMakeAutosuggestionFunction`)\n   */\n  categories?: string[];\n\n  /**\n   * Whether the context is available to the Copilot.\n   */\n  available?: \"enabled\" | \"disabled\";\n\n  /**\n   * A custom conversion function to use to serialize the value to a string. If not provided, the value\n   * will be serialized using `JSON.stringify`.\n   */\n  convert?: (value: any) => string;\n}\n\n/**\n * Adds the given information to the Copilot context to make it readable by Copilot.\n */\nexport function useCopilotReadable(\n  { description, value, convert, available }: UseCopilotReadableOptions,\n  dependencies?: any[],\n): string | undefined {\n  const { copilotkit } = useCopilotKit();\n  const ctxIdRef = useRef<string | undefined>(undefined);\n  useEffect(() => {\n    if (!copilotkit) return;\n\n    const found = Object.entries(copilotkit.context).find(([id, ctxItem]) => {\n      return JSON.stringify({ description, value }) == JSON.stringify(ctxItem);\n    });\n    if (found) {\n      ctxIdRef.current = found[0];\n      if (available === \"disabled\") copilotkit.removeContext(ctxIdRef.current);\n      return;\n    }\n    if (!found && available === \"disabled\") return;\n\n    ctxIdRef.current = copilotkit.addContext({\n      description,\n      value: (convert ?? JSON.stringify)(value),\n    });\n\n    return () => {\n      if (!ctxIdRef.current) return;\n      copilotkit.removeContext(ctxIdRef.current);\n    };\n  }, [description, value, convert]);\n\n  return ctxIdRef.current;\n}\n"],"mappings":";AA+DA,SAAS,qBAAqB;AAC9B,SAAS,WAAW,cAAc;AAyC3B,SAAS,mBACd,EAAE,aAAa,OAAO,SAAS,UAAU,GACzC,cACoB;AACpB,QAAM,EAAE,WAAW,IAAI,cAAc;AACrC,QAAM,WAAW,OAA2B,MAAS;AACrD,YAAU,MAAM;AACd,QAAI,CAAC;AAAY;AAEjB,UAAM,QAAQ,OAAO,QAAQ,WAAW,OAAO,EAAE,KAAK,CAAC,CAAC,IAAI,OAAO,MAAM;AACvE,aAAO,KAAK,UAAU,EAAE,aAAa,MAAM,CAAC,KAAK,KAAK,UAAU,OAAO;AAAA,IACzE,CAAC;AACD,QAAI,OAAO;AACT,eAAS,UAAU,MAAM,CAAC;AAC1B,UAAI,cAAc;AAAY,mBAAW,cAAc,SAAS,OAAO;AACvE;AAAA,IACF;AACA,QAAI,CAAC,SAAS,cAAc;AAAY;AAExC,aAAS,UAAU,WAAW,WAAW;AAAA,MACvC;AAAA,MACA,QAAQ,4BAAW,KAAK,WAAW,KAAK;AAAA,IAC1C,CAAC;AAED,WAAO,MAAM;AACX,UAAI,CAAC,SAAS;AAAS;AACvB,iBAAW,cAAc,SAAS,OAAO;AAAA,IAC3C;AAAA,EACF,GAAG,CAAC,aAAa,OAAO,OAAO,CAAC;AAEhC,SAAO,SAAS;AAClB;","names":[]}

package/dist/{chunk-QSNZUI5G.mjs → chunk-Y2L7KDVW.mjs}

@@ -3,7 +3,7 @@ import {
 } from "./chunk-4CEQJ2X6.mjs";
 import {
   defaultCopilotContextCategories
-} from "./chunk-WV57GREG.mjs";
+} from "./chunk-ZU6ZBX4E.mjs";
 import {
   __async,
   __spreadValues
@@ -117,4 +117,4 @@ ${instructions}
 export {
   CopilotTask
 };
-//# sourceMappingURL=chunk-QSNZUI5G.mjs.map
+//# sourceMappingURL=chunk-Y2L7KDVW.mjs.map

package/dist/{chunk-WV57GREG.mjs → chunk-ZU6ZBX4E.mjs}

@@ -1,6 +1,3 @@
-import {
-  ConsoleTrigger
-} from "./chunk-PMWUKW3Z.mjs";
 import {
   CopilotErrorBoundary
 } from "./chunk-LHERIF3L.mjs";
@@ -8,6 +5,9 @@ import {
   CopilotMessages,
   MessagesTapProvider
 } from "./chunk-HE22TZMF.mjs";
+import {
+  ConsoleTrigger
+} from "./chunk-PMWUKW3Z.mjs";
 import {
   shouldShowDevConsole
 } from "./chunk-ICIK2BSB.mjs";
@@ -540,4 +540,4 @@ export {
   CopilotKitInternal,
   defaultCopilotContextCategories
 };
-//# sourceMappingURL=chunk-WV57GREG.mjs.map
+//# sourceMappingURL=chunk-ZU6ZBX4E.mjs.map

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

@@ -2,14 +2,14 @@ import {
   CopilotKit,
   CopilotKitInternal,
   defaultCopilotContextCategories
-} from "../../chunk-WV57GREG.mjs";
-import "../../chunk-CYDWEPFL.mjs";
-import "../../chunk-2IDV5OHF.mjs";
+} from "../../chunk-ZU6ZBX4E.mjs";
+import "../../chunk-LHERIF3L.mjs";
+import "../../chunk-HE22TZMF.mjs";
 import "../../chunk-PMWUKW3Z.mjs";
 import "../../chunk-YCG6SNAU.mjs";
 import "../../chunk-PIF5KJYI.mjs";
-import "../../chunk-LHERIF3L.mjs";
-import "../../chunk-HE22TZMF.mjs";
+import "../../chunk-CYDWEPFL.mjs";
+import "../../chunk-2IDV5OHF.mjs";
 import "../../chunk-ICIK2BSB.mjs";
 import "../../chunk-RKTVJRK7.mjs";
 import "../../chunk-PMAFHQ7P.mjs";

package/dist/components/copilot-provider/index.mjs

@@ -2,14 +2,14 @@ import "../../chunk-SPCZTZCY.mjs";
 import {
   CopilotKit,
   defaultCopilotContextCategories
-} from "../../chunk-WV57GREG.mjs";
-import "../../chunk-CYDWEPFL.mjs";
-import "../../chunk-2IDV5OHF.mjs";
+} from "../../chunk-ZU6ZBX4E.mjs";
+import "../../chunk-LHERIF3L.mjs";
+import "../../chunk-HE22TZMF.mjs";
 import "../../chunk-PMWUKW3Z.mjs";
 import "../../chunk-YCG6SNAU.mjs";
 import "../../chunk-PIF5KJYI.mjs";
-import "../../chunk-LHERIF3L.mjs";
-import "../../chunk-HE22TZMF.mjs";
+import "../../chunk-CYDWEPFL.mjs";
+import "../../chunk-2IDV5OHF.mjs";
 import "../../chunk-ICIK2BSB.mjs";
 import "../../chunk-RKTVJRK7.mjs";
 import "../../chunk-PMAFHQ7P.mjs";

package/dist/components/index.mjs

@@ -3,14 +3,14 @@ import "../chunk-SPCZTZCY.mjs";
 import {
   CopilotKit,
   defaultCopilotContextCategories
-} from "../chunk-WV57GREG.mjs";
-import "../chunk-CYDWEPFL.mjs";
-import "../chunk-2IDV5OHF.mjs";
+} from "../chunk-ZU6ZBX4E.mjs";
+import "../chunk-LHERIF3L.mjs";
+import "../chunk-HE22TZMF.mjs";
 import "../chunk-PMWUKW3Z.mjs";
 import "../chunk-YCG6SNAU.mjs";
 import "../chunk-PIF5KJYI.mjs";
-import "../chunk-LHERIF3L.mjs";
-import "../chunk-HE22TZMF.mjs";
+import "../chunk-CYDWEPFL.mjs";
+import "../chunk-2IDV5OHF.mjs";
 import "../chunk-ICIK2BSB.mjs";
 import "../chunk-RKTVJRK7.mjs";
 import "../chunk-PMAFHQ7P.mjs";

package/dist/hooks/index.js

@@ -1789,22 +1789,45 @@ function useMakeCopilotDocumentReadable(document, categories, dependencies = [])
 
 // src/hooks/use-copilot-readable.ts
 var import_react27 = require("@copilotkitnext/react");
-function useCopilotReadable({ description, value }, dependencies) {
-  (0, import_react27.useAgentContext)({
-    description,
-    value
-  });
-  return;
+var import_react28 = require("react");
+function useCopilotReadable({ description, value, convert, available }, dependencies) {
+  const { copilotkit } = (0, import_react27.useCopilotKit)();
+  const ctxIdRef = (0, import_react28.useRef)(void 0);
+  (0, import_react28.useEffect)(() => {
+    if (!copilotkit)
+      return;
+    const found = Object.entries(copilotkit.context).find(([id, ctxItem]) => {
+      return JSON.stringify({ description, value }) == JSON.stringify(ctxItem);
+    });
+    if (found) {
+      ctxIdRef.current = found[0];
+      if (available === "disabled")
+        copilotkit.removeContext(ctxIdRef.current);
+      return;
+    }
+    if (!found && available === "disabled")
+      return;
+    ctxIdRef.current = copilotkit.addContext({
+      description,
+      value: (convert != null ? convert : JSON.stringify)(value)
+    });
+    return () => {
+      if (!ctxIdRef.current)
+        return;
+      copilotkit.removeContext(ctxIdRef.current);
+    };
+  }, [description, value, convert]);
+  return ctxIdRef.current;
 }
 
 // src/hooks/use-coagent.ts
-var import_react28 = require("react");
-var import_react29 = require("@copilotkitnext/react");
+var import_react29 = require("react");
+var import_react30 = require("@copilotkitnext/react");
 function useCoAgent(options) {
-  const { agent } = (0, import_react29.useAgent)({ agentId: options.name });
-  const { copilotkit } = (0, import_react29.useCopilotKit)();
+  const { agent } = (0, import_react30.useAgent)({ agentId: options.name });
+  const { copilotkit } = (0, import_react30.useCopilotKit)();
   const nodeName = useAgentNodeName(options.name);
-  const handleStateUpdate = (0, import_react28.useCallback)(
+  const handleStateUpdate = (0, import_react29.useCallback)(
     (newState) => {
       if (!agent)
         return;
@@ -1817,7 +1840,7 @@ function useCoAgent(options) {
     },
     [agent == null ? void 0 : agent.state, agent == null ? void 0 : agent.setState]
   );
-  (0, import_react28.useEffect)(() => {
+  (0, import_react29.useEffect)(() => {
     var _a;
     if (!options.config && !options.configurable)
       return;
@@ -1829,22 +1852,22 @@ function useCoAgent(options) {
     }
     copilotkit.setProperties(config);
   }, [options.config, options.configurable]);
-  const externalStateStr = (0, import_react28.useMemo)(
+  const externalStateStr = (0, import_react29.useMemo)(
     () => isExternalStateManagement(options) ? JSON.stringify(options.state) : void 0,
     [isExternalStateManagement(options) ? JSON.stringify(options.state) : void 0]
   );
-  (0, import_react28.useEffect)(() => {
+  (0, import_react29.useEffect)(() => {
     if ((agent == null ? void 0 : agent.state) && isExternalStateManagement(options) && JSON.stringify(options.state) !== JSON.stringify(agent.state)) {
       handleStateUpdate(options.state);
     }
   }, [agent, externalStateStr, handleStateUpdate]);
-  const hasStateValues = (0, import_react28.useCallback)((value) => {
+  const hasStateValues = (0, import_react29.useCallback)((value) => {
     return Boolean(value && Object.keys(value).length);
   }, []);
-  const initialStateRef = (0, import_react28.useRef)(
+  const initialStateRef = (0, import_react29.useRef)(
     isExternalStateManagement(options) ? options.state : "initialState" in options ? options.initialState : void 0
   );
-  (0, import_react28.useEffect)(() => {
+  (0, import_react29.useEffect)(() => {
     if (isExternalStateManagement(options)) {
       initialStateRef.current = options.state;
     } else if ("initialState" in options) {
@@ -1853,7 +1876,7 @@ function useCoAgent(options) {
   }, [
     isExternalStateManagement(options) ? JSON.stringify(options.state) : "initialState" in options ? JSON.stringify(options.initialState) : void 0
   ]);
-  (0, import_react28.useEffect)(() => {
+  (0, import_react29.useEffect)(() => {
     if (!agent)
       return;
     const subscriber = {
@@ -1881,7 +1904,7 @@ function useCoAgent(options) {
       subscription.unsubscribe();
     };
   }, [agent, handleStateUpdate, hasStateValues]);
-  return (0, import_react28.useMemo)(() => {
+  return (0, import_react29.useMemo)(() => {
     var _a, _b, _c;
     if (!agent) {
       const noop = () => {
@@ -1937,12 +1960,12 @@ var isExternalStateManagement = (options) => {
 
 // src/hooks/use-copilot-runtime-client.ts
 var import_runtime_client_gql3 = require("@copilotkit/runtime-client-gql");
-var import_react30 = require("react");
+var import_react31 = require("react");
 var import_shared11 = require("@copilotkit/shared");
 var useCopilotRuntimeClient = (options) => {
   const { setBannerError } = useToast();
   const _a = options, { showDevConsole, onError } = _a, runtimeOptions = __objRest(_a, ["showDevConsole", "onError"]);
-  const lastStructuredErrorRef = (0, import_react30.useRef)(null);
+  const lastStructuredErrorRef = (0, import_react31.useRef)(null);
   const traceUIError = (error, originalError) => __async(void 0, null, function* () {
     try {
       const errorEvent = {
@@ -1968,7 +1991,7 @@ var useCopilotRuntimeClient = (options) => {
       console.error("Error in onError handler:", error2);
     }
   });
-  const runtimeClient = (0, import_react30.useMemo)(() => {
+  const runtimeClient = (0, import_react31.useMemo)(() => {
     return new import_runtime_client_gql3.CopilotRuntimeClient(__spreadProps(__spreadValues({}, runtimeOptions), {
       handleGQLErrors: (error) => {
         var _a2;
@@ -2047,28 +2070,28 @@ function createStructuredError(gqlError) {
 }
 
 // src/hooks/use-copilot-authenticated-action.ts
-var import_react31 = require("react");
-var import_react32 = __toESM(require("react"));
+var import_react32 = require("react");
+var import_react33 = __toESM(require("react"));
 function useCopilotAuthenticatedAction_c(action, dependencies) {
   const { authConfig_c, authStates_c, setAuthStates_c } = useCopilotContext();
-  const pendingActionRef = (0, import_react31.useRef)(null);
-  const executeAction = (0, import_react31.useCallback)(
+  const pendingActionRef = (0, import_react32.useRef)(null);
+  const executeAction = (0, import_react32.useCallback)(
     (props) => {
       if (typeof action.render === "function") {
         return action.render(props);
       }
-      return action.render || import_react32.default.createElement(import_react31.Fragment);
+      return action.render || import_react33.default.createElement(import_react32.Fragment);
     },
     [action]
   );
-  const wrappedRender = (0, import_react31.useCallback)(
+  const wrappedRender = (0, import_react32.useCallback)(
     (props) => {
       const isAuthenticated = Object.values(authStates_c || {}).some(
         (state) => state.status === "authenticated"
       );
       if (!isAuthenticated) {
         pendingActionRef.current = props;
-        return (authConfig_c == null ? void 0 : authConfig_c.SignInComponent) ? import_react32.default.createElement(authConfig_c.SignInComponent, {
+        return (authConfig_c == null ? void 0 : authConfig_c.SignInComponent) ? import_react33.default.createElement(authConfig_c.SignInComponent, {
           onSignInComplete: (authState) => {
             setAuthStates_c == null ? void 0 : setAuthStates_c((prev) => __spreadProps(__spreadValues({}, prev), { [action.name]: authState }));
             if (pendingActionRef.current) {
@@ -2076,7 +2099,7 @@ function useCopilotAuthenticatedAction_c(action, dependencies) {
               pendingActionRef.current = null;
             }
           }
-        }) : import_react32.default.createElement(import_react31.Fragment);
+        }) : import_react33.default.createElement(import_react32.Fragment);
       }
       return executeAction(props);
     },
@@ -2091,13 +2114,13 @@ function useCopilotAuthenticatedAction_c(action, dependencies) {
 }
 
 // src/hooks/use-langgraph-interrupt.ts
-var import_react33 = require("react");
+var import_react34 = require("react");
 var import_shared12 = require("@copilotkit/shared");
 function useLangGraphInterrupt(action, dependencies) {
-  const { setInterruptAction, removeInterruptAction, interruptActions, threadId } = (0, import_react33.useContext)(CopilotContext);
+  const { setInterruptAction, removeInterruptAction, interruptActions, threadId } = (0, import_react34.useContext)(CopilotContext);
   const { addToast } = useToast();
   const actionId = (0, import_shared12.dataToUUID)(action, "lgAction");
-  (0, import_react33.useEffect)(() => {
+  (0, import_react34.useEffect)(() => {
     if (!action)
       return;
     setInterruptAction(__spreadProps(__spreadValues({}, action), { id: actionId }));
@@ -2108,10 +2131,10 @@ function useLangGraphInterrupt(action, dependencies) {
 }
 
 // src/hooks/use-copilot-additional-instructions.ts
-var import_react34 = require("react");
+var import_react35 = require("react");
 function useCopilotAdditionalInstructions({ instructions, available = "enabled" }, dependencies) {
   const { setAdditionalInstructions } = useCopilotContext();
-  (0, import_react34.useEffect)(() => {
+  (0, import_react35.useEffect)(() => {
     if (available === "disabled")
       return;
     setAdditionalInstructions((prevInstructions) => [...prevInstructions || [], instructions]);