@copilotkit/runtime-client-gql 0.0.0-mme-load-agent-state-20250117154700

package/src/client/conversion.ts

@@ -0,0 +1,211 @@
+import {
+  GenerateCopilotResponseMutation,
+  MessageInput,
+  MessageStatusCode,
+} from "../graphql/@generated/graphql";
+import {
+  ActionExecutionMessage,
+  AgentStateMessage,
+  Message,
+  ResultMessage,
+  TextMessage,
+} from "./types";
+
+import untruncateJson from "untruncate-json";
+
+export function filterAgentStateMessages(messages: Message[]): Message[] {
+  return messages.filter((message) => !message.isAgentStateMessage());
+}
+
+export function convertMessagesToGqlInput(messages: Message[]): MessageInput[] {
+  return messages.map((message) => {
+    if (message.isTextMessage()) {
+      return {
+        id: message.id,
+        createdAt: message.createdAt,
+        textMessage: {
+          content: message.content,
+          role: message.role as any,
+          parentMessageId: message.parentMessageId,
+        },
+      };
+    } else if (message.isActionExecutionMessage()) {
+      return {
+        id: message.id,
+        createdAt: message.createdAt,
+        actionExecutionMessage: {
+          name: message.name,
+          arguments: JSON.stringify(message.arguments),
+          parentMessageId: message.parentMessageId,
+        },
+      };
+    } else if (message.isResultMessage()) {
+      return {
+        id: message.id,
+        createdAt: message.createdAt,
+        resultMessage: {
+          result: message.result,
+          actionExecutionId: message.actionExecutionId,
+          actionName: message.actionName,
+        },
+      };
+    } else if (message.isAgentStateMessage()) {
+      return {
+        id: message.id,
+        createdAt: message.createdAt,
+        agentStateMessage: {
+          threadId: message.threadId,
+          role: message.role,
+          agentName: message.agentName,
+          nodeName: message.nodeName,
+          runId: message.runId,
+          active: message.active,
+          running: message.running,
+          state: JSON.stringify(message.state),
+        },
+      };
+    } else {
+      throw new Error("Unknown message type");
+    }
+  });
+}
+
+export function filterAdjacentAgentStateMessages(
+  messages: GenerateCopilotResponseMutation["generateCopilotResponse"]["messages"],
+): GenerateCopilotResponseMutation["generateCopilotResponse"]["messages"] {
+  const filteredMessages: GenerateCopilotResponseMutation["generateCopilotResponse"]["messages"] =
+    [];
+
+  messages.forEach((message, i) => {
+    // keep all other message types
+    if (message.__typename !== "AgentStateMessageOutput") {
+      filteredMessages.push(message);
+    } else {
+      const prevAgentStateMessageIndex = filteredMessages.findIndex(
+        // TODO: also check runId
+        (m) => m.__typename === "AgentStateMessageOutput" && m.agentName === message.agentName,
+      );
+      if (prevAgentStateMessageIndex === -1) {
+        filteredMessages.push(message);
+      } else {
+        filteredMessages[prevAgentStateMessageIndex] = message;
+      }
+    }
+  });
+
+  return filteredMessages;
+}
+
+export function convertGqlOutputToMessages(
+  messages: GenerateCopilotResponseMutation["generateCopilotResponse"]["messages"],
+): Message[] {
+  return messages.map((message) => {
+    if (message.__typename === "TextMessageOutput") {
+      return new TextMessage({
+        id: message.id,
+        role: message.role,
+        content: message.content.join(""),
+        parentMessageId: message.parentMessageId,
+        createdAt: new Date(),
+        status: message.status || { code: MessageStatusCode.Pending },
+      });
+    } else if (message.__typename === "ActionExecutionMessageOutput") {
+      return new ActionExecutionMessage({
+        id: message.id,
+        name: message.name,
+        arguments: getPartialArguments(message.arguments),
+        parentMessageId: message.parentMessageId,
+        createdAt: new Date(),
+        status: message.status || { code: MessageStatusCode.Pending },
+      });
+    } else if (message.__typename === "ResultMessageOutput") {
+      return new ResultMessage({
+        id: message.id,
+        result: message.result,
+        actionExecutionId: message.actionExecutionId,
+        actionName: message.actionName,
+        createdAt: new Date(),
+        status: message.status || { code: MessageStatusCode.Pending },
+      });
+    } else if (message.__typename === "AgentStateMessageOutput") {
+      return new AgentStateMessage({
+        id: message.id,
+        threadId: message.threadId,
+        role: message.role,
+        agentName: message.agentName,
+        nodeName: message.nodeName,
+        runId: message.runId,
+        active: message.active,
+        running: message.running,
+        state: JSON.parse(message.state),
+        createdAt: new Date(),
+      });
+    }
+
+    throw new Error("Unknown message type");
+  });
+}
+
+export function loadMessagesFromJsonRepresentation(json: any[]): Message[] {
+  const result: Message[] = [];
+  for (const item of json) {
+    if ("content" in item) {
+      result.push(
+        new TextMessage({
+          id: item.id,
+          role: item.role,
+          content: item.content,
+          parentMessageId: item.parentMessageId,
+          createdAt: item.createdAt || new Date(),
+          status: item.status || { code: MessageStatusCode.Success },
+        }),
+      );
+    } else if ("arguments" in item) {
+      result.push(
+        new ActionExecutionMessage({
+          id: item.id,
+          name: item.name,
+          arguments: item.arguments,
+          parentMessageId: item.parentMessageId,
+          createdAt: item.createdAt || new Date(),
+          status: item.status || { code: MessageStatusCode.Success },
+        }),
+      );
+    } else if ("result" in item) {
+      result.push(
+        new ResultMessage({
+          id: item.id,
+          result: item.result,
+          actionExecutionId: item.actionExecutionId,
+          actionName: item.actionName,
+          createdAt: item.createdAt || new Date(),
+          status: item.status || { code: MessageStatusCode.Success },
+        }),
+      );
+    } else if ("state" in item) {
+      result.push(
+        new AgentStateMessage({
+          id: item.id,
+          threadId: item.threadId,
+          role: item.role,
+          agentName: item.agentName,
+          nodeName: item.nodeName,
+          runId: item.runId,
+          active: item.active,
+          running: item.running,
+          state: item.state,
+          createdAt: item.createdAt || new Date(),
+        }),
+      );
+    }
+  }
+  return result;
+}
+
+function getPartialArguments(args: string[]) {
+  try {
+    return JSON.parse(untruncateJson(args.join("")));
+  } catch (e) {
+    return {};
+  }
+}

