@copilotkit/channels-core 0.1.1 → 0.2.1

package/dist/telemetry/bot-telemetry.d.ts

@@ -1,31 +0,0 @@
-import type { LambdaSendOptions } from "@copilotkit/shared";
-import type { StateStore } from "../state/state-store.js";
-export declare const BOT_TELEMETRY_EVENTS: readonly ["oss.bot.configured", "oss.bot.started", "oss.bot.start_failed", "oss.bot.agent_run", "oss.bot.agent_run_failed"];
-export type BotTelemetryEvent = (typeof BOT_TELEMETRY_EVENTS)[number];
-export declare function isTestEnv(): boolean;
-export declare function resolveEnvironment(): string;
-export interface BotTelemetryOptions {
-    backend: StateStore;
-    packageName: string;
-    packageVersion: string;
-    environment?: string;
-    disabled?: boolean;
-    sessionId?: string;
-    send?: (o: LambdaSendOptions) => Promise<void>;
-    resolveId?: () => Promise<string>;
-}
-export declare class BotTelemetry {
-    private readonly opts;
-    private readonly disabled;
-    private readonly sendFn;
-    private readonly sessionId;
-    private readonly environment;
-    private readonly resolveId;
-    private idPromise?;
-    private static disclosed;
-    constructor(opts: BotTelemetryOptions);
-    capture(event: BotTelemetryEvent, properties: Record<string, unknown>): void;
-    private disclose;
-    private dispatch;
-}
-//# sourceMappingURL=bot-telemetry.d.ts.map

package/dist/telemetry/bot-telemetry.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bot-telemetry.d.ts","sourceRoot":"","sources":["../../src/telemetry/bot-telemetry.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,oBAAoB,CAAC;AAC5D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAG1D,eAAO,MAAM,oBAAoB,6HAMvB,CAAC;AACX,MAAM,MAAM,iBAAiB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEtE,wBAAgB,SAAS,IAAI,OAAO,CAGnC;AAED,wBAAgB,kBAAkB,IAAI,MAAM,CAI3C;AAED,MAAM,WAAW,mBAAmB;IAClC,OAAO,EAAE,UAAU,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,iBAAiB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/C,SAAS,CAAC,EAAE,MAAM,OAAO,CAAC,MAAM,CAAC,CAAC;CACnC;AAED,qBAAa,YAAY;IASX,OAAO,CAAC,QAAQ,CAAC,IAAI;IARjC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;IACnC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAA0C;IACjE,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;IACnC,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAwB;IAClD,OAAO,CAAC,SAAS,CAAC,CAAkB;IACpC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAS;gBAEJ,IAAI,EAAE,mBAAmB;IAStD,OAAO,CAAC,KAAK,EAAE,iBAAiB,EAAE,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI;IAM5E,OAAO,CAAC,QAAQ;YAQF,QAAQ;CAsBvB"}

package/dist/telemetry/bot-telemetry.js

