@exotel-npm-dev/exotel-ai-assist 1.0.0

package/dist/transport/index.d.ts

@@ -0,0 +1,35 @@
+import { WorkerInboundMessage } from "../types";
+type TransportMessageHandler = (msg: WorkerInboundMessage) => void;
+export interface ITransport {
+    connect(url: string, authToken: string): void;
+    disconnect(): void;
+    send(payload: string): void;
+    onMessage(handler: TransportMessageHandler): void;
+    destroy(): void;
+}
+export declare class BroadcastChannelTransport implements ITransport {
+    private channel;
+    private socket;
+    private isLeader;
+    private socketConnected;
+    private handler;
+    private pendingUrl;
+    private pendingAuthToken;
+    private lockReleaser;
+    /**
+     * @param sessionHash - A hash of all connection-relevant params (see
+     *   Utils.hashParams). Tabs with identical params share one WebSocket;
+     *   any differing param produces a different hash and therefore a fully
+     *   independent connection.
+     */
+    constructor(sessionHash: string);
+    private _electLeader;
+    private _openSocket;
+    connect(url: string, authToken: string): void;
+    disconnect(): void;
+    send(payload: string): void;
+    onMessage(handler: TransportMessageHandler): void;
+    destroy(): void;
+}
+export declare function createTransport(sessionHash: string): ITransport;
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1,89 @@
+export interface ExotelAIAssistParams {
+    authToken: string;
+    call_sid: string;
+    /** Exotel account identifier. */
+    accountId: string;
+    /** WebSocket base URL. Defaults to the Exotel AI Assist backend if omitted. */
+    wssBaseUrl?: string;
+    reconnectInterval?: number;
+    maxReconnectAttempts?: number;
+    [key: string]: unknown;
+}
+/** A single AI-generated suggestion for the agent. */
+export interface Suggestion {
+    id: string;
+    text: string;
+    timestamp: number;
+}
+/** A single spoken line as received in the live transcript. */
+export interface TranscriptLine {
+    /** Unique stable ID (derived from the backend sequence number). */
+    id: string;
+    text: string;
+    /** Unix timestamp (ms) of the start of this utterance. */
+    startTime: number;
+    /** Unix timestamp (ms) of the end of this utterance. */
+    endTime: number;
+    isFinal: boolean;
+}
+/** The latest sentiment label for the call. */
+export interface Sentiment {
+    label: "positive" | "neutral" | "negative";
+    timestamp: number;
+}
+export type ConnectionStatus = "idle" | "connecting" | "connected" | "disconnected" | "error";
+/** Feature-flag config received from the AI Assist backend. */
+export interface BotConfig {
+    sentiment: boolean;
+    transcript: boolean;
+    suggestions: boolean;
+    status: "LIVE" | "DRAFT" | "DEACTIVATED";
+}
+interface TranscriptSegment {
+    is_final: boolean;
+    end_timestamp: string;
+    start_timestamp: string;
+    text: string;
+}
+interface TranscriptMessage {
+    sequence: number;
+    transcript_segments: TranscriptSegment[];
+}
+export interface WssEvent {
+    event_type: "suggestion" | "sentiment";
+    transcript: TranscriptMessage[];
+    text: string;
+}
+export interface InitialHandshakeResponse {
+    type: string;
+    config: BotConfig;
+    events: WssEvent[] | WssEvent;
+}
+export interface WssResponse {
+    config: BotConfig;
+    events: WssEvent;
+}
+export interface ControllerEvents {
+    suggestion: (data: Suggestion) => void;
+    transcript: (lines: TranscriptLine[]) => void;
+    sentiment: (data: Sentiment) => void;
+    /** Internal: bot feature-flag config. Consumed by the UI component only. */
+    botConfig: (config: BotConfig) => void;
+    onCallStart: () => void;
+    onCallEnd: () => void;
+    statusChange: (status: ConnectionStatus) => void;
+    error: (err: Error) => void;
+    raw: (data: unknown) => void;
+}
+export type WorkerInboundMessage = {
+    type: "MESSAGE";
+    payload: string;
+} | {
+    type: "CONNECTED";
+} | {
+    type: "DISCONNECTED";
+} | {
+    type: "ERROR";
+    message: string;
+};
+export {};

package/dist/utils/index.d.ts

