@copilotkit/runtime 1.1.3-feat-runtime-remote-actions.2 → 1.2.1

package/package.json

@@ -9,7 +9,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.1.3-feat-runtime-remote-actions.2",
+  "version": "1.2.1",
   "sideEffects": false,
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -31,8 +31,8 @@
     "ts-node": "^10.9.2",
     "tsup": "^6.7.0",
     "typescript": "^5.2.3",
-    "eslint-config-custom": "1.1.2-feat-runtime-remote-actions.2",
-    "tsconfig": "1.1.2-feat-runtime-remote-actions.2"
+    "eslint-config-custom": "1.2.1",
+    "tsconfig": "1.2.1"
   },
   "dependencies": {
     "@google/generative-ai": "^0.11.2",
@@ -54,7 +54,7 @@
     "rxjs": "^7.8.1",
     "type-graphql": "2.0.0-rc.1",
     "zod": "^3.23.3",
-    "@copilotkit/shared": "1.1.3-feat-runtime-remote-actions.2"
+    "@copilotkit/shared": "1.2.1"
   },
   "keywords": [
     "copilotkit",
@@ -74,8 +74,6 @@
     "test": "jest --passWithNoTests",
     "check-types": "tsc --noEmit",
     "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist && rm -rf .next && rm -rf __snapshots__",
-    "generate-graphql-schema": "rm -rf __snapshots__ && ts-node ./scripts/generate-gql-schema.ts",
-    "link:global": "pnpm link --global",
-    "unlink:global": "pnpm unlink --global"
+    "generate-graphql-schema": "rm -rf __snapshots__ && ts-node ./scripts/generate-gql-schema.ts"
   }
 }

package/src/graphql/inputs/generate-copilot-response.input.ts

@@ -4,8 +4,6 @@ import { FrontendInput } from "./frontend.input";
 import { CloudInput } from "./cloud.input";
 import { CopilotRequestType } from "../types/enums";
 import { ForwardedParametersInput } from "./forwarded-parameters.input";