@@ -1,70 +0,0 @@
-import { lambdaClient, isTelemetryDisabled } from "@copilotkit/shared";
-import { resolveInstallId } from "./install-id.js";
-export const BOT_TELEMETRY_EVENTS = [
-    "oss.bot.configured",
-    "oss.bot.started",
-    "oss.bot.start_failed",
-    "oss.bot.agent_run",
-    "oss.bot.agent_run_failed",
-];
-export function isTestEnv() {
-    const env = process.env;
-    return env.NODE_ENV === "test" || !!env.VITEST || !!env.JEST_WORKER_ID;
-}
-export function resolveEnvironment() {
-    const e = (process.env.NODE_ENV ?? "").toLowerCase();
-    if (e === "production" || e === "development" || e === "test")
-        return e;
-    return "unknown";
-}
-export class BotTelemetry {
-    opts;
-    disabled;
-    sendFn;
-    sessionId;
-    environment;
-    resolveId;
-    idPromise;
-    static disclosed = false;
-    constructor(opts) {
-        this.opts = opts;
-        this.disabled = opts.disabled ?? (isTelemetryDisabled() || isTestEnv());
-        this.sendFn = opts.send ?? lambdaClient.send;
-        this.sessionId = opts.sessionId ?? globalThis.crypto.randomUUID();
-        this.environment = opts.environment ?? resolveEnvironment();
-        this.resolveId =
-            opts.resolveId ?? (() => resolveInstallId({ backend: opts.backend }));
-    }
-    capture(event, properties) {
-        if (this.disabled)
-            return;
-        this.disclose();
-        void this.dispatch(event, properties);
-    }
-    disclose() {
-        if (BotTelemetry.disclosed)
-            return;
-        BotTelemetry.disclosed = true;
-        console.info("[CopilotKit Bot] anonymous telemetry enabled — see https://docs.copilotkit.ai/telemetry to opt out (set COPILOTKIT_TELEMETRY_DISABLED=true).");
-    }
-    async dispatch(event, properties) {
-        try {
-            this.idPromise ??= this.resolveId();
-            const anonymous_id = await this.idPromise;
-            await this.sendFn({
-                event,
-                properties,
-                globalProperties: {
-                    anonymous_id,
-                    bot_session_id: this.sessionId,
-                    environment: this.environment,
-                },
-                packageName: this.opts.packageName,
-                packageVersion: this.opts.packageVersion,
-            });
-        }
-        catch {
-            /* best-effort: telemetry must not break the host app */
-        }
-    }
-}

package/dist/telemetry/bot-telemetry.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=bot-telemetry.test.d.ts.map

package/dist/telemetry/bot-telemetry.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"bot-telemetry.test.d.ts","sourceRoot":"","sources":["../../src/telemetry/bot-telemetry.test.ts"],"names":[],"mappings":""}

package/dist/telemetry/bot-telemetry.test.js

@@ -1,56 +0,0 @@
-import { describe, it, expect, vi } from "vitest";
-import { BotTelemetry, BOT_TELEMETRY_EVENTS } from "./bot-telemetry.js";
-import { MemoryStore } from "../state/memory-store.js";
-const tick = () => new Promise((r) => setTimeout(r, 0));
-const base = {
-    backend: new MemoryStore(),
-    packageName: "@copilotkit/channels",
-    packageVersion: "0.0.3",
-};
-describe("BotTelemetry", () => {
-    it("sends event with anonymous_id + bot_session_id in global_properties", async () => {
-        const send = vi.fn().mockResolvedValue(undefined);
-        const t = new BotTelemetry({
-            ...base,
-            disabled: false,
-            send,
-            sessionId: "S1",
-            resolveId: async () => "ANON",
-        });
-        t.capture("oss.bot.configured", { platforms: ["slack"] });
-        await tick();
-        expect(send).toHaveBeenCalledTimes(1);
-        const arg = send.mock.calls[0][0];
-        expect(arg.event).toBe("oss.bot.configured");
-        expect(arg.properties).toEqual({ platforms: ["slack"] });
-        expect(arg.globalProperties.anonymous_id).toBe("ANON");
-        expect(arg.globalProperties.bot_session_id).toBe("S1");
-    });
-    it("is a no-op when disabled", async () => {
-        const send = vi.fn();
-        const t = new BotTelemetry({ ...base, disabled: true, send });
-        t.capture("oss.bot.started", {});
-        await tick();
-        expect(send).not.toHaveBeenCalled();
-    });
-    it("never throws when send rejects", async () => {
-        const send = vi.fn().mockRejectedValue(new Error("boom"));
-        const t = new BotTelemetry({
-            ...base,
-            disabled: false,
-            send,
-            resolveId: async () => "X",
-        });
-        expect(() => t.capture("oss.bot.agent_run", {})).not.toThrow();
-        await tick();
-    });
-    it("exposes the five event names", () => {
-        expect([...BOT_TELEMETRY_EVENTS].sort()).toEqual([
-            "oss.bot.agent_run",
-            "oss.bot.agent_run_failed",
-            "oss.bot.configured",
-            "oss.bot.start_failed",
-            "oss.bot.started",
-        ]);
-    });
-});

