@wazo/sdk 1.0.0-alpha.0 → 1.0.0-alpha.10

package/esm/voice/call.js

@@ -4,13 +4,17 @@ import { createActor } from 'xstate';
 import { Invitation } from 'sip.js/lib/api/invitation';
 import { SessionState } from 'sip.js/lib/api/session-state';
 import callStateMachine, { Actions, EstablishedActions, States, EstablishedStates } from '../state-machine/call-state-machine';
+import newFrom from '../utils/new-from';
+import updateFrom from '../utils/update-from';
 import IssueReporter from '../service/IssueReporter';
-import { getSipSessionId } from '../utils/sdp';
+import softphone from './softphone';
+import { getCallDisplayName, getCallNumber, getSipCallId } from '../utils/sdp';
 import { assertCan, assertState, getState } from '../state-machine/utils';
-import { downgradeToAudio, getLocalStream, getLocalVideoStream, getPeerConnection, getRemoteStream, getRemoteVideoStream, getStreamFromConstraints, getWebRtcStats, hasALocalVideoTrack, hasLocalVideo, hasRemoteVideo, isVideoRemotelyHeld, setLocalMediaStream, toggleVideo, upgradeToVideo } from '../utils/webrtc';
+import { downgradeToAudio, getLocalStream, getLocalVideoStream, getPeerConnection, getRemoteStream, getRemoteVideoStream, getStreamFromConstraints, getWebRtcStats, hasALocalVideoTrack, hasLocalVideo, hasRemoteVideo, isVideoMuted, isVideoRemotelyHeld, setLocalMediaStream, toggleVideo, upgradeToVideo } from '../utils/webrtc';
 const logger = IssueReporter.loggerFor('call');
 // Events
-export const EVENT_CALL_ACCEPTED = 'accepted';
+export const EVENT_CALL_REMOTLY_ACCEPTED = 'remotelyAccepted';
+export const EVENT_CALL_LOCALLY_ACCEPTED = 'locallyAccepted';
 export const EVENT_CALL_CANCELED = 'canceled';
 export const EVENT_PROGRESS = 'progress';
 export const EVENT_EARLY_MEDIA = 'earlyMedia';
@@ -33,12 +37,10 @@ export const EVENT_SHARE_SCREEN_ENDED = 'onScreenShareEnded';
 export const EVENT_WEB_RTC_STATS = 'webRtcStats';
 export const EVENT_CAMERA_RESUMED = 'onCameraResumed';
 export const EVENT_CAMERA_DISABLED = 'onCameraDisabled';
