@copilotkit/shared 0.0.0-feat-dynamic-copilotcloud-qa-20250117190454

package/dist/utils/json-schema.test.mjs

@@ -0,0 +1,140 @@
+import {
+  convertJsonSchemaToZodSchema
+} from "../chunk-JP2M4U4G.mjs";
+
+// src/utils/json-schema.test.ts
+import { z } from "zod";
+import { zodToJsonSchema } from "zod-to-json-schema";
+describe("convertJsonSchemaToZodSchema", () => {
+  it("should convert a simple JSON schema to a Zod schema", () => {
+    const jsonSchema = {
+      type: "object",
+      properties: {
+        name: { type: "string" },
+        age: { type: "number" }
+      },
+      required: ["name", "age"]
+    };
+    const expectedSchema = z.object({
+      name: z.string(),
+      age: z.number()
+    });
+    const result = convertJsonSchemaToZodSchema(jsonSchema, true);
+    const resultSchemaJson = zodToJsonSchema(result);
+    const expectedSchemaJson = zodToJsonSchema(expectedSchema);
+    expect(resultSchemaJson).toStrictEqual(expectedSchemaJson);
+  });
+  it("should convert a JSON schema with nested objects to a Zod schema", () => {
+    const jsonSchema = {
+      type: "object",
+      properties: {
+        name: { type: "string" },
+        address: {
+          type: "object",
+          properties: {
+            street: { type: "string" },
+            city: { type: "string" }
+          },
+          required: ["street", "city"]
+        }
+      },
+      required: ["name", "address"]
+    };
+    const expectedSchema = z.object({
+      name: z.string(),
+      address: z.object({
+        street: z.string(),
+        city: z.string()
+      })
+    });
+    const result = convertJsonSchemaToZodSchema(jsonSchema, true);
+    const resultSchemaJson = zodToJsonSchema(result);
+    const expectedSchemaJson = zodToJsonSchema(expectedSchema);
+    expect(resultSchemaJson).toStrictEqual(expectedSchemaJson);
+  });
+  it("should convert a JSON schema with arrays to a Zod schema", () => {
+    const jsonSchema = {
+      type: "object",
+      properties: {
+        names: {
+          type: "array",
+          items: { type: "string" }
+        }
+      },
+      required: ["names"]
+    };
+    const expectedSchema = z.object({
+      names: z.array(z.string())
+    });
+    const result = convertJsonSchemaToZodSchema(jsonSchema, true);
+    const resultSchemaJson = zodToJsonSchema(result);
+    const expectedSchemaJson = zodToJsonSchema(expectedSchema);
+    expect(resultSchemaJson).toStrictEqual(expectedSchemaJson);
+  });
+  it("should convert a JSON schema with optional properties to a Zod schema", () => {
+    const jsonSchema = {
+      type: "object",
+      properties: {
+        name: { type: "string" },
+        age: { type: "number", required: false }
+      }
+    };
+    const expectedSchema = z.object({
+      name: z.string().optional(),
+      age: z.number().optional()
+    }).optional();
+    const result = convertJsonSchemaToZodSchema(jsonSchema, false);
+    console.log(convertJsonSchemaToZodSchema(jsonSchema, false));
+    const resultSchemaJson = zodToJsonSchema(result);
+    const expectedSchemaJson = zodToJsonSchema(expectedSchema);
+    expect(resultSchemaJson).toStrictEqual(expectedSchemaJson);
+  });
+  it("should convert a JSON schema with different types to a Zod schema", () => {
+    const jsonSchema = {
+      type: "object",
+      properties: {
+        name: { type: "string" },
+        age: { type: "number" },
+        isAdmin: { type: "boolean" }
+      },
+      required: ["name", "age", "isAdmin"]
+    };
+    const expectedSchema = z.object({
+      name: z.string(),
+      age: z.number(),
+      isAdmin: z.boolean()
+    });
+    const result = convertJsonSchemaToZodSchema(jsonSchema, true);
+    const resultSchemaJson = zodToJsonSchema(result);
+    const expectedSchemaJson = zodToJsonSchema(expectedSchema);
+    expect(resultSchemaJson).toStrictEqual(expectedSchemaJson);
+  });
+  it("should handle edge case where JSON schema has no properties", () => {
+    const jsonSchema = {
+      type: "object"
+    };
+    const expectedSchema = z.object({});
+    const result = convertJsonSchemaToZodSchema(jsonSchema, true);
+    const resultSchemaJson = zodToJsonSchema(result);
+    const expectedSchemaJson = zodToJsonSchema(expectedSchema);
+    expect(resultSchemaJson).toStrictEqual(expectedSchemaJson);
+  });
+  it("should handle edge case where JSON schema has no required properties", () => {
+    const jsonSchema = {
+      type: "object",
+      properties: {
+        name: { type: "string" },
+        age: { type: "number" }
+      }
+    };
+    const expectedSchema = z.object({
+      name: z.string().optional(),
+      age: z.number().optional()
+    }).optional();
+    const result = convertJsonSchemaToZodSchema(jsonSchema, false);
+    const resultSchemaJson = zodToJsonSchema(result);
+    const expectedSchemaJson = zodToJsonSchema(expectedSchema);
+    expect(resultSchemaJson).toStrictEqual(expectedSchemaJson);
+  });
+});
+//# sourceMappingURL=json-schema.test.mjs.map

