@vapi-ai/web 2.4.0 → 2.5.1

package/vapi.ts

@@ -28,6 +28,10 @@ import {
   safeSetInputDevicesAsync,
 } from './daily-guards';
 
+export interface EndCallMessage {
+  type: 'end-call';
+}
+
 export interface AddMessageMessage {
   type: 'add-message';
   message: ChatCompletionMessageParam;
@@ -51,7 +55,8 @@ export interface SayMessage {
 type VapiClientToServerMessage =
   | AddMessageMessage
   | ControlMessages
-  | SayMessage;
+  | SayMessage
+  | EndCallMessage;
 
 type VapiEventNames =
   | 'call-end'
@@ -111,6 +116,43 @@ type VapiEventListeners = {
   'call-start-failed': (event: CallStartFailedEvent) => void;
 };
 
+type StartCallOptions = {
+  /**
+   * This determines whether the daily room will be deleted and all participants will be kicked once the user leaves the room.
+   * If set to `false`, the room will be kept alive even after the user leaves, allowing clients to reconnect to the same room.
+   * If set to `true`, the room will be deleted and reconnection will not be allowed.
+   *
+   * Defaults to `true`.
+   * @example true
+   */
+  roomDeleteOnUserLeaveEnabled?: boolean;
+}
+
+type WebCall = {
+  /**
+   * The Vapi WebCall URL. This is the URL that the call will be joined on.
+   * 
+   * call.webCallUrl or call.transport.callUrl
+   */
+  webCallUrl: string;
+  /**
+   * The Vapi WebCall ID. This is the ID of the call.
+   * 
+   * call.id
+   */
+  id?: string;
+  /**
+   * The Vapi WebCall artifact plan. This is the artifact plan of the call.
+   */
+  artifactPlan?: { videoRecordingEnabled?: boolean };
+  /**
+   * The Vapi WebCall assistant. This is the assistant of the call.
+   * 
+   * call.assistant
+   */
+  assistant?: { voice?: { provider?: string } };
+}
+
 async function startAudioPlayer(
   player: HTMLAudioElement,
   track: MediaStreamTrack,
@@ -246,6 +288,7 @@ export default class Vapi extends VapiEventEmitter {
     squad?: CreateSquadDTO | string,
     workflow?: CreateWorkflowDTO | string,
     workflowOverrides?: WorkflowOverrides,
+    options?: StartCallOptions
   ): Promise<Call | null> {
     const startTime = Date.now();
     
@@ -304,6 +347,7 @@ export default class Vapi extends VapiEventEmitter {
           workflow: typeof workflow === 'string' ? undefined : workflow,
           workflowId: typeof workflow === 'string' ? workflow : undefined,
           workflowOverrides,
+          roomDeleteOnUserLeaveEnabled: options?.roomDeleteOnUserLeaveEnabled,
         })
       ).data;
       
@@ -802,6 +846,12 @@ export default class Vapi extends VapiEventEmitter {
     }, 1000);
   }
 
+  /**
+   * Stops the call by destroying the Daily call object.
+   * 
+   * If `roomDeleteOnUserLeaveEnabled` is set to `false`, the Vapi call will be kept alive, allowing reconnections to the same call using the `reconnect` method.
+   * If `roomDeleteOnUserLeaveEnabled` is set to `true`, the Vapi call will also be destroyed, preventing any reconnections.
+   */
   async stop(): Promise<void> {
     this.started = false;
     if (this.call) {
@@ -811,6 +861,11 @@ export default class Vapi extends VapiEventEmitter {
     this.speakingTimeout = null;
   }
 
+  /**
+   * Sends a Live Call Control message to the Vapi server.
+   * 
+   * Docs: https://docs.vapi.ai/calls/call-features
+   */
   send(message: VapiClientToServerMessage): void {
     this.call?.sendAppMessage(JSON.stringify(message));
   }
@@ -837,6 +892,18 @@ export default class Vapi extends VapiEventEmitter {
     });
   }
 
