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

package/lib/voice/call.js

@@ -35,20 +35,24 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MESSAGE_TRACK_UPDATED = exports.MESSAGE_TYPE_SIGNAL = exports.MESSAGE_TYPE_CHAT = exports.EVENT_TERMINATE_SOUND = exports.EVENT_CAMERA_DISABLED = exports.EVENT_CAMERA_RESUMED = exports.EVENT_WEB_RTC_STATS = exports.EVENT_SHARE_SCREEN_ENDED = exports.EVENT_SHARE_SCREEN_STARTED = exports.EVENT_SHARE_SCREEN_ENDING = exports.EVENT_REMOVE_STREAM = exports.EVENT_VIDEO_STREAM = exports.EVENT_AUDIO_STREAM = exports.EVENT_TRACK = exports.EVENT_REINVITE = exports.EVENT_CALL_RESUMED = exports.EVENT_CALL_HELD = exports.EVENT_CALL_UN_MUTED = exports.EVENT_CALL_MUTED = exports.EVENT_CALL_ENDED = exports.EVENT_CALL_TERMINATING = exports.EVENT_CALL_REJECTED = exports.EVENT_CALL_ERROR = exports.EVENT_EARLY_MEDIA = exports.EVENT_PROGRESS = exports.EVENT_CALL_CANCELED = exports.EVENT_CALL_ACCEPTED = void 0;
+exports.MESSAGE_TRACK_UPDATED = exports.MESSAGE_TYPE_SIGNAL = exports.MESSAGE_TYPE_CHAT = exports.EVENT_CAMERA_DISABLED = exports.EVENT_CAMERA_RESUMED = exports.EVENT_WEB_RTC_STATS = exports.EVENT_SHARE_SCREEN_ENDED = exports.EVENT_SHARE_SCREEN_STARTED = exports.EVENT_SHARE_SCREEN_ENDING = exports.EVENT_REMOVE_STREAM = exports.EVENT_VIDEO_STREAM = exports.EVENT_AUDIO_STREAM = exports.EVENT_TRACK = exports.EVENT_REINVITE = exports.EVENT_CALL_RESUMED = exports.EVENT_CALL_HELD = exports.EVENT_CALL_UN_MUTED = exports.EVENT_CALL_MUTED = exports.EVENT_CALL_ENDED = exports.EVENT_CALL_TERMINATING = exports.EVENT_CALL_REJECTED = exports.EVENT_CALL_ERROR = exports.EVENT_EARLY_MEDIA = exports.EVENT_PROGRESS = exports.EVENT_CALL_CANCELED = exports.EVENT_CALL_LOCALLY_ACCEPTED = exports.EVENT_CALL_REMOTLY_ACCEPTED = void 0;
 /* eslint-disable no-underscore-dangle */
 const events_1 = require("events");
 const xstate_1 = require("xstate");
 const invitation_1 = require("sip.js/lib/api/invitation");
 const session_state_1 = require("sip.js/lib/api/session-state");
 const call_state_machine_1 = __importStar(require("../state-machine/call-state-machine"));
+const new_from_1 = __importDefault(require("../utils/new-from"));
+const update_from_1 = __importDefault(require("../utils/update-from"));
 const IssueReporter_1 = __importDefault(require("../service/IssueReporter"));
+const softphone_1 = __importDefault(require("./softphone"));
 const sdp_1 = require("../utils/sdp");
 const utils_1 = require("../state-machine/utils");
 const webrtc_1 = require("../utils/webrtc");
 const logger = IssueReporter_1.default.loggerFor('call');
 // Events
-exports.EVENT_CALL_ACCEPTED = 'accepted';
+exports.EVENT_CALL_REMOTLY_ACCEPTED = 'remotelyAccepted';
+exports.EVENT_CALL_LOCALLY_ACCEPTED = 'locallyAccepted';
 exports.EVENT_CALL_CANCELED = 'canceled';
 exports.EVENT_PROGRESS = 'progress';
 exports.EVENT_EARLY_MEDIA = 'earlyMedia';
@@ -71,20 +75,65 @@ exports.EVENT_SHARE_SCREEN_ENDED = 'onScreenShareEnded';
 exports.EVENT_WEB_RTC_STATS = 'webRtcStats';
 exports.EVENT_CAMERA_RESUMED = 'onCameraResumed';
 exports.EVENT_CAMERA_DISABLED = 'onCameraDisabled';
