@anganyai/voice-sdk 0.0.2 → 0.0.5

package/dist/index.d.cts

@@ -6,10 +6,23 @@
  */
 interface VoiceConfig {
     /**
-     * The base URL of the Angany API
+     * The base URL of the Angany API (REST endpoints)
+     * Used for authentication, conversation management, and other REST API calls
      * @default 'https://api.angany.ai'
      */
     apiUrl: string;
+    /**
+     * The base URL for Server-Sent Events (SSE) streaming
+     * Used for real-time transcription and event streaming
+     * @default Same as apiUrl
+     */
+    sseUrl?: string;
+    /**
+     * The WebSocket URL for SIP/WebRTC connections
+     * Used for voice communication
+     * @default Derived from apiUrl (wss://{apiUrl.hostname}/api/webrtc/)
+     */
+    sipUrl?: string;
     /**
      * The OIDC issuer URL
      * @default Same as apiUrl
@@ -854,6 +867,11 @@ declare class AuthManager extends EventEmitter<AuthEvents> {
     getEphemeralCredentialsForUser(userAccessToken: string): Promise<EphemeralCredentials>;
     /**
      * Get ephemeral credentials for WebRTC connections
+     *
+     * Returns cached credentials if available and valid, otherwise fetches new ones.
+     * This supports both:
+     * - Externally-provided credentials (via setEphemeralCredentials)
+     * - SDK-managed credentials (fetched using access token)
      */
     getEphemeralCredentials(): Promise<EphemeralCredentials>;
     /**
@@ -1248,12 +1266,27 @@ interface ConversationEvents extends Record<string, unknown[]> {
             text: string;
             timestamp: Date;
             isFinal: boolean;
+            humanTurnId?: string | undefined;
+            agentTurnId?: string | undefined;
+            speakerId?: string | number | undefined;
         }
     ];
     /**
      * Emitted on error
      */
     error: [error: Error];
+    /**
+     * Emitted when call ID is received
+     */
+    callId: [callId: string];
+    /**
+     * Emitted when call starts
+     */
+    callStarted: [callId: string];
+    /**
+     * Emitted when call ends
+     */
+    callEnded: [callId: string];
     /**
      * Emitted when agent is muted/unmuted
      */
@@ -1290,6 +1323,17 @@ interface ConversationEvents extends Record<string, unknown[]> {
  * Conversation management
  */
 
+/**
+ * URL configuration for conversation services
+ */
+interface ConversationUrls {
+    /** Base URL for REST API calls */
+    apiUrl: string;
+    /** Base URL for SSE streaming (defaults to apiUrl) */
+    sseUrl?: string | undefined;
+    /** WebSocket URL for SIP/WebRTC (defaults to derived from apiUrl) */
+    sipUrl?: string | undefined;
+}
 /**
  * Represents an active voice conversation
  */
@@ -1302,7 +1346,7 @@ declare class Conversation extends EventEmitter<ConversationEvents> {
     private userMuted;
     private startTime?;
     private endTime?;
-    private apiUrl;
+    private urls;
     private authManager;
     private sipManager;
     private transcriptionService;
@@ -1310,7 +1354,7 @@ declare class Conversation extends EventEmitter<ConversationEvents> {
     private callId?;
     private ephemeralCredentials?;
     private accessToken?;
-    constructor(id: string, options: ConversationOptions, authManager: AuthManager, apiUrl: string);
+    constructor(id: string, options: ConversationOptions, authManager: AuthManager, urls: ConversationUrls);
     /**
      * Initialize and start the conversation
      */
@@ -1319,8 +1363,15 @@ declare class Conversation extends EventEmitter<ConversationEvents> {
      * Send text to be spoken in the conversation
      */
     speak(text: string, options?: {
-        interrupt?: boolean;
-        waitForResponse?: boolean;
+        interruptsConversation?: boolean;
+        queueWhenSpeaking?: boolean;
+        muteAgent?: boolean | null;
+        voiceSettings?: {
+            stability?: number;
+            similarity_boost?: number;
+            style?: number;
+            use_speaker_boost?: boolean;
+        } | null;
     }): Promise<void>;
     /**
      * Mute or unmute the user's microphone
@@ -1338,6 +1389,24 @@ declare class Conversation extends EventEmitter<ConversationEvents> {
      * Check if agent is muted
      */
     isAgentMuted(): boolean;
+    /**
+     * Get the current call ID (available after connection)
+     */
+    getCallId(): string | undefined;
+    /**
+     * Mute the call via API (POST /calls/{call_id}/mute)
+     */
+    muteCall(): Promise<void>;
+    /**
+     * Unmute the call via API (DELETE /calls/{call_id}/mute)
+     */
+    unmuteCall(): Promise<void>;
+    /**
+     * Get call mute status via API (GET /calls/{call_id}/mute)
+     */
+    getCallMuteStatus(): Promise<{
+        muted: boolean;
+    }>;
     /**
      * Get conversation status
      */
@@ -1705,4 +1774,4 @@ declare function hasErrorCode(error: unknown, code: string): boolean;
  */
 declare const VERSION = "0.0.2";
 
-export { AnganyError, AnganyVoice, type AuthError, type AuthEvents, AuthManager, type AuthOptions, type AuthState, type AuthStatus, AuthenticationError, type BackendAuthOptions, type ClientCredentials, ConfigurationError, Conversation, ConversationError, type ConversationOptions, type ConversationState, type ConversationStatus, ErrorCodes, EventEmitter, type FrontendAuthOptions, type LogLevel, MediaError, NetworkError, PermissionError, ResourceError, type ServiceAccountAuthOptions, type ServiceAccountCredentials, type SpeakOptions, type TokenSet, type TranscriptionEvent, type UserInfo, VERSION, ValidationError, type VoiceConfig, type VoiceResource, hasErrorCode, isAnganyError };
+export { AnganyError, AnganyVoice, type AuthError, type AuthEvents, AuthManager, type AuthOptions, type AuthState, type AuthStatus, AuthenticationError, type BackendAuthOptions, type ClientCredentials, ConfigurationError, Conversation, ConversationError, type ConversationOptions, type ConversationState, type ConversationStatus, type ConversationUrls, ErrorCodes, EventEmitter, type FrontendAuthOptions, type LogLevel, MediaError, NetworkError, PermissionError, ResourceError, type ServiceAccountAuthOptions, type ServiceAccountCredentials, type SpeakOptions, type TokenSet, type TranscriptionEvent, type UserInfo, VERSION, ValidationError, type VoiceConfig, type VoiceResource, hasErrorCode, isAnganyError };

package/dist/index.d.ts

@@ -6,10 +6,23 @@
  */
 interface VoiceConfig {
     /**
-     * The base URL of the Angany API
+     * The base URL of the Angany API (REST endpoints)
+     * Used for authentication, conversation management, and other REST API calls
      * @default 'https://api.angany.ai'
      */
     apiUrl: string;
+    /**
+     * The base URL for Server-Sent Events (SSE) streaming
+     * Used for real-time transcription and event streaming
+     * @default Same as apiUrl
+     */
+    sseUrl?: string;
+    /**
+     * The WebSocket URL for SIP/WebRTC connections
+     * Used for voice communication
+     * @default Derived from apiUrl (wss://{apiUrl.hostname}/api/webrtc/)
+     */
+    sipUrl?: string;
     /**
      * The OIDC issuer URL
      * @default Same as apiUrl
@@ -854,6 +867,11 @@ declare class AuthManager extends EventEmitter<AuthEvents> {
     getEphemeralCredentialsForUser(userAccessToken: string): Promise<EphemeralCredentials>;
     /**
      * Get ephemeral credentials for WebRTC connections
+     *
+     * Returns cached credentials if available and valid, otherwise fetches new ones.
+     * This supports both:
+     * - Externally-provided credentials (via setEphemeralCredentials)
+     * - SDK-managed credentials (fetched using access token)
      */
     getEphemeralCredentials(): Promise<EphemeralCredentials>;
     /**
@@ -1248,12 +1266,27 @@ interface ConversationEvents extends Record<string, unknown[]> {
             text: string;
             timestamp: Date;
             isFinal: boolean;
+            humanTurnId?: string | undefined;
+            agentTurnId?: string | undefined;
+            speakerId?: string | number | undefined;
         }
     ];
     /**
      * Emitted on error
      */
     error: [error: Error];
+    /**
+     * Emitted when call ID is received
+     */
+    callId: [callId: string];
+    /**
+     * Emitted when call starts
+     */
+    callStarted: [callId: string];
+    /**
+     * Emitted when call ends
+     */
+    callEnded: [callId: string];
     /**
      * Emitted when agent is muted/unmuted
      */
@@ -1290,6 +1323,17 @@ interface ConversationEvents extends Record<string, unknown[]> {
  * Conversation management
  */
 
+/**
+ * URL configuration for conversation services
+ */
+interface ConversationUrls {
+    /** Base URL for REST API calls */
+    apiUrl: string;
+    /** Base URL for SSE streaming (defaults to apiUrl) */
+    sseUrl?: string | undefined;
+    /** WebSocket URL for SIP/WebRTC (defaults to derived from apiUrl) */
+    sipUrl?: string | undefined;
+}
 /**
  * Represents an active voice conversation
  */
@@ -1302,7 +1346,7 @@ declare class Conversation extends EventEmitter<ConversationEvents> {
     private userMuted;
     private startTime?;
     private endTime?;
-    private apiUrl;
+    private urls;
     private authManager;
     private sipManager;
     private transcriptionService;
@@ -1310,7 +1354,7 @@ declare class Conversation extends EventEmitter<ConversationEvents> {
     private callId?;
     private ephemeralCredentials?;
     private accessToken?;
-    constructor(id: string, options: ConversationOptions, authManager: AuthManager, apiUrl: string);
+    constructor(id: string, options: ConversationOptions, authManager: AuthManager, urls: ConversationUrls);
     /**
      * Initialize and start the conversation
      */
@@ -1319,8 +1363,15 @@ declare class Conversation extends EventEmitter<ConversationEvents> {
      * Send text to be spoken in the conversation
      */
     speak(text: string, options?: {
-        interrupt?: boolean;
-        waitForResponse?: boolean;
+        interruptsConversation?: boolean;
+        queueWhenSpeaking?: boolean;
+        muteAgent?: boolean | null;
+        voiceSettings?: {
+            stability?: number;
+            similarity_boost?: number;
+            style?: number;
+            use_speaker_boost?: boolean;
+        } | null;
     }): Promise<void>;
     /**
      * Mute or unmute the user's microphone
@@ -1338,6 +1389,24 @@ declare class Conversation extends EventEmitter<ConversationEvents> {
      * Check if agent is muted
      */
     isAgentMuted(): boolean;
+    /**
+     * Get the current call ID (available after connection)
+     */
+    getCallId(): string | undefined;
+    /**
+     * Mute the call via API (POST /calls/{call_id}/mute)
+     */
+    muteCall(): Promise<void>;
+    /**
+     * Unmute the call via API (DELETE /calls/{call_id}/mute)
+     */
+    unmuteCall(): Promise<void>;
+    /**
+     * Get call mute status via API (GET /calls/{call_id}/mute)
+     */
+    getCallMuteStatus(): Promise<{
+        muted: boolean;
+    }>;
     /**
      * Get conversation status
      */
@@ -1705,4 +1774,4 @@ declare function hasErrorCode(error: unknown, code: string): boolean;
  */
 declare const VERSION = "0.0.2";
 
-export { AnganyError, AnganyVoice, type AuthError, type AuthEvents, AuthManager, type AuthOptions, type AuthState, type AuthStatus, AuthenticationError, type BackendAuthOptions, type ClientCredentials, ConfigurationError, Conversation, ConversationError, type ConversationOptions, type ConversationState, type ConversationStatus, ErrorCodes, EventEmitter, type FrontendAuthOptions, type LogLevel, MediaError, NetworkError, PermissionError, ResourceError, type ServiceAccountAuthOptions, type ServiceAccountCredentials, type SpeakOptions, type TokenSet, type TranscriptionEvent, type UserInfo, VERSION, ValidationError, type VoiceConfig, type VoiceResource, hasErrorCode, isAnganyError };
+export { AnganyError, AnganyVoice, type AuthError, type AuthEvents, AuthManager, type AuthOptions, type AuthState, type AuthStatus, AuthenticationError, type BackendAuthOptions, type ClientCredentials, ConfigurationError, Conversation, ConversationError, type ConversationOptions, type ConversationState, type ConversationStatus, type ConversationUrls, ErrorCodes, EventEmitter, type FrontendAuthOptions, type LogLevel, MediaError, NetworkError, PermissionError, ResourceError, type ServiceAccountAuthOptions, type ServiceAccountCredentials, type SpeakOptions, type TokenSet, type TranscriptionEvent, type UserInfo, VERSION, ValidationError, type VoiceConfig, type VoiceResource, hasErrorCode, isAnganyError };