package/dist/utils/json-schema.test.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utils/json-schema.test.ts"],"sourcesContent":["import { z } from \"zod\";\nimport { convertJsonSchemaToZodSchema } from \"../utils/json-schema\";\nimport { zodToJsonSchema } from \"zod-to-json-schema\";\n\ndescribe(\"convertJsonSchemaToZodSchema\", () => {\n  it(\"should convert a simple JSON schema to a Zod schema\", () => {\n    const jsonSchema = {\n      type: \"object\",\n      properties: {\n        name: { type: \"string\" },\n        age: { type: \"number\" },\n      },\n      required: [\"name\", \"age\"],\n    };\n\n    const expectedSchema = z.object({\n      name: z.string(),\n      age: z.number(),\n    });\n\n    const result = convertJsonSchemaToZodSchema(jsonSchema, true);\n    const resultSchemaJson = zodToJsonSchema(result);\n    const expectedSchemaJson = zodToJsonSchema(expectedSchema);\n\n    expect(resultSchemaJson).toStrictEqual(expectedSchemaJson);\n  });\n\n  it(\"should convert a JSON schema with nested objects to a Zod schema\", () => {\n    const jsonSchema = {\n      type: \"object\",\n      properties: {\n        name: { type: \"string\" },\n        address: {\n          type: \"object\",\n          properties: {\n            street: { type: \"string\" },\n            city: { type: \"string\" },\n          },\n          required: [\"street\", \"city\"],\n        },\n      },\n      required: [\"name\", \"address\"],\n    };\n\n    const expectedSchema = z.object({\n      name: z.string(),\n      address: z.object({\n        street: z.string(),\n        city: z.string(),\n      }),\n    });\n\n    const result = convertJsonSchemaToZodSchema(jsonSchema, true);\n    const resultSchemaJson = zodToJsonSchema(result);\n    const expectedSchemaJson = zodToJsonSchema(expectedSchema);\n\n    expect(resultSchemaJson).toStrictEqual(expectedSchemaJson);\n  });\n\n  it(\"should convert a JSON schema with arrays to a Zod schema\", () => {\n    const jsonSchema = {\n      type: \"object\",\n      properties: {\n        names: {\n          type: \"array\",\n          items: { type: \"string\" },\n        },\n      },\n      required: [\"names\"],\n    };\n\n    const expectedSchema = z.object({\n      names: z.array(z.string()),\n    });\n\n    const result = convertJsonSchemaToZodSchema(jsonSchema, true);\n    const resultSchemaJson = zodToJsonSchema(result);\n    const expectedSchemaJson = zodToJsonSchema(expectedSchema);\n\n    expect(resultSchemaJson).toStrictEqual(expectedSchemaJson);\n  });\n\n  it(\"should convert a JSON schema with optional properties to a Zod schema\", () => {\n    const jsonSchema = {\n      type: \"object\",\n      properties: {\n        name: { type: \"string\" },\n        age: { type: \"number\", required: false },\n      },\n    };\n\n    const expectedSchema = z\n      .object({\n        name: z.string().optional(),\n        age: z.number().optional(),\n      })\n      .optional();\n\n    const result = convertJsonSchemaToZodSchema(jsonSchema, false);\n\n    console.log(convertJsonSchemaToZodSchema(jsonSchema, false));\n\n    const resultSchemaJson = zodToJsonSchema(result);\n    const expectedSchemaJson = zodToJsonSchema(expectedSchema);\n\n    expect(resultSchemaJson).toStrictEqual(expectedSchemaJson);\n  });\n\n  it(\"should convert a JSON schema with different types to a Zod schema\", () => {\n    const jsonSchema = {\n      type: \"object\",\n      properties: {\n        name: { type: \"string\" },\n        age: { type: \"number\" },\n        isAdmin: { type: \"boolean\" },\n      },\n      required: [\"name\", \"age\", \"isAdmin\"],\n    };\n\n    const expectedSchema = z.object({\n      name: z.string(),\n      age: z.number(),\n      isAdmin: z.boolean(),\n    });\n\n    const result = convertJsonSchemaToZodSchema(jsonSchema, true);\n    const resultSchemaJson = zodToJsonSchema(result);\n    const expectedSchemaJson = zodToJsonSchema(expectedSchema);\n\n    expect(resultSchemaJson).toStrictEqual(expectedSchemaJson);\n  });\n\n  it(\"should handle edge case where JSON schema has no properties\", () => {\n    const jsonSchema = {\n      type: \"object\",\n    };\n\n    const expectedSchema = z.object({});\n\n    const result = convertJsonSchemaToZodSchema(jsonSchema, true);\n    const resultSchemaJson = zodToJsonSchema(result);\n    const expectedSchemaJson = zodToJsonSchema(expectedSchema);\n\n    expect(resultSchemaJson).toStrictEqual(expectedSchemaJson);\n  });\n\n  it(\"should handle edge case where JSON schema has no required properties\", () => {\n    const jsonSchema = {\n      type: \"object\",\n      properties: {\n        name: { type: \"string\" },\n        age: { type: \"number\" },\n      },\n    };\n\n    const expectedSchema = z\n      .object({\n        name: z.string().optional(),\n        age: z.number().optional(),\n      })\n      .optional();\n\n    const result = convertJsonSchemaToZodSchema(jsonSchema, false);\n    const resultSchemaJson = zodToJsonSchema(result);\n    const expectedSchemaJson = zodToJsonSchema(expectedSchema);\n\n    expect(resultSchemaJson).toStrictEqual(expectedSchemaJson);\n  });\n});\n"],"mappings":";;;;;AAAA,SAAS,SAAS;AAElB,SAAS,uBAAuB;AAEhC,SAAS,gCAAgC,MAAM;AAC7C,KAAG,uDAAuD,MAAM;AAC9D,UAAM,aAAa;AAAA,MACjB,MAAM;AAAA,MACN,YAAY;AAAA,QACV,MAAM,EAAE,MAAM,SAAS;AAAA,QACvB,KAAK,EAAE,MAAM,SAAS;AAAA,MACxB;AAAA,MACA,UAAU,CAAC,QAAQ,KAAK;AAAA,IAC1B;AAEA,UAAM,iBAAiB,EAAE,OAAO;AAAA,MAC9B,MAAM,EAAE,OAAO;AAAA,MACf,KAAK,EAAE,OAAO;AAAA,IAChB,CAAC;AAED,UAAM,SAAS,6BAA6B,YAAY,IAAI;AAC5D,UAAM,mBAAmB,gBAAgB,MAAM;AAC/C,UAAM,qBAAqB,gBAAgB,cAAc;AAEzD,WAAO,gBAAgB,EAAE,cAAc,kBAAkB;AAAA,EAC3D,CAAC;AAED,KAAG,oEAAoE,MAAM;AAC3E,UAAM,aAAa;AAAA,MACjB,MAAM;AAAA,MACN,YAAY;AAAA,QACV,MAAM,EAAE,MAAM,SAAS;AAAA,QACvB,SAAS;AAAA,UACP,MAAM;AAAA,UACN,YAAY;AAAA,YACV,QAAQ,EAAE,MAAM,SAAS;AAAA,YACzB,MAAM,EAAE,MAAM,SAAS;AAAA,UACzB;AAAA,UACA,UAAU,CAAC,UAAU,MAAM;AAAA,QAC7B;AAAA,MACF;AAAA,MACA,UAAU,CAAC,QAAQ,SAAS;AAAA,IAC9B;AAEA,UAAM,iBAAiB,EAAE,OAAO;AAAA,MAC9B,MAAM,EAAE,OAAO;AAAA,MACf,SAAS,EAAE,OAAO;AAAA,QAChB,QAAQ,EAAE,OAAO;AAAA,QACjB,MAAM,EAAE,OAAO;AAAA,MACjB,CAAC;AAAA,IACH,CAAC;AAED,UAAM,SAAS,6BAA6B,YAAY,IAAI;AAC5D,UAAM,mBAAmB,gBAAgB,MAAM;AAC/C,UAAM,qBAAqB,gBAAgB,cAAc;AAEzD,WAAO,gBAAgB,EAAE,cAAc,kBAAkB;AAAA,EAC3D,CAAC;AAED,KAAG,4DAA4D,MAAM;AACnE,UAAM,aAAa;AAAA,MACjB,MAAM;AAAA,MACN,YAAY;AAAA,QACV,OAAO;AAAA,UACL,MAAM;AAAA,UACN,OAAO,EAAE,MAAM,SAAS;AAAA,QAC1B;AAAA,MACF;AAAA,MACA,UAAU,CAAC,OAAO;AAAA,IACpB;AAEA,UAAM,iBAAiB,EAAE,OAAO;AAAA,MAC9B,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC;AAAA,IAC3B,CAAC;AAED,UAAM,SAAS,6BAA6B,YAAY,IAAI;AAC5D,UAAM,mBAAmB,gBAAgB,MAAM;AAC/C,UAAM,qBAAqB,gBAAgB,cAAc;AAEzD,WAAO,gBAAgB,EAAE,cAAc,kBAAkB;AAAA,EAC3D,CAAC;AAED,KAAG,yEAAyE,MAAM;AAChF,UAAM,aAAa;AAAA,MACjB,MAAM;AAAA,MACN,YAAY;AAAA,QACV,MAAM,EAAE,MAAM,SAAS;AAAA,QACvB,KAAK,EAAE,MAAM,UAAU,UAAU,MAAM;AAAA,MACzC;AAAA,IACF;AAEA,UAAM,iBAAiB,EACpB,OAAO;AAAA,MACN,MAAM,EAAE,OAAO,EAAE,SAAS;AAAA,MAC1B,KAAK,EAAE,OAAO,EAAE,SAAS;AAAA,IAC3B,CAAC,EACA,SAAS;AAEZ,UAAM,SAAS,6BAA6B,YAAY,KAAK;AAE7D,YAAQ,IAAI,6BAA6B,YAAY,KAAK,CAAC;AAE3D,UAAM,mBAAmB,gBAAgB,MAAM;AAC/C,UAAM,qBAAqB,gBAAgB,cAAc;AAEzD,WAAO,gBAAgB,EAAE,cAAc,kBAAkB;AAAA,EAC3D,CAAC;AAED,KAAG,qEAAqE,MAAM;AAC5E,UAAM,aAAa;AAAA,MACjB,MAAM;AAAA,MACN,YAAY;AAAA,QACV,MAAM,EAAE,MAAM,SAAS;AAAA,QACvB,KAAK,EAAE,MAAM,SAAS;AAAA,QACtB,SAAS,EAAE,MAAM,UAAU;AAAA,MAC7B;AAAA,MACA,UAAU,CAAC,QAAQ,OAAO,SAAS;AAAA,IACrC;AAEA,UAAM,iBAAiB,EAAE,OAAO;AAAA,MAC9B,MAAM,EAAE,OAAO;AAAA,MACf,KAAK,EAAE,OAAO;AAAA,MACd,SAAS,EAAE,QAAQ;AAAA,IACrB,CAAC;AAED,UAAM,SAAS,6BAA6B,YAAY,IAAI;AAC5D,UAAM,mBAAmB,gBAAgB,MAAM;AAC/C,UAAM,qBAAqB,gBAAgB,cAAc;AAEzD,WAAO,gBAAgB,EAAE,cAAc,kBAAkB;AAAA,EAC3D,CAAC;AAED,KAAG,+DAA+D,MAAM;AACtE,UAAM,aAAa;AAAA,MACjB,MAAM;AAAA,IACR;AAEA,UAAM,iBAAiB,EAAE,OAAO,CAAC,CAAC;AAElC,UAAM,SAAS,6BAA6B,YAAY,IAAI;AAC5D,UAAM,mBAAmB,gBAAgB,MAAM;AAC/C,UAAM,qBAAqB,gBAAgB,cAAc;AAEzD,WAAO,gBAAgB,EAAE,cAAc,kBAAkB;AAAA,EAC3D,CAAC;AAED,KAAG,wEAAwE,MAAM;AAC/E,UAAM,aAAa;AAAA,MACjB,MAAM;AAAA,MACN,YAAY;AAAA,QACV,MAAM,EAAE,MAAM,SAAS;AAAA,QACvB,KAAK,EAAE,MAAM,SAAS;AAAA,MACxB;AAAA,IACF;AAEA,UAAM,iBAAiB,EACpB,OAAO;AAAA,MACN,MAAM,EAAE,OAAO,EAAE,SAAS;AAAA,MAC1B,KAAK,EAAE,OAAO,EAAE,SAAS;AAAA,IAC3B,CAAC,EACA,SAAS;AAEZ,UAAM,SAAS,6BAA6B,YAAY,KAAK;AAC7D,UAAM,mBAAmB,gBAAgB,MAAM;AAC/C,UAAM,qBAAqB,gBAAgB,cAAc;AAEzD,WAAO,gBAAgB,EAAE,cAAc,kBAAkB;AAAA,EAC3D,CAAC;AACH,CAAC;","names":[]}