-import { AgentSessionInput } from "./agent-session.input";
-import { AgentStateInput } from "./agent-state.input";
 
 @InputType()
 export class GenerateCopilotResponseMetadataInput {
@@ -35,13 +33,4 @@ export class GenerateCopilotResponseInput {
 
   @Field(() => ForwardedParametersInput, { nullable: true })
   forwardedParameters?: ForwardedParametersInput;
-
-  @Field(() => AgentSessionInput, { nullable: true })
-  agentSession?: AgentSessionInput;
-
-  @Field(() => AgentStateInput, { nullable: true })
-  agentState?: AgentStateInput;
-
-  @Field(() => [AgentStateInput], { nullable: true })
-  agentStates?: AgentStateInput[];
 }

package/src/graphql/inputs/message.input.ts

@@ -14,9 +14,6 @@ export class MessageInput extends BaseMessage {
 
   @Field(() => ResultMessageInput, { nullable: true })
   resultMessage?: ResultMessageInput;
-
-  @Field(() => AgentStateMessageInput, { nullable: true })
-  agentStateMessage?: AgentStateMessageInput;
 }
 
 @InputType()
@@ -51,30 +48,3 @@ export class ResultMessageInput {
   @Field(() => String)
   result: string;
 }
-
-@InputType()
-export class AgentStateMessageInput {
-  @Field(() => String)
-  threadId: string;
-
-  @Field(() => String)
-  agentName: string;
-
-  @Field(() => MessageRole)
-  role: MessageRole;
-
-  @Field(() => String)
-  state: string;
-
-  @Field(() => Boolean)
-  running: boolean;
-
-  @Field(() => String)
-  nodeName: string;
-
-  @Field(() => String)
-  runId: string;
-
-  @Field(() => Boolean)
-  active: boolean;
-}

package/src/graphql/resolvers/copilot.resolver.ts

@@ -32,13 +32,7 @@ import {
   MessageStreamInterruptedResponse,
   UnknownErrorResponse,
 } from "../../utils";
-import {
-  ActionExecutionMessage,
-  AgentStateMessage,
-  Message,
-  ResultMessage,
-  TextMessage,
-} from "../types/converted";
+import { ActionExecutionMessage, Message, ResultMessage, TextMessage } from "../types/converted";
 import telemetry from "../../lib/telemetry-client";
 import { randomId } from "@copilotkit/shared";
 
@@ -55,6 +49,8 @@ const invokeGuardrails = async ({
   onResult: (result: GuardrailsResult) => void;
   onError: (err: Error) => void;
 }) => {
+  console.log("invokeGuardrails.baseUrl", baseUrl);
+
   if (
     data.messages.length &&
     data.messages[data.messages.length - 1].textMessage?.role === MessageRole.user
@@ -120,14 +116,14 @@ export class CopilotResolver {
     let logger = ctx.logger.child({ component: "CopilotResolver.generateCopilotResponse" });
     logger.debug({ data }, "Generating Copilot response");
 
+    const copilotRuntime = ctx._copilotkit.runtime;
+    const serviceAdapter = ctx._copilotkit.serviceAdapter;
+
     if (properties) {
       logger.debug("Properties provided, merging with context properties");
       ctx.properties = { ...ctx.properties, ...properties };
     }
 
-    const copilotRuntime = ctx._copilotkit.runtime;
-    const serviceAdapter = ctx._copilotkit.serviceAdapter;
-
     let copilotCloudPublicApiKey: string | null = null;
     let copilotCloudBaseUrl: string;
 
@@ -173,20 +169,17 @@ export class CopilotResolver {
       eventSource,
       threadId = randomId(),
       runId,
-      serverSideActions,
-      actionInputsWithoutAgents,
-    } = await copilotRuntime.processRuntimeRequest({
+      actions,
+    } = await copilotRuntime.process({
       serviceAdapter,
       messages: data.messages,
       actions: data.frontend.actions,
       threadId: data.threadId,
       runId: data.runId,
       publicApiKey: undefined,
+      properties: ctx.properties || {},
       outputMessagesPromise,
-      graphqlContext: ctx,
       forwardedParameters: data.forwardedParameters,
-      agentSession: data.agentSession,
-      agentStates: data.agentStates,
       url: data.frontend.url,
     });
 
@@ -254,14 +247,9 @@ export class CopilotResolver {
 
         // run and process the event stream
         const eventStream = eventSource
-          .processRuntimeEvents({
-            serverSideActions,
+          .process({
+            serversideActions: actions,
             guardrailsResult$: data.cloud?.guardrails ? guardrailsResult$ : null,
-            actionInputsWithoutAgents: actionInputsWithoutAgents.filter(
-              // TODO-AGENTS: do not exclude ALL server side actions
-              (action) =>
-                !serverSideActions.find((serverSideAction) => serverSideAction.name == action.name),
-            ),
           })
           .pipe(
             // shareReplay() ensures that later subscribers will see the whole stream instead of
@@ -293,6 +281,7 @@ export class CopilotResolver {
                 const streamingTextStatus = new Subject<typeof MessageStatusUnion>();
 
                 const messageId = randomId();
+
                 // push the new message
                 pushMessage({
                   id: messageId,
@@ -444,39 +433,6 @@ export class CopilotResolver {
                   }),
                 );
                 break;
-              ////////////////////////////////
-              // AgentStateMessage
-              ////////////////////////////////
-              case RuntimeEventTypes.AgentStateMessage:
-                logger.debug({ event }, "Agent message event received");
-                pushMessage({
-                  id: randomId(),
-                  status: new SuccessMessageStatus(),
-                  threadId: event.threadId,
-                  agentName: event.agentName,
-                  nodeName: event.nodeName,
-                  runId: event.runId,
-                  active: event.active,
-                  state: event.state,
-                  running: event.running,
-                  role: MessageRole.assistant,
-                  createdAt: new Date(),
-                });
-                outputMessages.push(
-                  plainToInstance(AgentStateMessage, {
-                    id: randomId(),
-                    threadId: event.threadId,
-                    agentName: event.agentName,
-                    nodeName: event.nodeName,
-                    runId: event.runId,
-                    active: event.active,
-                    state: event.state,
-                    running: event.running,
-                    role: MessageRole.assistant,
-                    createdAt: new Date(),
-                  }),
-                );
-                break;
             }
           },
           error: (err) => {

package/src/graphql/types/converted/index.ts

@@ -2,7 +2,6 @@ import {
   ActionExecutionMessageInput,
   ResultMessageInput,
   TextMessageInput,
-  AgentStateMessageInput,
 } from "../../inputs/message.input";
 import { BaseMessage } from "../base";
 import { ActionExecutionScope, MessageRole } from "../enums";
@@ -28,17 +27,3 @@ export class ResultMessage extends BaseMessage implements ResultMessageInput {
   actionName: string;
   result: string;
 }
-
-export class AgentStateMessage
-  extends BaseMessage
-  implements Omit<AgentStateMessageInput, "state">
-{
-  threadId: string;
-  agentName: string;
-  nodeName: string;
-  runId: string;
-  active: boolean;
-  role: MessageRole;
-  state: any;
-  running: boolean;
-}

package/src/graphql/types/copilot-response.type.ts

@@ -11,8 +11,6 @@ import { ResponseStatusUnion } from "./response-status.type";
       return ActionExecutionMessageOutput;
     } else if (value.hasOwnProperty("result")) {
       return ResultMessageOutput;
-    } else if (value.hasOwnProperty("state")) {
-      return AgentStateMessageOutput;
     }
     return undefined;
   },
@@ -61,33 +59,6 @@ export class ResultMessageOutput {
   result: string;
 }
 
-@ObjectType({ implements: BaseMessageOutput })
-export class AgentStateMessageOutput {
-  @Field(() => String)
-  threadId: string;
-
-  @Field(() => String)
-  agentName: string;
-
-  @Field(() => String)
-  nodeName: string;
-
-  @Field(() => String)
-  runId: string;
-
-  @Field(() => Boolean)
-  active: boolean;
-
-  @Field(() => MessageRole)
-  role: MessageRole;
-
-  @Field(() => String)
-  state: string;
-
-  @Field(() => Boolean)
-  running: boolean;
-}
-
 @ObjectType()
 export class CopilotResponse {
   @Field(() => String)

package/src/graphql/types/enums.ts

@@ -9,7 +9,6 @@ export enum MessageRole {
 export enum ActionExecutionScope {
   server = "server",
   client = "client",
-  passThrough = "passThrough",
 }
 
 export enum CopilotRequestType {

package/src/lib/copilot-runtime.ts

@@ -0,0 +1,231 @@
+/**
+ * <Callout type="info">
+ *   This is the reference for the `CopilotRuntime` class. For more information and example code snippets, please see [Concept: Copilot Runtime](/concepts/copilot-runtime).
+ * </Callout>
+ *
+ * ## Usage
+ *
+ * ```tsx
+ * import { CopilotRuntime } from "@copilotkit/runtime";
+ *
+ * const copilotKit = new CopilotRuntime();
+ * ```
+ */
+
+import { Action, actionParametersToJsonSchema, Parameter } from "@copilotkit/shared";
+import { RemoteChain, RemoteChainParameters, CopilotServiceAdapter } from "../service-adapters";
+import { MessageInput } from "../graphql/inputs/message.input";
+import { ActionInput } from "../graphql/inputs/action.input";
+import { RuntimeEventSource } from "../service-adapters/events";
+import { convertGqlInputToMessages } from "../service-adapters/conversion";
+import { Message } from "../graphql/types/converted";
+import { ForwardedParametersInput } from "../graphql/inputs/forwarded-parameters.input";
+
+interface CopilotRuntimeRequest {
+  serviceAdapter: CopilotServiceAdapter;
+  messages: MessageInput[];
+  actions: ActionInput[];
+  outputMessagesPromise: Promise<Message[]>;
+  properties: any;
+  threadId?: string;
+  runId?: string;
+  publicApiKey?: string;
+  url?: string;
+  forwardedParameters?: ForwardedParametersInput;
+}
+
+interface CopilotRuntimeResponse {
+  threadId: string;
+  runId?: string;
+  eventSource: RuntimeEventSource;
+  actions: Action<any>[];
+}
+
+type ActionsConfiguration<T extends Parameter[] | [] = []> =
+  | Action<T>[]
+  | ((ctx: { properties: any; url?: string }) => Action<T>[]);
+
+interface OnBeforeRequestOptions {
+  threadId?: string;
+  runId?: string;
+  inputMessages: Message[];
+  properties: any;
+  url?: string;
+}
+
+type OnBeforeRequestHandler = (options: OnBeforeRequestOptions) => void | Promise<void>;
+
+interface OnAfterRequestOptions {
+  threadId: string;
+  runId?: string;
+  inputMessages: Message[];
+  outputMessages: Message[];
+  properties: any;
+  url?: string;
+}
+
+type OnAfterRequestHandler = (options: OnAfterRequestOptions) => void | Promise<void>;
+
+interface Middleware {
+  /**
+   * A function that is called before the request is processed.
+   */
+  onBeforeRequest?: OnBeforeRequestHandler;
+
+  /**
+   * A function that is called after the request is processed.
+   */
+  onAfterRequest?: OnAfterRequestHandler;
+}
+
+export interface CopilotRuntimeConstructorParams<T extends Parameter[] | [] = []> {
+  /**
+   * Middleware to be used by the runtime.
+   *
+   * ```ts
+   * onBeforeRequest: (options: {
+   *   threadId?: string;
+   *   runId?: string;
+   *   inputMessages: Message[];
+   *   properties: any;
+   * }) => void | Promise<void>;
+   * ```
+   *
+   * ```ts
+   * onAfterRequest: (options: {
+   *   threadId?: string;
+   *   runId?: string;
+   *   inputMessages: Message[];
+   *   outputMessages: Message[];
+   *   properties: any;
+   * }) => void | Promise<void>;
+   * ```
+   */
+  middleware?: Middleware;
+
+  /*
+   * A list of server side actions that can be executed.
+   */
+  actions?: ActionsConfiguration<T>;
+
+  /*
+   * An array of LangServer URLs.
+   */
+  langserve?: RemoteChainParameters[];
+}
+
+export class CopilotRuntime<const T extends Parameter[] | [] = []> {
+  public actions: ActionsConfiguration<T>;
+  private langserve: Promise<Action<any>>[] = [];
+  private onBeforeRequest?: OnBeforeRequestHandler;
+  private onAfterRequest?: OnAfterRequestHandler;
+
+  constructor(params?: CopilotRuntimeConstructorParams<T>) {
+    this.actions = params?.actions || [];
+
+    for (const chain of params?.langserve || []) {
+      const remoteChain = new RemoteChain(chain);
+      this.langserve.push(remoteChain.toAction());
+    }
+
+    this.onBeforeRequest = params?.middleware?.onBeforeRequest;
+    this.onAfterRequest = params?.middleware?.onAfterRequest;
+  }
+
+  async process(request: CopilotRuntimeRequest): Promise<CopilotRuntimeResponse> {
+    const {
+      serviceAdapter,
+      messages,
+      actions: clientSideActionsInput,
+      threadId,
+      runId,
+      properties,
+      outputMessagesPromise,
+      forwardedParameters,
+      url,
+    } = request;
+    const langserveFunctions: Action<any>[] = [];
+
+    for (const chainPromise of this.langserve) {
+      try {
+        const chain = await chainPromise;
+        langserveFunctions.push(chain);
+      } catch (error) {
+        console.error("Error loading langserve chain:", error);
+      }
+    }
+
+    const configuredActions =
+      typeof this.actions === "function" ? this.actions({ properties, url }) : this.actions;
+
+    const actions = [...configuredActions, ...langserveFunctions];
+
+    const serverSideActionsInput: ActionInput[] = actions.map((action) => ({
+      name: action.name,
+      description: action.description,
+      jsonSchema: JSON.stringify(actionParametersToJsonSchema(action.parameters)),
+    }));
+
+    const actionInputs = flattenToolCallsNoDuplicates([
+      ...serverSideActionsInput,
+      ...clientSideActionsInput,
+    ]);
+    const inputMessages = convertGqlInputToMessages(messages);
+
+    await this.onBeforeRequest?.({
+      threadId,
+      runId,
+      inputMessages,
+      properties,
+      url,
+    });
+
+    try {
+      const eventSource = new RuntimeEventSource();
+
+      const result = await serviceAdapter.process({
+        messages: inputMessages,
+        actions: actionInputs,
+        threadId,
+        runId,
+        eventSource,
+        forwardedParameters,
+      });
+
+      outputMessagesPromise
+        .then((outputMessages) => {
+          this.onAfterRequest?.({
+            threadId: result.threadId,
+            runId: result.runId,
+            inputMessages,
+            outputMessages,
+            properties,
+            url,
+          });
+        })
+        .catch((_error) => {});
+
+      return {
+        threadId: result.threadId,
+        runId: result.runId,
+        eventSource,
+        actions: actions,
+      };
+    } catch (error) {
+      console.error("Error getting response:", error);
+      throw error;
+    }
+  }
+}
+
+export function flattenToolCallsNoDuplicates(toolsByPriority: ActionInput[]): ActionInput[] {
+  let allTools: ActionInput[] = [];
+  const allToolNames: string[] = [];
+  for (const tool of toolsByPriority) {
+    if (!allToolNames.includes(tool.name)) {
+      allTools.push(tool);
+      allToolNames.push(tool.name);
+    }
+  }
+  return allTools;
+}

package/src/lib/index.ts

@@ -1,4 +1,4 @@
-export * from "./runtime/copilot-runtime";
+export * from "./copilot-runtime";
 export * from "../service-adapters/openai/openai-adapter";
 export * from "../service-adapters/langchain/langchain-adapter";
 export * from "../service-adapters/google/google-genai-adapter";

package/src/lib/integrations/shared.ts

@@ -2,7 +2,7 @@ import { YogaInitialContext } from "graphql-yoga";
 import { buildSchemaSync } from "type-graphql";
 import { CopilotResolver } from "../../graphql/resolvers/copilot.resolver";
 import { useDeferStream } from "@graphql-yoga/plugin-defer-stream";
-import { CopilotRuntime } from "../runtime/copilot-runtime";
+import { CopilotRuntime } from "../copilot-runtime";
 import { CopilotServiceAdapter } from "../../service-adapters";
 import { CopilotCloudOptions } from "../cloud";
 import { LogLevel, createLogger } from "../../lib/logger";

package/src/service-adapters/conversion.ts

@@ -3,7 +3,6 @@ import {
   Message,
   ResultMessage,
   TextMessage,
-  AgentStateMessage,
 } from "../graphql/types/converted";
 import { MessageInput } from "../graphql/inputs/message.input";
 import { plainToInstance } from "class-transformer";
@@ -41,21 +40,6 @@ export function convertGqlInputToMessages(inputMessages: MessageInput[]): Messag
           result: message.resultMessage.result,
         }),
       );
-    } else if (message.agentStateMessage) {
-      messages.push(
-        plainToInstance(AgentStateMessage, {
-          id: message.id,
-          threadId: message.agentStateMessage.threadId,
-          createdAt: message.createdAt,
-          agentName: message.agentStateMessage.agentName,
-          nodeName: message.agentStateMessage.nodeName,
-          runId: message.agentStateMessage.runId,
-          active: message.agentStateMessage.active,
-          role: message.agentStateMessage.role,
-          state: JSON.parse(message.agentStateMessage.state),
-          running: message.agentStateMessage.running,
-        }),
-      );
     }
   }