@chatbase-co/voice-sdk 0.1.2

package/dist/index.d.cts

@@ -0,0 +1,85 @@
+/**
+ * The `data` object returned by
+ * `POST /api/v2/agents/{agentId}/voice/sessions`. Only `participantToken`
+ * is required to connect — pass the whole object through.
+ */
+type VoiceSession = {
+    /** Short-lived token scoped to this session's room. */
+    participantToken: string;
+    /** Optional voice server address override; omitted by the API. */
+    serverUrl?: string;
+    sessionId?: string;
+    roomName?: string;
+    maxDurationSeconds?: number;
+    conversationId?: string;
+    userId?: string;
+};
+type ConnectionState = 'connecting' | 'connected' | 'reconnecting' | 'disconnected' | 'error';
+type AgentState = 'initializing' | 'listening' | 'thinking' | 'speaking';
+type TranscriptSegment = {
+    /**
+     * Full text of the segment so far. Segments grow while being spoken —
+     * re-render the segment identified by `segmentId` on every event.
+     */
+    text: string;
+    speaker: 'user' | 'agent';
+    segmentId: string;
+};
+type ChatbaseVoiceEvents = {
+    /** Connection lifecycle of the session transport. */
+    connectionState: (state: ConnectionState) => void;
+    /** What the agent is doing: initializing, listening, thinking, speaking. */
+    agentState: (state: AgentState) => void;
+    /** Live transcripts of both sides, streamed while spoken. */
+    transcript: (segment: TranscriptSegment) => void;
+    /** The session ended (client disconnect, duration limit, credits, …). */
+    sessionEnd: (reason?: string) => void;
+    /** A non-fatal problem (e.g. microphone unavailable) or connect failure. */
+    error: (error: Error) => void;
+};
+
+/**
+ * A real-time voice session with a Chatbase agent.
+ *
+ * Mint a session server-side with `POST /api/v2/agents/{agentId}/voice/sessions`
+ * (the API key must never reach the client), hand the response `data` to
+ * `connect()`, and the agent joins automatically: its audio plays, transcripts
+ * and state stream through the events, and the microphone is live for
+ * barge-in. One instance handles one session; `connect()` again after
+ * `disconnect()` for the next.
+ */
+declare class ChatbaseVoice {
+    private room;
+    private readonly serverUrl;
+    private readonly audioElements;
+    private readonly listeners;
+    constructor(options?: {
+        serverUrl?: string;
+    });
+    /**
+     * Join the session. Accepts the `data` object returned by the voice
+     * sessions endpoint, or just the `participantToken` string. Enables the
+     * microphone if the user allows it; without mic permission the session
+     * continues in text mode (`sendText` still gets spoken replies).
+     */
+    connect(session: VoiceSession | string): Promise<void>;
+    /** Leave the session. The agent hangs up and `sessionEnd` fires. */
+    disconnect(): Promise<void>;
+    /** Stop sending microphone audio. The session stays alive. */
+    mute(): Promise<void>;
+    /** Resume sending microphone audio. */
+    unmute(): Promise<void>;
+    get isMuted(): boolean;
+    /** The local microphone stream, e.g. for a waveform visualization. */
+    get localAudioStream(): MediaStream | null;
+    /** Send a text message into the live session; the agent replies with speech. */
+    sendText(message: string): Promise<void>;
+    /** Subscribe to a session event. Returns an unsubscribe function. */
+    on<E extends keyof ChatbaseVoiceEvents>(event: E, listener: ChatbaseVoiceEvents[E]): () => void;
+    off<E extends keyof ChatbaseVoiceEvents>(event: E, listener: ChatbaseVoiceEvents[E]): void;
+    private emit;
+    private requireRoom;
+    private wire;
+}
+
+export { type AgentState, ChatbaseVoice, type ChatbaseVoiceEvents, type ConnectionState, type TranscriptSegment, type VoiceSession };

package/dist/index.d.ts

@@ -0,0 +1,85 @@
+/**
+ * The `data` object returned by
+ * `POST /api/v2/agents/{agentId}/voice/sessions`. Only `participantToken`
+ * is required to connect — pass the whole object through.
+ */
+type VoiceSession = {
+    /** Short-lived token scoped to this session's room. */
+    participantToken: string;
+    /** Optional voice server address override; omitted by the API. */
+    serverUrl?: string;
+    sessionId?: string;
+    roomName?: string;
+    maxDurationSeconds?: number;
+    conversationId?: string;
+    userId?: string;
+};
+type ConnectionState = 'connecting' | 'connected' | 'reconnecting' | 'disconnected' | 'error';
+type AgentState = 'initializing' | 'listening' | 'thinking' | 'speaking';
+type TranscriptSegment = {
+    /**
+     * Full text of the segment so far. Segments grow while being spoken —
+     * re-render the segment identified by `segmentId` on every event.
+     */
+    text: string;
+    speaker: 'user' | 'agent';
+    segmentId: string;
+};
+type ChatbaseVoiceEvents = {
+    /** Connection lifecycle of the session transport. */
+    connectionState: (state: ConnectionState) => void;
+    /** What the agent is doing: initializing, listening, thinking, speaking. */
+    agentState: (state: AgentState) => void;
+    /** Live transcripts of both sides, streamed while spoken. */
+    transcript: (segment: TranscriptSegment) => void;
+    /** The session ended (client disconnect, duration limit, credits, …). */
+    sessionEnd: (reason?: string) => void;
+    /** A non-fatal problem (e.g. microphone unavailable) or connect failure. */
+    error: (error: Error) => void;
+};
+
+/**
+ * A real-time voice session with a Chatbase agent.
+ *
+ * Mint a session server-side with `POST /api/v2/agents/{agentId}/voice/sessions`
+ * (the API key must never reach the client), hand the response `data` to
+ * `connect()`, and the agent joins automatically: its audio plays, transcripts
+ * and state stream through the events, and the microphone is live for
+ * barge-in. One instance handles one session; `connect()` again after
+ * `disconnect()` for the next.
+ */
+declare class ChatbaseVoice {
+    private room;
+    private readonly serverUrl;
+    private readonly audioElements;
+    private readonly listeners;
+    constructor(options?: {
+        serverUrl?: string;
+    });
+    /**
+     * Join the session. Accepts the `data` object returned by the voice
+     * sessions endpoint, or just the `participantToken` string. Enables the
+     * microphone if the user allows it; without mic permission the session
+     * continues in text mode (`sendText` still gets spoken replies).
+     */
+    connect(session: VoiceSession | string): Promise<void>;
+    /** Leave the session. The agent hangs up and `sessionEnd` fires. */
+    disconnect(): Promise<void>;
+    /** Stop sending microphone audio. The session stays alive. */
+    mute(): Promise<void>;
+    /** Resume sending microphone audio. */
+    unmute(): Promise<void>;
+    get isMuted(): boolean;
+    /** The local microphone stream, e.g. for a waveform visualization. */
+    get localAudioStream(): MediaStream | null;
+    /** Send a text message into the live session; the agent replies with speech. */
+    sendText(message: string): Promise<void>;
+    /** Subscribe to a session event. Returns an unsubscribe function. */
+    on<E extends keyof ChatbaseVoiceEvents>(event: E, listener: ChatbaseVoiceEvents[E]): () => void;
+    off<E extends keyof ChatbaseVoiceEvents>(event: E, listener: ChatbaseVoiceEvents[E]): void;
+    private emit;
+    private requireRoom;
+    private wire;
+}
+
+export { type AgentState, ChatbaseVoice, type ChatbaseVoiceEvents, type ConnectionState, type TranscriptSegment, type VoiceSession };