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

package/dist/index.mjs

@@ -5,7 +5,7 @@ import "./chunk-36KQV2NA.mjs";
 import "./chunk-LUGEI4YQ.mjs";
 import {
   CopilotTask
-} from "./chunk-QSNZUI5G.mjs";
+} from "./chunk-Y2L7KDVW.mjs";
 import "./chunk-4CEQJ2X6.mjs";
 import "./chunk-A6NKSGH3.mjs";
 import {
@@ -52,7 +52,7 @@ import {
 } from "./chunk-ZVF5Q6IH.mjs";
 import {
   useCopilotReadable
-} from "./chunk-2CYJN455.mjs";
+} from "./chunk-RQ6LWR6S.mjs";
 import {
   useCopilotRuntimeClient
 } from "./chunk-6ESSSQ7Q.mjs";
@@ -71,16 +71,16 @@ import "./chunk-SPCZTZCY.mjs";
 import {
   CopilotKit,
   defaultCopilotContextCategories
-} from "./chunk-WV57GREG.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-CYDWEPFL.mjs";
 import {
   SUGGESTION_RETRY_CONFIG
 } from "./chunk-2IDV5OHF.mjs";
-import "./chunk-PMWUKW3Z.mjs";
-import "./chunk-YCG6SNAU.mjs";
-import "./chunk-PIF5KJYI.mjs";
-import "./chunk-LHERIF3L.mjs";
-import "./chunk-HE22TZMF.mjs";
 import {
   shouldShowDevConsole
 } from "./chunk-ICIK2BSB.mjs";

package/dist/lib/copilot-task.mjs

@@ -1,17 +1,17 @@
 import {
   CopilotTask
-} from "../chunk-QSNZUI5G.mjs";
+} from "../chunk-Y2L7KDVW.mjs";
 import "../chunk-4CEQJ2X6.mjs";
 import "../chunk-JD7BAH7U.mjs";
 import "../chunk-SPCZTZCY.mjs";
-import "../chunk-WV57GREG.mjs";
-import "../chunk-CYDWEPFL.mjs";
-import "../chunk-2IDV5OHF.mjs";
+import "../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/lib/index.mjs

@@ -1,18 +1,18 @@
 import "../chunk-LUGEI4YQ.mjs";
 import {
   CopilotTask
-} from "../chunk-QSNZUI5G.mjs";
+} from "../chunk-Y2L7KDVW.mjs";
 import "../chunk-4CEQJ2X6.mjs";
 import "../chunk-JD7BAH7U.mjs";
 import "../chunk-SPCZTZCY.mjs";
-import "../chunk-WV57GREG.mjs";
-import "../chunk-CYDWEPFL.mjs";
-import "../chunk-2IDV5OHF.mjs";
+import "../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/package.json

@@ -9,7 +9,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.50.0-beta.7",
+  "version": "1.50.0-beta.8",
   "sideEffects": [
     "**/*.css"
   ],
@@ -52,17 +52,17 @@
     "tsup": "^6.7.0",
     "typescript": "^5.2.3",
     "zod": ">=3.0.0",
-    "eslint-config-custom": "1.4.6",
-    "tsconfig": "1.4.6"
+    "tsconfig": "1.4.6",
+    "eslint-config-custom": "1.4.6"
   },
   "dependencies": {
-    "@copilotkitnext/core": "0.0.25",
-    "@copilotkitnext/react": "0.0.25",
+    "@copilotkitnext/core": "0.0.28",
+    "@copilotkitnext/react": "0.0.28",
     "@scarf/scarf": "^1.3.0",
     "react-markdown": "^8.0.7",
     "untruncate-json": "^0.0.1",
-    "@copilotkit/runtime-client-gql": "1.50.0-beta.7",
-    "@copilotkit/shared": "1.50.0-beta.7"
+    "@copilotkit/runtime-client-gql": "1.50.0-beta.8",
+    "@copilotkit/shared": "1.50.0-beta.8"
   },
   "keywords": [
     "copilotkit",

package/src/hooks/use-copilot-readable.ts

@@ -61,9 +61,10 @@
  * }
  * ```
  */
+import { useCopilotKit } from "@copilotkitnext/react";
 import { useEffect, useRef } from "react";
-import { useCopilotContext } from "../context/copilot-context";
-import { useAgentContext } from "@copilotkitnext/react";
+
+type DataType = object | number | string | boolean | null | undefined;
 
 /**
  * Options for the useCopilotReadable hook.
@@ -76,7 +77,7 @@ export interface UseCopilotReadableOptions {
   /**
    * The value to be added to the Copilot context. Object values are automatically stringified.
    */
-  value: any;
+  value: DataType | Record<string, any> | DataType[];
   /**
    * The ID of the parent context, if any.
    */
@@ -96,23 +97,41 @@ export interface UseCopilotReadableOptions {
    * 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;
-}
-
-function convertToJSON(description: string, value: any): string {
-  return `${description}: ${typeof value === "string" ? value : JSON.stringify(value)}`;
+  convert?: (value: any) => string;
 }
 
 /**
  * Adds the given information to the Copilot context to make it readable by Copilot.
  */
 export function useCopilotReadable(
-  { description, value }: UseCopilotReadableOptions,
+  { description, value, convert, available }: UseCopilotReadableOptions,
   dependencies?: any[],
-): undefined {
-  useAgentContext({
-    description,
-    value,
-  });
-  return;
+): string | undefined {
+  const { copilotkit } = useCopilotKit();
+  const ctxIdRef = useRef<string | undefined>(undefined);
+  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 ?? JSON.stringify)(value),
+    });
+
+    return () => {
+      if (!ctxIdRef.current) return;
+      copilotkit.removeContext(ctxIdRef.current);
+    };
+  }, [description, value, convert]);
+
+  return ctxIdRef.current;
 }

package/dist/chunk-2CYJN455.mjs

@@ -1,14 +0,0 @@
-// src/hooks/use-copilot-readable.ts
-import { useAgentContext } from "@copilotkitnext/react";
-function useCopilotReadable({ description, value }, dependencies) {
-  useAgentContext({
-    description,
-    value
-  });
-  return;
-}
-
-export {
-  useCopilotReadable
-};
-//# sourceMappingURL=chunk-2CYJN455.mjs.map

package/dist/chunk-2CYJN455.mjs.map

@@ -1 +0,0 @@
-{"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 { useEffect, useRef } from \"react\";\nimport { useCopilotContext } from \"../context/copilot-context\";\nimport { useAgentContext } from \"@copilotkitnext/react\";\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: any;\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?: (description: string, value: any) => string;\n}\n\nfunction convertToJSON(description: string, value: any): string {\n  return `${description}: ${typeof value === \"string\" ? value : JSON.stringify(value)}`;\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 }: UseCopilotReadableOptions,\n  dependencies?: any[],\n): undefined {\n  useAgentContext({\n    description,\n    value,\n  });\n  return;\n}\n"],"mappings":";AAiEA,SAAS,uBAAuB;AA2CzB,SAAS,mBACd,EAAE,aAAa,MAAM,GACrB,cACW;AACX,kBAAgB;AAAA,IACd;AAAA,IACA;AAAA,EACF,CAAC;AACD;AACF;","names":[]}