package/src/client/index.ts

@@ -0,0 +1,10 @@
+export * from "./CopilotRuntimeClient";
+export {
+  convertMessagesToGqlInput,
+  convertGqlOutputToMessages,
+  filterAdjacentAgentStateMessages,
+  filterAgentStateMessages,
+  loadMessagesFromJsonRepresentation,
+} from "./conversion";
+export * from "./types";
+export type { GraphQLError } from "graphql";

package/src/client/types.ts

@@ -0,0 +1,127 @@
+import { randomId } from "@copilotkit/shared";
+import {
+  ActionExecutionMessageInput,
+  MessageRole,
+  MessageStatus,
+  ResultMessageInput,
+  TextMessageInput,
+  BaseMessageOutput,
+  AgentStateMessageInput,
+  MessageStatusCode,
+} from "../graphql/@generated/graphql";
+
+type MessageType = "TextMessage" | "ActionExecutionMessage" | "ResultMessage" | "AgentStateMessage";
+
+export class Message {
+  type: MessageType;
+  id: BaseMessageOutput["id"];
+  createdAt: BaseMessageOutput["createdAt"];
+  status: MessageStatus;
+
+  constructor(props: any) {
+    props.id ??= randomId();
+    props.status ??= { code: MessageStatusCode.Success };
+    props.createdAt ??= new Date();
+    Object.assign(this, props);
+  }
+
+  isTextMessage(): this is TextMessage {
+    return this.type === "TextMessage";
+  }
+
+  isActionExecutionMessage(): this is ActionExecutionMessage {
+    return this.type === "ActionExecutionMessage";
+  }
+
+  isResultMessage(): this is ResultMessage {
+    return this.type === "ResultMessage";
+  }
+
+  isAgentStateMessage(): this is AgentStateMessage {
+    return this.type === "AgentStateMessage";
+  }
+}
+
+// alias Role to MessageRole
+export const Role = MessageRole;
+
+// when constructing any message, the base fields are optional
+type MessageConstructorOptions = Partial<Message>;
+
+type TextMessageConstructorOptions = MessageConstructorOptions & TextMessageInput;
+
+export class TextMessage extends Message implements TextMessageConstructorOptions {
+  role: TextMessageInput["role"];
+  content: TextMessageInput["content"];
+  parentMessageId: TextMessageInput["parentMessageId"];
+
+  constructor(props: TextMessageConstructorOptions) {
+    super(props);
+    this.type = "TextMessage";
+  }
+}
+
+type ActionExecutionMessageConstructorOptions = MessageConstructorOptions &
+  Omit<ActionExecutionMessageInput, "arguments"> & {
+    arguments: Record<string, any>;
+  };
+
+export class ActionExecutionMessage
+  extends Message
+  implements Omit<ActionExecutionMessageInput, "arguments" | "scope">
+{
+  name: ActionExecutionMessageInput["name"];
+  arguments: Record<string, any>;
+  parentMessageId: ActionExecutionMessageInput["parentMessageId"];
+  constructor(props: ActionExecutionMessageConstructorOptions) {
+    super(props);
+    this.type = "ActionExecutionMessage";
+  }
+}
+
+type ResultMessageConstructorOptions = MessageConstructorOptions & ResultMessageInput;
+
+export class ResultMessage extends Message implements ResultMessageConstructorOptions {
+  actionExecutionId: ResultMessageInput["actionExecutionId"];
+  actionName: ResultMessageInput["actionName"];
+  result: ResultMessageInput["result"];
+
+  constructor(props: ResultMessageConstructorOptions) {
+    super(props);
+    this.type = "ResultMessage";
+  }
+
+  static decodeResult(result: string): any {
+    try {
+      return JSON.parse(result);
+    } catch (e) {
+      return result;
+    }
+  }
+
+  static encodeResult(result: any): string {
+    if (result === undefined) {
+      return "";
+    } else if (typeof result === "string") {
+      return result;
+    } else {
+      return JSON.stringify(result);
+    }
+  }
+}
+
+export class AgentStateMessage extends Message implements Omit<AgentStateMessageInput, "state"> {
+  agentName: AgentStateMessageInput["agentName"];
+  state: any;
+  running: AgentStateMessageInput["running"];
+  threadId: AgentStateMessageInput["threadId"];
+  role: AgentStateMessageInput["role"];
+  nodeName: AgentStateMessageInput["nodeName"];
+  runId: AgentStateMessageInput["runId"];
+  active: AgentStateMessageInput["active"];
+
+  constructor(props: any) {
+    super(props);
+    this.type = "AgentStateMessage";
+  }
+}

