@chanl/widget-sdk 0.2.0-canary.0

package/dist/voice/voice-client.d.ts

@@ -0,0 +1,231 @@
+import { EventEmitter } from 'eventemitter3';
+import { AssistantOverrides, AudialConfig, ConnectionStatus, WebsocketCallCreatePayload, ChatSessionCreatePayload, ChatSessionResponse, ChatMessageResponse, ChatMessage, ChatHistoryResponse, ChatSessionState, ChatState, InboundServerMessage, OutboundClientMessage, TranscriptMessage } from './types';
+interface AudialEventMap extends Record<string, (...args: any[]) => void> {
+    ready: () => void;
+    "speech-start": () => void;
+    "speech-end": () => void;
+    volumeLevel: (v: number) => void;
+    message: (m: InboundServerMessage) => void;
+    transcript: (t: TranscriptMessage) => void;
+    closed: (code: number, reason: string) => void;
+    /**
+     * @deprecated Use `audio-deafened` instead
+     */
+    muted: (m: boolean) => void;
+    "audio-deafened": (deafened: boolean) => void;
+    "audio-undeafened": (deafened: boolean) => void;
+    "mic-muted": () => void;
+    "mic-unmuted": () => void;
+    error: (e: Error) => void;
+    "node-update": (currentNodeId: string) => void;
+    "interruption": () => void;
+    "chat-session-created": (session: ChatSessionResponse) => void;
+    "chat-message": (response: ChatMessageResponse) => void;
+    "chat-state-change": (state: ChatState) => void;
+    "chat-session-ended": (sessionId: string) => void;
+}
+export declare class VoiceClient extends EventEmitter<AudialEventMap> {
+    private publicKey;
+    private config;
+    private readonly log;
+    private state;
+    /**
+     * Active transport — WebSocket or WebRTC.
+     * Created on start(), destroyed on stop().
+     */
+    private transport;
+    /**
+     * Which transport is actually in use for the current call.
+     */
+    private activeTransportType;
+    /**
+     * Room connection state
+     */
+    private roomState;
+    /**
+     * The current node ID
+     */
+    private currentNodeId;
+    private audioDeafened;
+    private micMuted;
+    private retryPolicy;
+    private retryCount;
+    private reconnectTimer;
+    private connectionTimeoutTimer;
+    private lastCallPayload?;
+    private lastOverrides?;
+    private idempotencyKey;
+    private static readonly IDEMPOTENCY_STORAGE_KEY;
+    private static readonly IDEMPOTENCY_STORAGE_AT;
+    private static readonly IDEMPOTENCY_MAX_AGE_MS;
+    private chatState;
+    private chatSession;
+    private chatMessages;
+    constructor(publicKey: string, config?: Partial<AudialConfig>);
+    private getAuthHeaders;
+    private applyPublicKeyAuth;
+    /**
+     * Start a call with the specified agent.
+     * Creates the appropriate transport (WebRTC or WebSocket) and connects.
+     */
+    start(agentId: string, overrides?: AssistantOverrides): void;
+    start(payload: WebsocketCallCreatePayload, overrides?: AssistantOverrides): void;
+    /**
+     * Minimal description of a real-time session result returned by a
+     * `createSession` function. Mirrors the shape of `RealtimeSessionResult`
+     * from `@chanl/sdk` so consumers can pass `sdk.realtime.createSession`'s
+     * return value (after unwrapping `{ data }`) directly, without importing
+     * that type here (which would create a cross-package dependency).
+     *
+     * Only the fields needed for wiring are required; everything else is optional
+     * so this interface is forward-compatible as new credential types are added.
+     */
+    /**
+     * High-level orchestration method: fetch a provider session via an injected
+     * `createSession` function, then wire the credential into `connectProviderSession`.
+     *
+     * This keeps widget-sdk free of a dependency on `@chanl/sdk`. The consumer
+     * (e.g. chanl-admin) injects `sdk.realtime.createSession` as a plain function.
+     *
+     * Phase 1 only supports `credentialType === 'join-url'` (VAPI Daily rooms).
+     * Attempting to start a session with `token` or `ws-url` credentials will
+     * throw immediately with a clear "not yet supported" message.
+     *
+     * @param createSession - Async function that, given an agentId, resolves with
+     *   a session result containing `{ provider, credentialType, joinUrl?, ... }`.
+     * @param agentId - The agent ID to pass to `createSession`.
+     * @param opts.overrides - Optional assistant overrides forwarded to the transport.
+     *
+     * @throws Error if credentialType is not 'join-url' (Phase 1 only).
+     * @throws Error if a call is already active.
+     * @throws Error (async, via 'error' event) if the transport connect fails.
+     */
+    startProviderSession(createSession: (agentId: string) => Promise<{
+        provider: string;
+        credentialType: 'token' | 'join-url' | 'ws-url';
+        joinUrl?: string;
+        token?: string;
+        wsUrl?: string;
+        config?: Record<string, unknown>;
+    }>, agentId: string, opts?: {
+        overrides?: AssistantOverrides;
+    }): Promise<void>;
+    /**
+     * Connect to a provider-managed voice session via a direct join URL.
+     *
+     * Unlike `start()`, this method does NOT call POST /interactions/websocket
+     * to create a room. Instead it instantiates the appropriate provider
+     * transport (currently only 'vapi' is supported) and connects directly
+     * to the provider's session URL (e.g. a VAPI Daily.co web-call URL).
+     *
+     * The public event API (ready, closed, transcript, speech-start, etc.)
+     * is identical to the room-based flow.
+     *
+     * @param params.provider - Provider identifier. Currently supports 'vapi'.
+     * @param params.joinUrl  - The provider's session join URL.
+     * @param params.overrides - Optional assistant overrides forwarded to the transport.
+     *
+     * @throws Error if provider is unsupported or if already in an active call.
+     */
+    connectProviderSession({ provider, joinUrl, overrides, }: {
+        provider: string;
+        joinUrl: string;
+        overrides?: AssistantOverrides;
+    }): void;
+    /**
+     * Internal async implementation of connectProviderSession.
+     * Separated so the public method can remain synchronous (matching start()).
+     */
+    private _connectVapiProviderSession;
+    /**
+     * Stop the current call
+     */
+    stop(code?: number, reason?: string): void;
+    /**
+     * Send a message to the server
+     */
+    send(message: OutboundClientMessage, shouldLog?: boolean): void;
+    deafen(): void;
+    undeafen(): void;
+    toggleDeafen(): void;
+    setVolume(volume: number): void;
+    muteMic(): void;
+    unmuteMic(): Promise<void>;
+    toggleMicMute(): void;
+    /**
+     * Create room and connect via the appropriate transport.
+     */
+    private createRoomAndConnect;
+    /**
+     * Determine which transport to use based on config + browser capabilities.
+     *
+     * Default is 'auto': uses WebRTC if browser supports RTCPeerConnection,
+     * otherwise falls back to WebSocket. Signaling goes through the platform's
+     * /voice-ws/ proxy — no separate bot URL needed.
+     */
+    private resolveTransportType;
+    /**
+     * Get the WebRTC signaling relay URL.
+     *
+     * Points to the platform's bot provider endpoint which relays signaling
+     * to the voice-bot. Same URL in dev, staging, prod — no separate bot URL.
+     *
+     * POST {url}/offer/{interactionId} → platform → voice-bot /offer
+     * POST {url}/candidates → platform → voice-bot /candidates
+     */
+    private resolveSignalingUrl;
+    /**
+     * Create the callbacks object that wires transport events to Audial.
+     */
+    private createTransportCallbacks;
+    /**
+     * Handle messages from the transport. All event routing happens here.
+     * Audio handling is done internally by the transport — we only get
+     * the message for event emission purposes.
+     */
+    private handleTransportMessage;
+    private handleConnectionError;
+    /**
+     * Reconnect the transport layer without re-creating the platform room.
+     * Used by the retry path to avoid leaking a new "queued" interaction per
+     * attempt. The existing roomState is preserved; only a fresh transport
+     * is constructed and connected to the same room.
+     */
+    private retryTransportOnly;
+    reconnect(): void;
+    getConnectionStatus(): ConnectionStatus;
+    private cleanup;
+    private getHttpUrl;
+    private getBaseUrl;
+    private createRoom;
+    /**
+     * Mint a new Idempotency-Key, or restore one from sessionStorage if a
+     * recent key exists (within IDEMPOTENCY_MAX_AGE_MS). Restore path
+     * handles the "user refreshed the tab during a pending connect" case:
+     * the original interaction is still queued on the server, and reusing
+     * the key gets us back the same interaction instead of leaking a new
+     * one.
+     */
+    private restoreOrMintIdempotencyKey;
+    private clearIdempotencyKey;
+    /**
+     * Generate a UUID v4. Prefers crypto.randomUUID() (modern browsers +
+     * Node 14.17+); falls back to a getRandomValues-backed implementation,
+     * and finally Math.random if neither is available (SSR test envs).
+     */
+    private mintUuid;
+    private expandAgentSettings;
+    createChatSession(agentId: string, options?: ChatSessionCreatePayload): Promise<ChatSessionResponse>;
+    sendChatMessage(message: string): Promise<ChatMessageResponse>;
+    streamChatMessage(message: string, onChunk: (text: string) => void): Promise<ChatMessageResponse>;
+    getChatHistory(): Promise<ChatHistoryResponse>;
+    endChatSession(): Promise<void>;
+    getChatState(): ChatState;
+    getChatSession(): ChatSessionState | null;
+    getChatMessages(): ChatMessage[];
+    hasChatSession(): boolean;
+    private setChatState;
+    private resetChatState;
+}
+export {};
+//# sourceMappingURL=voice-client.d.ts.map

