@copilotkit/react-core 1.1.2 → 1.1.3-feat-runtime-remote-actions.1

package/dist/hooks/index.js

@@ -79,6 +79,8 @@ var __async = (__this, __arguments, generator) => {
 // src/hooks/index.ts
 var hooks_exports = {};
 __export(hooks_exports, {
+  useCoAgent: () => useCoAgent,
+  useCoAgentAction: () => useCoAgentAction,
   useCopilotAction: () => useCopilotAction,
   useCopilotChat: () => useCopilotChat,
   useCopilotReadable: () => useCopilotReadable,
@@ -97,7 +99,12 @@ var emptyCopilotContext = {
   },
   removeAction: () => {
   },
-  chatComponentsCache: { current: {} },
+  coagentActions: {},
+  setCoagentAction: () => {
+  },
+  removeCoagentAction: () => {
+  },
+  chatComponentsCache: { current: { actions: {}, coagentActions: {} } },
   getContextString: (documents, categories) => returnAndThrowInDebug(""),
   addContext: () => "",
   removeContext: () => {
@@ -130,9 +137,22 @@ var emptyCopilotContext = {
   },
   removeChatSuggestionConfiguration: () => {
   },
-  showDevConsole: "auto"
+  showDevConsole: "auto",
+  coagentStates: {},
+  setCoagentStates: () => {
+  },
+  agentSession: null,
+  setAgentSession: () => {
+  }
 };
 var CopilotContext = import_react.default.createContext(emptyCopilotContext);
+function useCopilotContext() {
+  const context = import_react.default.useContext(CopilotContext);
+  if (context === emptyCopilotContext) {
+    throw new Error("Remember to wrap your app in a `<CopilotKit> {...} </CopilotKit>` !!!");
+  }
+  return context;
+}
 function returnAndThrowInDebug(value) {
   throw new Error("Remember to wrap your app in a `<CopilotKit> {...} </CopilotKit>` !!!");
   return value;
@@ -155,7 +175,12 @@ function useChat(options) {
     initialMessages,
     isLoading,
     actions,
-    onFunctionCall
+    onFunctionCall,
+    onCoagentAction,
+    setCoagentStates,
+    coagentStates,
+    agentSession,
+    setAgentSession
   } = options;
   const abortControllerRef = (0, import_react2.useRef)();
   const threadIdRef = (0, import_react2.useRef)(null);
@@ -184,17 +209,18 @@ function useChat(options) {
     const messagesWithContext = [systemMessage, ...initialMessages || [], ...previousMessages];
     const stream = import_runtime_client_gql.CopilotRuntimeClient.asStream(
       runtimeClient.generateCopilotResponse({
-        data: __spreadProps(__spreadValues({
+        data: __spreadProps(__spreadValues(__spreadProps(__spreadValues({
           frontend: {
             actions: actions.map((action) => ({
               name: action.name,
               description: action.description || "",
               jsonSchema: JSON.stringify((0, import_shared.actionParametersToJsonSchema)(action.parameters || []))
-            }))
+            })),
+            url: window.location.href
           },
           threadId: threadIdRef.current,
           runId: runIdRef.current,
-          messages: (0, import_runtime_client_gql.convertMessagesToGqlInput)(messagesWithContext)
+          messages: (0, import_runtime_client_gql.convertMessagesToGqlInput)((0, import_runtime_client_gql.filterAgentStateMessages)(messagesWithContext))
         }, copilotConfig.cloud ? {
           cloud: __spreadValues({}, ((_c = (_b = (_a = copilotConfig.cloud.guardrails) == null ? void 0 : _a.input) == null ? void 0 : _b.restrictToTopic) == null ? void 0 : _c.enabled) ? {
             guardrails: {
@@ -208,6 +234,13 @@ function useChat(options) {
           metadata: {
             requestType: import_runtime_client_gql.CopilotRequestType.Chat
           }
+        }), agentSession ? {
+          agentSession
+        } : {}), {
+          agentStates: Object.values(coagentStates).map((state) => ({
+            agentName: state.name,
+            state: JSON.stringify(state.state)
+          }))
         }),
         properties: copilotConfig.properties,
         signal: (_d = abortControllerRef.current) == null ? void 0 : _d.signal
@@ -215,7 +248,8 @@ function useChat(options) {
     );
     const guardrailsEnabled = ((_g = (_f = (_e = copilotConfig.cloud) == null ? void 0 : _e.guardrails) == null ? void 0 : _f.input) == null ? void 0 : _g.restrictToTopic.enabled) || false;
     const reader = stream.getReader();
-    let results = {};
+    let actionResults = {};
+    let executedCoagentActions = [];
     try {
       while (true) {
         const { done, value } = yield reader.read();
@@ -227,7 +261,9 @@ function useChat(options) {
         }
         threadIdRef.current = value.generateCopilotResponse.threadId || null;
         runIdRef.current = value.generateCopilotResponse.runId || null;
-        const messages2 = (0, import_runtime_client_gql.convertGqlOutputToMessages)(value.generateCopilotResponse.messages);
+        const messages2 = (0, import_runtime_client_gql.convertGqlOutputToMessages)(
+          (0, import_runtime_client_gql.filterAdjacentAgentStateMessages)(value.generateCopilotResponse.messages)
+        );
         if (messages2.length === 0) {
           continue;
         }
@@ -242,8 +278,30 @@ function useChat(options) {
         } else {
           for (const message of messages2) {
             newMessages.push(message);
+            if (message instanceof import_runtime_client_gql.AgentStateMessage) {
+              if (message.running) {
+                setCoagentStates((prevAgentStates) => __spreadProps(__spreadValues({}, prevAgentStates), {
+                  [message.agentName]: {
+                    name: message.agentName,
+                    state: message.state,
+                    running: message.running,
+                    active: message.active,
+                    threadId: message.threadId,
+                    nodeName: message.nodeName,
+                    runId: message.runId
+                  }
+                }));
+                setAgentSession({
+                  threadId: message.threadId,
+                  agentName: message.agentName,
+                  nodeName: message.nodeName
+                });
+              } else {
+                setAgentSession(null);
+              }
+            }
             if (message instanceof import_runtime_client_gql.ActionExecutionMessage && message.status.code !== import_runtime_client_gql.MessageStatusCode.Pending && message.scope === "client" && onFunctionCall) {
-              if (!(message.id in results)) {
+              if (!(message.id in actionResults)) {
                 if (guardrailsEnabled && value.generateCopilotResponse.status === void 0) {
                   break;
                 }
@@ -252,16 +310,27 @@ function useChat(options) {
                   name: message.name,
                   args: message.arguments
                 });
-                results[message.id] = result;
+                actionResults[message.id] = result;
               }
               newMessages.push(
                 new import_runtime_client_gql.ResultMessage({
-                  result: import_runtime_client_gql.ResultMessage.encodeResult(results[message.id]),
+                  result: import_runtime_client_gql.ResultMessage.encodeResult(actionResults[message.id]),
                   actionExecutionId: message.id,
                   actionName: message.name
                 })
               );
             }
+            if (message instanceof import_runtime_client_gql.AgentStateMessage && !message.active && !executedCoagentActions.includes(message.id) && onCoagentAction) {
+              if (guardrailsEnabled && value.generateCopilotResponse.status === void 0) {
+                break;
+              }
+              yield onCoagentAction({
+                name: message.agentName,
+                nodeName: message.nodeName,
+                state: message.state
+              });
+              executedCoagentActions.push(message.id);
+            }
           }
         }
         if (newMessages.length > 0) {
@@ -270,7 +339,7 @@ function useChat(options) {
       }
       if (
         // if we have client side results
-        Object.values(results).length || // or the last message we received is a result
+        Object.values(actionResults).length || // or the last message we received is a result
         newMessages.length && newMessages[newMessages.length - 1] instanceof import_runtime_client_gql.ResultMessage
       ) {
         yield new Promise((resolve) => setTimeout(resolve, 10));
@@ -339,8 +408,13 @@ function useCopilotChat(_a = {}) {
     isLoading,
     setIsLoading,
     chatInstructions,
-    actions
-  } = (0, import_react4.useContext)(CopilotContext);
+    actions,
+    coagentStates,
+    setCoagentStates,
+    coagentActions,
+    agentSession,
+    setAgentSession
+  } = useCopilotContext();
   const latestGetContextString = useUpdatedRef(getContextString);
   const deleteMessage = (0, import_react4.useCallback)(
     (messageId) => {
@@ -356,24 +430,76 @@ function useCopilotChat(_a = {}) {
       role: import_runtime_client_gql2.Role.System
     });
   }, [getContextString, makeSystemMessage, chatInstructions]);
+  const onCoagentAction = (0, import_react4.useCallback)(
+    (args) => __async(this, null, function* () {
+      var _a2;
+      const { name, nodeName, state } = args;
+      let action = Object.values(coagentActions).find(
+        (action2) => action2.name === name && action2.nodeName === nodeName
+      );
+      if (!action) {
+        action = Object.values(coagentActions).find(
+          (action2) => action2.name === name && !action2.nodeName
+        );
+      }
+      if (action) {
+        yield (_a2 = action.handler) == null ? void 0 : _a2.call(action, { state, nodeName });
+      }
+    }),
+    [coagentActions]
+  );
   const { append, reload, stop } = useChat(__spreadProps(__spreadValues({}, options), {
     actions: Object.values(actions),
     copilotConfig: copilotApiConfig,
     initialMessages: options.initialMessages || [],
     onFunctionCall: getFunctionCallHandler(),
+    onCoagentAction,
     messages,
     setMessages,
     makeSystemMessageCallback,
     isLoading,
-    setIsLoading
+    setIsLoading,
+    coagentStates,
+    setCoagentStates,
+    agentSession,
+    setAgentSession
   }));
+  const latestAppend = useUpdatedRef(append);
+  const latestAppendFunc = (0, import_react4.useCallback)(
+    (message) => {
+      return latestAppend.current(message);
+    },
+    [latestAppend]
+  );
+  const latestReload = useUpdatedRef(reload);
+  const latestReloadFunc = (0, import_react4.useCallback)(() => {
+    return latestReload.current();
+  }, [latestReload]);
+  const latestStop = useUpdatedRef(stop);
+  const latestStopFunc = (0, import_react4.useCallback)(() => {
+    return latestStop.current();
+  }, [latestStop]);
+  const latestDelete = useUpdatedRef(deleteMessage);
+  const latestDeleteFunc = (0, import_react4.useCallback)(
+    (messageId) => {
+      return latestDelete.current(messageId);
+    },
+    [latestDelete]
+  );
+  const latestSetMessages = useUpdatedRef(setMessages);
+  const latestSetMessagesFunc = (0, import_react4.useCallback)(
+    (messages2) => {
+      return latestSetMessages.current(messages2);
+    },
+    [latestSetMessages]
+  );
   return {
     visibleMessages: messages,
-    appendMessage: append,
-    setMessages,
-    reloadMessages: reload,
-    stopGeneration: stop,
-    deleteMessage,
+    appendMessage: latestAppendFunc,
+    setMessages: latestSetMessagesFunc,
+    reloadMessages: latestReloadFunc,
+    stopGeneration: latestStopFunc,
+    deleteMessage: latestDeleteFunc,
     isLoading
   };
 }
@@ -412,22 +538,25 @@ ${additionalInstructions}` : "");
 var import_react5 = require("react");
 var import_shared3 = require("@copilotkit/shared");
 function useCopilotAction(action, dependencies) {
-  const { setAction, removeAction, actions, chatComponentsCache } = (0, import_react5.useContext)(CopilotContext);
+  const { setAction, removeAction, actions, chatComponentsCache } = useCopilotContext();
   const idRef = (0, import_react5.useRef)((0, import_shared3.randomId)());
   if (dependencies === void 0) {
     if (actions[idRef.current]) {
       actions[idRef.current].handler = action.handler;
       if (typeof action.render === "function") {
         if (chatComponentsCache.current !== null) {
-          chatComponentsCache.current[action.name] = action.render;
+          chatComponentsCache.current.actions[action.name] = action.render;
         }
       }
     }
   }
   (0, import_react5.useEffect)(() => {
+    if (action.disabled) {
+      return;
+    }
     setAction(idRef.current, action);
     if (chatComponentsCache.current !== null && action.render !== void 0) {
-      chatComponentsCache.current[action.name] = action.render;
+      chatComponentsCache.current.actions[action.name] = action.render;
     }
     return () => {
       removeAction(idRef.current);
@@ -437,6 +566,7 @@ function useCopilotAction(action, dependencies) {
     removeAction,
     action.description,
     action.name,
+    action.disabled,
     // This should be faster than deep equality checking
     // In addition, all major JS engines guarantee the order of object keys
     JSON.stringify(action.parameters),
@@ -447,12 +577,48 @@ function useCopilotAction(action, dependencies) {
   ]);
 }
 
-// src/hooks/use-make-copilot-document-readable.ts
+// src/hooks/use-coagent-action.ts
 var import_react6 = require("react");
-function useMakeCopilotDocumentReadable(document, categories, dependencies = []) {
-  const { addDocumentContext, removeDocumentContext } = (0, import_react6.useContext)(CopilotContext);
-  const idRef = (0, import_react6.useRef)();
+var import_shared4 = require("@copilotkit/shared");
+function useCoAgentAction(action, dependencies) {
+  const { setCoagentAction, removeCoagentAction, coagentActions, chatComponentsCache } = (0, import_react6.useContext)(CopilotContext);
+  const idRef = (0, import_react6.useRef)((0, import_shared4.randomId)());
+  const key = `${action.name}-${action.nodeName || "global"}`;
+  if (dependencies === void 0) {
+    if (coagentActions[idRef.current]) {
+      coagentActions[idRef.current].handler = action.handler;
+      if (typeof action.render === "function") {
+        if (chatComponentsCache.current !== null) {
+          chatComponentsCache.current.coagentActions[key] = action.render;
+        }
+      }
+    }
+  }
   (0, import_react6.useEffect)(() => {
+    setCoagentAction(idRef.current, action);
+    if (chatComponentsCache.current !== null && action.render !== void 0) {
+      chatComponentsCache.current.coagentActions[key] = action.render;
+    }
+    return () => {
+      removeCoagentAction(idRef.current);
+    };
+  }, [
+    setCoagentAction,
+    removeCoagentAction,
+    action.name,
+    // include render only if it's a string
+    typeof action.render === "string" ? action.render : void 0,
+    // dependencies set by the developer
+    ...dependencies || []
+  ]);
+}
+
+// src/hooks/use-make-copilot-document-readable.ts
+var import_react7 = require("react");
+function useMakeCopilotDocumentReadable(document, categories, dependencies = []) {
+  const { addDocumentContext, removeDocumentContext } = useCopilotContext();
+  const idRef = (0, import_react7.useRef)();
+  (0, import_react7.useEffect)(() => {
     const id = addDocumentContext(document, categories);
     idRef.current = id;
     return () => {
@@ -463,16 +629,16 @@ function useMakeCopilotDocumentReadable(document, categories, dependencies = [])
 }
 
 // src/hooks/use-copilot-readable.ts
-var import_react7 = require("react");
+var import_react8 = require("react");
 function convertToJSON(description, value) {
   return `${description}: ${typeof value === "string" ? value : JSON.stringify(value)}`;
 }
 function useCopilotReadable({ description, value, parentId, categories, convert }, dependencies) {
-  const { addContext, removeContext } = (0, import_react7.useContext)(CopilotContext);
-  const idRef = (0, import_react7.useRef)();
+  const { addContext, removeContext } = useCopilotContext();
+  const idRef = (0, import_react8.useRef)();
   convert = convert || convertToJSON;
   const information = convert(description, value);
-  (0, import_react7.useEffect)(() => {
+  (0, import_react8.useEffect)(() => {
     const id = addContext(information, parentId, categories);
     idRef.current = id;
     return () => {
@@ -481,8 +647,85 @@ function useCopilotReadable({ description, value, parentId, categories, convert
   }, [information, parentId, addContext, removeContext, ...dependencies || []]);
   return idRef.current;
 }
+
+// src/hooks/use-coagent.ts
+var import_react9 = require("react");
+function useCoAgent(options) {
+  const isExternalStateManagement = (options2) => {
+    return "state" in options2 && "setState" in options2;
+  };
+  const { name } = options;
+  const isInternalStateManagementWithInitial = (options2) => {
+    return "initialState" in options2;
+  };
+  const { coagentStates, setCoagentStates } = useCopilotContext();
+  const getCoagentState = (coagentStates2, name2) => {
+    if (coagentStates2[name2]) {
+      return coagentStates2[name2];
+    } else {
+      return {
+        name: name2,
+        state: isInternalStateManagementWithInitial(options) ? options.initialState : {},
+        running: false,
+        active: false,
+        threadId: void 0,
+        nodeName: void 0,
+        runId: void 0
+      };
+    }
+  };
+  const setState = (newState) => {
+    setCoagentStates((prevAgentStates) => {
+      let coagentState2 = getCoagentState(prevAgentStates, name);
+      const updatedState = typeof newState === "function" ? newState(coagentState2.state) : newState;
+      return __spreadProps(__spreadValues({}, prevAgentStates), {
+        [name]: __spreadProps(__spreadValues({}, coagentState2), {
+          state: updatedState
+        })
+      });
+    });
+  };
+  const coagentState = getCoagentState(coagentStates, name);
+  const state = isExternalStateManagement(options) ? options.state : coagentState.state;
+  (0, import_react9.useEffect)(() => {
+    if (isExternalStateManagement(options)) {
+      setState(options.state);
+    } else if (coagentStates[name] === void 0) {
+      setState(options.initialState === void 0 ? {} : options.initialState);
+    }
+  }, [isExternalStateManagement(options) ? JSON.stringify(options.state) : void 0]);
+  return {
+    name,
+    nodeName: coagentState.nodeName,
+    state,
+    setState,
+    running: coagentState.running,
+    start: () => {
+      startAgent(name);
+    },
+    stop: () => {
+      stopAgent(name);
+    }
+  };
+}
+function startAgent(name) {
+  const { setAgentSession } = useCopilotContext();
+  setAgentSession({
+    agentName: name
+  });
+}
+function stopAgent(name) {
+  const { agentSession, setAgentSession } = useCopilotContext();
+  if (agentSession && agentSession.agentName === name) {
+    setAgentSession(null);
+  } else {
+    console.warn(`No agent session found for ${name}`);
+  }
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  useCoAgent,
+  useCoAgentAction,
   useCopilotAction,
   useCopilotChat,
   useCopilotReadable,