@kognitivedev/cloud-voice 0.2.29

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@kognitivedev/cloud-voice",
+  "version": "0.2.29",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./browser": {
+      "types": "./dist/browser.d.ts",
+      "default": "./dist/browser.js"
+    },
+    "./server": {
+      "types": "./dist/server.d.ts",
+      "default": "./dist/server.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc -w --noCheck",
+    "test": "vitest run",
+    "prepublishOnly": "npm run build"
+  },
+  "dependencies": {
+    "@kognitivedev/client-core": "^0.2.29"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.0.0",
+    "vitest": "^3.0.0"
+  },
+  "description": "Cloud voice agents SDK for Kognitive hosted voice APIs",
+  "keywords": [
+    "kognitive",
+    "voice",
+    "cloud",
+    "sdk",
+    "agents"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/kognitivedev/kognitive",
+    "directory": "packages/cloud-voice"
+  },
+  "homepage": "https://kognitive.dev"
+}

package/src/__tests__/browser.test.ts

@@ -0,0 +1,196 @@
+import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
+import { createVoiceWidget } from "../browser";
+
+type Listener = (event: any) => void;
+
+class FakeElement {
+    children: FakeElement[] = [];
+    dataset: Record<string, string> = {};
+    style: Record<string, string> = {};
+    className = "";
+    textContent = "";
+    attributes: Record<string, string> = {};
+    parent: FakeElement | null = null;
+    contentWindow?: { postMessage: ReturnType<typeof vi.fn> };
+
+    constructor(public readonly tagName = "div") {
+        if (tagName === "iframe") {
+            this.contentWindow = { postMessage: vi.fn() };
+        }
+    }
+
+    appendChild(child: FakeElement) {
+        child.parent = this;
+        this.children.push(child);
+        return child;
+    }
+
+    append(...children: FakeElement[]) {
+        for (const child of children) this.appendChild(child);
+    }
+
+    remove() {
+        if (!this.parent) return;
+        this.parent.children = this.parent.children.filter((child) => child !== this);
+        this.parent = null;
+    }
+
+    replaceChildren(...children: FakeElement[]) {
+        this.children = [];
+        for (const child of children) this.appendChild(child);
+    }
+
+    setAttribute(name: string, value: string) {
+        this.attributes[name] = value;
+    }
+
+    addEventListener() {}
+    removeEventListener() {}
+    dispatchEvent() {}
+
+    querySelector(selector: string) {
+        const match = selector.match(/data-kognitive-tool-call-id="([^"]+)"/);
+        if (!match) return null;
+        return this.children.find((child) => child.dataset.kognitiveToolCallId === match[1]) ?? null;
+    }
+}
+
+describe("createVoiceWidget", () => {
+    let body: FakeElement;
+    let listeners: Record<string, Set<Listener>>;
+    let originalWindow: unknown;
+    let originalDocument: unknown;
+    let originalHTMLElement: unknown;
+    let originalNode: unknown;
+
+    beforeEach(() => {
+        body = new FakeElement("body");
+        listeners = {};
+        originalWindow = (globalThis as any).window;
+        originalDocument = (globalThis as any).document;
+        originalHTMLElement = (globalThis as any).HTMLElement;
+        originalNode = (globalThis as any).Node;
+        (globalThis as any).HTMLElement = FakeElement;
+        (globalThis as any).Node = FakeElement;
+        (globalThis as any).document = {
+            body,
+            createElement: (tagName: string) => new FakeElement(tagName),
+            querySelector: () => body,
+        };
+        (globalThis as any).window = {
+            addEventListener: (type: string, listener: Listener) => {
+                listeners[type] ??= new Set();
+                listeners[type].add(listener);
+            },
+            removeEventListener: (type: string, listener: Listener) => {
+                listeners[type]?.delete(listener);
+            },
+        };
+    });
+
+    afterEach(() => {
+        (globalThis as any).window = originalWindow;
+        (globalThis as any).document = originalDocument;
+        (globalThis as any).HTMLElement = originalHTMLElement;
+        (globalThis as any).Node = originalNode;
+    });
+
+    it("registers executable client tools with the iframe", () => {
+        const widget = createVoiceWidget({
+            baseUrl: "https://dashboard.example.com",
+            publicKey: "kvp_test",
+            agent: "support",
+            tools: {
+                lookup_order: {
+                    description: "Look up an order",
+                    inputSchema: { type: "object", properties: { orderNumber: { type: "string" } } },
+                    execute: async () => ({ ok: true }),
+                },
+                render_only: () => "rendered",
+            },
+        });
+
+        const iframe = widget.iframe as unknown as FakeElement;
+        listeners.message.forEach((listener) => listener({
+            source: iframe.contentWindow,
+            data: { type: "kognitive.cloudVoice.iframe.ready" },
+        }));
+
+        expect(iframe.contentWindow?.postMessage).toHaveBeenCalledWith({
+            type: "kognitive.cloudVoice.tools.register",
+            tools: [{
+                id: "lookup_order",
+                name: "lookup_order",
+                description: "Look up an order",
+                inputSchema: { type: "object", properties: { orderNumber: { type: "string" } } },
+            }],
+        }, "https://dashboard.example.com");
+
+        widget.destroy();
+        expect(listeners.message.size).toBe(0);
+    });
+
+    it("includes startup parameters in the embedded iframe URL", () => {
+        const widget = createVoiceWidget({
+            baseUrl: "https://dashboard.example.com",
+            publicKey: "kvp_test",
+            agent: "support",
+            parameters: { customer_name: "Ada", account_tier: "gold" },
+        });
+        const iframe = widget.iframe as unknown as FakeElement & { src: string };
+        const url = new URL(iframe.src);
+
+        expect(url.searchParams.get("parameters")).toBe(JSON.stringify({ customer_name: "Ada", account_tier: "gold" }));
+        widget.destroy();
+    });
+
+    it("executes client tools and posts results back to the iframe", async () => {
+        const execute = vi.fn(async (input: unknown) => ({ status: "ok", input }));
+        const onToolState = vi.fn();
+        const widget = createVoiceWidget({
+            baseUrl: "https://dashboard.example.com",
+            publicKey: "kvp_test",
+            agent: "support",
+            tools: {
+                lookup_order: {
+                    execute,
+                    render: ({ state }) => `state:${state}`,
+                },
+            },
+            onToolState,
+        });
+        const iframe = widget.iframe as unknown as FakeElement;
+
+        listeners.message.forEach((listener) => listener({
+            source: iframe.contentWindow,
+            data: {
+                type: "kognitive.cloudVoice.tool.call",
+                requestId: "request_1",
+                toolName: "lookup_order",
+                args: { orderNumber: "KV-1042" },
+            },
+        }));
+
+        await new Promise((resolve) => setTimeout(resolve, 0));
+
+        expect(execute).toHaveBeenCalledWith({ orderNumber: "KV-1042" }, {
+            toolName: "lookup_order",
+            toolCallId: "request_1",
+            callId: undefined,
+            sessionId: undefined,
+        });
+        expect(iframe.contentWindow?.postMessage).toHaveBeenCalledWith({
+            type: "kognitive.cloudVoice.tool.result",
+            requestId: "request_1",
+            result: { status: "ok", input: { orderNumber: "KV-1042" } },
+        }, "https://dashboard.example.com");
+        expect(onToolState).toHaveBeenCalledWith(expect.objectContaining({
+            toolName: "lookup_order",
+            state: "output-available",
+        }));
+        const toolRoot = body.children[0];
+        expect(toolRoot.children).toHaveLength(1);
+        expect(toolRoot.children[0].dataset.kognitiveToolCallId).toBe("request_1");
+        expect(toolRoot.children[0].textContent).toBe("state:output-available");
+    });
+});