@vapi-ai/web 2.5.2 → 2.6.1

package/dist/vapi.d.ts

@@ -1,5 +1,5 @@
 import type { ChatCompletionMessageParam } from 'openai/resources';
-import { DailyCall, DailyAdvancedConfig, DailyFactoryOptions, DailyParticipant, DailyVideoSendSettings } from '@daily-co/daily-js';
+import { DailyCall, DailyAdvancedConfig, DailyFactoryOptions, DailyEventObjectNoPayload, DailyEventObjectRecordingError, DailyEventObjectRecordingStarted, DailyEventObjectRecordingStopped, DailyParticipant, DailyVideoSendSettings } from '@daily-co/daily-js';
 import EventEmitter from 'events';
 import { Call, CreateSquadDTO, CreateAssistantDTO, AssistantOverrides, CreateWorkflowDTO, WorkflowOverrides } from './api';
 export interface EndCallMessage {
@@ -23,7 +23,7 @@ export interface SayMessage {
     interruptAssistantEnabled?: boolean;
 }
 type VapiClientToServerMessage = AddMessageMessage | ControlMessages | SayMessage | EndCallMessage;
-type VapiEventNames = 'call-end' | 'call-start' | 'volume-level' | 'speech-start' | 'speech-end' | 'message' | 'video' | 'error' | 'camera-error' | 'network-quality-change' | 'network-connection' | 'daily-participant-updated' | 'call-start-progress' | 'call-start-success' | 'call-start-failed';
+type VapiEventNames = 'call-end' | 'call-start' | 'volume-level' | 'local-volume-level' | 'local-audio-level-observer-error' | 'speech-start' | 'speech-end' | 'message' | 'video' | 'error' | 'camera-error' | 'network-quality-change' | 'network-connection' | 'daily-participant-updated' | 'call-start-progress' | 'call-start-success' | 'call-start-failed' | 'recording-started' | 'recording-stopped' | 'recording-stats' | 'recording-error' | 'recording-upload-completed';
 interface CallStartProgressEvent {
     stage: string;
     status: 'started' | 'completed' | 'failed';
@@ -48,6 +48,8 @@ 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;
@@ -60,6 +62,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 = {
     /**
@@ -123,6 +130,7 @@ export default class Vapi extends VapiEventEmitter {
     start(assistant?: CreateAssistantDTO | string, assistantOverrides?: AssistantOverrides, squad?: CreateSquadDTO | string, workflow?: CreateWorkflowDTO | string, workflowOverrides?: WorkflowOverrides, options?: StartCallOptions): Promise<Call | null>;
     private onAppMessage;
     private handleRemoteParticipantsAudioLevel;
+    private handleLocalAudioLevel;
     /**
      * Stops the call by destroying the Daily call object.
      *
@@ -149,6 +157,36 @@ export default class Vapi extends VapiEventEmitter {
     increaseMicLevel(gain: number): Promise<void>;
     setOutputDeviceAsync(options: Parameters<DailyCall['setOutputDeviceAsync']>[0]): void;
     getDailyCallObject(): DailyCall | null;
+    /**
+     * 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.
+     */
+    getLocalAudioLevel(): number;
+    /**
+     * 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.
+     */
+    startLocalAudioLevelObserver(interval?: number): Promise<void>;
+    /**
+     * Stops the local audio level observer. After calling this, 'local-volume-level'
+     * events will no longer be emitted until the observer is started again.
+     */
+    stopLocalAudioLevelObserver(): void;
+    /**
+     * Returns whether the local audio level observer is currently running.
+     */
+    isLocalAudioLevelObserverRunning(): boolean;
     startScreenSharing(displayMediaOptions?: DisplayMediaStreamOptions, screenVideoSendSettings?: DailyVideoSendSettings): void;
     stopScreenSharing(): void;
     /**

package/dist/vapi.js

@@ -300,6 +300,26 @@ class Vapi extends VapiEventEmitter {
             this.call.on('network-connection', (event) => {
                 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;
@@ -479,6 +499,7 @@ class Vapi extends VapiEventEmitter {
             const audioObserverStartTime = Date.now();
             try {
                 this.call.startRemoteParticipantsAudioLevelObserver(100);
+                this.call.startLocalAudioLevelObserver(100);
                 const audioObserverDuration = Date.now() - audioObserverStartTime;
                 this.emit('call-start-progress', {
                     stage: 'audio-observer-setup',
@@ -509,9 +530,16 @@ 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({
@@ -653,6 +681,9 @@ class Vapi extends VapiEventEmitter {
             this.speakingTimeout = null;
         }, 1000);
     }
+    handleLocalAudioLevel(e) {
+        this.emit('local-volume-level', e.audioLevel);
+    }
     /**
      * Stops the call by destroying the Daily call object.
      *
@@ -733,6 +764,53 @@ class Vapi extends VapiEventEmitter {
     getDailyCallObject() {
         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.
+     */
+    getLocalAudioLevel() {
+        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.
+     */
+    async startLocalAudioLevelObserver(interval) {
+        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.
+     */
+    stopLocalAudioLevelObserver() {
+        this.call?.stopLocalAudioLevelObserver();
+    }
+    /**
+     * Returns whether the local audio level observer is currently running.
+     */
+    isLocalAudioLevelObserverRunning() {
+        if (!this.call) {
+            return false;
+        }
+        return this.call.isLocalAudioLevelObserverRunning();
+    }
     startScreenSharing(displayMediaOptions, screenVideoSendSettings) {
         this.call?.startScreenShare({
             displayMediaOptions,
@@ -849,6 +927,26 @@ class Vapi extends VapiEventEmitter {
             this.call.on('network-connection', (event) => {
                 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;
@@ -888,9 +986,16 @@ 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({
@@ -1021,6 +1126,7 @@ class Vapi extends VapiEventEmitter {
             const audioObserverStartTime = Date.now();
             try {
                 this.call.startRemoteParticipantsAudioLevelObserver(100);
+                this.call.startLocalAudioLevelObserver(100);
                 const audioObserverDuration = Date.now() - audioObserverStartTime;
                 this.emit('call-start-progress', {
                     stage: 'audio-observer-setup',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vapi-ai/web",
-  "version": "2.5.2",
+  "version": "2.6.1",
   "description": "",
   "main": "dist/vapi.js",
   "types": "dist/vapi.d.ts",
@@ -19,19 +19,19 @@
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/VapiAI/web.git"
+    "url": "git+https://github.com/VapiAI/client-sdk-web.git"
   },
   "author": "vapi",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/VapiAI/web/issues"
+    "url": "https://github.com/VapiAI/client-sdk-web/issues"
   },
-  "homepage": "https://github.com/VapiAI/web#readme",
+  "homepage": "https://github.com/VapiAI/client-sdk-web#readme",
   "engines": {
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@daily-co/daily-js": "^0.85.0",
+    "@daily-co/daily-js": "^0.87.0",
     "events": "^3.3.0"
   },
   "devDependencies": {

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;
@@ -169,6 +181,8 @@ 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;
@@ -181,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 = {
@@ -539,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;
@@ -736,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',
@@ -766,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({
@@ -927,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.
    * 
@@ -1027,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,
@@ -1161,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;
@@ -1208,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({
@@ -1353,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',