-export const EVENT_TERMINATE_SOUND = 'terminateSound';
 export const MESSAGE_TYPE_CHAT = 'message/TYPE_CHAT';
 export const MESSAGE_TYPE_SIGNAL = 'message/TYPE_SIGNAL';
 export const MESSAGE_TRACK_UPDATED = 'onTrackUpdated';
 class Call extends EventEmitter {
-    eventEmitter;
     callActor;
     // Wazo call id, used in Wazo Websocket and API
     apiId;
@@ -49,7 +51,54 @@ class Call extends EventEmitter {
     endTime;
     phone;
     shouldSendReinvite = false;
+    recording = false;
+    displayName;
+    number;
     currentScreenShare;
+    static newFrom(call) {
+        return newFrom(call, Call);
+    }
+    static parseCall(apiCall) {
+        const sipCall = {
+            id: apiCall.sipCallId,
+            stateChange: {
+                addListener: () => { },
+            },
+            remoteIdentity: {
+                uri: {
+                    _normal: {
+                        user: apiCall.calleeNumber,
+                    },
+                },
+            },
+            // Mock sdk so `hasLocalVideo` will return true.
+            sessionDescriptionHandler: {
+                localMediaStream: {
+                    getTracks: () => (apiCall.isVideo ? [{ kind: 'video', readyState: 'live' }] : []),
+                },
+            },
+        };
+        const call = new Call(sipCall, softphone);
+        call.apiId = apiCall.id;
+        call.answerTime = new Date(+apiCall.startingTime);
+        // Update call state
+        const snapshot = call.callActor.getSnapshot();
+        if (apiCall.isUp()) {
+            snapshot.value = { [States.ESTABLISHED]: EstablishedStates.ONGOING };
+        }
+        if (apiCall.muted) {
+            snapshot.value = { [States.ESTABLISHED]: EstablishedStates.MUTED };
+        }
+        if (apiCall.isRinging()) {
+            snapshot.value = States.RINGING;
+        }
+        if (apiCall.isRecording()) {
+            call.recording = true;
+        }
+        // @ts-ignore
+        call.callActor.update(snapshot);
+        return call;
+    }
     constructor(sipCall, phone) {
         super();
         this.callActor = createActor(callStateMachine);
@@ -57,7 +106,8 @@ class Call extends EventEmitter {
         this.creationTime = new Date();
         this.phone = phone;
         this.sipCall = sipCall;
-        this._bindEvents();
+        this.number = getCallNumber(sipCall);
+        this.displayName = getCallDisplayName(sipCall);
     }
     async accept(options = {}) {
         assertCan(this.callActor, Actions.ACCEPT);
@@ -68,6 +118,7 @@ class Call extends EventEmitter {
         this.answerTime = new Date();
         return this.phone.client.answer(this.sipCall, options.withCamera).then(() => {
             logger.info('call - accepted', { id: this.id, ...options });
+            this.emit(EVENT_CALL_LOCALLY_ACCEPTED, this);
             return this.id;
         }).catch(e => {
             logger.error(e);
@@ -78,16 +129,18 @@ class Call extends EventEmitter {
     async reject() {
         assertCan(this.callActor, Actions.REJECT);
         logger.info('call - reject', { id: this.id });
-        this.eventEmitter.emit(EVENT_TERMINATE_SOUND, 'call rejected locally');
-        this.shouldSendReinvite = false;
-        return this.hangup();
+        return this._terminate();
     }
     async hangup() {
         assertCan(this.callActor, Actions.HANGUP);
         logger.info('call - hangup', { id: this.id });
+        return this._terminate();
+    }
+    async _terminate() {
         await this.phone.client.hangup(this.sipCall);
+        this.shouldSendReinvite = false;
         // Remove this call from softphone's calls
-        this.phone.removeCall(this);
+        this.phone.onCallTerminated(this);
         return true;
     }
     forceCancel() {
@@ -99,7 +152,7 @@ class Call extends EventEmitter {
             logger.info('call - force cancel, error', e);
         }
     }
-    startConference(withCalls) {
+    startConference( /* withCalls: Call[] */) {
         // @TODO
         // const participants = [this, ...withCalls].reduce((acc: Record<string, any>, call: Call) => {
         //   acc[call.talkingToIds[0]] = call;
@@ -117,14 +170,14 @@ class Call extends EventEmitter {
         logger.info('call - mute', { id: this.id });
         this._sendAction(EstablishedActions.MUTE);
         this.phone.client.mute(this.sipCall);
-        this.eventEmitter.emit(EVENT_CALL_MUTED);
+        this.emit(EVENT_CALL_MUTED);
     }
     unMute() {
         assertCan(this.callActor, EstablishedActions.UN_MUTE);
         logger.info('call - un-mute', { id: this.id });
         this._sendAction(EstablishedActions.UN_MUTE);
         this.phone.client.unmute(this.sipCall);
-        this.eventEmitter.emit(EVENT_CALL_UN_MUTED);
+        this.emit(EVENT_CALL_UN_MUTED);
     }
     async hold() {
         assertCan(this.callActor, EstablishedActions.HOLD);
@@ -140,7 +193,7 @@ class Call extends EventEmitter {
             await downgradeToAudio(this.sipCall);
         }
         const promise = this.phone.client.hold(this.sipCall, this.isConference(), hasVideo);
-        this.eventEmitter.emit(EVENT_CALL_HELD);
+        this.emit(EVENT_CALL_HELD);
         return promise;
     }
     async resume() {
@@ -167,7 +220,7 @@ class Call extends EventEmitter {
                 this._onScreenSharing(stream, hadVideo, wasDesktop);
             }
         };
-        this.eventEmitter.emit(EVENT_CALL_RESUMED);
+        this.emit(EVENT_CALL_RESUMED);
         return promise.then(() => {
             const stream = this.getLocalVideoStream();
             if (wasScreensharing) {
@@ -180,19 +233,37 @@ class Call extends EventEmitter {
         assertState(this.callActor, States.ESTABLISHED);
         logger.info('call - turn camera on', { id: this.id });
         toggleVideo(this.sipCall, true);
-        this.eventEmitter.emit(EVENT_CAMERA_RESUMED);
+        this.emit(EVENT_CAMERA_RESUMED);
     }
     turnCameraOff() {
         assertState(this.callActor, States.ESTABLISHED);
         logger.info('call -  turn camera off', { id: this.id });
         toggleVideo(this.sipCall, false);
-        this.eventEmitter.emit(EVENT_CAMERA_DISABLED);
+        this.emit(EVENT_CAMERA_DISABLED);
+    }
+    isMuted() {
+        return this._hasEstablishedState(EstablishedStates.MUTED);
+    }
+    isCameraMuted() {
+        return isVideoMuted(this.sipCall);
     }
     isHeld() {
-        return getState(this.callActor) === EstablishedStates.HELD;
+        return this._hasEstablishedState(EstablishedStates.HELD);
+    }
+    isEstablishing() {
+        return this.sipCall.state === SessionState.Establishing;
     }
     isEstablished() {
-        return getState(this.callActor) === States.ESTABLISHED;
+        return typeof this.state === 'object' && States.ESTABLISHED in this.state;
+    }
+    isRinging() {
+        return this.state === States.RINGING;
+    }
+    isOutgoing() {
+        return this.sipCall instanceof Invitation;
+    }
+    isIncoming() {
+        return !this.isOutgoing();
     }
     isConference() {
         return getPeerConnection(this.sipCall)?.sfu;
@@ -200,7 +271,7 @@ class Call extends EventEmitter {
     transfer(target) {
         assertState(this.callActor, States.ESTABLISHED);
         logger.info('call - transfer', { id: this.id, target });
-        this.phone.client.transfer(this.sipCall, target);
+        return this.phone.client.transfer(this.sipCall, target);
     }
     atxfer() {
         assertState(this.callActor, States.ESTABLISHED);
@@ -320,7 +391,7 @@ class Call extends EventEmitter {
         catch (e) {
             console.warn(e);
         }
-        this.eventEmitter.emit(EVENT_SHARE_SCREEN_ENDED);
+        this.emit(EVENT_SHARE_SCREEN_ENDED);
         this.currentScreenShare = null;
         return reinvited;
     }
@@ -329,9 +400,13 @@ class Call extends EventEmitter {
         logger.info('call - updrading directly in screensharing mode', { id: this.id, tracks: localStream?.getTracks() });
         this._onScreenSharing(localStream, false, desktop);
     }
+    onMakeCall() {
+        this._bindEvents();
+        this._sendAction(Actions.MAKE_CALL);
+    }
     onAccepted() {
         this._sendAction(Actions.REMOTLY_ACCEPTED);
-        this.emit(EVENT_CALL_ACCEPTED);
+        this.emit(EVENT_CALL_REMOTLY_ACCEPTED);
     }
     onProgress() {
         this.emit(EVENT_PROGRESS);
@@ -345,10 +420,14 @@ class Call extends EventEmitter {
     onError(error) {
         this.emit(EVENT_CALL_ERROR, error);
     }
+    onCallIncoming() {
+        this._bindEvents();
+        this._sendAction(Actions.INCOMING_CALL);
+    }
     onRejected() {
         this.endTime = new Date();
         this.emit(EVENT_CALL_REJECTED);
-        this.phone.removeCall(this);
+        this.phone.onCallTerminated(this);
     }
     onNetworkStats(stats, previousStats) {
         this.emit(EVENT_WEB_RTC_STATS, stats, previousStats);
@@ -380,13 +459,24 @@ class Call extends EventEmitter {
     onReinvite(request, updatedCalleeName, updatedNumber, hadRemoteVideo) {
         this.emit(EVENT_REINVITE, request, updatedCalleeName, updatedNumber, hadRemoteVideo);
     }
+    updateFrom(call) {
+        updateFrom(this, call);
+    }
+    is(otherCall) {
+        return otherCall && this.id && this.id === otherCall.id;
+    }
+    shouldAutoAnswer() {
+        return !!this.sipCall.request?.getHeader('alert-info');
+    }
     get id() {
-        return getSipSessionId(this.sipCall);
+        return getSipCallId(this.sipCall);
+    }
+    get state() {
+        return getState(this.callActor);
     }
-    get number() {
-        const identity = this.sipCall.remoteIdentity || this.sipCall.assertedIdentity;
-        // @ts-ignore: private
-        return identity ? identity.uri._normal.user : null;
+    _hasEstablishedState(establishedState) {
+        const state = this.state;
+        return typeof state === 'object' && States.ESTABLISHED in state && state[States.ESTABLISHED] === establishedState;
     }
     _bindEvents() {
         if (this.sipCall instanceof Invitation) {
@@ -396,21 +486,22 @@ class Call extends EventEmitter {
                 logger.trace('call - on sip session canceled', { callId: message.callId, id: this.id });
                 onCancel(message);
                 const elsewhere = message.data.indexOf('cause=26') !== -1 && message.data.indexOf('completed elsewhere') !== -1;
-                this.eventEmitter.emit(EVENT_CALL_CANCELED, elsewhere);
+                this.emit(EVENT_CALL_CANCELED, elsewhere);
             };
         }
-        this.sipCall.stateChange.addListener((newState) => {
+        this.sipCall?.stateChange?.addListener((newState) => {
             switch (newState) {
                 case SessionState.Terminating:
                     logger.info('call - terminating', { id: this.id });
-                    this.eventEmitter.emit(EVENT_CALL_TERMINATING);
+                    this.emit(EVENT_CALL_TERMINATING);
                     break;
                 case SessionState.Terminated:
                     {
                         logger.info('call - terminated', { id: this.id });
                         // Should be called before `_onCallTerminated` or the callCount will not decrement...
                         this.endTime = new Date();
-                        return this.eventEmitter.emit(EVENT_CALL_ENDED);
+                        this.emit(EVENT_CALL_ENDED);
+                        return this.phone.onCallTerminated(this);
                     }
                 default:
                     break;
@@ -437,18 +528,17 @@ class Call extends EventEmitter {
                 kind,
             });
             if (kind === 'audio') {
-                return this.eventEmitter.emit(EVENT_AUDIO_STREAM, stream);
+                return this.emit(EVENT_AUDIO_STREAM, stream);
             }
-            return this.eventEmitter.emit(EVENT_VIDEO_STREAM, stream, event.track.id, event);
+            return this.emit(EVENT_VIDEO_STREAM, stream, event.track.id, event);
         };
         peerConnection.onremovestream = (event) => {
             logger.info('call - on remove stream called on the peer connection', {
                 id: event.stream.id,
                 tracks: event.stream.getTracks(),
             });
-            this.eventEmitter.emit(EVENT_REMOVE_STREAM, event.stream);
+            this.emit(EVENT_REMOVE_STREAM, event.stream);
         };
-        // Client events
     }
     _downgradeToAudio(withMessage = true) {
         assertState(this.callActor, States.ESTABLISHED);
@@ -508,7 +598,7 @@ class Call extends EventEmitter {
         if (screenTrack) {
             screenTrack.onended = () => {
                 logger.info('call - on screenshare ended', { hadVideo, id: this.id, screenTrack });
-                this.eventEmitter.emit(EVENT_SHARE_SCREEN_ENDING);
+                this.emit(EVENT_SHARE_SCREEN_ENDING);
             };
         }
         this.currentScreenShare = {
@@ -518,10 +608,12 @@ class Call extends EventEmitter {
             desktop,
         };
         setLocalMediaStream(this.sipCall, screenStream);
-        this.eventEmitter.emit(EVENT_SHARE_SCREEN_STARTED, screenStream);
+        this.emit(EVENT_SHARE_SCREEN_STARTED, screenStream);
     }
     _sendAction(action) {
+        const was = this.state;
         this.callActor.send({ type: action });
+        logger.trace('call - send action', { action, was, state: this.state });
     }
 }
 export default Call;