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

package/dist/telemetry/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/telemetry/utils.ts"],"sourcesContent":["import chalk from \"chalk\";\n\nexport function flattenObject(\n  obj: Record<string, any>,\n  parentKey = \"\",\n  res: Record<string, any> = {},\n): Record<string, any> {\n  for (let key in obj) {\n    const propName = parentKey ? `${parentKey}.${key}` : key;\n    if (typeof obj[key] === \"object\" && obj[key] !== null) {\n      flattenObject(obj[key], propName, res);\n    } else {\n      res[propName] = obj[key];\n    }\n  }\n  return res;\n}\n\nexport function printSecurityNotice(advisory: {\n  advisory: string | null;\n  message: string;\n  severity: \"low\" | \"medium\" | \"high\" | \"none\";\n}) {\n  const severityColor =\n    {\n      low: chalk.blue,\n      medium: chalk.yellow,\n      high: chalk.red,\n    }[advisory.severity.toLowerCase()] || chalk.white;\n\n  console.log();\n  console.log(`━━━━━━━━━━━━━━━━━━ ${chalk.bold(`CopilotKit`)} ━━━━━━━━━━━━━━━━━━`);\n  console.log();\n  console.log(`${chalk.bold(`Severity: ${severityColor(advisory.severity.toUpperCase())}`)}`);\n  console.log();\n  console.log(`${chalk.bold(advisory.message)}`);\n  console.log();\n  console.log(`━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━`);\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAkB;AAEX,SAAS,cACd,KACA,YAAY,IACZ,MAA2B,CAAC,GACP;AACrB,WAAS,OAAO,KAAK;AACnB,UAAM,WAAW,YAAY,GAAG,aAAa,QAAQ;AACrD,QAAI,OAAO,IAAI,GAAG,MAAM,YAAY,IAAI,GAAG,MAAM,MAAM;AACrD,oBAAc,IAAI,GAAG,GAAG,UAAU,GAAG;AAAA,IACvC,OAAO;AACL,UAAI,QAAQ,IAAI,IAAI,GAAG;AAAA,IACzB;AAAA,EACF;AACA,SAAO;AACT;AAEO,SAAS,oBAAoB,UAIjC;AACD,QAAM,gBACJ;AAAA,IACE,KAAK,aAAAA,QAAM;AAAA,IACX,QAAQ,aAAAA,QAAM;AAAA,IACd,MAAM,aAAAA,QAAM;AAAA,EACd,EAAE,SAAS,SAAS,YAAY,CAAC,KAAK,aAAAA,QAAM;AAE9C,UAAQ,IAAI;AACZ,UAAQ,IAAI,gHAAsB,aAAAA,QAAM,KAAK,YAAY,gHAAsB;AAC/E,UAAQ,IAAI;AACZ,UAAQ,IAAI,GAAG,aAAAA,QAAM,KAAK,aAAa,cAAc,SAAS,SAAS,YAAY,CAAC,GAAG,GAAG;AAC1F,UAAQ,IAAI;AACZ,UAAQ,IAAI,GAAG,aAAAA,QAAM,KAAK,SAAS,OAAO,GAAG;AAC7C,UAAQ,IAAI;AACZ,UAAQ,IAAI,kSAAkD;AAChE;","names":["chalk"]}

package/dist/telemetry/utils.mjs

@@ -0,0 +1,9 @@
+import {
+  flattenObject,
+  printSecurityNotice
+} from "../chunk-6QGXWNS5.mjs";
+export {
+  flattenObject,
+  printSecurityNotice
+};
+//# sourceMappingURL=utils.mjs.map

package/dist/telemetry/utils.mjs.map

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

package/dist/types/index.mjs

@@ -1,6 +1,6 @@
 import "../chunk-BANDZXMP.mjs";
-import "../chunk-NAFEBKSO.mjs";
 import "../chunk-YBHX4Y25.mjs";
 import "../chunk-MSUB6DGR.mjs";
 import "../chunk-IAFBVORQ.mjs";
+import "../chunk-NAFEBKSO.mjs";
 //# sourceMappingURL=index.mjs.map

package/dist/utils/index.mjs

@@ -1,12 +1,12 @@
 import "../chunk-CYDWEPFL.mjs";
-import {
-  actionParametersToJsonSchema
-} from "../chunk-CIPF7PMC.mjs";
 import {
   actionToChatCompletionFunction,
   annotatedFunctionToAction,
   annotatedFunctionToChatCompletionFunction
 } from "../chunk-S4HGLK2E.mjs";
