@copilotkit/react-core 0.21.0-mme-assistant-api.0 → 0.21.0-mme-experimental-actions.1

package/dist/index.js

@@ -87,6 +87,7 @@ __export(src_exports, {
   fetchAndDecodeChatCompletionAsText: () => fetchAndDecodeChatCompletionAsText,
   fetchChatCompletion: () => fetchChatCompletion,
   processMessageStream: () => processMessageStream,
+  useCopilotAction: () => useCopilotAction,
   useCopilotChat: () => useCopilotChat,
   useCopilotChatV2: () => useCopilotChatV2,
   useCopilotContext: () => useCopilotContext,
@@ -460,31 +461,25 @@ ${nonDocumentStrings}`;
   );
 }
 var defaultCopilotContextCategories = ["global"];
-function entryPointsToFunctionCallHandler(entryPoints) {
+function entryPointsToChatCompletionFunctions(actions) {
+  return actions.map(import_shared.actionToChatCompletionFunction);
+}
+function entryPointsToFunctionCallHandler(actions) {
   return (chatMessages, functionCall) => __async(this, null, function* () {
-    let entrypointsByFunctionName = {};
-    for (let entryPoint of entryPoints) {
-      entrypointsByFunctionName[entryPoint.name] = entryPoint;
+    let actionsByFunctionName = {};
+    for (let action2 of actions) {
+      actionsByFunctionName[action2.name] = action2;
     }
-    const entryPointFunction = entrypointsByFunctionName[functionCall.name || ""];
-    if (entryPointFunction) {
+    const action = actionsByFunctionName[functionCall.name || ""];
+    if (action) {
       let functionCallArguments = [];
       if (functionCall.arguments) {
         functionCallArguments = JSON.parse(functionCall.arguments);
       }
-      const paramsInCorrectOrder = [];
-      for (let arg of entryPointFunction.argumentAnnotations) {
-        paramsInCorrectOrder.push(
-          functionCallArguments[arg.name]
-        );
-      }
-      yield entryPointFunction.implementation(...paramsInCorrectOrder);
+      return yield action.handler(functionCallArguments);
     }
   });
 }
-function entryPointsToChatCompletionFunctions(entryPoints) {
-  return entryPoints.map(import_shared.annotatedFunctionToChatCompletionFunction);
-}
 
 // src/hooks/use-copilot-chat.ts
 var import_react6 = require("react");
@@ -507,6 +502,7 @@ function fetchChatCompletion(_0) {
     body,
     signal
   }) {
+    var _a, _b;
     temperature || (temperature = 0.5);
     tools || (tools = []);
     const cleanedMessages = messages.map((message) => {
@@ -522,47 +518,32 @@ function fetchChatCompletion(_0) {
         model,
         messages: cleanedMessages,
         stream: true
-      }, tools.length ? { tools } : {}), temperature ? { temperature } : {}), tools.length != 0 ? { tool_choice: "auto" } : {}), copilotConfig.body), copilotConfig.backendOnlyProps), excludeBackendOnlyProps(copilotConfig)), body ? __spreadValues({}, body) : {})),
+      }, tools.length ? { tools } : {}), temperature ? { temperature } : {}), tools.length != 0 ? { tool_choice: "auto" } : {}), copilotConfig.body), copilotConfig.backendOnlyProps), Object.keys((_a = copilotConfig["body"]) != null ? _a : {}).length > 0 ? { [import_shared2.EXCLUDE_FROM_FORWARD_PROPS_KEYS]: Object.keys((_b = copilotConfig["body"]) != null ? _b : {}) } : {}), body ? __spreadValues({}, body) : {})),
       signal
     });
     return response;
   });
 }
-function excludeBackendOnlyProps(copilotConfig) {
-  var _a;
-  const backendOnlyProps = (_a = copilotConfig.backendOnlyProps) != null ? _a : {};
-  if (Object.keys(backendOnlyProps).length > 0) {
-    return {
-      [import_shared2.EXCLUDE_FROM_FORWARD_PROPS_KEYS]: Object.keys(backendOnlyProps)
-    };
-  } else {
-    return {};
-  }
-}
 function fetchAndDecodeChatCompletion(params) {
   return __async(this, null, function* () {
     const response = yield fetchChatCompletion(params);
     if (!response.ok || !response.body) {
-      response.events = null;
-    } else {
-      const events = yield (0, import_shared2.decodeChatCompletion)((0, import_shared2.parseChatCompletion)(response.body));
-      response.events = events;
+      return __spreadProps(__spreadValues({}, response), { events: null });
     }
-    return response;
+    const events = yield (0, import_shared2.decodeChatCompletion)((0, import_shared2.parseChatCompletion)(response.body));
+    return __spreadProps(__spreadValues({}, response), { events });
   });
 }
 function fetchAndDecodeChatCompletionAsText(params) {
   return __async(this, null, function* () {
     const response = yield fetchChatCompletion(params);
     if (!response.ok || !response.body) {
-      response.events = null;
-    } else {
-      const events = yield (0, import_shared2.decodeChatCompletionAsText)(
-        (0, import_shared2.decodeChatCompletion)((0, import_shared2.parseChatCompletion)(response.body))
-      );
-      response.events = events;
+      return __spreadProps(__spreadValues({}, response), { events: null });
     }
-    return response;
+    const events = yield (0, import_shared2.decodeChatCompletionAsText)(
+      (0, import_shared2.decodeChatCompletion)((0, import_shared2.parseChatCompletion)(response.body))
+    );
+    return __spreadProps(__spreadValues({}, response), { events });
   });
 }
 
@@ -572,8 +553,6 @@ function useChat(options) {
   const [input, setInput] = (0, import_react5.useState)("");
   const [isLoading, setIsLoading] = (0, import_react5.useState)(false);
   const abortControllerRef = (0, import_react5.useRef)();
-  const threadIdRef = (0, import_react5.useRef)(null);
-  const runIdRef = (0, import_react5.useRef)(null);
   const runChatCompletion = (messages2) => __async(this, null, function* () {
     setIsLoading(true);
     const newMessages = [
@@ -587,27 +566,14 @@ function useChat(options) {
     const abortController = new AbortController();
     abortControllerRef.current = abortController;
     setMessages([...messages2, ...newMessages]);
-    const copilotConfigBody = options.copilotConfig.body || {};
-    if (threadIdRef.current) {
-      copilotConfigBody.threadId = threadIdRef.current;
-    }
-    if (runIdRef.current) {
-      copilotConfigBody.runId = runIdRef.current;
-    }
     const messagesWithContext = [...options.initialMessages || [], ...messages2];
     const response = yield fetchAndDecodeChatCompletion({
-      copilotConfig: __spreadProps(__spreadValues({}, options.copilotConfig), { body: copilotConfigBody }),
+      copilotConfig: options.copilotConfig,
       messages: messagesWithContext,
       tools: options.tools,
       headers: options.headers,
       signal: abortController.signal
     });
-    if (response.headers.get("threadid")) {
-      threadIdRef.current = response.headers.get("threadid");
-    }
-    if (response.headers.get("runid")) {
-      runIdRef.current = response.headers.get("runid");
-    }
     if (!response.events) {
       throw new Error("Failed to fetch chat completion");
     }
@@ -799,12 +765,90 @@ ${additionalInstructions}` : "");
 }
 
 // src/hooks/use-make-copilot-actionable.ts
