@copilotkit/runtime 1.54.1 → 1.55.0-next.7

package/src/v2/runtime/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;
+    "cloud.api_key_provided": boolean;
+    "cloud.public_api_key"?: string;
+    "cloud.base_url"?: string;
+  };
+  "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;
+  "cloud.api_key_provided": boolean;
+  "cloud.public_api_key"?: string;
+  "cloud.base_url"?: string;
+}
+
+export interface AgentExecutionResponseInfo {
+  provider?: string;
+  model?: string;
+  langGraphHost?: string;
+  langGraphVersion?: string;
+  hashedLgcKey?: string;
+}

package/src/v2/runtime/telemetry/index.ts

@@ -0,0 +1,7 @@
+export { default as telemetry } from "./telemetry-client";
+export { TelemetryClient, isTelemetryDisabled } from "./telemetry-client";
+export type {
+  AnalyticsEvents,
+  RuntimeInstanceCreatedInfo,
+  AgentExecutionResponseInfo,
+} from "./events";

package/src/v2/runtime/telemetry/scarf-client.ts

@@ -0,0 +1,39 @@
+import * as packageJson from "../../../../package.json";
+
+const SCARF_BASE_URL = `https://copilotkit.gateway.scarf.sh/${packageJson.version}`;
+
+class ScarfClient {
+  constructor() {}
+
+  async logEvent(properties: Record<string, any>): Promise<void> {
+    try {
+      const controller = new AbortController();
+      const timeoutId = setTimeout(() => controller.abort(), 3000);
+
+      const queryParams = new URLSearchParams();
+
+      Object.entries(properties).forEach(([key, value]) => {
+        if (value !== null && value !== undefined) {
+          queryParams.append(key, String(value));
+        }
+      });
+
+      const url = `${SCARF_BASE_URL}?${queryParams.toString()}`;
+
+      const response = await fetch(url, {
+        method: "GET",
+        signal: controller.signal,
+      });
+
+      clearTimeout(timeoutId);
+
+      if (!response.ok) {
+        throw new Error(`HTTP error! status: ${response.status}`);
+      }
+    } catch {
+      // Silently fail - telemetry should not break the application
+    }
+  }
+}
+
+export default new ScarfClient();

package/src/v2/runtime/telemetry/telemetry-client.ts

@@ -0,0 +1,70 @@
+import { AnalyticsEvents } from "./events";
+import scarfClient from "./scarf-client";
+
+export function isTelemetryDisabled(): boolean {
+  return (
+    (process.env as Record<string, string | undefined>)
+      .COPILOTKIT_TELEMETRY_DISABLED === "true" ||
+    (process.env as Record<string, string | undefined>)
+      .COPILOTKIT_TELEMETRY_DISABLED === "1" ||
+    (process.env as Record<string, string | undefined>).DO_NOT_TRACK ===
+      "true" ||
+    (process.env as Record<string, string | undefined>).DO_NOT_TRACK === "1"
+  );
+}
+
+export class TelemetryClient {
+  private telemetryDisabled: boolean = false;
+  private sampleRate: number = 0.05;
+
+  constructor({
+    telemetryDisabled,
+    sampleRate,
+  }: {
+    telemetryDisabled?: boolean;
+    sampleRate?: number;
+  } = {}) {
+    this.telemetryDisabled = telemetryDisabled ?? isTelemetryDisabled();
+    this.setSampleRate(sampleRate);
+  }
+
+  private shouldSendEvent() {
+    if (this.telemetryDisabled) {
+      return false;
+    }
+    const randomNumber = Math.random();
+    return randomNumber < this.sampleRate;
+  }
+
+  async capture<K extends keyof AnalyticsEvents>(
+    event: K,
+    properties: AnalyticsEvents[K],
+  ) {
+    if (!this.shouldSendEvent()) {
+      return;
+    }
+
+    await scarfClient.logEvent({
+      event,
+    });
+  }
+
+  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;
+  }
+}
+
+const telemetry = new TelemetryClient();
+export default telemetry;

package/src/v2/runtime/transcription-service/transcription-service.ts

@@ -0,0 +1,11 @@
+export interface TranscribeFileOptions {
+  audioFile: File;
+  /** MIME type of the audio file */
+  mimeType?: string;
+  /** Size of the audio file in bytes */
+  size?: number;
+}
+
+export abstract class TranscriptionService {
+  abstract transcribeFile(options: TranscribeFileOptions): Promise<string>;
+}

package/tsconfig.json

@@ -2,12 +2,19 @@
   "extends": "../tsconfig/base.json",
   "compilerOptions": {
     "types": ["node", "vitest/globals"],
-    "lib": ["es2017", "dom"],
+    "target": "es2022",
+    "lib": ["es2022", "dom", "dom.iterable"],
+    "useDefineForClassFields": false,
     "emitDecoratorMetadata": true,
     "experimentalDecorators": true,
     "strict": false,
     "resolveJsonModule": true
   },
-  "include": ["./src/**/*.ts", "./src/**/*.test.ts", "./src/**/__tests__/*", "./tests/**/*.ts"],
+  "include": [
+    "./src/**/*.ts",
+    "./src/**/*.test.ts",
+    "./src/**/__tests__/*",
+    "./tests/**/*.ts"
+  ],
   "exclude": ["dist", "build", "node_modules"]
 }

package/tsdown.config.ts

@@ -32,6 +32,7 @@ export default defineConfig({
     "groq-sdk",
     "@whatwg-node/fetch",
     "@whatwg-node/server",
+    "rxjs",
   ],
   exports: true,
 });