package/dist/utils/random-id.d.ts

@@ -0,0 +1,3 @@
+declare function randomId(): string;
+
+export { randomId };

package/dist/utils/random-id.js

@@ -0,0 +1,34 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/utils/random-id.ts
+var random_id_exports = {};
+__export(random_id_exports, {
+  randomId: () => randomId
+});
+module.exports = __toCommonJS(random_id_exports);
+var import_uuid = require("uuid");
+function randomId() {
+  return "ck-" + (0, import_uuid.v4)();
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  randomId
+});
+//# sourceMappingURL=random-id.js.map

package/dist/utils/random-id.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/utils/random-id.ts"],"sourcesContent":["import { v4 as uuidv4 } from \"uuid\";\n\nexport function randomId() {\n  return \"ck-\" + uuidv4();\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,kBAA6B;AAEtB,SAAS,WAAW;AACzB,SAAO,YAAQ,YAAAA,IAAO;AACxB;","names":["uuidv4"]}

package/dist/utils/random-id.mjs

@@ -0,0 +1,7 @@
+import {
+  randomId
+} from "../chunk-RIPX6APP.mjs";
+export {
+  randomId
+};
+//# sourceMappingURL=random-id.mjs.map

package/dist/utils/random-id.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/jest.config.js

@@ -0,0 +1,5 @@
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+module.exports = {
+  preset: 'ts-jest',
+  testEnvironment: 'node',
+};

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@copilotkit/shared",
+  "private": false,
+  "homepage": "https://github.com/CopilotKit/CopilotKit",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/CopilotKit/CopilotKit.git"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "0.0.0-feat-dynamic-copilotcloud-qa-20250117190454",
+  "sideEffects": false,
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "types": "./dist/index.d.ts",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/jest": "^29.5.4",
+    "@types/uuid": "^10.0.0",
+    "eslint": "^8.56.0",
+    "jest": "^29.6.4",
+    "ts-jest": "^29.1.1",
+    "tsup": "^6.7.0",
+    "typescript": "^5.2.3",
+    "eslint-config-custom": "1.4.6",
+    "tsconfig": "1.4.6"
+  },
+  "dependencies": {
+    "@segment/analytics-node": "^2.1.2",
+    "chalk": "4.1.2",
+    "uuid": "^10.0.0",
+    "zod": "^3.23.3",
+    "zod-to-json-schema": "^3.23.5"
+  },
+  "keywords": [
+    "copilotkit",
+    "copilot",
+    "react",
+    "nextjs",
+    "nodejs",
+    "ai",
+    "assistant",
+    "javascript",
+    "automation",
+    "textarea"
+  ],
+  "scripts": {
+    "build": "tsup --clean",
+    "dev": "tsup --watch --no-splitting",
+    "test": "jest --passWithNoTests",
+    "check-types": "tsc --noEmit",
+    "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist && rm -rf .next",
+    "link:global": "pnpm link --global",
+    "unlink:global": "pnpm unlink --global"
+  }
+}