-exports.EVENT_TERMINATE_SOUND = 'terminateSound';
 exports.MESSAGE_TYPE_CHAT = 'message/TYPE_CHAT';
 exports.MESSAGE_TYPE_SIGNAL = 'message/TYPE_SIGNAL';
 exports.MESSAGE_TRACK_UPDATED = 'onTrackUpdated';
 class Call extends events_1.EventEmitter {
+    static newFrom(call) {
+        return (0, new_from_1.default)(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_1.default);
+        call.apiId = apiCall.id;
+        call.answerTime = new Date(+apiCall.startingTime);
+        // Update call state
+        const snapshot = call.callActor.getSnapshot();
+        if (apiCall.isUp()) {
+            snapshot.value = { [call_state_machine_1.States.ESTABLISHED]: call_state_machine_1.EstablishedStates.ONGOING };
+        }
+        if (apiCall.muted) {
+            snapshot.value = { [call_state_machine_1.States.ESTABLISHED]: call_state_machine_1.EstablishedStates.MUTED };
+        }
+        if (apiCall.isRinging()) {
+            snapshot.value = call_state_machine_1.States.RINGING;
+        }
+        if (apiCall.isRecording()) {
+            call.recording = true;
+        }
+        // @ts-ignore
+        call.callActor.update(snapshot);
+        return call;
+    }
     constructor(sipCall, phone) {
         super();
         this.shouldSendReinvite = false;
+        this.recording = false;
         this.callActor = (0, xstate_1.createActor)(call_state_machine_1.default);
         this.callActor.start();
         this.creationTime = new Date();
         this.phone = phone;
         this.sipCall = sipCall;
-        this._bindEvents();
+        this.number = (0, sdp_1.getCallNumber)(sipCall);
+        this.displayName = (0, sdp_1.getCallDisplayName)(sipCall);
     }
     accept() {
         return __awaiter(this, arguments, void 0, function* (options = {}) {
@@ -96,6 +145,7 @@ class Call extends events_1.EventEmitter {
             this.answerTime = new Date();
             return this.phone.client.answer(this.sipCall, options.withCamera).then(() => {
                 logger.info('call - accepted', Object.assign({ id: this.id }, options));
+                this.emit(exports.EVENT_CALL_LOCALLY_ACCEPTED, this);
                 return this.id;
             }).catch(e => {
                 logger.error(e);
@@ -108,18 +158,22 @@ class Call extends events_1.EventEmitter {
         return __awaiter(this, void 0, void 0, function* () {
             (0, utils_1.assertCan)(this.callActor, call_state_machine_1.Actions.REJECT);
             logger.info('call - reject', { id: this.id });
-            this.eventEmitter.emit(exports.EVENT_TERMINATE_SOUND, 'call rejected locally');
-            this.shouldSendReinvite = false;
-            return this.hangup();
+            return this._terminate();
         });
     }
     hangup() {
         return __awaiter(this, void 0, void 0, function* () {
             (0, utils_1.assertCan)(this.callActor, call_state_machine_1.Actions.HANGUP);
             logger.info('call - hangup', { id: this.id });
+            return this._terminate();
+        });
+    }
+    _terminate() {
+        return __awaiter(this, void 0, void 0, function* () {
             yield 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;
         });
     }
@@ -132,7 +186,7 @@ class Call extends events_1.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;
@@ -150,14 +204,14 @@ class Call extends events_1.EventEmitter {
         logger.info('call - mute', { id: this.id });
         this._sendAction(call_state_machine_1.EstablishedActions.MUTE);
         this.phone.client.mute(this.sipCall);
-        this.eventEmitter.emit(exports.EVENT_CALL_MUTED);
+        this.emit(exports.EVENT_CALL_MUTED);
     }
     unMute() {
         (0, utils_1.assertCan)(this.callActor, call_state_machine_1.EstablishedActions.UN_MUTE);
         logger.info('call - un-mute', { id: this.id });
         this._sendAction(call_state_machine_1.EstablishedActions.UN_MUTE);
         this.phone.client.unmute(this.sipCall);
-        this.eventEmitter.emit(exports.EVENT_CALL_UN_MUTED);
+        this.emit(exports.EVENT_CALL_UN_MUTED);
     }
     hold() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -174,7 +228,7 @@ class Call extends events_1.EventEmitter {
                 yield (0, webrtc_1.downgradeToAudio)(this.sipCall);
             }
             const promise = this.phone.client.hold(this.sipCall, this.isConference(), hasVideo);
-            this.eventEmitter.emit(exports.EVENT_CALL_HELD);
+            this.emit(exports.EVENT_CALL_HELD);
             return promise;
         });
     }
@@ -203,7 +257,7 @@ class Call extends events_1.EventEmitter {
                     this._onScreenSharing(stream, hadVideo, wasDesktop);
                 }
             };
-            this.eventEmitter.emit(exports.EVENT_CALL_RESUMED);
+            this.emit(exports.EVENT_CALL_RESUMED);
             return promise.then(() => {
                 const stream = this.getLocalVideoStream();
                 if (wasScreensharing) {
@@ -217,19 +271,37 @@ class Call extends events_1.EventEmitter {
         (0, utils_1.assertState)(this.callActor, call_state_machine_1.States.ESTABLISHED);
         logger.info('call - turn camera on', { id: this.id });
         (0, webrtc_1.toggleVideo)(this.sipCall, true);
-        this.eventEmitter.emit(exports.EVENT_CAMERA_RESUMED);
+        this.emit(exports.EVENT_CAMERA_RESUMED);
     }
     turnCameraOff() {
         (0, utils_1.assertState)(this.callActor, call_state_machine_1.States.ESTABLISHED);
         logger.info('call -  turn camera off', { id: this.id });
         (0, webrtc_1.toggleVideo)(this.sipCall, false);
-        this.eventEmitter.emit(exports.EVENT_CAMERA_DISABLED);
+        this.emit(exports.EVENT_CAMERA_DISABLED);
+    }
+    isMuted() {
+        return this._hasEstablishedState(call_state_machine_1.EstablishedStates.MUTED);
+    }
+    isCameraMuted() {
+        return (0, webrtc_1.isVideoMuted)(this.sipCall);
     }
     isHeld() {
-        return (0, utils_1.getState)(this.callActor) === call_state_machine_1.EstablishedStates.HELD;
+        return this._hasEstablishedState(call_state_machine_1.EstablishedStates.HELD);
+    }
+    isEstablishing() {
+        return this.sipCall.state === session_state_1.SessionState.Establishing;
     }
     isEstablished() {
-        return (0, utils_1.getState)(this.callActor) === call_state_machine_1.States.ESTABLISHED;
+        return typeof this.state === 'object' && call_state_machine_1.States.ESTABLISHED in this.state;
+    }
+    isRinging() {
+        return this.state === call_state_machine_1.States.RINGING;
+    }
+    isOutgoing() {
+        return this.sipCall instanceof invitation_1.Invitation;
+    }
+    isIncoming() {
+        return !this.isOutgoing();
     }
     isConference() {
         var _a;
@@ -238,7 +310,7 @@ class Call extends events_1.EventEmitter {
     transfer(target) {
         (0, utils_1.assertState)(this.callActor, call_state_machine_1.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() {
         (0, utils_1.assertState)(this.callActor, call_state_machine_1.States.ESTABLISHED);
@@ -366,7 +438,7 @@ class Call extends events_1.EventEmitter {
             catch (e) {
                 console.warn(e);
             }
-            this.eventEmitter.emit(exports.EVENT_SHARE_SCREEN_ENDED);
+            this.emit(exports.EVENT_SHARE_SCREEN_ENDED);
             this.currentScreenShare = null;
             return reinvited;
         });
@@ -376,9 +448,13 @@ class Call extends events_1.EventEmitter {
         logger.info('call - updrading directly in screensharing mode', { id: this.id, tracks: localStream === null || localStream === void 0 ? void 0 : localStream.getTracks() });
         this._onScreenSharing(localStream, false, desktop);
     }
+    onMakeCall() {
+        this._bindEvents();
+        this._sendAction(call_state_machine_1.Actions.MAKE_CALL);
+    }
     onAccepted() {
         this._sendAction(call_state_machine_1.Actions.REMOTLY_ACCEPTED);
-        this.emit(exports.EVENT_CALL_ACCEPTED);
+        this.emit(exports.EVENT_CALL_REMOTLY_ACCEPTED);
     }
     onProgress() {
         this.emit(exports.EVENT_PROGRESS);
@@ -392,10 +468,14 @@ class Call extends events_1.EventEmitter {
     onError(error) {
         this.emit(exports.EVENT_CALL_ERROR, error);
     }
+    onCallIncoming() {
+        this._bindEvents();
+        this._sendAction(call_state_machine_1.Actions.INCOMING_CALL);
+    }
     onRejected() {
         this.endTime = new Date();
         this.emit(exports.EVENT_CALL_REJECTED);
-        this.phone.removeCall(this);
+        this.phone.onCallTerminated(this);
     }
     onNetworkStats(stats, previousStats) {
         this.emit(exports.EVENT_WEB_RTC_STATS, stats, previousStats);
@@ -427,15 +507,28 @@ class Call extends events_1.EventEmitter {
     onReinvite(request, updatedCalleeName, updatedNumber, hadRemoteVideo) {
         this.emit(exports.EVENT_REINVITE, request, updatedCalleeName, updatedNumber, hadRemoteVideo);
     }
+    updateFrom(call) {
+        (0, update_from_1.default)(this, call);
+    }
+    is(otherCall) {
+        return otherCall && this.id && this.id === otherCall.id;
+    }
+    shouldAutoAnswer() {
+        var _a;
+        return !!((_a = this.sipCall.request) === null || _a === void 0 ? void 0 : _a.getHeader('alert-info'));
+    }
     get id() {
-        return (0, sdp_1.getSipSessionId)(this.sipCall);
+        return (0, sdp_1.getSipCallId)(this.sipCall);
+    }
+    get state() {
+        return (0, utils_1.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' && call_state_machine_1.States.ESTABLISHED in state && state[call_state_machine_1.States.ESTABLISHED] === establishedState;
     }
     _bindEvents() {
+        var _a, _b;
         if (this.sipCall instanceof invitation_1.Invitation) {
             // Monkey patch to know when canceled with the CANCEL message
             const onCancel = this.sipCall._onCancel.bind(this.sipCall);
@@ -443,21 +536,22 @@ class Call extends events_1.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(exports.EVENT_CALL_CANCELED, elsewhere);
+                this.emit(exports.EVENT_CALL_CANCELED, elsewhere);
             };
         }
-        this.sipCall.stateChange.addListener((newState) => {
+        (_b = (_a = this.sipCall) === null || _a === void 0 ? void 0 : _a.stateChange) === null || _b === void 0 ? void 0 : _b.addListener((newState) => {
             switch (newState) {
                 case session_state_1.SessionState.Terminating:
                     logger.info('call - terminating', { id: this.id });
-                    this.eventEmitter.emit(exports.EVENT_CALL_TERMINATING);
+                    this.emit(exports.EVENT_CALL_TERMINATING);
                     break;
                 case session_state_1.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(exports.EVENT_CALL_ENDED);
+                        this.emit(exports.EVENT_CALL_ENDED);
+                        return this.phone.onCallTerminated(this);
                     }
                 default:
                     break;
@@ -484,18 +578,17 @@ class Call extends events_1.EventEmitter {
                 kind,
             });
             if (kind === 'audio') {
-                return this.eventEmitter.emit(exports.EVENT_AUDIO_STREAM, stream);
+                return this.emit(exports.EVENT_AUDIO_STREAM, stream);
             }
-            return this.eventEmitter.emit(exports.EVENT_VIDEO_STREAM, stream, event.track.id, event);
+            return this.emit(exports.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(exports.EVENT_REMOVE_STREAM, event.stream);
+            this.emit(exports.EVENT_REMOVE_STREAM, event.stream);
         };
-        // Client events
     }
     _downgradeToAudio(withMessage = true) {
         (0, utils_1.assertState)(this.callActor, call_state_machine_1.States.ESTABLISHED);
@@ -558,7 +651,7 @@ class Call extends events_1.EventEmitter {
         if (screenTrack) {
             screenTrack.onended = () => {
                 logger.info('call - on screenshare ended', { hadVideo, id: this.id, screenTrack });
-                this.eventEmitter.emit(exports.EVENT_SHARE_SCREEN_ENDING);
+                this.emit(exports.EVENT_SHARE_SCREEN_ENDING);
             };
         }
         this.currentScreenShare = {
@@ -568,10 +661,12 @@ class Call extends events_1.EventEmitter {
             desktop,
         };
         (0, webrtc_1.setLocalMediaStream)(this.sipCall, screenStream);
-        this.eventEmitter.emit(exports.EVENT_SHARE_SCREEN_STARTED, screenStream);
+        this.emit(exports.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 });
     }
 }
 exports.default = Call;