package/src/graphql/@generated/fragment-masking.ts

@@ -0,0 +1,87 @@
+/* eslint-disable */
+import type { ResultOf, DocumentTypeDecoration, TypedDocumentNode } from '@graphql-typed-document-node/core';
+import type { FragmentDefinitionNode } from 'graphql';
+import type { Incremental } from './graphql';
+
+
+export type FragmentType<TDocumentType extends DocumentTypeDecoration<any, any>> = TDocumentType extends DocumentTypeDecoration<
+  infer TType,
+  any
+>
+  ? [TType] extends [{ ' $fragmentName'?: infer TKey }]
+    ? TKey extends string
+      ? { ' $fragmentRefs'?: { [key in TKey]: TType } }
+      : never
+    : never
+  : never;
+
+// return non-nullable if `fragmentType` is non-nullable
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType: FragmentType<DocumentTypeDecoration<TType, any>>
+): TType;
+// return nullable if `fragmentType` is undefined
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType: FragmentType<DocumentTypeDecoration<TType, any>> | undefined
+): TType | undefined;
+// return nullable if `fragmentType` is nullable
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType: FragmentType<DocumentTypeDecoration<TType, any>> | null
+): TType | null;
+// return nullable if `fragmentType` is nullable or undefined
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType: FragmentType<DocumentTypeDecoration<TType, any>> | null | undefined
+): TType | null | undefined;
+// return array of non-nullable if `fragmentType` is array of non-nullable
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>>>
+): Array<TType>;
+// return array of nullable if `fragmentType` is array of nullable
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType: Array<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined
+): Array<TType> | null | undefined;
+// return readonly array of non-nullable if `fragmentType` is array of non-nullable
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>>
+): ReadonlyArray<TType>;
+// return readonly array of nullable if `fragmentType` is array of nullable
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType: ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined
+): ReadonlyArray<TType> | null | undefined;
+export function useFragment<TType>(
+  _documentNode: DocumentTypeDecoration<TType, any>,
+  fragmentType: FragmentType<DocumentTypeDecoration<TType, any>> | Array<FragmentType<DocumentTypeDecoration<TType, any>>> | ReadonlyArray<FragmentType<DocumentTypeDecoration<TType, any>>> | null | undefined
+): TType | Array<TType> | ReadonlyArray<TType> | null | undefined {
+  return fragmentType as any;
+}
+
+
+export function makeFragmentData<
+  F extends DocumentTypeDecoration<any, any>,
+  FT extends ResultOf<F>
+>(data: FT, _fragment: F): FragmentType<F> {
+  return data as FragmentType<F>;
+}
+export function isFragmentReady<TQuery, TFrag>(
+  queryNode: DocumentTypeDecoration<TQuery, any>,
+  fragmentNode: TypedDocumentNode<TFrag>,
+  data: FragmentType<TypedDocumentNode<Incremental<TFrag>, any>> | null | undefined
+): data is FragmentType<typeof fragmentNode> {
+  const deferredFields = (queryNode as { __meta__?: { deferredFields: Record<string, (keyof TFrag)[]> } }).__meta__
+    ?.deferredFields;
+
+  if (!deferredFields) return true;
+
+  const fragDef = fragmentNode.definitions[0] as FragmentDefinitionNode | undefined;
+  const fragName = fragDef?.name?.value;
+
+  const fields = (fragName && deferredFields[fragName]) || [];
+  return fields.length > 0 && fields.every(field => data && field in data);
+}

