@copilotkit/react-core 1.1.1-feat-runtime-remote-actions.4 → 1.1.1-feat-runtime-remote-actions.5

package/dist/hooks/index.js

@@ -79,10 +79,10 @@ var __async = (__this, __arguments, generator) => {
 // src/hooks/index.ts
 var hooks_exports = {};
 __export(hooks_exports, {
-  useAgentState: () => useAgentState,
+  useCoagent: () => useCoagent,
+  useCoagentAction: () => useCoagentAction,
   useCopilotAction: () => useCopilotAction,
   useCopilotChat: () => useCopilotChat,
-  useCopilotChatUI: () => useCopilotChatUI,
   useCopilotReadable: () => useCopilotReadable,
   useMakeCopilotDocumentReadable: () => useMakeCopilotDocumentReadable
 });
@@ -99,7 +99,12 @@ var emptyCopilotContext = {
   },
   removeAction: () => {
   },
-  chatComponentsCache: { current: { actions: {}, chatUI: {} } },
+  coagentActions: {},
+  setCoagentAction: () => {
+  },
+  removeCoagentAction: () => {
+  },
+  chatComponentsCache: { current: { actions: {}, coagentActions: {} } },
   getContextString: (documents, categories) => returnAndThrowInDebug(""),
   addContext: () => "",
   removeContext: () => {
@@ -133,11 +138,11 @@ var emptyCopilotContext = {
   removeChatSuggestionConfiguration: () => {
   },
   showDevConsole: "auto",
-  agentStates: {},
-  setAgentStates: () => {
+  coagentStates: {},
+  setCoagentStates: () => {
   },
-  chatUI: [],
-  setChatUI: () => {
+  agentSession: null,
+  setAgentSession: () => {
   }
 };
 var CopilotContext = import_react.default.createContext(emptyCopilotContext);
@@ -167,12 +172,15 @@ function useChat(options) {
     isLoading,
     actions,
     onFunctionCall,
-    setAgentStates
+    onCoagentAction,
+    setCoagentStates,
+    coagentStates,
+    agentSession,
+    setAgentSession
   } = options;
   const abortControllerRef = (0, import_react2.useRef)();
   const threadIdRef = (0, import_react2.useRef)(null);
   const runIdRef = (0, import_react2.useRef)(null);
-  const agentSessionRef = (0, import_react2.useRef)(null);
   const publicApiKey = copilotConfig.publicApiKey;
   const headers = __spreadValues(__spreadValues({}, copilotConfig.headers || {}), publicApiKey ? { [import_shared.COPILOT_CLOUD_PUBLIC_API_KEY_HEADER]: publicApiKey } : {});
   const runtimeClient = new import_runtime_client_gql.CopilotRuntimeClient({
@@ -197,7 +205,7 @@ function useChat(options) {
     const messagesWithContext = [systemMessage, ...initialMessages || [], ...previousMessages];
     const stream = import_runtime_client_gql.CopilotRuntimeClient.asStream(
       runtimeClient.generateCopilotResponse({
-        data: __spreadValues(__spreadProps(__spreadValues({
+        data: __spreadProps(__spreadValues(__spreadProps(__spreadValues({
           frontend: {
             actions: actions.map((action) => ({
               name: action.name,
@@ -221,20 +229,22 @@ function useChat(options) {
           metadata: {
             requestType: import_runtime_client_gql.CopilotRequestType.Chat
           }
-        }), agentSessionRef.current ? {
-          agentSession: {
-            threadId: agentSessionRef.current.threadId,
-            agentName: agentSessionRef.current.agentName,
-            nodeName: agentSessionRef.current.nodeName
-          }
-        } : {}),
+        }), 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
       })
     );
     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();
@@ -263,25 +273,28 @@ function useChat(options) {
             newMessages.push(message);
             if (message instanceof import_runtime_client_gql.AgentStateMessage) {
               if (message.running) {
-                setAgentStates((prevAgentStates) => __spreadProps(__spreadValues({}, prevAgentStates), {
-                  [message.agentName]: message
+                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
+                  }
                 }));
-                agentSessionRef.current = {
+                setAgentSession({
                   threadId: message.threadId,
                   agentName: message.agentName,
                   nodeName: message.nodeName
-                };
-              } else {
-                setAgentStates((prevAgentStates) => {
-                  const newAgentStates = __spreadValues({}, prevAgentStates);
-                  delete newAgentStates[message.agentName];
-                  return newAgentStates;
                 });
-                agentSessionRef.current = null;
+              } 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;
                 }
@@ -290,26 +303,39 @@ 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) {
           const filteredMessages = [...previousMessages, ...newMessages].reduce(
             (acc, message) => {
-              if (message instanceof import_runtime_client_gql.AgentStateMessage && // Check if the current message is an AgentStateMessage
-              acc.length > 0 && // Ensure there is at least one message in the accumulator
-              acc[acc.length - 1] instanceof import_runtime_client_gql.AgentStateMessage && // Check if the last message in the accumulator is also an AgentStateMessage
-              acc[acc.length - 1].agentName === message.agentName && // Check if the agentName is the same
-              acc[acc.length - 1].nodeName === message.nodeName) {
+              if (
+                // If the current message is an AgentStateMessage
+                message instanceof import_runtime_client_gql.AgentStateMessage && // And there is at least one message in the accumulator
+                acc.length > 0 && // And the last message in the accumulator is also an AgentStateMessage
+                acc[acc.length - 1] instanceof import_runtime_client_gql.AgentStateMessage && // And the agentName, nodeName, and runId are the same
+                acc[acc.length - 1].agentName === message.agentName && acc[acc.length - 1].nodeName === message.nodeName && acc[acc.length - 1].runId === message.runId
+              ) {
                 acc[acc.length - 1] = message;
               } else {
                 acc.push(message);
@@ -323,7 +349,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));
@@ -393,7 +419,11 @@ function useCopilotChat(_a = {}) {
     setIsLoading,
     chatInstructions,
     actions,
-    setAgentStates
+    coagentStates,
+    setCoagentStates,
+    coagentActions,
+    agentSession,
+    setAgentSession
   } = (0, import_react4.useContext)(CopilotContext);
   const latestGetContextString = useUpdatedRef(getContextString);
   const deleteMessage = (0, import_react4.useCallback)(
@@ -410,17 +440,39 @@ 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,
-    setAgentStates
+    coagentStates,
+    setCoagentStates,
+    agentSession,
+    setAgentSession
   }));
   return {
     visibleMessages: messages,
@@ -502,12 +554,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 } = (0, import_react7.useContext)(CopilotContext);
+  const idRef = (0, import_react7.useRef)();
+  (0, import_react7.useEffect)(() => {
     const id = addDocumentContext(document, categories);
     idRef.current = id;
     return () => {
@@ -518,16 +606,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 } = (0, import_react8.useContext)(CopilotContext);
+  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 () => {
@@ -537,58 +625,86 @@ function useCopilotReadable({ description, value, parentId, categories, convert
   return idRef.current;
 }
 
-// src/hooks/use-agent-state.ts
-var import_runtime_client_gql3 = require("@copilotkit/runtime-client-gql");
-function useAgentState(agentName) {
-  const { agentStates, setAgentStates } = useCopilotContext();
-  const { visibleMessages, setMessages } = useCopilotChat();
-  const setSpecificAgentState = (newState) => {
-    setAgentStates((prevAgentStates) => {
-      const currentState2 = prevAgentStates[agentName];
-      if (!currentState2) {
-        throw new Error(`Agent state ${agentName} not found`);
-      }
-      const updatedState = typeof newState === "function" ? newState(currentState2) : newState;
-      const lastAgentStateMessage = [...visibleMessages].reverse().find((message) => message instanceof import_runtime_client_gql3.AgentStateMessage);
-      const agentStateMessage = new import_runtime_client_gql3.AgentStateMessage({
-        agentName,
-        nodeName: lastAgentStateMessage.nodeName,
-        state: updatedState,
-        running: lastAgentStateMessage.running,
-        threadId: lastAgentStateMessage.threadId,
-        role: lastAgentStateMessage.role
-      });
-      setMessages([...visibleMessages, agentStateMessage]);
+// 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), {
-        [agentName]: agentStateMessage
+        [name]: __spreadProps(__spreadValues({}, coagentState2), {
+          state: updatedState
+        })
       });
     });
   };
-  const currentState = agentStates[agentName];
-  return [
-    currentState == null ? void 0 : currentState.state,
-    setSpecificAgentState,
-    currentState ? { nodeName: currentState.nodeName } : void 0
-  ];
+  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);
+    }
+  };
 }
-
-// src/hooks/use-copilot-chat-ui.ts
-var import_react8 = require("react");
-function useCopilotChatUI(chatUI, dependencies) {
-  const { chatUI: chatUIFromContext, setChatUI } = useCopilotContext();
-  (0, import_react8.useEffect)(() => {
-    setChatUI([...chatUIFromContext, chatUI]);
-    return () => {
-      setChatUI(chatUIFromContext.filter((ui) => ui !== chatUI));
-    };
-  }, [chatUI.agentName, chatUI.nodeName, setChatUI]);
+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 = {
-  useAgentState,
+  useCoagent,
+  useCoagentAction,
   useCopilotAction,
   useCopilotChat,
-  useCopilotChatUI,
   useCopilotReadable,
   useMakeCopilotDocumentReadable
 });