@copilotkit/runtime 1.0.0-beta.0 → 1.0.0-beta.1

package/dist/index.js

@@ -5,6 +5,9 @@ var __getOwnPropNames = Object.getOwnPropertyNames;
 var __getProtoOf = Object.getPrototypeOf;
 var __hasOwnProp = Object.prototype.hasOwnProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+var __commonJS = (cb, mod) => function __require() {
+  return mod || (0, cb[__getOwnPropNames(cb)[0]])((mod = { exports: {} }).exports, mod), mod.exports;
+};
 var __export = (target, all) => {
   for (var name in all)
     __defProp(target, name, { get: all[name], enumerable: true });
@@ -27,6 +30,77 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
+// package.json
+var require_package = __commonJS({
+  "package.json"(exports, module2) {
+    module2.exports = {
+      name: "@copilotkit/runtime",
+      private: false,
+      publishConfig: {
+        access: "public"
+      },
+      version: "1.0.0-beta.1",
+      sideEffects: false,
+      main: "./dist/index.js",
+      module: "./dist/index.mjs",
+      exports: {
+        ".": "./dist/index.js"
+      },
+      types: "./dist/index.d.ts",
+      license: "MIT",
+      scripts: {
+        build: "tsup --clean",
+        dev: 'tsup --watch --onSuccess "pnpm run generate-graphql-schema"',
+        test: "jest --passWithNoTests",
+        "check-types": "tsc --noEmit",
+        clean: "rm -rf .turbo && rm -rf node_modules && rm -rf dist && rm -rf .next",
+        "generate-graphql-schema": "rm -rf __snapshots__ && ts-node ./scripts/generate-gql-schema.ts"
+      },
+      devDependencies: {
+        "@swc/core": "1.5.28",
+        "@types/express": "^4.17.21",
+        "@types/jest": "^29.5.4",
+        "@types/node": "^18.11.17",
+        "@whatwg-node/server": "^0.9.34",
+        eslint: "^8.56.0",
+        "eslint-config-custom": "workspace:*",
+        jest: "^29.6.4",
+        nodemon: "^3.1.3",
+        "ts-jest": "^29.1.1",
+        "ts-node": "^10.9.2",
+        tsconfig: "workspace:*",
+        tsup: "^6.7.0",
+        typescript: "^5.2.3"
+      },
+      dependencies: {
+        "@copilotkit/shared": "workspace:*",
+        "@google/generative-ai": "^0.11.2",
+        "@graphql-yoga/plugin-defer-stream": "^3.3.1",
+        "@langchain/community": "^0.0.53",
+        "@langchain/core": "^0.1.61",
+        "@langchain/openai": "^0.0.28",
+        "class-transformer": "^0.5.1",
+        express: "^4.19.2",
+        graphql: "^16.8.1",
+        "graphql-scalars": "^1.23.0",
+        "graphql-yoga": "^5.3.1",
+        "groq-sdk": "^0.5.0",
+        "js-tiktoken": "^1.0.8",
+        langchain: "^0.1.36",
+        nanoid: "3.3.4",
+        openai: "^4.50.0",
+        pino: "^9.2.0",
+        "pino-pretty": "^11.2.1",
+        "reflect-metadata": "^0.2.2",
+        rxjs: "^7.8.1",
+        tiktoken: "^1.0.15",
+        "type-graphql": "2.0.0-rc.1",
+        zod: "^3.23.3"
+      }
+    };
+  }
+});
+
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
@@ -40,8 +114,10 @@ __export(src_exports, {
   UnknownErrorResponse: () => UnknownErrorResponse,
   buildSchema: () => buildSchema,
   config: () => config,
+  copilotRuntimeNestEndpoint: () => copilotRuntimeNestEndpoint,
   copilotRuntimeNextJSAppRouterEndpoint: () => copilotRuntimeNextJSAppRouterEndpoint,
   copilotRuntimeNextJSPagesRouterEndpoint: () => copilotRuntimeNextJSPagesRouterEndpoint,
+  copilotRuntimeNodeExpressEndpoint: () => copilotRuntimeNodeExpressEndpoint,
   copilotRuntimeNodeHttpEndpoint: () => copilotRuntimeNodeHttpEndpoint,
   createContext: () => createContext,
   flattenToolCallsNoDuplicates: () => flattenToolCallsNoDuplicates,
@@ -1280,6 +1356,14 @@ var ActionExecutionScope;
   ActionExecutionScope2["server"] = "server";
   ActionExecutionScope2["client"] = "client";
 })(ActionExecutionScope || (ActionExecutionScope = {}));
+var CopilotRequestType;
+(function(CopilotRequestType2) {
+  CopilotRequestType2["Chat"] = "Chat";
+  CopilotRequestType2["Task"] = "Task";
+  CopilotRequestType2["TextareaCompletion"] = "TextareaCompletion";
+  CopilotRequestType2["TextareaPopover"] = "TextareaPopover";
+  CopilotRequestType2["Suggestion"] = "Suggestion";
+})(CopilotRequestType || (CopilotRequestType = {}));
 (0, import_type_graphql2.registerEnumType)(MessageRole, {
   name: "MessageRole",
   description: "The role of the message"
@@ -1288,6 +1372,10 @@ var ActionExecutionScope;
   name: "ActionExecutionScope",
   description: "The scope of the action"
 });
+(0, import_type_graphql2.registerEnumType)(CopilotRequestType, {
+  name: "CopilotRequestType",
+  description: "The type of Copilot request"
+});
 
 // src/graphql/inputs/message.input.ts
 function _ts_decorate2(decorators, target, key, desc) {
@@ -1519,15 +1607,12 @@ GuardrailsRuleInput = _ts_decorate5([
   (0, import_type_graphql6.InputType)()
 ], GuardrailsRuleInput);
 var GuardrailsInput = class {
-  inputValidationRules = {
-    allowList: [],
-    denyList: []
-  };
+  inputValidationRules;
 };
 __name(GuardrailsInput, "GuardrailsInput");
 _ts_decorate5([
   (0, import_type_graphql6.Field)(() => GuardrailsRuleInput, {
-    nullable: true
+    nullable: false
   }),
   _ts_metadata5("design:type", typeof GuardrailsRuleInput === "undefined" ? Object : GuardrailsRuleInput)
 ], GuardrailsInput.prototype, "inputValidationRules", void 0);
@@ -1583,7 +1668,21 @@ function _ts_metadata7(k, v) {
     return Reflect.metadata(k, v);
 }
 __name(_ts_metadata7, "_ts_metadata");
+var GenerateCopilotResponseMetadataInput = class {
+  requestType;
+};
+__name(GenerateCopilotResponseMetadataInput, "GenerateCopilotResponseMetadataInput");
+_ts_decorate7([
+  (0, import_type_graphql8.Field)(() => CopilotRequestType, {
+    nullable: true
+  }),
+  _ts_metadata7("design:type", typeof CopilotRequestType === "undefined" ? Object : CopilotRequestType)
+], GenerateCopilotResponseMetadataInput.prototype, "requestType", void 0);
+GenerateCopilotResponseMetadataInput = _ts_decorate7([
+  (0, import_type_graphql8.InputType)()
+], GenerateCopilotResponseMetadataInput);
 var GenerateCopilotResponseInput = class {
+  metadata;
   threadId;
   runId;
   messages;
@@ -1591,6 +1690,12 @@ var GenerateCopilotResponseInput = class {
   cloud;
 };
 __name(GenerateCopilotResponseInput, "GenerateCopilotResponseInput");
+_ts_decorate7([
+  (0, import_type_graphql8.Field)(() => GenerateCopilotResponseMetadataInput, {
+    nullable: false
+  }),
+  _ts_metadata7("design:type", typeof GenerateCopilotResponseMetadataInput === "undefined" ? Object : GenerateCopilotResponseMetadataInput)
+], GenerateCopilotResponseInput.prototype, "metadata", void 0);
 _ts_decorate7([
   (0, import_type_graphql8.Field)(() => String, {
     nullable: true
@@ -1992,6 +2097,15 @@ var UnknownErrorResponse = class extends FailedResponseStatus {
 };
 __name(UnknownErrorResponse, "UnknownErrorResponse");
 
+// src/lib/telemetry-client.ts
+var import_shared2 = require("@copilotkit/shared");
+var packageJson = require_package();
+var telemetryClient = new import_shared2.TelemetryClient({
+  packageName: packageJson.name,
+  packageVersion: packageJson.version
+});
+var telemetry_client_default = telemetryClient;
+
 // src/graphql/resolvers/copilot.resolver.ts
 function _ts_decorate11(decorators, target, key, desc) {
   var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
@@ -2017,6 +2131,7 @@ function _ts_param(paramIndex, decorator) {
 __name(_ts_param, "_ts_param");
 var invokeGuardrails = /* @__PURE__ */ __name(async ({ baseUrl, copilotCloudPublicApiKey, data, onResult, onError }) => {
   var _a;
+  console.log("invokeGuardrails.baseUrl", baseUrl);
   if (data.messages.length && ((_a = data.messages[data.messages.length - 1].textMessage) == null ? void 0 : _a.role) === MessageRole.user) {
     const messages = data.messages.filter((m) => m.textMessage !== void 0 && (m.textMessage.role === MessageRole.user || m.textMessage.role === MessageRole.assistant)).map((m) => ({
       role: m.textMessage.role,
@@ -2051,6 +2166,11 @@ var CopilotResolver = class {
     return "Hello World";
   }
   async generateCopilotResponse(ctx, data, properties) {
+    var _a, _b, _c;
+    telemetry_client_default.capture("oss.runtime.copilot_request_created", {
+      "cloud.guardrails.enabled": ((_a = data.cloud) == null ? void 0 : _a.guardrails) !== void 0,
+      requestType: data.metadata.requestType
+    });
     let logger2 = ctx.logger.child({
       component: "CopilotResolver.generateCopilotResponse"
     });
@@ -2083,8 +2203,8 @@ var CopilotResolver = class {
       }
       if (process.env.COPILOT_CLOUD_BASE_URL) {
         copilotCloudBaseUrl = process.env.COPILOT_CLOUD_BASE_URL;
-      } else if (ctx._copilotkit.baseUrl) {
-        copilotCloudBaseUrl = ctx._copilotkit.baseUrl;
+      } else if ((_b = ctx._copilotkit.cloud) == null ? void 0 : _b.baseUrl) {
+        copilotCloudBaseUrl = (_c = ctx._copilotkit.cloud) == null ? void 0 : _c.baseUrl;
       } else {
         copilotCloudBaseUrl = "https://api.cloud.copilotkit.ai";
       }
@@ -2120,9 +2240,9 @@ var CopilotResolver = class {
       runId,
       status: (0, import_rxjs2.firstValueFrom)(responseStatus$),
       messages: new import_graphql_yoga.Repeater(async (pushMessage, stopStreamingMessages) => {
-        var _a, _b;
+        var _a2, _b2;
         logger2.debug("Messages repeater created");
-        if ((_a = data.cloud) == null ? void 0 : _a.guardrails) {
+        if ((_a2 = data.cloud) == null ? void 0 : _a2.guardrails) {
           logger2 = logger2.child({
             guardrails: true
           });
@@ -2171,7 +2291,7 @@ var CopilotResolver = class {
         let eventStreamSubscription;
         const eventStream = eventSource.process({
           serversideActions: actions,
-          guardrailsResult$: ((_b = data.cloud) == null ? void 0 : _b.guardrails) ? guardrailsResult$ : null
+          guardrailsResult$: ((_b2 = data.cloud) == null ? void 0 : _b2.guardrails) ? guardrailsResult$ : null
         }).pipe(
           // shareReplay() ensures that later subscribers will see the whole stream instead of
           // just the events that were emitted after the subscriber was added.
@@ -2333,9 +2453,9 @@ var CopilotResolver = class {
             rejectOutputMessagesPromise(err);
           },
           complete: async () => {
-            var _a2;
+            var _a3;
             logger2.debug("Event stream completed");
-            if ((_a2 = data.cloud) == null ? void 0 : _a2.guardrails) {
+            if ((_a3 = data.cloud) == null ? void 0 : _a3.guardrails) {
               logger2.debug("Guardrails is enabled, waiting for guardrails result");
               await (0, import_rxjs2.firstValueFrom)(guardrailsResult$);
             }
@@ -2444,10 +2564,20 @@ function getCommonConfig(options) {
     level: logLevel,
     component: "getCommonConfig"
   });
-  logger2.debug("Getting common config");
   const contextLogger = createLogger({
     level: logLevel
   });
+  if (options.cloud) {
+    telemetry_client_default.setCloudConfiguration({
+      publicApiKey: options.cloud.publicApiKey,
+      baseUrl: options.cloud.baseUrl
+    });
+  }
+  telemetry_client_default.setGlobalProperties({
+    runtime: {
+      serviceAdapter: options.serviceAdapter.constructor.name
+    }
+  });
   return {
     logging: createLogger({
       component: "Yoga GraphQL",
@@ -2466,6 +2596,12 @@ __name(getCommonConfig, "getCommonConfig");
 var import_graphql_yoga2 = require("graphql-yoga");
 function copilotRuntimeNextJSAppRouterEndpoint(options) {
   const commonConfig = getCommonConfig(options);
+  telemetry_client_default.setGlobalProperties({
+    runtime: {
+      framework: "nextjs-app-router"
+    }
+  });
+  telemetry_client_default.capture("oss.runtime.instance_created", {});
   const logger2 = commonConfig.logging;
   logger2.debug("Creating NextJS App Router endpoint");
   const yoga = (0, import_graphql_yoga2.createYoga)({
@@ -2493,6 +2629,12 @@ var config = {
 };
 function copilotRuntimeNextJSPagesRouterEndpoint(options) {
   const commonConfig = getCommonConfig(options);
+  telemetry_client_default.setGlobalProperties({
+    runtime: {
+      framework: "nextjs-pages-router"
+    }
+  });
+  telemetry_client_default.capture("oss.runtime.instance_created", {});
   const logger2 = commonConfig.logging;
   logger2.debug("Creating NextJS Pages Router endpoint");
   const yoga = (0, import_graphql_yoga3.createYoga)({
@@ -2507,6 +2649,12 @@ __name(copilotRuntimeNextJSPagesRouterEndpoint, "copilotRuntimeNextJSPagesRouter
 var import_graphql_yoga4 = require("graphql-yoga");
 function copilotRuntimeNodeHttpEndpoint(options) {
   const commonConfig = getCommonConfig(options);
+  telemetry_client_default.setGlobalProperties({
+    runtime: {
+      framework: "node-http"
+    }
+  });
+  telemetry_client_default.capture("oss.runtime.instance_created", {});
   const logger2 = commonConfig.logging;
   logger2.debug("Creating Node HTTP endpoint");
   const yoga = (0, import_graphql_yoga4.createYoga)({
@@ -2516,6 +2664,30 @@ function copilotRuntimeNodeHttpEndpoint(options) {
   return yoga;
 }
 __name(copilotRuntimeNodeHttpEndpoint, "copilotRuntimeNodeHttpEndpoint");
+
+// src/lib/integrations/node-express/index.ts
+function copilotRuntimeNodeExpressEndpoint(options) {
+  telemetry_client_default.setGlobalProperties({
+    runtime: {
+      framework: "node-express"
+    }
+  });
+  telemetry_client_default.capture("oss.runtime.instance_created", {});
+  return copilotRuntimeNodeHttpEndpoint(options);
+}
+__name(copilotRuntimeNodeExpressEndpoint, "copilotRuntimeNodeExpressEndpoint");
+
+// src/lib/integrations/nest/index.ts
+function copilotRuntimeNestEndpoint(options) {
+  telemetry_client_default.setGlobalProperties({
+    runtime: {
+      framework: "nest"
+    }
+  });
+  telemetry_client_default.capture("oss.runtime.instance_created", {});
+  return copilotRuntimeNodeHttpEndpoint(options);
+}
+__name(copilotRuntimeNestEndpoint, "copilotRuntimeNestEndpoint");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   CopilotRuntime,
@@ -2528,8 +2700,10 @@ __name(copilotRuntimeNodeHttpEndpoint, "copilotRuntimeNodeHttpEndpoint");
   UnknownErrorResponse,
   buildSchema,
   config,
+  copilotRuntimeNestEndpoint,
   copilotRuntimeNextJSAppRouterEndpoint,
   copilotRuntimeNextJSPagesRouterEndpoint,
+  copilotRuntimeNodeExpressEndpoint,
   copilotRuntimeNodeHttpEndpoint,
   createContext,
   flattenToolCallsNoDuplicates,