+import {
+  actionParametersToJsonSchema
+} from "../chunk-CIPF7PMC.mjs";
 export {
   actionParametersToJsonSchema,
   actionToChatCompletionFunction,

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.0.0-beta.0",
+  "version": "1.0.0-beta.1",
   "sideEffects": false,
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -17,7 +17,6 @@
   },
   "types": "./dist/index.d.ts",
   "license": "MIT",
-  "peerDependencies": {},
   "devDependencies": {
     "@types/jest": "^29.5.4",
     "eslint": "^8.56.0",
@@ -28,7 +27,10 @@
     "eslint-config-custom": "1.0.0-beta.0",
     "tsconfig": "1.0.0-beta.0"
   },
-  "dependencies": {},
+  "dependencies": {
+    "chalk": "4.1.2",
+    "posthog-node": "^4.0.1"
+  },
   "scripts": {
     "build": "tsup --clean",
     "dev": "tsup --watch --no-splitting",

package/src/index.ts

@@ -1,3 +1,4 @@
 export * from "./types";
 export * from "./utils";
 export * from "./constants";
+export * from "./telemetry";

package/src/telemetry/events.ts

@@ -0,0 +1,7 @@
+export type AnalyticsEvents = {
+  "oss.runtime.instance_created": {};
+  "oss.runtime.copilot_request_created": {
+    "cloud.guardrails.enabled": boolean;
+    requestType: string;
+  };
+};

package/src/telemetry/index.ts

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

package/src/telemetry/telemetry-client.ts

@@ -0,0 +1,164 @@
+import { PostHog } from "posthog-node";
+import { AnalyticsEvents } from "./events";
+import { flattenObject, printSecurityNotice } from "./utils";
+import { randomUUID } from "crypto";
+
+export class TelemetryClient {
+  posthog: PostHog | undefined;
+  globalProperties: Record<string, any> = {};
+  cloudConfiguration: { publicApiKey: string; baseUrl: string } | null = null;
+  packageName: string;
+  packageVersion: string;
+  private telemetryDisabled: boolean = false;
+  private telemetryBaseUrl: string | undefined;
+  private sampleRate: number = 0.05;
+
+  constructor({
+    packageName,
+    packageVersion,
+    telemetryDisabled,
+    telemetryBaseUrl,
+    posthogToken,
+    sampleRate,
+  }: {
+    packageName: string;
+    packageVersion: string;
+    telemetryDisabled?: boolean;
+    telemetryBaseUrl?: string;
+    posthogToken?: 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);
+
+    this.telemetryBaseUrl =
+      telemetryBaseUrl ||
+      (process.env as any).COPILOTKIT_TELEMETRY_BASE_URL ||
+      "https://telemetry.copilotkit.ai";
+
+    this.posthog = new PostHog(posthogToken || "token", {
+      host: `${this.telemetryBaseUrl}/telemetry/ingest`,
+    });
+
+    this.setGlobalProperties({
+      "copilotkit.package.name": packageName,
+      "copilotkit.package.version": packageVersion,
+    });
+
+    // Eliminates a PostHog error on Next.js
+    if (typeof (globalThis as any).navigator !== "undefined") {
+      (globalThis as any).navigator = {};
+    }
+  }
+
+  private shouldSendEvent() {
+    if (!this.telemetryBaseUrl) {
+      return false;
+    }
+
+    const randomNumber = Math.random();
+    return randomNumber < this.sampleRate;
+  }
+
+  async capture<K extends keyof AnalyticsEvents>(event: K, properties: AnalyticsEvents[K]) {
+    if (!this.shouldSendEvent() || !this.posthog) {
+      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.posthog.capture({
+      distinctId: randomUUID(),
+      event,
+      properties: { ...orderedPropertiesWithGlobal },
+    });
+  }
+
+  async checkForUpdates() {
+    const url = `${this.telemetryBaseUrl}/check-for-updates?packageName=${this.packageName}&packageVersion=${this.packageVersion}`;
+
+    const response = await fetch(url);
+
+    if (!response.ok) {
+      return;
+    }
+
+    const result = await response.json();
+    const { advisory, severity } = result;
+
+    if (!advisory && (severity === "low" || severity === "none")) {
+      return;
+    }
+
+    printSecurityNotice(result);
+  }
+
+  setTelemetryBaseUrl(url: string) {
+    this.telemetryBaseUrl = url;
+
+    if (this.posthog) {
+      this.posthog.host = `${url}/telemetry/ingest`;
+    }
+  }
+
+  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;
+
+    if (process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE) {
+      _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(`━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━`);
+}