package/src/graphql/@generated/gql.ts

@@ -0,0 +1,52 @@
+/* eslint-disable */
+import * as types from './graphql';
+import type { TypedDocumentNode as DocumentNode } from '@graphql-typed-document-node/core';
+
+/**
+ * Map of all GraphQL operations in the project.
+ *
+ * This map has several performance disadvantages:
+ * 1. It is not tree-shakeable, so it will include all operations in the project.
+ * 2. It is not minifiable, so the string of a GraphQL query will be multiple times inside the bundle.
+ * 3. It does not support dead code elimination, so it will add unused operations.
+ *
+ * Therefore it is highly recommended to use the babel or swc plugin for production.
+ */
+const documents = {
+    "\n  mutation generateCopilotResponse($data: GenerateCopilotResponseInput!, $properties: JSONObject) {\n    generateCopilotResponse(data: $data, properties: $properties) {\n      threadId\n      runId\n      extensions {\n        openaiAssistantAPI {\n          runId\n          threadId\n        }\n      }\n      ... on CopilotResponse @defer {\n        status {\n          ... on BaseResponseStatus {\n            code\n          }\n          ... on FailedResponseStatus {\n            reason\n            details\n          }\n        }\n      }\n      messages @stream {\n        __typename\n        ... on BaseMessageOutput {\n          id\n          createdAt\n        }\n        ... on BaseMessageOutput @defer {\n          status {\n            ... on SuccessMessageStatus {\n              code\n            }\n            ... on FailedMessageStatus {\n              code\n              reason\n            }\n            ... on PendingMessageStatus {\n              code\n            }\n          }\n        }\n        ... on TextMessageOutput {\n          content @stream\n          role\n          parentMessageId\n        }\n        ... on ActionExecutionMessageOutput {\n          name\n          arguments @stream\n          parentMessageId\n        }\n        ... on ResultMessageOutput {\n          result\n          actionExecutionId\n          actionName\n        }\n        ... on AgentStateMessageOutput {\n          threadId\n          state\n          running\n          agentName\n          nodeName\n          runId\n          active\n          role\n        }\n      }\n    }\n  }\n": types.GenerateCopilotResponseDocument,
+    "\n  query availableAgents {\n    availableAgents {\n      agents {\n        name\n        id\n        description\n      }\n    }\n  }\n": types.AvailableAgentsDocument,
+    "\n  query loadAgentState($data: LoadAgentStateInput!) {\n    loadAgentState(data: $data) {\n      threadId\n      threadExists\n      state\n      messages\n    }\n  }\n": types.LoadAgentStateDocument,
+};
+
+/**
+ * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
+ *
+ *
+ * @example
+ * ```ts
+ * const query = graphql(`query GetUser($id: ID!) { user(id: $id) { name } }`);
+ * ```
+ *
+ * The query argument is unknown!
+ * Please regenerate the types.
+ */
+export function graphql(source: string): unknown;
+
+/**
+ * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
+ */
+export function graphql(source: "\n  mutation generateCopilotResponse($data: GenerateCopilotResponseInput!, $properties: JSONObject) {\n    generateCopilotResponse(data: $data, properties: $properties) {\n      threadId\n      runId\n      extensions {\n        openaiAssistantAPI {\n          runId\n          threadId\n        }\n      }\n      ... on CopilotResponse @defer {\n        status {\n          ... on BaseResponseStatus {\n            code\n          }\n          ... on FailedResponseStatus {\n            reason\n            details\n          }\n        }\n      }\n      messages @stream {\n        __typename\n        ... on BaseMessageOutput {\n          id\n          createdAt\n        }\n        ... on BaseMessageOutput @defer {\n          status {\n            ... on SuccessMessageStatus {\n              code\n            }\n            ... on FailedMessageStatus {\n              code\n              reason\n            }\n            ... on PendingMessageStatus {\n              code\n            }\n          }\n        }\n        ... on TextMessageOutput {\n          content @stream\n          role\n          parentMessageId\n        }\n        ... on ActionExecutionMessageOutput {\n          name\n          arguments @stream\n          parentMessageId\n        }\n        ... on ResultMessageOutput {\n          result\n          actionExecutionId\n          actionName\n        }\n        ... on AgentStateMessageOutput {\n          threadId\n          state\n          running\n          agentName\n          nodeName\n          runId\n          active\n          role\n        }\n      }\n    }\n  }\n"): (typeof documents)["\n  mutation generateCopilotResponse($data: GenerateCopilotResponseInput!, $properties: JSONObject) {\n    generateCopilotResponse(data: $data, properties: $properties) {\n      threadId\n      runId\n      extensions {\n        openaiAssistantAPI {\n          runId\n          threadId\n        }\n      }\n      ... on CopilotResponse @defer {\n        status {\n          ... on BaseResponseStatus {\n            code\n          }\n          ... on FailedResponseStatus {\n            reason\n            details\n          }\n        }\n      }\n      messages @stream {\n        __typename\n        ... on BaseMessageOutput {\n          id\n          createdAt\n        }\n        ... on BaseMessageOutput @defer {\n          status {\n            ... on SuccessMessageStatus {\n              code\n            }\n            ... on FailedMessageStatus {\n              code\n              reason\n            }\n            ... on PendingMessageStatus {\n              code\n            }\n          }\n        }\n        ... on TextMessageOutput {\n          content @stream\n          role\n          parentMessageId\n        }\n        ... on ActionExecutionMessageOutput {\n          name\n          arguments @stream\n          parentMessageId\n        }\n        ... on ResultMessageOutput {\n          result\n          actionExecutionId\n          actionName\n        }\n        ... on AgentStateMessageOutput {\n          threadId\n          state\n          running\n          agentName\n          nodeName\n          runId\n          active\n          role\n        }\n      }\n    }\n  }\n"];
+/**
+ * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
+ */
+export function graphql(source: "\n  query availableAgents {\n    availableAgents {\n      agents {\n        name\n        id\n        description\n      }\n    }\n  }\n"): (typeof documents)["\n  query availableAgents {\n    availableAgents {\n      agents {\n        name\n        id\n        description\n      }\n    }\n  }\n"];
+/**
+ * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
+ */
+export function graphql(source: "\n  query loadAgentState($data: LoadAgentStateInput!) {\n    loadAgentState(data: $data) {\n      threadId\n      threadExists\n      state\n      messages\n    }\n  }\n"): (typeof documents)["\n  query loadAgentState($data: LoadAgentStateInput!) {\n    loadAgentState(data: $data) {\n      threadId\n      threadExists\n      state\n      messages\n    }\n  }\n"];
+
+export function graphql(source: string) {
+  return (documents as any)[source] ?? {};
+}
+
+export type DocumentType<TDocumentNode extends DocumentNode<any, any>> = TDocumentNode extends DocumentNode<  infer TType,  any>  ? TType  : never;