package/src/constants/index.ts

@@ -0,0 +1,4 @@
+export const COPILOT_CLOUD_API_URL = "https://api.cloud.copilotkit.ai";
+export const COPILOT_CLOUD_VERSION = "v1";
+export const COPILOT_CLOUD_CHAT_URL = `${COPILOT_CLOUD_API_URL}/copilotkit/${COPILOT_CLOUD_VERSION}`;
+export const COPILOT_CLOUD_PUBLIC_API_KEY_HEADER = "X-CopilotCloud-Public-Api-Key";

package/src/index.ts

@@ -0,0 +1,7 @@
+export * from "./types";
+export * from "./utils";
+export * from "./constants";
+export * from "./telemetry";
+
+import * as packageJson from "../package.json";
+export const COPILOTKIT_VERSION = packageJson.version;

package/src/telemetry/events.ts

@@ -0,0 +1,35 @@
+export type AnalyticsEvents = {
+  "oss.runtime.instance_created": RuntimeInstanceCreatedInfo;
+  "oss.runtime.copilot_request_created": {
+    "cloud.guardrails.enabled": boolean;
+    requestType: string;
+  };
+  "oss.runtime.server_action_executed": {};
+  "oss.runtime.remote_action_executed": RemoteActionExecutionInfo;
+  "oss.runtime.agent_execution_stream_started": { hashedLgcKey?: string };
+  "oss.runtime.agent_execution_stream_ended": AgentExecutionResponseInfo;
+  "oss.runtime.agent_execution_stream_errored": { hashedLgcKey?: string; error?: string };
+};
+
+export interface RuntimeInstanceCreatedInfo {
+  actionsAmount: number;
+  endpointTypes: string[];
+  hashedLgcKey?: string;
+  endpointsAmount: number;
+  agentsAmount?: number | null;
+}
+
+export interface RemoteActionExecutionInfo {
+  agentExecution: boolean;
+  type: "self-hosted" | "langgraph-platform";
+  agentsAmount?: number | null;
+  hashedLgcKey?: string;
+}
+
+export interface AgentExecutionResponseInfo {
+  provider?: string;
+  model?: string;
+  langGraphHost?: string;
+  langGraphVersion?: string;
+  hashedLgcKey?: string;
+}