+var import_react8 = require("react");
+var import_nanoid5 = require("nanoid");
+
+// src/hooks/use-copilot-action-implementation.ts
 var import_react7 = require("react");
 var import_nanoid4 = require("nanoid");
-function useMakeCopilotActionable(annotatedFunction, dependencies) {
+function useCopilotActionImplementation(action, dependencies) {
+  const { setEntryPoint, removeEntryPoint, entryPoints } = (0, import_react7.useContext)(CopilotContext);
   const idRef = (0, import_react7.useRef)((0, import_nanoid4.nanoid)());
-  const { setEntryPoint, removeEntryPoint } = (0, import_react7.useContext)(CopilotContext);
-  const memoizedAnnotatedFunction = (0, import_react7.useMemo)(
+  if (dependencies === void 0) {
+    if (entryPoints[idRef.current]) {
+      entryPoints[idRef.current].handler = action.handler;
+    }
+  }
+  (0, import_react7.useEffect)(() => {
+    setEntryPoint(idRef.current, action);
+    return () => {
+      removeEntryPoint(idRef.current);
+    };
+  }, [
+    setEntryPoint,
+    removeEntryPoint,
+    action.description,
+    action.name,
+    // This should be faster than deep equality checking
+    // In addition, all major JS engines guarantee the order of object keys
+    JSON.stringify(action.parameters),
+    // dependencies set by the developer
+    ...dependencies || []
+  ]);
+}
+function annotatedFunctionToAction(annotatedFunction) {
+  const parameters = annotatedFunction.argumentAnnotations.map((annotation) => {
+    switch (annotation.type) {
+      case "string":
+      case "number":
+      case "boolean":
+      case "object":
+        return {
+          name: annotation.name,
+          description: annotation.description,
+          type: annotation.type,
+          required: annotation.required
+        };
+      case "array":
+        let type;
+        if (annotation.items.type === "string") {
+          type = "string[]";
+        } else if (annotation.items.type === "number") {
+          type = "number[]";
+        } else if (annotation.items.type === "boolean") {
+          type = "boolean[]";
+        } else if (annotation.items.type === "object") {
+          type = "object[]";
+        } else {
+          type = "string[]";
+        }
+        return {
+          name: annotation.name,
+          description: annotation.description,
+          type,
+          required: annotation.required
+        };
+    }
+  });
+  return {
+    name: annotatedFunction.name,
+    description: annotatedFunction.description,
+    parameters,
+    handler: (args) => {
+      const paramsInCorrectOrder = [];
+      for (let arg of annotatedFunction.argumentAnnotations) {
+        paramsInCorrectOrder.push(args[arg.name]);
+      }
+      return annotatedFunction.implementation(...paramsInCorrectOrder);
+    }
+  };
+}
+
+// src/hooks/use-make-copilot-actionable.ts
+function useMakeCopilotActionable(annotatedFunction, dependencies) {
+  const idRef = (0, import_react8.useRef)((0, import_nanoid5.nanoid)());
+  const { setEntryPoint, removeEntryPoint } = (0, import_react8.useContext)(CopilotContext);
+  const memoizedAnnotatedFunction = (0, import_react8.useMemo)(
     () => ({
       name: annotatedFunction.name,
       description: annotatedFunction.description,
@@ -813,20 +857,26 @@ function useMakeCopilotActionable(annotatedFunction, dependencies) {
     }),
     dependencies
   );
-  (0, import_react7.useEffect)(() => {
-    setEntryPoint(idRef.current, memoizedAnnotatedFunction);
+  (0, import_react8.useEffect)(() => {
+    const action = annotatedFunctionToAction(memoizedAnnotatedFunction);
+    setEntryPoint(idRef.current, action);
     return () => {
       removeEntryPoint(idRef.current);
     };
   }, [memoizedAnnotatedFunction, setEntryPoint, removeEntryPoint]);
 }
 
+// src/hooks/use-copilot-action.ts
+function useCopilotAction(action, dependencies) {
+  return useCopilotActionImplementation(action, dependencies);
+}
+
 // src/hooks/use-make-copilot-readable.ts
-var import_react8 = require("react");
+var import_react9 = require("react");
 function useMakeCopilotReadable(information, parentId, categories) {
-  const { addContext, removeContext } = (0, import_react8.useContext)(CopilotContext);
-  const idRef = (0, import_react8.useRef)();
-  (0, import_react8.useEffect)(() => {
+  const { addContext, removeContext } = (0, import_react9.useContext)(CopilotContext);
+  const idRef = (0, import_react9.useRef)();
+  (0, import_react9.useEffect)(() => {
     const id = addContext(information, parentId, categories);
     idRef.current = id;
     return () => {
@@ -837,11 +887,11 @@ function useMakeCopilotReadable(information, parentId, categories) {
 }
 
 // src/hooks/use-make-copilot-document-readable.ts
-var import_react9 = require("react");
+var import_react10 = require("react");
 function useMakeCopilotDocumentReadable(document, categories, dependencies = []) {
-  const { addDocumentContext, removeDocumentContext } = (0, import_react9.useContext)(CopilotContext);
-  const idRef = (0, import_react9.useRef)();
-  (0, import_react9.useEffect)(() => {
+  const { addDocumentContext, removeDocumentContext } = (0, import_react10.useContext)(CopilotContext);
+  const idRef = (0, import_react10.useRef)();
+  (0, import_react10.useEffect)(() => {
     const id = addDocumentContext(document, categories);
     idRef.current = id;
     return () => {
@@ -852,7 +902,7 @@ function useMakeCopilotDocumentReadable(document, categories, dependencies = [])
 }
 
 // src/openai-assistants/hooks/use-copilot-chat-v2.ts
-var import_react10 = require("react");
+var import_react11 = require("react");
 
 // src/openai-assistants/utils/process-message-stream.ts
 function processMessageStream(reader, processMessage) {
@@ -885,13 +935,13 @@ function useCopilotChatV2(options) {
     getChatCompletionFunctionDescriptions,
     getFunctionCallHandler,
     copilotApiConfig
-  } = (0, import_react10.useContext)(CopilotContext);
-  const [messages, setMessages] = (0, import_react10.useState)([]);
-  const [input, setInput] = (0, import_react10.useState)("");
-  const [threadId, setThreadId] = (0, import_react10.useState)(void 0);
-  const [status, setStatus] = (0, import_react10.useState)("awaiting_message");
-  const [error, setError] = (0, import_react10.useState)(void 0);
-  const systemMessage = (0, import_react10.useMemo)(() => {
+  } = (0, import_react11.useContext)(CopilotContext);
+  const [messages, setMessages] = (0, import_react11.useState)([]);
+  const [input, setInput] = (0, import_react11.useState)("");
+  const [threadId, setThreadId] = (0, import_react11.useState)(void 0);
+  const [status, setStatus] = (0, import_react11.useState)("awaiting_message");
+  const [error, setError] = (0, import_react11.useState)(void 0);
+  const systemMessage = (0, import_react11.useMemo)(() => {
     const systemMessageMaker = options.makeSystemMessage || defaultSystemMessage2;
     const contextString = getContextString([], defaultCopilotContextCategories);
     return {
@@ -998,14 +1048,14 @@ If you would like to call a function, call it without saying anything else.
 var CopilotTask = class {
   constructor(config) {
     this.instructions = config.instructions;
-    this.functions = config.actions || [];
+    this.actions = config.actions || [];
     this.includeCopilotReadable = config.includeCopilotReadable || true;
     this.includeCopilotActionable = config.includeCopilotActionable || true;
   }
   run(context, data) {
     return __async(this, null, function* () {
       const entryPoints = this.includeCopilotActionable ? Object.assign({}, context.entryPoints) : {};
-      for (const fn of this.functions) {
+      for (const fn of this.actions) {
         entryPoints[fn.name] = fn;
       }
       let contextString = "";
@@ -1091,6 +1141,7 @@ ${instructions}
   fetchAndDecodeChatCompletionAsText,
   fetchChatCompletion,
   processMessageStream,
+  useCopilotAction,
   useCopilotChat,
   useCopilotChatV2,
   useCopilotContext,