@copilotkit/react-core 1.2.0 → 1.2.2-feat-runtime-remote-actions.0

package/dist/hooks/use-make-copilot-document-readable.mjs

@@ -1,7 +1,7 @@
 import {
   useMakeCopilotDocumentReadable
-} from "../chunk-QR4XKQOA.mjs";
-import "../chunk-LB7ULLSU.mjs";
+} from "../chunk-326LK7LX.mjs";
+import "../chunk-J2YXDQHR.mjs";
 import "../chunk-SKC7AJIV.mjs";
 export {
   useMakeCopilotDocumentReadable

package/dist/index.d.ts

@@ -3,9 +3,11 @@ export { CopilotKitProps } from './components/copilot-provider/copilotkit-props.
 export { CopilotApiConfig, CopilotContext, CopilotContextParams, useCopilotContext } from './context/copilot-context.js';
 export { UseCopilotChatOptions, UseCopilotChatReturn, useCopilotChat } from './hooks/use-copilot-chat.js';
 export { useCopilotAction } from './hooks/use-copilot-action.js';
+export { useCoAgentAction } from './hooks/use-coagent-action.js';
 export { useMakeCopilotDocumentReadable } from './hooks/use-make-copilot-document-readable.js';
 export { UseChatHelpers } from './hooks/use-chat.js';
 export { useCopilotReadable } from './hooks/use-copilot-readable.js';
+export { useCoAgent } from './hooks/use-coagent.js';
 export { DocumentPointer } from './types/document-pointer.js';
 export { SystemMessageFunction } from './types/system-message.js';
 export { ActionRenderProps, RenderFunctionStatus } from './types/frontend-action.js';
@@ -17,3 +19,5 @@ import 'react';
 import '@copilotkit/shared';
 import '@copilotkit/runtime-client-gql';
 import './hooks/use-tree.js';
+import './types/coagent-action.js';
+import './types/coagent-state.js';

package/dist/index.js

@@ -86,6 +86,8 @@ __export(src_exports, {
   CopilotTask: () => CopilotTask,
   defaultCopilotContextCategories: () => defaultCopilotContextCategories,
   extract: () => extract,
+  useCoAgent: () => useCoAgent,
+  useCoAgentAction: () => useCoAgentAction,
   useCopilotAction: () => useCopilotAction,
   useCopilotChat: () => useCopilotChat,
   useCopilotContext: () => useCopilotContext,
@@ -105,7 +107,12 @@ var emptyCopilotContext = {
   },
   removeAction: () => {
   },
-  chatComponentsCache: { current: {} },
+  coagentActions: {},
+  setCoagentAction: () => {
+  },
+  removeCoagentAction: () => {
+  },
+  chatComponentsCache: { current: { actions: {}, coagentActions: {} } },
   getContextString: (documents, categories) => returnAndThrowInDebug(""),
   addContext: () => "",
   removeContext: () => {
@@ -138,7 +145,13 @@ var emptyCopilotContext = {
   },
   removeChatSuggestionConfiguration: () => {
   },
-  showDevConsole: "auto"
+  showDevConsole: "auto",
+  coagentStates: {},
+  setCoagentStates: () => {
+  },
+  agentSession: null,
+  setAgentSession: () => {
+  }
 };
 var CopilotContext = import_react.default.createContext(emptyCopilotContext);
 function useCopilotContext() {
@@ -366,7 +379,11 @@ function CopilotKit(_a) {
   }
   const chatApiEndpoint = props.runtimeUrl || import_shared3.COPILOT_CLOUD_CHAT_URL;
   const [actions, setActions] = (0, import_react4.useState)({});
-  const chatComponentsCache = (0, import_react4.useRef)({});
+  const [coagentActions, setCoagentActions] = (0, import_react4.useState)({});
+  const chatComponentsCache = (0, import_react4.useRef)({
+    actions: {},
+    coagentActions: {}
+  });
   const { addElement, removeElement, printTree } = use_tree_default();
   const [messages, setMessages] = (0, import_react4.useState)([]);
   const [isLoading, setIsLoading] = (0, import_react4.useState)(false);
@@ -390,6 +407,20 @@ function CopilotKit(_a) {
       return newPoints;
     });
   }, []);
+  const setCoagentAction = (0, import_react4.useCallback)((id, action) => {
+    setCoagentActions((prevPoints) => {
+      return __spreadProps(__spreadValues({}, prevPoints), {
+        [id]: action
+      });
+    });
+  }, []);
+  const removeCoagentAction = (0, import_react4.useCallback)((id) => {
+    setCoagentActions((prevPoints) => {
+      const newPoints = __spreadValues({}, prevPoints);
+      delete newPoints[id];
+      return newPoints;
+    });
+  }, []);
   const getContextString = (0, import_react4.useCallback)(
     (documents, categories) => {
       const documentsString = documents.map((document) => {
@@ -480,6 +511,14 @@ ${nonDocumentStrings}`;
       return rest;
     });
   };
+  const [coagentStates, setCoagentStates] = (0, import_react4.useState)({});
+  let initialAgentSession = null;
+  if (props.agent) {
+    initialAgentSession = {
+      agentName: props.agent
+    };
+  }
+  const [agentSession, setAgentSession] = (0, import_react4.useState)(initialAgentSession);
   return /* @__PURE__ */ (0, import_jsx_runtime.jsx)(
     CopilotContext.Provider,
     {
@@ -489,6 +528,9 @@ ${nonDocumentStrings}`;
         getFunctionCallHandler,
         setAction,
         removeAction,
+        coagentActions,
+        setCoagentAction,
+        removeCoagentAction,
         getContextString,
         addContext,
         removeContext,
@@ -505,7 +547,11 @@ ${nonDocumentStrings}`;
         removeChatSuggestionConfiguration,
         chatInstructions,
         setChatInstructions,
-        showDevConsole: props.showDevConsole === void 0 ? "auto" : props.showDevConsole
+        showDevConsole: props.showDevConsole === void 0 ? "auto" : props.showDevConsole,
+        coagentStates,
+        setCoagentStates,
+        agentSession,
+        setAgentSession
       },
       children
     }
@@ -523,8 +569,9 @@ function entryPointsToFunctionCallHandler(actions) {
     if (action) {
       yield new Promise((resolve, reject) => {
         (0, import_react_dom.flushSync)(() => __async(this, null, function* () {
+          var _a;
           try {
-            result = yield action.handler(args);
+            result = yield (_a = action.handler) == null ? void 0 : _a.call(action, args);
             resolve();
           } catch (error) {
             reject(error);
@@ -555,7 +602,12 @@ function useChat(options) {
     initialMessages,
     isLoading,
     actions,
-    onFunctionCall
+    onFunctionCall,
+    onCoagentAction,
+    setCoagentStates,
+    coagentStates,
+    agentSession,
+    setAgentSession
   } = options;
   const abortControllerRef = (0, import_react5.useRef)();
   const threadIdRef = (0, import_react5.useRef)(null);
@@ -584,7 +636,7 @@ 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,
@@ -595,7 +647,7 @@ function useChat(options) {
           },
           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: {
@@ -609,6 +661,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
@@ -616,7 +675,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();
@@ -628,7 +688,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;
         }
@@ -644,7 +706,7 @@ function useChat(options) {
           for (const message of messages2) {
             newMessages.push(message);
             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;
                 }
@@ -653,16 +715,50 @@ 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);
+            }
+          }
+          const lastAgentStateMessage = [...messages2].reverse().find((message) => message instanceof import_runtime_client_gql.AgentStateMessage);
+          if (lastAgentStateMessage) {
+            if (lastAgentStateMessage.running) {
+              setCoagentStates((prevAgentStates) => __spreadProps(__spreadValues({}, prevAgentStates), {
+                [lastAgentStateMessage.agentName]: {
+                  name: lastAgentStateMessage.agentName,
+                  state: lastAgentStateMessage.state,
+                  running: lastAgentStateMessage.running,
+                  active: lastAgentStateMessage.active,
+                  threadId: lastAgentStateMessage.threadId,
+                  nodeName: lastAgentStateMessage.nodeName,
+                  runId: lastAgentStateMessage.runId
+                }
+              }));
+              setAgentSession({
+                threadId: lastAgentStateMessage.threadId,
+                agentName: lastAgentStateMessage.agentName,
+                nodeName: lastAgentStateMessage.nodeName
+              });
+            } else {
+              setAgentSession(null);
+            }
           }
         }
         if (newMessages.length > 0) {
@@ -671,7 +767,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));
@@ -733,7 +829,12 @@ function useCopilotChat(_a = {}) {
     isLoading,
     setIsLoading,
     chatInstructions,
-    actions
+    actions,
+    coagentStates,
+    setCoagentStates,
+    coagentActions,
+    agentSession,
+    setAgentSession
   } = useCopilotContext();
   const latestGetContextString = useUpdatedRef(getContextString);
   const deleteMessage = (0, import_react6.useCallback)(
@@ -750,16 +851,39 @@ function useCopilotChat(_a = {}) {
       role: import_runtime_client_gql2.Role.System
     });
   }, [getContextString, makeSystemMessage2, chatInstructions]);
+  const onCoagentAction = (0, import_react6.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_react6.useCallback)(
@@ -842,7 +966,7 @@ function useCopilotAction(action, dependencies) {
       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;
         }
       }
     }
@@ -853,7 +977,7 @@ function useCopilotAction(action, dependencies) {
     }
     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);
@@ -874,12 +998,48 @@ function useCopilotAction(action, dependencies) {
   ]);
 }
 
-// src/hooks/use-make-copilot-document-readable.ts
+// src/hooks/use-coagent-action.ts
 var import_react8 = require("react");
+var import_shared6 = require("@copilotkit/shared");
+function useCoAgentAction(action, dependencies) {
+  const { setCoagentAction, removeCoagentAction, coagentActions, chatComponentsCache } = (0, import_react8.useContext)(CopilotContext);
+  const idRef = (0, import_react8.useRef)((0, import_shared6.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_react8.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_react9 = require("react");
 function useMakeCopilotDocumentReadable(document, categories, dependencies = []) {
   const { addDocumentContext, removeDocumentContext } = useCopilotContext();
-  const idRef = (0, import_react8.useRef)();
-  (0, import_react8.useEffect)(() => {
+  const idRef = (0, import_react9.useRef)();
+  (0, import_react9.useEffect)(() => {
     const id = addDocumentContext(document, categories);
     idRef.current = id;
     return () => {
@@ -890,16 +1050,16 @@ function useMakeCopilotDocumentReadable(document, categories, dependencies = [])
 }
 
 // src/hooks/use-copilot-readable.ts
-var import_react9 = require("react");
+var import_react10 = 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 } = useCopilotContext();
-  const idRef = (0, import_react9.useRef)();
+  const idRef = (0, import_react10.useRef)();
   convert = convert || convertToJSON;
   const information = convert(description, value);
-  (0, import_react9.useEffect)(() => {
+  (0, import_react10.useEffect)(() => {
     const id = addContext(information, parentId, categories);
     idRef.current = id;
     return () => {
@@ -909,9 +1069,84 @@ function useCopilotReadable({ description, value, parentId, categories, convert
   return idRef.current;
 }
 
+// src/hooks/use-coagent.ts
+var import_react11 = 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_react11.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}`);
+  }
+}
+
 // src/lib/copilot-task.ts
 var import_runtime_client_gql3 = require("@copilotkit/runtime-client-gql");
-var import_shared6 = require("@copilotkit/shared");
+var import_shared7 = require("@copilotkit/shared");
 var CopilotTask = class {
   constructor(config) {
     this.instructions = config.instructions;
@@ -955,11 +1190,11 @@ var CopilotTask = class {
             actions: Object.values(actions).map((action) => ({
               name: action.name,
               description: action.description || "",
-              jsonSchema: JSON.stringify((0, import_shared6.actionParametersToJsonSchema)(action.parameters || []))
+              jsonSchema: JSON.stringify((0, import_shared7.actionParametersToJsonSchema)(action.parameters || []))
             })),
             url: window.location.href
           },
-          messages: (0, import_runtime_client_gql3.convertMessagesToGqlInput)(messages),
+          messages: (0, import_runtime_client_gql3.convertMessagesToGqlInput)((0, import_runtime_client_gql3.filterAgentStateMessages)(messages)),
           metadata: {
             requestType: import_runtime_client_gql3.CopilotRequestType.Task
           },
@@ -1010,7 +1245,7 @@ ${instructions}
 }
 
 // src/utils/extract.ts
-var import_shared7 = require("@copilotkit/shared");
+var import_shared8 = require("@copilotkit/shared");
 var import_runtime_client_gql4 = require("@copilotkit/runtime-client-gql");
 var import_runtime_client_gql5 = require("@copilotkit/runtime-client-gql");
 var import_runtime_client_gql6 = require("@copilotkit/runtime-client-gql");
@@ -1046,7 +1281,7 @@ function extract(_0) {
       content: makeSystemMessage(contextString, instructions),
       role: import_runtime_client_gql4.Role.System
     });
-    const headers = __spreadValues(__spreadValues({}, context.copilotApiConfig.headers || {}), context.copilotApiConfig.publicApiKey ? { [import_shared7.COPILOT_CLOUD_PUBLIC_API_KEY_HEADER]: context.copilotApiConfig.publicApiKey } : {});
+    const headers = __spreadValues(__spreadValues({}, context.copilotApiConfig.headers || {}), context.copilotApiConfig.publicApiKey ? { [import_shared8.COPILOT_CLOUD_PUBLIC_API_KEY_HEADER]: context.copilotApiConfig.publicApiKey } : {});
     const runtimeClient = new import_runtime_client_gql5.CopilotRuntimeClient({
       url: context.copilotApiConfig.chatApiEndpoint,
       publicApiKey: context.copilotApiConfig.publicApiKey,
@@ -1061,13 +1296,13 @@ function extract(_0) {
               {
                 name: action.name,
                 description: action.description || "",
-                jsonSchema: JSON.stringify((0, import_shared7.actionParametersToJsonSchema)(action.parameters || []))
+                jsonSchema: JSON.stringify((0, import_shared8.actionParametersToJsonSchema)(action.parameters || []))
               }
             ],
             url: window.location.href
           },
           messages: (0, import_runtime_client_gql6.convertMessagesToGqlInput)(
-            includeMessages ? [systemMessage, ...messages] : [systemMessage]
+            includeMessages ? [systemMessage, ...(0, import_runtime_client_gql6.filterAgentStateMessages)(messages)] : [systemMessage]
           ),
           metadata: {
             requestType
@@ -1148,6 +1383,8 @@ Any additional messages provided are for providing context only and should not b
   CopilotTask,
   defaultCopilotContextCategories,
   extract,
+  useCoAgent,
+  useCoAgentAction,
   useCopilotAction,
   useCopilotChat,
   useCopilotContext,