package/src/telemetry/index.ts

@@ -0,0 +1 @@
+export * from "./telemetry-client";

package/src/telemetry/telemetry-client.ts

@@ -0,0 +1,126 @@
+import { Analytics } from "@segment/analytics-node";
+import { AnalyticsEvents } from "./events";
+import { flattenObject, printSecurityNotice } from "./utils";
+import { v4 as uuidv4 } from "uuid";
+
+export class TelemetryClient {
+  segment: Analytics | undefined;
+  globalProperties: Record<string, any> = {};
+  cloudConfiguration: { publicApiKey: string; baseUrl: string } | null = null;
+  packageName: string;
+  packageVersion: string;
+  private telemetryDisabled: boolean = false;
+  private sampleRate: number = 0.05;
+  private anonymousId = `anon_${uuidv4()}`;
+
+  constructor({
+    packageName,
+    packageVersion,
+    telemetryDisabled,
+    telemetryBaseUrl,
+    sampleRate,
+  }: {
+    packageName: string;
+    packageVersion: string;
+    telemetryDisabled?: boolean;
+    telemetryBaseUrl?: string;
+    sampleRate?: number;
+  }) {
+    this.packageName = packageName;
+    this.packageVersion = packageVersion;
+    this.telemetryDisabled =
+      telemetryDisabled ||
+      (process.env as any).COPILOTKIT_TELEMETRY_DISABLED === "true" ||
+      (process.env as any).COPILOTKIT_TELEMETRY_DISABLED === "1" ||
+      (process.env as any).DO_NOT_TRACK === "true" ||
+      (process.env as any).DO_NOT_TRACK === "1";
+
+    if (this.telemetryDisabled) {
+      return;
+    }
+
+    this.setSampleRate(sampleRate);
+
+    // eslint-disable-next-line
+    const writeKey = process.env.COPILOTKIT_SEGMENT_WRITE_KEY || "n7XAZtQCGS2v1vvBy3LgBCv2h3Y8whja";
+
+    this.segment = new Analytics({
+      writeKey,
+    });
+
+    this.setGlobalProperties({
+      "copilotkit.package.name": packageName,
+      "copilotkit.package.version": packageVersion,
+    });
+  }
+
+  private shouldSendEvent() {
+    const randomNumber = Math.random();
+    return randomNumber < this.sampleRate;
+  }
+
+  async capture<K extends keyof AnalyticsEvents>(event: K, properties: AnalyticsEvents[K]) {
+    if (!this.shouldSendEvent() || !this.segment) {
+      return;
+    }
+
+    const flattenedProperties = flattenObject(properties);
+    const propertiesWithGlobal = {
+      ...this.globalProperties,
+      ...flattenedProperties,
+    };
+    const orderedPropertiesWithGlobal = Object.keys(propertiesWithGlobal)
+      .sort()
+      .reduce(
+        (obj, key) => {
+          obj[key] = propertiesWithGlobal[key];
+          return obj;
+        },
+        {} as Record<string, any>,
+      );
+
+    this.segment.track({
+      anonymousId: this.anonymousId,
+      event,
+      properties: { ...orderedPropertiesWithGlobal },
+    });
+  }
+
+  setGlobalProperties(properties: Record<string, any>) {
+    const flattenedProperties = flattenObject(properties);
+    this.globalProperties = { ...this.globalProperties, ...flattenedProperties };
+  }
+
+  setCloudConfiguration(properties: { publicApiKey: string; baseUrl: string }) {
+    this.cloudConfiguration = properties;
+
+    this.setGlobalProperties({
+      cloud: {
+        publicApiKey: properties.publicApiKey,
+        baseUrl: properties.baseUrl,
+      },
+    });
+  }
+
+  private setSampleRate(sampleRate: number | undefined) {
+    let _sampleRate: number;
+
+    _sampleRate = sampleRate ?? 0.05;
+
+    // eslint-disable-next-line
+    if (process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE) {
+      // eslint-disable-next-line
+      _sampleRate = parseFloat(process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE);
+    }
+
+    if (_sampleRate < 0 || _sampleRate > 1) {
+      throw new Error("Sample rate must be between 0 and 1");
+    }
+
+    this.sampleRate = _sampleRate;
+    this.setGlobalProperties({
+      sampleRate: this.sampleRate,
+      sampleRateAdjustmentFactor: 1 - this.sampleRate,
+    });
+  }
+}