package/dist/voice/voice-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"voice-client.d.ts","sourceRoot":"","sources":["../../src/voice/voice-client.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAE7C,OAAO,EACL,kBAAkB,EAClB,YAAY,EAEZ,gBAAgB,EAEhB,0BAA0B,EAI1B,wBAAwB,EACxB,mBAAmB,EACnB,mBAAmB,EACnB,WAAW,EACX,mBAAmB,EACnB,gBAAgB,EAChB,SAAS,EACT,oBAAoB,EACpB,qBAAqB,EACrB,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAOjB,UAAU,cAAe,SAAQ,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,CAAC;IACvE,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,cAAc,EAAE,MAAM,IAAI,CAAC;IAC3B,YAAY,EAAE,MAAM,IAAI,CAAC;IACzB,WAAW,EAAE,CAAC,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IACjC,OAAO,EAAE,CAAC,CAAC,EAAE,oBAAoB,KAAK,IAAI,CAAC;IAC3C,UAAU,EAAE,CAAC,CAAC,EAAE,iBAAiB,KAAK,IAAI,CAAC;IAC3C,MAAM,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/C;;OAEG;IACH,KAAK,EAAE,CAAC,CAAC,EAAE,OAAO,KAAK,IAAI,CAAC;IAC5B,gBAAgB,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,CAAC;IAC9C,kBAAkB,EAAE,CAAC,QAAQ,EAAE,OAAO,KAAK,IAAI,CAAC;IAChD,WAAW,EAAE,MAAM,IAAI,CAAC;IACxB,aAAa,EAAE,MAAM,IAAI,CAAC;IAC1B,KAAK,EAAE,CAAC,CAAC,EAAE,KAAK,KAAK,IAAI,CAAC;IAC1B,aAAa,EAAE,CAAC,aAAa,EAAE,MAAM,KAAK,IAAI,CAAC;IAC/C,cAAc,EAAE,MAAM,IAAI,CAAC;IAE3B,sBAAsB,EAAE,CAAC,OAAO,EAAE,mBAAmB,KAAK,IAAI,CAAC;IAC/D,cAAc,EAAE,CAAC,QAAQ,EAAE,mBAAmB,KAAK,IAAI,CAAC;IACxD,mBAAmB,EAAE,CAAC,KAAK,EAAE,SAAS,KAAK,IAAI,CAAC;IAChD,oBAAoB,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;CACnD;AAED,qBAAa,WAAY,SAAQ,YAAY,CAAC,cAAc,CAAC;IAK3D,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,MAAM,CAAe;IAE7B,OAAO,CAAC,QAAQ,CAAC,GAAG,CAMlB;IAMF,OAAO,CAAC,KAAK,CAAiC;IAE9C;;;OAGG;IACH,OAAO,CAAC,SAAS,CAA2B;IAE5C;;OAEG;IACH,OAAO,CAAC,mBAAmB,CAAgD;IAE3E;;OAEG;IACH,OAAO,CAAC,SAAS,CAAoC;IAErD;;OAEG;IACH,OAAO,CAAC,aAAa,CAAuB;IAM5C,OAAO,CAAC,aAAa,CAAkB;IACvC,OAAO,CAAC,QAAQ,CAAkB;IAMlC,OAAO,CAAC,WAAW,CAAmD;IACtE,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,cAAc,CAA+B;IACrD,OAAO,CAAC,sBAAsB,CAA8C;IAM5E,OAAO,CAAC,eAAe,CAAC,CAA6B;IACrD,OAAO,CAAC,aAAa,CAAC,CAAqB;IAS3C,OAAO,CAAC,cAAc,CAAuB;IAC7C,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,uBAAuB,CAA0B;IACzE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,sBAAsB,CAAyB;IACvE,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,sBAAsB,CAAW;IAMzD,OAAO,CAAC,SAAS,CAA6B;IAC9C,OAAO,CAAC,WAAW,CAAiC;IACpD,OAAO,CAAC,YAAY,CAAqB;gBAE7B,SAAS,EAAE,MAAM,EAAE,MAAM,GAAE,OAAO,CAAC,YAAY,CAAM;IAsCjE,OAAO,CAAC,cAAc;IAatB,OAAO,CAAC,kBAAkB;IAU1B;;;OAGG;IACH,KAAK,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,kBAAkB,GAAG,IAAI;IAC5D,KAAK,CAAC,OAAO,EAAE,0BAA0B,EAAE,SAAS,CAAC,EAAE,kBAAkB,GAAG,IAAI;IA6ChF;;;;;;;;;OASG;IAEH;;;;;;;;;;;;;;;;;;;OAmBG;IACG,oBAAoB,CACxB,aAAa,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,OAAO,CAAC;QAC1C,QAAQ,EAAE,MAAM,CAAC;QACjB,cAAc,EAAE,OAAO,GAAG,UAAU,GAAG,QAAQ,CAAC;QAChD,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KAClC,CAAC,EACF,OAAO,EAAE,MAAM,EACf,IAAI,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,kBAAkB,CAAA;KAAE,GACxC,OAAO,CAAC,IAAI,CAAC;IAgChB;;;;;;;;;;;;;;;;OAgBG;IACH,sBAAsB,CAAC,EACrB,QAAQ,EACR,OAAO,EACP,SAAS,GACV,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,EAAE,MAAM,CAAC;QAChB,SAAS,CAAC,EAAE,kBAAkB,CAAC;KAChC,GAAG,IAAI;IAkCR;;;OAGG;YACW,2BAA2B;IAwBzC;;OAEG;IACH,IAAI,CAAC,IAAI,GAAE,MAAa,EAAE,MAAM,GAAE,MAAsB,GAAG,IAAI;IA6B/D;;OAEG;IACH,IAAI,CAAC,OAAO,EAAE,qBAAqB,EAAE,SAAS,GAAE,OAAc,GAAG,IAAI;IAmCrE,MAAM;IAON,QAAQ;IAOR,YAAY;IAIZ,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAIxB,OAAO,IAAI,IAAI;IAOT,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAWhC,aAAa,IAAI,IAAI;IAM5B;;OAEG;YACW,oBAAoB;IAgFlC;;;;;;OAMG;IACH,OAAO,CAAC,oBAAoB;IAc5B;;;;;;;;OAQG;IACH,OAAO,CAAC,mBAAmB;IAS3B;;OAEG;IACH,OAAO,CAAC,wBAAwB;IAqChC;;;;OAIG;IACH,OAAO,CAAC,sBAAsB;IA4E9B,OAAO,CAAC,qBAAqB;IAmC7B;;;;;OAKG;YACW,kBAAkB;IA+BhC,SAAS,IAAI,IAAI;IAgBjB,mBAAmB,IAAI,gBAAgB;IAiBvC,OAAO,CAAC,OAAO;IAwBf,OAAO,CAAC,UAAU;IAQlB,OAAO,CAAC,UAAU;YA0BJ,UAAU;IAuExB;;;;;;;OAOG;IACH,OAAO,CAAC,2BAA2B;IA2BnC,OAAO,CAAC,mBAAmB;IAU3B;;;;OAIG;IACH,OAAO,CAAC,QAAQ;IAkBhB,OAAO,CAAC,mBAAmB;IAsCrB,iBAAiB,CACrB,OAAO,EAAE,MAAM,EACf,OAAO,GAAE,wBAA6B,GACrC,OAAO,CAAC,mBAAmB,CAAC;IAoDzB,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,mBAAmB,CAAC;IAqE9D,iBAAiB,CACrB,OAAO,EAAE,MAAM,EACf,OAAO,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,GAC9B,OAAO,CAAC,mBAAmB,CAAC;IAsFzB,cAAc,IAAI,OAAO,CAAC,mBAAmB,CAAC;IAuC9C,cAAc,IAAI,OAAO,CAAC,IAAI,CAAC;IA2CrC,YAAY,IAAI,SAAS;IAIzB,cAAc,IAAI,gBAAgB,GAAG,IAAI;IAIzC,eAAe,IAAI,WAAW,EAAE;IAIhC,cAAc,IAAI,OAAO;IAIzB,OAAO,CAAC,YAAY;IAOpB,OAAO,CAAC,cAAc;CAKvB"}