@@ -0,0 +1,39 @@
+import { ExotelAIAssistParams } from "../types";
+export declare class Utils {
+    static MAX_EXTRA_QUERY_PARAMS: number;
+    /**
+     * Returns a deterministic SHA-1 hex digest for any plain object.
+     *
+     * Key ordering is irrelevant — `{a:1, b:2}` and `{b:2, a:1}` produce the
+     * same hash.  Powered by `object-hash`, which handles nested objects,
+     * arrays, and all primitive types correctly.
+     */
+    static hash(obj: Record<string, unknown>): string;
+    /**
+     * Formats a timestamp in milliseconds to a human-readable time string.
+     * @param ms - The timestamp in milliseconds.
+     * @returns The formatted time string.
+     */
+    static formatTimestamp(ms: number): string;
+    /**
+     * Returns the base WebSocket URL for the given account ID.
+     * @param accountId - The account ID to get the base WebSocket URL for.
+     * @returns The base WebSocket URL.
+     */
+    static getWssBaseUrl(accountId: string): string;
+    /**
+     * Builds a WebSocket URL from the given parameters.
+     * @param params - The parameters to build the WebSocket URL from.
+     * @returns The WebSocket URL.
+     */
+    static buildWsUrl(params: ExotelAIAssistParams): string;
+    static constructQueryParams(params: ExotelAIAssistParams): string;
+    /**
+     * Returns a unique ID string.
+     *
+     * If the browser supports `crypto.randomUUID`, it uses that. Otherwise, it
+     * falls back to a simple timestamp-based ID.
+     * @returns A unique ID string.
+     */
+    static getUniqueId(): string;
+}

package/package.json

@@ -0,0 +1,97 @@
+{
+  "name": "@exotel-npm-dev/exotel-ai-assist",
+  "version": "1.0.0",
+  "description": "AI-powered real-time suggestions, transcript, and sentiment for agent calls",
+  "license": "Apache-2.0",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./react": {
+      "types": "./dist/react/index.d.ts",
+      "require": "./dist/react/index.js",
+      "default": "./dist/react/index.js"
+    },
+    "./controller": {
+      "types": "./dist/controller/index.d.ts",
+      "require": "./dist/controller/index.js",
+      "default": "./dist/controller/index.js"
+    }
+  },
+  "typesVersions": {
+    "*": {
+      "react": [
+        "dist/react/index.d.ts"
+      ],
+      "controller": [
+        "dist/controller/index.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "dist",
+    "react.js",
+    "controller.js"
+  ],
+  "scripts": {
+    "build": "tsc --emitDeclarationOnly && NODE_ENV=production rollup --config rollup.config.mjs",
+    "dev": "rollup --config rollup.config.mjs --watch",
+    "clean": "rm -rf dist",
+    "lint": "eslint src --ext .ts,.tsx"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.29.0",
+    "@babel/preset-env": "^7.29.0",
+    "@rollup/plugin-babel": "^7.0.0",
+    "@rollup/plugin-commonjs": "^29.0.2",
+    "@rollup/plugin-node-resolve": "^16.0.3",
+    "@rollup/plugin-typescript": "^12.3.0",
+    "@types/node": "^20.0.0",
+    "@types/object-hash": "^3.0.6",
+    "@types/react": "^16.14.0",
+    "@types/react-dom": "^16.9.0",
+    "postcss": "^8.5.8",
+    "react": "^16.14.0",
+    "react-dom": "^16.14.0",
+    "rollup": "^4.59.0",
+    "rollup-plugin-postcss": "^4.0.2",
+    "tslib": "^2.8.1",
+    "typescript": "^5.4.0"
+  },
+  "dependencies": {
+    "@radix-ui/react-tabs": "^1.1.0",
+    "@radix-ui/react-tooltip": "^1.1.0",
+    "eventemitter3": "^5.0.1",
+    "lucide-react": "^0.263.0",
+    "object-hash": "^3.0.0"
+  },
+  "peerDependencies": {
+    "react": ">=16.8.0",
+    "react-dom": ">=16.8.0"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    }
+  },
+  "engines": {
+    "node": ">=16"
+  },
+  "keywords": [
+    "exotel",
+    "ai",
+    "assist",
+    "call",
+    "websocket",
+    "transcript",
+    "sentiment",
+    "suggestion"
+  ]
+}

package/react.js

@@ -0,0 +1,5 @@
+// Webpack 4 / CRA 4 compatibility shim.
+// Modern bundlers (webpack 5+) use the "exports" field in package.json and
+// never load this file.  Webpack 4 does not understand "exports", so it
+// resolves @exotel-npm-dev/exotel-ai-assist/react to this CJS file directly.
+module.exports = require("./dist/react/index.js");