@vapi-ai/web 2.5.1 → 2.6.1

package/vapi.ts

@@ -5,7 +5,12 @@ import DailyIframe, {
   DailyAdvancedConfig,
   DailyFactoryOptions,
   DailyEventObjectAppMessage,
+  DailyEventObjectLocalAudioLevel,
+  DailyEventObjectNoPayload,
   DailyEventObjectParticipant,
+  DailyEventObjectRecordingError,
+  DailyEventObjectRecordingStarted,
+  DailyEventObjectRecordingStopped,
   DailyEventObjectRemoteParticipantsAudioLevel,
   DailyParticipant,
   DailyVideoSendSettings,
@@ -62,6 +67,8 @@ type VapiEventNames =
   | 'call-end'
   | 'call-start'
   | 'volume-level'
+  | 'local-volume-level'
+  | 'local-audio-level-observer-error'
   | 'speech-start'
   | 'speech-end'
   | 'message'
@@ -73,7 +80,12 @@ type VapiEventNames =
   | 'daily-participant-updated'
   | 'call-start-progress'
   | 'call-start-success'
-  | 'call-start-failed';
+  | 'call-start-failed'
+  | 'recording-started'
+  | 'recording-stopped'
+  | 'recording-stats'
+  | 'recording-error'
+  | 'recording-upload-completed';
 
 interface CallStartProgressEvent {
   stage: string;
@@ -98,10 +110,79 @@ interface CallStartFailedEvent {
   context: Record<string, any>;
 }
 
+interface SerializedError {
+  message: string;
+  name?: string;
+  stack?: string;
+  code?: string | number;
+  cause?: string;
+  [key: string]: any;
+}
+
+/**
+ * Extracts error details into a plain object that serializes properly to JSON.
+ * Error objects don't serialize well because their properties (message, stack, name) 
+ * are not enumerable and get lost when using JSON.stringify().
+ */
+function serializeError(error: unknown): SerializedError {
+  if (error === null || error === undefined) {
+    return { message: 'Unknown error (null or undefined)' };
+  }
+  
+  if (error instanceof Error) {
+    const serialized: SerializedError = {
+      message: error.message,
+      name: error.name,
+      stack: error.stack,
+    };
+    
+    // Include any additional properties that might be on the error
+    const errorAsAny = error as any;
+    if (errorAsAny.code !== undefined) {
+      serialized.code = errorAsAny.code;
+    }
+    if (errorAsAny.cause !== undefined) {
+      serialized.cause = String(errorAsAny.cause);
+    }
+    if (errorAsAny.reason !== undefined) {
+      serialized.reason = errorAsAny.reason;
+    }
+    if (errorAsAny.details !== undefined) {
+      serialized.details = errorAsAny.details;
+    }
+    // Daily.co specific error properties
+    if (errorAsAny.errorMsg !== undefined) {
+      serialized.errorMsg = errorAsAny.errorMsg;
+    }
+    if (errorAsAny.error !== undefined && typeof errorAsAny.error === 'string') {
+      serialized.errorDetail = errorAsAny.error;
+    }
+    
+    return serialized;
+  }
+  
+  if (typeof error === 'string') {
+    return { message: error };
+  }
+  
+  if (typeof error === 'object') {
+    // It's already a plain object, but let's ensure message exists
+    const errorObj = error as Record<string, any>;
+    return {
+      message: errorObj.message || errorObj.error || JSON.stringify(error),
+      ...errorObj
+    };
+  }
+  
+  return { message: String(error) };
+}
+
 type VapiEventListeners = {
   'call-end': () => void;
   'call-start': () => void;
   'volume-level': (volume: number) => void;
+  'local-volume-level': (volume: number) => void;
+  'local-audio-level-observer-error': (error: any) => void;
   'speech-start': () => void;
   'speech-end': () => void;
   video: (track: MediaStreamTrack) => void;
@@ -114,6 +195,11 @@ type VapiEventListeners = {
   'call-start-progress': (event: CallStartProgressEvent) => void;
   'call-start-success': (event: CallStartSuccessEvent) => void;
   'call-start-failed': (event: CallStartFailedEvent) => void;
+  'recording-started': (event: DailyEventObjectRecordingStarted) => void;
+  'recording-stopped': (event: DailyEventObjectRecordingStopped) => void;
+  'recording-stats': (event: DailyEventObjectNoPayload) => void;
+  'recording-error': (event: DailyEventObjectRecordingError) => void;
+  'recording-upload-completed': (event: DailyEventObjectNoPayload) => void;
 };
 
 type StartCallOptions = {
@@ -298,7 +384,7 @@ export default class Vapi extends VapiEventEmitter {
       this.emit('error', { 
         type: 'validation-error', 
         stage: 'input-validation',
-        message: error.message,
+        error: serializeError(error),
         timestamp: new Date().toISOString()
       });
       throw error;
@@ -410,17 +496,18 @@ export default class Vapi extends VapiEventEmitter {
         });
       } catch (error) {
         const dailyCallDuration = Date.now() - dailyCallStartTime;
+        const serializedError = serializeError(error);
         this.emit('call-start-progress', {
           stage: 'daily-call-object-creation',
           status: 'failed',
           duration: dailyCallDuration,
           timestamp: new Date().toISOString(),
-          metadata: { error: error?.toString() }
+          metadata: { error: serializedError.message }
         });
         this.emit('error', {
           type: 'daily-call-object-creation-error',
           stage: 'daily-call-object-creation',
-          error,
+          error: serializedError,
           timestamp: new Date().toISOString()
         });
         throw error;
@@ -445,14 +532,22 @@ export default class Vapi extends VapiEventEmitter {
       });
 
       this.call.on('error', (error: any) => {
-        this.emit('error', error);
+        this.emit('error', {
+          type: 'daily-error',
+          error: serializeError(error),
+          timestamp: new Date().toISOString()
+        });
         if (isVideoRecordingEnabled) {
           this.call?.stopRecording();
         }
       });
 
       this.call.on('camera-error', (error: any) => {
-        this.emit('camera-error', error);
+        this.emit('camera-error', {
+          type: 'camera-error',
+          error: serializeError(error),
+          timestamp: new Date().toISOString()
+        });
       });
 
       this.call.on('network-quality-change', (event: any) => {
@@ -463,6 +558,26 @@ export default class Vapi extends VapiEventEmitter {
         this.emit('network-connection', event);
       });
 
+      this.call.on('recording-started', (event) => {
+        if (event) this.emit('recording-started', event);
+      });
+
+      this.call.on('recording-stopped', (event) => {
+        if (event) this.emit('recording-stopped', event);
+      });
+
+      this.call.on('recording-stats', (event) => {
+        if (event) this.emit('recording-stats', event);
+      });
+
+      this.call.on('recording-error', (event) => {
+        if (event) this.emit('recording-error', event);
+      });
+
+      this.call.on('recording-upload-completed', (event) => {
+        if (event) this.emit('recording-upload-completed', event);
+      });
+
       this.call.on('track-started', async (e) => {
         if (!e || !e.participant) {
           return;
@@ -560,17 +675,18 @@ export default class Vapi extends VapiEventEmitter {
         });
       } catch (error) {
         const joinDuration = Date.now() - joinStartTime;
+        const serializedError = serializeError(error);
         this.emit('call-start-progress', {
           stage: 'daily-call-join',
           status: 'failed',
           duration: joinDuration,
           timestamp: new Date().toISOString(),
-          metadata: { error: error?.toString() }
+          metadata: { error: serializedError.message }
         });
         this.emit('error', {
           type: 'daily-call-join-error',
           stage: 'daily-call-join',
-          error,
+          error: serializedError,
           duration: joinDuration,
           timestamp: new Date().toISOString()
         });
@@ -623,17 +739,18 @@ export default class Vapi extends VapiEventEmitter {
           });
         } catch (error) {
           const recordingSetupDuration = Date.now() - recordingStartTime;
+          const serializedError = serializeError(error);
           this.emit('call-start-progress', {
             stage: 'video-recording-setup',
             status: 'failed',
             duration: recordingSetupDuration,
             timestamp: new Date().toISOString(),
-            metadata: { error: error?.toString() }
+            metadata: { error: serializedError.message }
           });
           this.emit('error', {
             type: 'video-recording-setup-error',
             stage: 'video-recording-setup',
-            error,
+            error: serializedError,
             timestamp: new Date().toISOString()
           });
           // Don't throw here, video recording is optional
@@ -658,6 +775,7 @@ export default class Vapi extends VapiEventEmitter {
       
       try {
         this.call.startRemoteParticipantsAudioLevelObserver(100);
+        this.call.startLocalAudioLevelObserver(100);
         const audioObserverDuration = Date.now() - audioObserverStartTime;
         this.emit('call-start-progress', {
           stage: 'audio-observer-setup',
@@ -667,17 +785,18 @@ export default class Vapi extends VapiEventEmitter {
         });
       } catch (error) {
         const audioObserverDuration = Date.now() - audioObserverStartTime;
+        const serializedError = serializeError(error);
         this.emit('call-start-progress', {
           stage: 'audio-observer-setup',
           status: 'failed',
           duration: audioObserverDuration,
           timestamp: new Date().toISOString(),
-          metadata: { error: error?.toString() }
+          metadata: { error: serializedError.message }
         });
         this.emit('error', {
           type: 'audio-observer-setup-error',
           stage: 'audio-observer-setup',
-          error,
+          error: serializedError,
           timestamp: new Date().toISOString()
         });
         // Don't throw here, this is non-critical
@@ -687,10 +806,17 @@ export default class Vapi extends VapiEventEmitter {
         if (e) this.handleRemoteParticipantsAudioLevel(e);
       });
 
+      this.call.on('local-audio-level', (e) => {
+        if (e) this.handleLocalAudioLevel(e);
+      });
+
       this.call.on('app-message', (e) => this.onAppMessage(e));
 
       this.call.on('nonfatal-error', (e) => {
         // https://docs.daily.co/reference/daily-js/events/meeting-events#type-audio-processor-error
+        if (e?.type === 'local-audio-level-observer-error') {
+          this.emit('local-audio-level-observer-error', serializeError(e));
+        }
         if (e?.type === 'audio-processor-error') {
           this.call
             ?.updateInputSettings({
@@ -733,17 +859,18 @@ export default class Vapi extends VapiEventEmitter {
         });
       } catch (error) {
         const audioProcessingDuration = Date.now() - audioProcessingStartTime;
+        const serializedError = serializeError(error);
         this.emit('call-start-progress', {
           stage: 'audio-processing-setup',
           status: 'failed',
           duration: audioProcessingDuration,
           timestamp: new Date().toISOString(),
-          metadata: { error: error?.toString() }
+          metadata: { error: serializedError.message }
         });
         this.emit('error', {
           type: 'audio-processing-setup-error',
           stage: 'audio-processing-setup',
-          error,
+          error: serializedError,
           timestamp: new Date().toISOString()
         });
         // Don't throw here, this is non-critical
@@ -759,12 +886,13 @@ export default class Vapi extends VapiEventEmitter {
       return webCall;
     } catch (e) {
       const totalDuration = Date.now() - startTime;
+      const serializedError = serializeError(e);
       
       this.emit('call-start-failed', {
         stage: 'unknown',
         totalDuration,
-        error: e?.toString() || 'Unknown error occurred',
-        errorStack: e instanceof Error ? e.stack : 'No stack trace available',
+        error: serializedError.message,
+        errorStack: serializedError.stack || 'No stack trace available',
         timestamp: new Date().toISOString(),
         context: {
           hasAssistant: !!assistant,
@@ -778,7 +906,7 @@ export default class Vapi extends VapiEventEmitter {
       this.emit('error', {
         type: 'start-method-error',
         stage: 'unknown',
-        error: e,
+        error: serializedError,
         totalDuration,
         timestamp: new Date().toISOString(),
         context: {
@@ -846,6 +974,10 @@ export default class Vapi extends VapiEventEmitter {
     }, 1000);
   }
 
+  private handleLocalAudioLevel(e: DailyEventObjectLocalAudioLevel) {
+    this.emit('local-volume-level', e.audioLevel);
+  }
+
   /**
    * Stops the call by destroying the Daily call object.
    * 
@@ -946,6 +1078,57 @@ export default class Vapi extends VapiEventEmitter {
     return this.call;
   }
 
+  /**
+   * Returns the most recent local (microphone) audio level, a number between 0 and 1.
+   *
+   * Useful for detecting when the local participant's microphone is not picking up any
+   * audio (e.g. wrong input device selected, OS-level input volume at 0, or muted
+   * hardware) so you can surface a "we can't hear you" style warning in your UI.
+   *
+   * Returns 0 when there is no active call.
+   */
+  public getLocalAudioLevel(): number {
+    if (!this.call) {
+      return 0;
+    }
+    return this.call.getLocalAudioLevel();
+  }
+
+  /**
+   * Starts (or restarts) the local audio level observer. The observer is started
+   * automatically when a call begins, but this can be used to change the sampling
+   * interval or restart it if it was stopped.
+   *
+   * While running, the Vapi instance emits 'local-volume-level' events with the local
+   * microphone audio level (0 to 1).
+   *
+   * @param interval How often, in milliseconds, to emit audio level events. Defaults to Daily's default.
+   */
+  public async startLocalAudioLevelObserver(interval?: number): Promise<void> {
+    if (!this.call) {
+      throw new Error('Call object is not available.');
+    }
+    await this.call.startLocalAudioLevelObserver(interval);
+  }
+
+  /**
+   * Stops the local audio level observer. After calling this, 'local-volume-level'
+   * events will no longer be emitted until the observer is started again.
+   */
+  public stopLocalAudioLevelObserver(): void {
+    this.call?.stopLocalAudioLevelObserver();
+  }
+
+  /**
+   * Returns whether the local audio level observer is currently running.
+   */
+  public isLocalAudioLevelObserverRunning(): boolean {
+    if (!this.call) {
+      return false;
+    }
+    return this.call.isLocalAudioLevelObserverRunning();
+  }
+
   public startScreenSharing(displayMediaOptions?: DisplayMediaStreamOptions, screenVideoSendSettings?: DailyVideoSendSettings) {
     this.call?.startScreenShare({
       displayMediaOptions,
@@ -1054,14 +1237,22 @@ export default class Vapi extends VapiEventEmitter {
       });
 
       this.call.on('error', (error: any) => {
-        this.emit('error', error);
+        this.emit('error', {
+          type: 'daily-error',
+          error: serializeError(error),
+          timestamp: new Date().toISOString()
+        });
         if (isVideoRecordingEnabled) {
           this.call?.stopRecording();
         }
       });
 
       this.call.on('camera-error', (error: any) => {
-        this.emit('camera-error', error);
+        this.emit('camera-error', {
+          type: 'camera-error',
+          error: serializeError(error),
+          timestamp: new Date().toISOString()
+        });
       });
 
       this.call.on('network-quality-change', (event: any) => {
@@ -1072,6 +1263,26 @@ export default class Vapi extends VapiEventEmitter {
         this.emit('network-connection', event);
       });
 
+      this.call.on('recording-started', (event) => {
+        if (event) this.emit('recording-started', event);
+      });
+
+      this.call.on('recording-stopped', (event) => {
+        if (event) this.emit('recording-stopped', event);
+      });
+
+      this.call.on('recording-stats', (event) => {
+        if (event) this.emit('recording-stats', event);
+      });
+
+      this.call.on('recording-error', (event) => {
+        if (event) this.emit('recording-error', event);
+      });
+
+      this.call.on('recording-upload-completed', (event) => {
+        if (event) this.emit('recording-upload-completed', event);
+      });
+
       this.call.on('track-started', async (e) => {
         if (!e || !e.participant) {
           return;
@@ -1119,10 +1330,17 @@ export default class Vapi extends VapiEventEmitter {
         if (e) this.handleRemoteParticipantsAudioLevel(e);
       });
 
+      this.call.on('local-audio-level', (e) => {
+        if (e) this.handleLocalAudioLevel(e);
+      });
+
       this.call.on('app-message', (e) => this.onAppMessage(e));
 
       this.call.on('nonfatal-error', (e) => {
         // https://docs.daily.co/reference/daily-js/events/meeting-events#type-audio-processor-error
+        if (e?.type === 'local-audio-level-observer-error') {
+          this.emit('local-audio-level-observer-error', serializeError(e));
+        }
         if (e?.type === 'audio-processor-error') {
           this.call
             ?.updateInputSettings({
@@ -1234,12 +1452,13 @@ export default class Vapi extends VapiEventEmitter {
           });
         } catch (error) {
           const recordingSetupDuration = Date.now() - recordingStartTime;
+          const serializedError = serializeError(error);
           this.emit('call-start-progress', {
             stage: 'video-recording-setup',
             status: 'failed',
             duration: recordingSetupDuration,
             timestamp: new Date().toISOString(),
-            metadata: { error: error?.toString() }
+            metadata: { error: serializedError.message }
           });
           // Don't throw here, video recording is optional
         }
@@ -1263,6 +1482,7 @@ export default class Vapi extends VapiEventEmitter {
       
       try {
         this.call.startRemoteParticipantsAudioLevelObserver(100);
+        this.call.startLocalAudioLevelObserver(100);
         const audioObserverDuration = Date.now() - audioObserverStartTime;
         this.emit('call-start-progress', {
           stage: 'audio-observer-setup',
@@ -1272,12 +1492,13 @@ export default class Vapi extends VapiEventEmitter {
         });
       } catch (error) {
         const audioObserverDuration = Date.now() - audioObserverStartTime;
+        const serializedError = serializeError(error);
         this.emit('call-start-progress', {
           stage: 'audio-observer-setup',
           status: 'failed',
           duration: audioObserverDuration,
           timestamp: new Date().toISOString(),
-          metadata: { error: error?.toString() }
+          metadata: { error: serializedError.message }
         });
         // Don't throw here, this is non-critical
       }
@@ -1309,12 +1530,13 @@ export default class Vapi extends VapiEventEmitter {
         });
       } catch (error) {
         const audioProcessingDuration = Date.now() - audioProcessingStartTime;
+        const serializedError = serializeError(error);
         this.emit('call-start-progress', {
           stage: 'audio-processing-setup',
           status: 'failed',
           duration: audioProcessingDuration,
           timestamp: new Date().toISOString(),
-          metadata: { error: error?.toString() }
+          metadata: { error: serializedError.message }
         });
         // Don't throw here, this is non-critical
       }
@@ -1330,12 +1552,13 @@ export default class Vapi extends VapiEventEmitter {
 
     } catch (e) {
       const totalDuration = Date.now() - startTime;
+      const serializedError = serializeError(e);
       
       this.emit('call-start-failed', {
         stage: 'reconnect',
         totalDuration,
-        error: e?.toString() || 'Unknown error occurred',
-        errorStack: e instanceof Error ? e.stack : 'No stack trace available',
+        error: serializedError.message,
+        errorStack: serializedError.stack || 'No stack trace available',
         timestamp: new Date().toISOString(),
         context: {
           isReconnect: true,
@@ -1349,7 +1572,7 @@ export default class Vapi extends VapiEventEmitter {
       // Also emit the generic error event for backward compatibility
       this.emit('error', {
         type: 'reconnect-error',
-        error: e,
+        error: serializedError,
         totalDuration,
         timestamp: new Date().toISOString(),
         context: {