package/src/telemetry/utils.ts

@@ -0,0 +1,39 @@
+import chalk from "chalk";
+
+export function flattenObject(
+  obj: Record<string, any>,
+  parentKey = "",
+  res: Record<string, any> = {},
+): Record<string, any> {
+  for (let key in obj) {
+    const propName = parentKey ? `${parentKey}.${key}` : key;
+    if (typeof obj[key] === "object" && obj[key] !== null) {
+      flattenObject(obj[key], propName, res);
+    } else {
+      res[propName] = obj[key];
+    }
+  }
+  return res;
+}
+
+export function printSecurityNotice(advisory: {
+  advisory: string | null;
+  message: string;
+  severity: "low" | "medium" | "high" | "none";
+}) {
+  const severityColor =
+    {
+      low: chalk.blue,
+      medium: chalk.yellow,
+      high: chalk.red,
+    }[advisory.severity.toLowerCase()] || chalk.white;
+
+  console.log();
+  console.log(`━━━━━━━━━━━━━━━━━━ ${chalk.bold(`CopilotKit`)} ━━━━━━━━━━━━━━━━━━`);
+  console.log();
+  console.log(`${chalk.bold(`Severity: ${severityColor(advisory.severity.toUpperCase())}`)}`);
+  console.log();
+  console.log(`${chalk.bold(advisory.message)}`);
+  console.log();
+  console.log(`━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━`);
+}