+  /**
+   * Ends the call immediately by sending a `end-call` message using Live Call Control, and destroys the Daily call object.
+   * 
+   * This method always ends the call, regardless of the `roomDeleteOnUserLeaveEnabled` option.
+   */
+  public end() {
+    this.send({
+      type: 'end-call',
+    });
+    this.stop();
+  }
+
   public setInputDevicesAsync(
     options: Parameters<DailyCall['setInputDevicesAsync']>[0],
   ) {
@@ -889,4 +956,538 @@ export default class Vapi extends VapiEventEmitter {
   public stopScreenSharing() {
     this.call?.stopScreenShare();
   }
+
+  /**
+   * Reconnects to an active call.
+   * 
+   * 
+   * @param webCall 
+   */
+  async reconnect(webCall: WebCall): Promise<void> {
+    const startTime = Date.now();
+    
+    if (this.started) {
+      throw new Error('Cannot reconnect while a call is already in progress. Call stop() first.');
+    }
+
+    if (!webCall.webCallUrl) {
+      throw new Error('webCallUrl is required for reconnection.');
+    }
+
+    this.emit('call-start-progress', {
+      stage: 'reconnect-initialization',
+      status: 'started',
+      timestamp: new Date().toISOString(),
+      metadata: {
+        callId: webCall.id || 'unknown',
+        hasVideoRecording: !!webCall?.artifactPlan?.videoRecordingEnabled,
+        voiceProvider: webCall?.assistant?.voice?.provider || 'unknown'
+      }
+    });
+
+    this.started = true;
+
+    try {
+      // Clean up any existing call object
+      if (this.call) {
+        this.emit('call-start-progress', {
+          stage: 'cleanup-existing-call',
+          status: 'started',
+          timestamp: new Date().toISOString()
+        });
+        await this.cleanup();
+        this.emit('call-start-progress', {
+          stage: 'cleanup-existing-call',
+          status: 'completed',
+          timestamp: new Date().toISOString()
+        });
+      }
+
+      const isVideoRecordingEnabled = webCall?.artifactPlan?.videoRecordingEnabled ?? false;
+      const isVideoEnabled = webCall?.assistant?.voice?.provider === 'tavus';
+
+      // Stage 1: Create Daily call object
+      this.emit('call-start-progress', {
+        stage: 'daily-call-object-creation',
+        status: 'started',
+        timestamp: new Date().toISOString(),
+        metadata: {
+          audioSource: this.dailyCallObject.audioSource ?? true,
+          videoSource: this.dailyCallObject.videoSource ?? isVideoRecordingEnabled,
+          isVideoRecordingEnabled,
+          isVideoEnabled
+        }
+      });
+
+      const dailyCallStartTime = Date.now();
+      this.call = DailyIframe.createCallObject({
+        audioSource: this.dailyCallObject.audioSource ?? true,
+        videoSource: this.dailyCallObject.videoSource ?? isVideoRecordingEnabled,
+        dailyConfig: this.dailyCallConfig,
+      });
+
+      const dailyCallDuration = Date.now() - dailyCallStartTime;
+      this.emit('call-start-progress', {
+        stage: 'daily-call-object-creation',
+        status: 'completed',
+        duration: dailyCallDuration,
+        timestamp: new Date().toISOString()
+      });
+
+      this.call.iframe()?.style.setProperty('display', 'none');
+
+      // Set up event listeners
+      this.call.on('left-meeting', () => {
+        this.emit('call-end');
+        if (!this.hasEmittedCallEndedStatus) {
+          this.emit('message', {
+            type: 'status-update',
+            status: 'ended',
+            'endedReason': 'customer-ended-call',
+          });
+          this.hasEmittedCallEndedStatus = true;
+        }
+        if (isVideoRecordingEnabled) {
+          this.call?.stopRecording();
+        }
+        this.cleanup().catch(console.error);
+      });
+
+      this.call.on('error', (error: any) => {
+        this.emit('error', error);
+        if (isVideoRecordingEnabled) {
+          this.call?.stopRecording();
+        }
+      });
+
+      this.call.on('camera-error', (error: any) => {
+        this.emit('camera-error', error);
+      });
+
+      this.call.on('network-quality-change', (event: any) => {
+        this.emit('network-quality-change', event);
+      });
+
+      this.call.on('network-connection', (event: any) => {
+        this.emit('network-connection', event);
+      });
+
+      this.call.on('track-started', async (e) => {
+        if (!e || !e.participant) {
+          return;
+        }
+        if (e.participant?.local) {
+          return;
+        }
+        if (e.participant?.user_name !== 'Vapi Speaker') {
+          return;
+        }
+        if (e.track.kind === 'video') {
+          this.emit('video', e.track);
+        }
+        if (e.track.kind === 'audio') {
+          await buildAudioPlayer(e.track, e.participant.session_id);
+        }
+        this.call?.sendAppMessage('playable');
+      });
+
+      this.call.on('participant-joined', (e) => {
+        if (!e || !this.call) return;
+        subscribeToTracks(
+          e,
+          this.call,
+          isVideoRecordingEnabled,
+          isVideoEnabled,
+        );
+      });
+
+      this.call.on('participant-updated', (e) => {
+        if (!e) {
+          return;
+        }
+        this.emit('daily-participant-updated', e.participant);
+      });
+
+      this.call.on('participant-left', (e) => {
+        if (!e) {
+          return;
+        }
+        destroyAudioPlayer(e.participant.session_id);
+      });
+
+      this.call.on('remote-participants-audio-level', (e) => {
+        if (e) this.handleRemoteParticipantsAudioLevel(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 === 'audio-processor-error') {
+          this.call
+            ?.updateInputSettings({
+              audio: {
+                processor: {
+                  type: 'none',
+                },
+              },
+            })
+            .then(() => {
+              safeSetLocalAudio(this.call, true);
+            });
+        }
+      });
+
+      // Stage 2: Mobile device handling and permissions
+      const isMobile = this.isMobileDevice();
+      this.emit('call-start-progress', {
+        stage: 'mobile-permissions',
+        status: 'started',
+        timestamp: new Date().toISOString(),
+        metadata: { isMobile }
+      });
+      
+      if (isMobile) {
+        const mobileWaitStartTime = Date.now();
+        await this.sleep(1000);
+        const mobileWaitDuration = Date.now() - mobileWaitStartTime;
+        this.emit('call-start-progress', {
+          stage: 'mobile-permissions',
+          status: 'completed',
+          duration: mobileWaitDuration,
+          timestamp: new Date().toISOString(),
+          metadata: { action: 'permissions-wait' }
+        });
+      } else {
+        this.emit('call-start-progress', {
+          stage: 'mobile-permissions',
+          status: 'completed',
+          timestamp: new Date().toISOString(),
+          metadata: { action: 'skipped-not-mobile' }
+        });
+      }
+
+      // Stage 3: Join the call
+      this.emit('call-start-progress', {
+        stage: 'daily-call-join',
+        status: 'started',
+        timestamp: new Date().toISOString()
+      });
+      
+      const joinStartTime = Date.now();
+      await this.call.join({
+        url: webCall.webCallUrl,
+        subscribeToTracksAutomatically: false,
+      });
+      
+      const joinDuration = Date.now() - joinStartTime;
+      this.emit('call-start-progress', {
+        stage: 'daily-call-join',
+        status: 'completed',
+        duration: joinDuration,
+        timestamp: new Date().toISOString()
+      });
+
+      // Stage 4: Video recording setup (if enabled)
+      if (isVideoRecordingEnabled) {
+        this.emit('call-start-progress', {
+          stage: 'video-recording-setup',
+          status: 'started',
+          timestamp: new Date().toISOString()
+        });
+        
+        const recordingStartTime = Date.now();
+        const recordingRequestedTime = new Date().getTime();
+
+        try {
+          this.call.startRecording({
+            width: 1280,
+            height: 720,
+            backgroundColor: '#FF1F2D3D',
+            layout: {
+              preset: 'default',
+            },
+          });
+
+          const recordingSetupDuration = Date.now() - recordingStartTime;
+          this.emit('call-start-progress', {
+            stage: 'video-recording-setup',
+            status: 'completed',
+            duration: recordingSetupDuration,
+            timestamp: new Date().toISOString()
+          });
+
+          this.call.on('recording-started', () => {
+            const totalRecordingDelay = (new Date().getTime() - recordingRequestedTime) / 1000;
+            this.emit('call-start-progress', {
+              stage: 'video-recording-started',
+              status: 'completed',
+              timestamp: new Date().toISOString(),
+              metadata: { delaySeconds: totalRecordingDelay }
+            });
+            
+            this.send({
+              type: 'control',
+              control: 'say-first-message',
+              videoRecordingStartDelaySeconds: totalRecordingDelay,
+            });
+          });
+        } catch (error) {
+          const recordingSetupDuration = Date.now() - recordingStartTime;
+          this.emit('call-start-progress', {
+            stage: 'video-recording-setup',
+            status: 'failed',
+            duration: recordingSetupDuration,
+            timestamp: new Date().toISOString(),
+            metadata: { error: error?.toString() }
+          });
+          // Don't throw here, video recording is optional
+        }
+      } else {
+        this.emit('call-start-progress', {
+          stage: 'video-recording-setup',
+          status: 'completed',
+          timestamp: new Date().toISOString(),
+          metadata: { action: 'skipped-not-enabled' }
+        });
+      }
+
+      // Stage 5: Audio level observer setup
+      this.emit('call-start-progress', {
+        stage: 'audio-observer-setup',
+        status: 'started',
+        timestamp: new Date().toISOString()
+      });
+      
+      const audioObserverStartTime = Date.now();
+      
+      try {
+        this.call.startRemoteParticipantsAudioLevelObserver(100);
+        const audioObserverDuration = Date.now() - audioObserverStartTime;
+        this.emit('call-start-progress', {
+          stage: 'audio-observer-setup',
+          status: 'completed',
+          duration: audioObserverDuration,
+          timestamp: new Date().toISOString()
+        });
+      } catch (error) {
+        const audioObserverDuration = Date.now() - audioObserverStartTime;
+        this.emit('call-start-progress', {
+          stage: 'audio-observer-setup',
+          status: 'failed',
+          duration: audioObserverDuration,
+          timestamp: new Date().toISOString(),
+          metadata: { error: error?.toString() }
+        });
+        // Don't throw here, this is non-critical
+      }
+
+      // Stage 6: Audio processing setup
+      this.emit('call-start-progress', {
+        stage: 'audio-processing-setup',
+        status: 'started',
+        timestamp: new Date().toISOString()
+      });
+      
+      const audioProcessingStartTime = Date.now();
+      
+      try {
+        this.call.updateInputSettings({
+          audio: {
+            processor: {
+              type: 'noise-cancellation',
+            },
+          },
+        });
+        
+        const audioProcessingDuration = Date.now() - audioProcessingStartTime;
+        this.emit('call-start-progress', {
+          stage: 'audio-processing-setup',
+          status: 'completed',
+          duration: audioProcessingDuration,
+          timestamp: new Date().toISOString()
+        });
+      } catch (error) {
+        const audioProcessingDuration = Date.now() - audioProcessingStartTime;
+        this.emit('call-start-progress', {
+          stage: 'audio-processing-setup',
+          status: 'failed',
+          duration: audioProcessingDuration,
+          timestamp: new Date().toISOString(),
+          metadata: { error: error?.toString() }
+        });
+        // Don't throw here, this is non-critical
+      }
+
+      const totalDuration = Date.now() - startTime;
+      this.emit('call-start-success', {
+        totalDuration,
+        callId: webCall?.id || 'unknown',
+        timestamp: new Date().toISOString()
+      });
+
+      this.emit('call-start');
+
+    } catch (e) {
+      const totalDuration = Date.now() - startTime;
+      
+      this.emit('call-start-failed', {
+        stage: 'reconnect',
+        totalDuration,
+        error: e?.toString() || 'Unknown error occurred',
+        errorStack: e instanceof Error ? e.stack : 'No stack trace available',
+        timestamp: new Date().toISOString(),
+        context: {
+          isReconnect: true,
+          callId: webCall?.id || 'unknown',
+          hasVideoRecording: !!webCall?.artifactPlan?.videoRecordingEnabled,
+          voiceProvider: webCall?.assistant?.voice?.provider || 'unknown',
+          isMobile: this.isMobileDevice()
+        }
+      });
+      
+      // Also emit the generic error event for backward compatibility
+      this.emit('error', {
+        type: 'reconnect-error',
+        error: e,
+        totalDuration,
+        timestamp: new Date().toISOString(),
+        context: {
+          isReconnect: true,
+          callId: webCall?.id || 'unknown',
+          hasVideoRecording: !!webCall?.artifactPlan?.videoRecordingEnabled,
+          voiceProvider: webCall?.assistant?.voice?.provider || 'unknown',
+          isMobile: this.isMobileDevice()
+        }
+      });
+      
+      await this.cleanup();
+      throw e;
+    }
+  }
+
+  /**
+   * Runs all network connectivity tests for pre-call diagnostics.
+   * Creates a temporary Daily call object for testing purposes.
+   * 
+   * Tests performed:
+   * 1. Network connectivity (TURN server) - Tests if traffic can be relayed through TURN servers
+   * 2. Websocket connectivity - Tests if websocket connections can be established  
+   * 3. Call quality - Tests overall call quality metrics (if available in SDK version)
+   * 
+   * @returns {Promise<Record<string, any>>} Test results object with status for each test
+   * 
+   * @example
+   * // Run pre-call network diagnostics
+   * const results = await Vapi.runNetworkTestsStandalone();
+   * if (results.networkConnectivity?.result === 'failed') {
+   *   console.warn('Network issues detected - calls may not work properly');
+   * }
+   * 
+   * @static
+   */
+  public static async runNetworkTestsStandalone(): Promise<Record<string, any>> {
+    console.log('Starting standalone network connectivity tests...');
+    
+    const results: Record<string, any> = {};
+    let tempCall: DailyCall | null = null;
+    
+    try {
+      // Create a temporary call object for testing
+      console.log('Creating temporary call object for testing...');
+      tempCall = DailyIframe.createCallObject({
+        audioSource: true,
+        videoSource: true,
+      });
+
+      // Test 1: Network Connectivity (TURN server test)
+      console.log('\n1. Testing network connectivity (TURN server)...');
+      let videoTrack: MediaStreamTrack | null = null;
+      
+      try {
+        // Create a dummy video track for the test
+        const stream = await navigator.mediaDevices.getUserMedia({ video: true });
+        videoTrack = stream.getVideoTracks()[0];
+        
+        const networkTest = await tempCall.testNetworkConnectivity(videoTrack);
+        results.networkConnectivity = networkTest;
+        console.log('Network connectivity test result:', networkTest);
+      } catch (error) {
+        results.networkConnectivity = { result: 'error', error: error?.toString() };
+        console.error('Network connectivity test error:', error);
+      } finally {
+        // Clean up the video track
+        if (videoTrack) {
+          videoTrack.stop();
+        }
+      }
+
+      // Test 2: Websocket Connectivity
+      console.log('\n2. Testing websocket connectivity...');
+      try {
+        const websocketTest = await tempCall.testWebsocketConnectivity();
+        results.websocketConnectivity = websocketTest;
+        console.log('Websocket connectivity test result:', websocketTest);
+      } catch (error) {
+        results.websocketConnectivity = { result: 'error', error: error?.toString() };
+        console.error('Websocket connectivity test error:', error);
+      }
+
+      // Test 3: Call Quality (if available)
+      console.log('\n3. Testing call quality...');
+      try {
+        // Check if the method exists
+        if (typeof tempCall.testCallQuality === 'function') {
+          // Call quality test requires startCamera to initialize call state
+          try {
+            // Use startCamera to initialize the call state without needing a room
+            console.log('Initializing call state with startCamera...');
+            await tempCall.startCamera();
+            
+            // Now run the call quality test
+            const callQualityTest = await tempCall.testCallQuality();
+            results.callQuality = callQualityTest;
+            console.log('Call quality test result:', callQualityTest);
+            
+            // Camera will be cleaned up when we destroy the call object
+          } catch (startCameraError: any) {
+            // If startCamera fails, it might be due to permissions or other issues
+            console.error('Failed to start camera for call quality test:', startCameraError);
+            results.callQuality = { 
+              result: 'error', 
+              error: startCameraError?.toString(),
+              message: 'Failed to initialize camera for call quality test. Check camera permissions.' 
+            };
+          }
+        } else {
+          results.callQuality = { result: 'not-available', message: 'testCallQuality method not available' };
+          console.log('Call quality test not available in current Daily.co version');
+        }
+      } catch (error: any) {
+        results.callQuality = { result: 'error', error: error?.toString() };
+        console.error('Call quality test error:', error);
+      }
+
+    } catch (error) {
+      console.error('Failed to create temporary call object:', error);
+      results.error = error?.toString();
+    } finally {
+      // Clean up the temporary call object
+      if (tempCall) {
+        try {
+          console.log('Cleaning up temporary call object...');
+          await tempCall.destroy();
+        } catch (error) {
+          console.error('Error destroying temporary call object:', error);
+        }
+      }
+    }
+
+    // Summary
+    console.log('\n=== Network Test Summary ===');
+    console.log('Results:', JSON.stringify(results, null, 2));
+    
+    return results;
+  }
+
 }