package/dist/telemetry/create-bot-telemetry.test.d.ts

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=create-bot-telemetry.test.d.ts.map

package/dist/telemetry/create-bot-telemetry.test.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"create-bot-telemetry.test.d.ts","sourceRoot":"","sources":["../../src/telemetry/create-bot-telemetry.test.ts"],"names":[],"mappings":""}

package/dist/telemetry/create-bot-telemetry.test.js

@@ -1,71 +0,0 @@
-import { describe, it, expect, vi, beforeEach } from "vitest";
-const capture = vi.fn();
-vi.mock("./bot-telemetry.js", () => ({
-    // A `function` (not an arrow) so `new BotTelemetry(...)` in create-bot.ts is
-    // constructible under vitest's mock — an arrow implementation throws
-    // "is not a constructor".
-    BotTelemetry: vi.fn().mockImplementation(function () {
-        return { capture };
-    }),
-    BOT_TELEMETRY_EVENTS: [],
-}));
-import { createBot } from "../create-bot.js";
-import { FakeAdapter } from "../testing/fake-adapter.js";
-import { FakeAgent } from "../testing/fake-agent.js";
-import { Section } from "@copilotkit/channels-ui";
-const tick = () => new Promise((r) => setTimeout(r, 0));
-describe("createBot telemetry wiring", () => {
-    beforeEach(() => capture.mockClear());
-    it("emits oss.bot.configured with a config snapshot", async () => {
-        // The config snapshot is captured at start() — the backend (and therefore
-        // telemetry) is resolved there, not at construction, so an adapter attached
-        // via addAdapter can still provide the persistence backend.
-        const bot = createBot({
-            adapters: [new FakeAdapter()],
-            components: [
-                function Card() {
-                    return Section({ children: "x" });
-                },
-            ],
-        });
-        await bot.start();
-        const call = capture.mock.calls.find((c) => c[0] === "oss.bot.configured");
-        expect(call).toBeDefined();
-        expect(call[1].platforms).toEqual(["custom"]); // FakeAdapter.platform "fake" → normalized
-        expect(call[1].store).toBe("memory");
-        expect(call[1].hasComponents).toBe(true);
-    });
-    it("emits oss.bot.started on start, start_failed (category only) on a throwing adapter", async () => {
-        const ok = new FakeAdapter();
-        const bot = createBot({ adapters: [ok] });
-        await bot.start();
-        expect(capture.mock.calls.find((c) => c[0] === "oss.bot.started")?.[1]
-            .startedCount).toBe(1);
-        capture.mockClear();
-        const bad = new FakeAdapter();
-        bad.start = () => Promise.reject(Object.assign(new Error("xoxb-SECRET token bad"), { code: "EAUTH" }));
-        const bot2 = createBot({ adapters: [bad] });
-        await bot2.start();
-        const f = capture.mock.calls.find((c) => c[0] === "oss.bot.start_failed");
-        expect(f).toBeDefined();
-        expect(f[1].errorClass).toBe("auth");
-        expect(JSON.stringify(f[1])).not.toContain("SECRET");
-    });
-    it("emits oss.bot.agent_run on a successful run", async () => {
-        const fake = new FakeAdapter();
-        const bot = createBot({ adapters: [fake], agent: () => new FakeAgent() });
-        bot.onMention(async ({ thread }) => {
-            await thread.runAgent();
-        });
-        await bot.start();
-        capture.mockClear();
-        fake.emitTurn({ userText: "hi", conversationKey: "c1" });
-        await tick();
-        await tick();
-        const run = capture.mock.calls.find((c) => c[0] === "oss.bot.agent_run");
-        expect(run).toBeDefined();
-        expect(run[1].platform).toBe("custom"); // "fake" → normalized
-        expect(typeof run[1].durationMs).toBe("number");
-        expect(run[1].interrupted).toBe(false);
-    });
-});