package/src/types/action.ts

@@ -0,0 +1,128 @@
+type TypeMap = {
+  string: string;
+  number: number;
+  boolean: boolean;
+  object: object;
+  "string[]": string[];
+  "number[]": number[];
+  "boolean[]": boolean[];
+  "object[]": object[];
+};
+
+type AbstractParameter = {
+  name: string;
+  type?: keyof TypeMap;
+  description?: string;
+  required?: boolean;
+};
+
+interface StringParameter extends AbstractParameter {
+  type: "string";
+  enum?: string[];
+}
+
+interface ObjectParameter extends AbstractParameter {
+  type: "object";
+  attributes?: Parameter[];
+}
+
+interface ObjectArrayParameter extends AbstractParameter {
+  type: "object[]";
+  attributes?: Parameter[];
+}
+
+type SpecialParameters = StringParameter | ObjectParameter | ObjectArrayParameter;
+interface BaseParameter extends AbstractParameter {
+  type?: Exclude<AbstractParameter["type"], SpecialParameters["type"]>;
+}
+
+export type Parameter = BaseParameter | SpecialParameters;
+
+type OptionalParameterType<P extends AbstractParameter> = P["required"] extends false
+  ? undefined
+  : never;
+
+type StringParameterType<P> = P extends StringParameter
+  ? P extends { enum?: Array<infer E> }
+    ? E
+    : string
+  : never;
+
+type ObjectParameterType<P> = P extends ObjectParameter
+  ? P extends { attributes?: infer Attributes extends Parameter[] }
+    ? MappedParameterTypes<Attributes>
+    : object
+  : never;
+
+type ObjectArrayParameterType<P> = P extends ObjectArrayParameter
+  ? P extends { attributes?: infer Attributes extends Parameter[] }
+    ? MappedParameterTypes<Attributes>[]
+    : any[]
+  : never;
+
+type MappedTypeOrString<T> = T extends keyof TypeMap ? TypeMap[T] : string;
+type BaseParameterType<P extends AbstractParameter> = P extends { type: infer T }
+  ? T extends BaseParameter["type"]
+    ? MappedTypeOrString<T>
+    : never
+  : string;
+
+export type MappedParameterTypes<T extends Parameter[] | [] = []> = T extends []
+  ? Record<string, any>
+  : {
+      [P in T[number] as P["name"]]:
+        | OptionalParameterType<P>
+        | StringParameterType<P>
+        | ObjectParameterType<P>
+        | ObjectArrayParameterType<P>
+        | BaseParameterType<P>;
+    };
+
+export type Action<T extends Parameter[] | [] = []> = {
+  name: string;
+  description?: string;
+  parameters?: T;
+  handler?: T extends []
+    ? () => any | Promise<any>
+    : (args: MappedParameterTypes<T>) => any | Promise<any>;
+};
+
+// This is the original "ceiling is being raised" version of MappedParameterTypes.
+//
+// ceiling is being raised. cursor's copilot helped us write "superhuman code"
+// for a critical feature. We can read this code, but VERY few engineers out
+// there could write it from scratch.
+// Took lots of convincing too. "come on, this must be possible, try harder".
+// and obviously- done in parts.
+//
+// - https://twitter.com/ataiiam/status/1765089261374914957
+//   (Mar 5, 2024)
+//
+// export type MappedParameterTypes<T extends Parameter[]> = {
+//   // Check if the parameter has an 'enum' defined
+//   [P in T[number] as P["name"]]: P extends { enum: Array<infer E> }
+//     ? E extends string // Ensure the enum values are strings
+//       ? P["required"] extends false // Check if the parameter is optional
+//         ? E | undefined // If so, include 'undefined' in the type
+//         : E // Otherwise, use the enum type directly
+//       : never // This case should not occur since 'enum' implies string values
+//     : // Handle parameters defined as 'object' with specified attributes
+//     P extends { type: "object"; attributes: infer Attributes }
+//     ? Attributes extends Parameter[]
+//       ? MappedParameterTypes<Attributes> // Recursively map the attributes of the object
+//       : never // If 'attributes' is not an array of Parameters, this is invalid
+//     : // Handle parameters defined as 'object[]' without specified attributes
+//     P extends { type: "object[]"; attributes?: never }
+//     ? any[] // Default to 'any[]' for arrays of objects without specific attributes
+//     : // Handle parameters defined as 'object[]' with specified attributes
+//     P extends { type: "object[]"; attributes: infer Attributes }
+//     ? Attributes extends Parameter[]
+//       ? MappedParameterTypes<Attributes>[] // Recursively map each object in the array
+//       : any[] // Default to 'any[]' if attributes are not properly defined
+//     : // Handle all other parameter types
+//     P["required"] extends false
+//     ? // Include 'undefined' for optional parameters
+//       TypeMap[P["type"] extends keyof TypeMap ? P["type"] : "string"] | undefined
+//     : // Use the direct mapping from 'TypeMap' for the parameter's type
+//       TypeMap[P["type"] extends keyof TypeMap ? P["type"] : "string"];
+// };

package/src/types/copilot-cloud-config.ts

@@ -0,0 +1,11 @@
+export interface CopilotCloudConfig {
+  guardrails: {
+    input: {
+      restrictToTopic: {
+        enabled: boolean;
+        validTopics: string[];
+        invalidTopics: string[];
+      };
+    };
+  };
+}

package/src/types/index.ts

@@ -0,0 +1,4 @@
+export * from "./openai-assistant";
+export * from "./action";
+export * from "./copilot-cloud-config";
+export * from "./utility";