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

package/lib/voice/call.js

@@ -35,7 +35,7 @@ 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_ACCEPTED = void 0;
 /* eslint-disable no-underscore-dangle */
 const events_1 = require("events");
 const xstate_1 = require("xstate");
@@ -43,6 +43,7 @@ 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 IssueReporter_1 = __importDefault(require("../service/IssueReporter"));
+const softphone_1 = __importStar(require("./softphone"));
 const sdp_1 = require("../utils/sdp");
 const utils_1 = require("../state-machine/utils");
 const webrtc_1 = require("../utils/webrtc");
@@ -71,19 +72,63 @@ 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 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._sendAction(Actions.ES);
+        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.number = (0, sdp_1.getCallNumber)(sipCall);
+        this.displayName = (0, sdp_1.getCallDisplayName)(sipCall);
         this._bindEvents();
     }
     accept() {
@@ -108,7 +153,7 @@ 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.phone.emit(softphone_1.EVENT_TERMINATE_SOUND, 'call rejected locally');
             this.shouldSendReinvite = false;
             return this.hangup();
         });
@@ -119,7 +164,7 @@ class Call extends events_1.EventEmitter {
             logger.info('call - hangup', { id: this.id });
             yield this.phone.client.hangup(this.sipCall);
             // Remove this call from softphone's calls
-            this.phone.removeCall(this);
+            this.phone.onCallTerminated(this);
             return true;
         });
     }
@@ -132,7 +177,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 +195,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 +219,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 +248,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 +262,25 @@ 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);
     }
     isEstablished() {
-        return (0, utils_1.getState)(this.callActor) === call_state_machine_1.States.ESTABLISHED;
+        return call_state_machine_1.States.ESTABLISHED in this.state;
     }
     isConference() {
         var _a;
@@ -366,7 +417,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;
         });
@@ -392,10 +443,13 @@ class Call extends events_1.EventEmitter {
     onError(error) {
         this.emit(exports.EVENT_CALL_ERROR, error);
     }
+    onCallIncoming() {
+        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);
@@ -424,16 +478,21 @@ class Call extends events_1.EventEmitter {
     isVideoRemotelyHeld() {
         return (0, webrtc_1.isVideoRemotelyHeld)(this.sipCall);
     }
+    isRinging() {
+        return this.state === call_state_machine_1.States.RINGING;
+    }
     onReinvite(request, updatedCalleeName, updatedNumber, hadRemoteVideo) {
         this.emit(exports.EVENT_REINVITE, request, updatedCalleeName, updatedNumber, hadRemoteVideo);
     }
     get id() {
         return (0, sdp_1.getSipSessionId)(this.sipCall);
     }
-    get number() {
-        const identity = this.sipCall.remoteIdentity || this.sipCall.assertedIdentity;
-        // @ts-ignore: private
-        return identity ? identity.uri._normal.user : null;
+    get state() {
+        return (0, utils_1.getState)(this.callActor);
+    }
+    _hasEstablishedState(establishedState) {
+        const state = this.state;
+        return call_state_machine_1.States.ESTABLISHED in state && state[call_state_machine_1.States.ESTABLISHED] === establishedState;
     }
     _bindEvents() {
         if (this.sipCall instanceof invitation_1.Invitation) {
@@ -443,21 +502,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) => {
             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 +544,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 +617,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,7 +627,7 @@ 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) {
         this.callActor.send({ type: action });

package/lib/voice/softphone.js

@@ -35,26 +35,30 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Softphone = exports.MESSAGE_TYPE_SIGNAL = exports.MESSAGE_TYPE_CHAT = exports.EVENT_ON_SIGNAL = exports.EVENT_ON_CHAT = exports.EVENT_ON_MESSAGE = exports.EVENT_VIDEO_INPUT_CHANGE = exports.EVENT_DISCONNECTED = exports.EVENT_UNREGISTERED = exports.EVENT_REGISTERED = exports.EVENT_HEARTBEAT_TIMEOUT = exports.EVENT_HEARTBEAT = exports.EVENT_INCOMING = void 0;
+exports.Softphone = exports.MESSAGE_TYPE_SIGNAL = exports.MESSAGE_TYPE_CHAT = exports.EVENT_ON_SIGNAL = exports.EVENT_ON_CHAT = exports.EVENT_ON_MESSAGE = exports.EVENT_PLAY_INBOUND_CALL_SOUND = exports.EVENT_PLAY_RING_SOUND = exports.EVENT_PLAY_HANGUP_SOUND = exports.EVENT_TERMINATE_SOUND = exports.EVENT_VIDEO_INPUT_CHANGE = exports.EVENT_DISCONNECTED = exports.EVENT_UNREGISTERED = exports.EVENT_REGISTERED = exports.EVENT_HEARTBEAT_TIMEOUT = exports.EVENT_HEARTBEAT = exports.EVENT_OUTGOING = exports.EVENT_INCOMING = void 0;
 /* eslint-disable no-underscore-dangle */
 const events_1 = require("events");
 const xstate_1 = require("xstate");
 const InvalidState_1 = __importDefault(require("../domain/InvalidState"));
 const __1 = __importDefault(require(".."));
 const softphone_state_machine_1 = __importStar(require("../state-machine/softphone-state-machine"));
-const call_state_machine_1 = require("../state-machine/call-state-machine");
 const web_rtc_client_1 = __importDefault(require("../web-rtc-client"));
 const IssueReporter_1 = __importDefault(require("../service/IssueReporter"));
 const sip_logger_1 = __importDefault(require("../utils/sip-logger"));
 const call_1 = __importDefault(require("./call"));
 const utils_1 = require("../state-machine/utils");
 exports.EVENT_INCOMING = 'incoming';
+exports.EVENT_OUTGOING = 'outgoing';
 exports.EVENT_HEARTBEAT = 'heartbeat';
 exports.EVENT_HEARTBEAT_TIMEOUT = 'heartbeatTimeout';
 exports.EVENT_REGISTERED = 'registered';
 exports.EVENT_UNREGISTERED = 'unregistered';
 exports.EVENT_DISCONNECTED = 'disconnected';
 exports.EVENT_VIDEO_INPUT_CHANGE = 'videoInputChange';
+exports.EVENT_TERMINATE_SOUND = 'terminateSound';
+exports.EVENT_PLAY_HANGUP_SOUND = 'playHangupSound';
+exports.EVENT_PLAY_RING_SOUND = 'playRingSound';
+exports.EVENT_PLAY_INBOUND_CALL_SOUND = 'playInboundCallSound';
 exports.EVENT_ON_MESSAGE = 'message';
 exports.EVENT_ON_CHAT = 'phone/ON_CHAT';
 exports.EVENT_ON_SIGNAL = 'phone/ON_SIGNAL';
@@ -64,6 +68,7 @@ const logger = IssueReporter_1.default.loggerFor('softphone');
 class Softphone extends events_1.EventEmitter {
     constructor() {
         super();
+        this.ringingEnabled = true;
         this.calls = [];
         this.softphoneActor = (0, xstate_1.createActor)(softphone_state_machine_1.default);
         this.softphoneActor.start();
@@ -138,19 +143,20 @@ class Softphone extends events_1.EventEmitter {
                 logger.warn('softphone -  calling with empty number, bailing.');
                 return Promise.resolve(null);
             }
-            if (this.getState() !== softphone_state_machine_1.States.UNREGISTERED) {
-                throw new InvalidState_1.default(`Invalid state ${softphone_state_machine_1.States.UNREGISTERED}`, softphone_state_machine_1.States.UNREGISTERED);
-            }
-            if (this.getState() !== softphone_state_machine_1.States.REGISTERING) {
+            if (this.state === softphone_state_machine_1.States.REGISTERING) {
                 logger.info('softphone - calling when registering, waiting for Softphone to be registered ...');
                 yield (0, utils_1.waitUntilState)(this.softphoneActor, softphone_state_machine_1.States.REGISTERED);
             }
+            if (this.state !== softphone_state_machine_1.States.UNREGISTERED) {
+                throw new InvalidState_1.default(`Invalid state ${softphone_state_machine_1.States.UNREGISTERED}`, softphone_state_machine_1.States.UNREGISTERED);
+            }
             // Hold other calls
             this.holdAllCalls();
             let sipCall;
             try {
                 sipCall = this.client.call(options.params.To, options.withCamera, options.audioOnly, options.conference, options);
                 const call = new call_1.default(sipCall, this);
+                this.emit(exports.EVENT_OUTGOING, call);
                 return call;
             }
             catch (error) {
@@ -162,6 +168,58 @@ class Softphone extends events_1.EventEmitter {
     removeCall(callToRemove) {
         this.calls = this.calls.filter((call) => call.id !== callToRemove.id);
     }
+    onCallTerminated(call) {
+        logger.info('softphone - on call terminated', { id: call.id });
+        const currentCall = this.getCurrentCall();
+        const isCurrentCall = (currentCall === null || currentCall === void 0 ? void 0 : currentCall.id) === call.id;
+        const isRinging = call.isRinging();
+        const isCurrentIncomingCall = isCurrentCall && isRinging;
+        const incomingCalls = this.getIncomingCalls();
+        const nbIncomingCalls = incomingCalls.length;
+        // Send an event to terminate ringing sound
+        if (isCurrentIncomingCall) {
+            setTimeout(() => {
+                // Avoid race condition when the other is calling and hanging up immediately
+                this.emit(exports.EVENT_TERMINATE_SOUND, call, 'call terminated');
+            }, 5);
+        }
+        // If the terminated call was an incoming call, we have to re-trigger if it's was the first incoming call
+        // Otherwise, we have to re-trigger an incoming call event if another call is incoming
+        const shouldRetrigger = isCurrentCall ? nbIncomingCalls : isCurrentIncomingCall;
+        // Re-trigger incoming call event for remaining incoming calls
+        logger.info('Softphone - check to re-trigger incoming call', { shouldRetrigger, nbIncomingCalls });
+        if (shouldRetrigger && nbIncomingCalls > 1) {
+            const nextCall = incomingCalls.find(c => c.id !== call.id);
+            // Avoid race condition
+            setTimeout(() => {
+                if (this.ringingEnabled) {
+                    if (currentCall) {
+                        this.emit(exports.EVENT_PLAY_RING_SOUND, this.audioRingDeviceId, this.audioRingVolume, nextCall);
+                    }
+                    else {
+                        this.emit(exports.EVENT_PLAY_INBOUND_CALL_SOUND, this.audioOutputDeviceId, this.audioOutputVolume, nextCall);
+                    }
+                }
+                this.emit(exports.EVENT_INCOMING, nextCall);
+            }, 100);
+        }
+        // @ts-ignore: does not exist
+        if (!call.sipCall.isCanceled) {
+            setTimeout(() => {
+                this.emit(exports.EVENT_PLAY_HANGUP_SOUND, this.audioOutputDeviceId, this.audioOutputVolume, call);
+            }, 10);
+        }
+        this.client.onCallEnded(call.sipCall);
+        this.removeCall(call);
+    }
+    enableRinging() {
+        logger.info('softphone - enable ringing');
+        this.ringingEnabled = true;
+    }
+    disableRinging() {
+        logger.info('softphone - disable ringing');
+        this.ringingEnabled = false;
+    }
     holdAllCalls(exceptCall = null) {
         this.calls.filter(call => !call.isHeld() && call.id === (exceptCall === null || exceptCall === void 0 ? void 0 : exceptCall.id)).forEach(call => call.hold());
     }
@@ -216,25 +274,37 @@ class Softphone extends events_1.EventEmitter {
         logger.info('softphone - changing ring volume', { volume });
         this.audioRingVolume = volume;
     }
-    getCalls() {
-        return this.calls;
-    }
     getCurrentCall() {
         return this.calls.find(call => call.isEstablished());
     }
-    getState() {
-        return this.softphoneActor.getSnapshot().value;
+    getIncomingCalls() {
+        return this.calls.filter(call => call.isRinging());
+    }
+    get state() {
+        return (0, utils_1.getState)(this.softphoneActor);
     }
     getUserAgent() {
         var _a, _b;
         return ((_b = (_a = this.client) === null || _a === void 0 ? void 0 : _a.config) === null || _b === void 0 ? void 0 : _b.userAgentString) || 'softphone';
     }
+    isRegistered() {
+        return this.state === softphone_state_machine_1.States.REGISTERED;
+    }
     _bindEvents() {
         this.client.on(this.client.INVITE, (sipSession) => {
             const call = new call_1.default(sipSession, this);
-            call._sendAction(call_state_machine_1.Actions.INCOMING_CALL);
+            logger.info('softphone - on invite', { callId: call.id, number: call.number });
+            call.onCallIncoming();
             this.calls.push(call);
-            this.eventEmitter.emit(exports.EVENT_INCOMING, call);
+            this.emit(exports.EVENT_INCOMING, call);
+            if (!this.getCurrentCall()) {
+                if (this.ringingEnabled) {
+                    this.emit(exports.EVENT_PLAY_RING_SOUND, this.audioRingDeviceId, this.audioRingVolume, call);
+                }
+            }
+            else {
+                this.emit(exports.EVENT_PLAY_INBOUND_CALL_SOUND, this.audioOutputDeviceId, this.audioOutputVolume, call);
+            }
         });
         this.client.on(this.client.ON_REINVITE, (sipCall, request, updatedCalleeName, updatedNumber, hadRemoteVideo) => {
             logger.info('softphone - on reinvite', {
@@ -247,6 +317,8 @@ class Softphone extends events_1.EventEmitter {
             this._onCallEvent(sipCall, 'onReinvite', request, updatedCalleeName, updatedNumber, hadRemoteVideo);
         });
         this.client.on(this.client.ACCEPTED, (sipCall) => __awaiter(this, void 0, void 0, function* () {
+            const call = this._getCall(sipCall);
+            this.emit(exports.EVENT_TERMINATE_SOUND, call, 'call accepted');
             this._onCallEvent(sipCall, 'onAccepted');
             if (this.audioOutputDeviceId) {
                 yield this.client.changeAudioOutputDevice(this.audioOutputDeviceId);
@@ -276,12 +348,12 @@ class Softphone extends events_1.EventEmitter {
         });
         this.client.on(this.client.UNREGISTERED, () => {
             logger.info('softphone - unregistered');
-            this.eventEmitter.emit(exports.EVENT_UNREGISTERED);
+            this.emit(exports.EVENT_UNREGISTERED);
             this._sendAction(softphone_state_machine_1.Actions.UNREGISTERED);
         });
         this.client.on(this.client.ON_DISCONNECTED, () => {
             logger.info('softphone - disconnected');
-            this.eventEmitter.emit(exports.EVENT_DISCONNECTED);
+            this.emit(exports.EVENT_DISCONNECTED);
             this._sendAction(softphone_state_machine_1.Actions.TRANSPORT_CLOSED);
         });
         this.client.on(this.client.REGISTERED, () => {
@@ -292,7 +364,7 @@ class Softphone extends events_1.EventEmitter {
             }
             this.stopHeartbeat();
             this._sendAction(softphone_state_machine_1.Actions.REGISTER_DONE);
-            this.eventEmitter.emit(exports.EVENT_REGISTERED);
+            this.emit(exports.EVENT_REGISTERED);
             // If the phone registered with a current callSession (eg: when switching network):
             // send a reinvite to renegociate ICE with new IP
             if (this.shouldSendReinvite) {
@@ -308,7 +380,7 @@ class Softphone extends events_1.EventEmitter {
         });
         this.client.on(this.client.DISCONNECTED, () => {
             logger.info('softphone - disconnected');
-            this.eventEmitter.emit(exports.EVENT_DISCONNECTED);
+            this.emit(exports.EVENT_DISCONNECTED);
             // Do not trigger heartbeat if already running
             if (!this.client.hasHeartbeat()) {
                 this.startHeartbeat();
@@ -317,17 +389,17 @@ class Softphone extends events_1.EventEmitter {
             this.shouldSendReinvite = this.calls.length > 0;
         });
         this.client.on('onVideoInputChange', stream => {
-            this.eventEmitter.emit(exports.EVENT_VIDEO_INPUT_CHANGE, stream);
+            this.emit(exports.EVENT_VIDEO_INPUT_CHANGE, stream);
         });
         this.client.on(this.client.MESSAGE, (message) => {
             this._onMessage(message);
-            this.eventEmitter.emit(exports.EVENT_ON_MESSAGE, message);
+            this.emit(exports.EVENT_ON_MESSAGE, message);
         });
         this.client.setOnHeartbeatTimeout(() => {
-            this.eventEmitter.emit(exports.EVENT_HEARTBEAT_TIMEOUT);
+            this.emit(exports.EVENT_HEARTBEAT_TIMEOUT);
         });
         this.client.setOnHeartbeatCallback(() => {
-            this.eventEmitter.emit(exports.EVENT_HEARTBEAT);
+            this.emit(exports.EVENT_HEARTBEAT);
         });
     }
     _sendAction(action) {
@@ -360,11 +432,11 @@ class Softphone extends events_1.EventEmitter {
         const { type, content, } = body;
         switch (type) {
             case exports.MESSAGE_TYPE_CHAT:
-                this.eventEmitter.emit(exports.EVENT_ON_CHAT, content);
+                this.emit(exports.EVENT_ON_CHAT, content);
                 break;
             case exports.MESSAGE_TYPE_SIGNAL:
                 {
-                    this.eventEmitter.emit(exports.EVENT_ON_SIGNAL, content);
+                    this.emit(exports.EVENT_ON_SIGNAL, content);
                     break;
                 }
             default:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wazo/sdk",
-  "version": "1.0.0-alpha.0",
+  "version": "1.0.0-alpha.2",
   "description": "Wazo's JavaScript Software Development Kit.",
   "main": "index.js",
   "types": "lib/types/index.d.ts",

package/src/__tests__/__voice__/call.test.ts

@@ -3,8 +3,9 @@ import { Inviter, UserAgent, type URI } from 'sip.js';
 
 import softphone from '../../voice/softphone';
 import Call from '../../voice/call';
-import { Actions, States } from '../../state-machine/call-state-machine';
+import { Actions, EstablishedStates, States } from '../../state-machine/call-state-machine';
 import { Actions as SoftphoneActions } from '../../state-machine/softphone-state-machine';
+import ApiCall from '../../domain/Call';
 
 import InvalidStateTransition from '../../domain/InvalidStateTransition';
 
@@ -33,6 +34,7 @@ jest.mock('../../web-rtc-client', () => jest.fn().mockImplementation(() => ({
   answer: jest.fn(() => Promise.resolve()),
   hangup: jest.fn(() => Promise.resolve()),
   register: jest.fn(() => Promise.resolve()),
+  onCallEnded: jest.fn(() => Promise.resolve()),
   setOnHeartbeatTimeout: jest.fn(() => Promise.resolve()),
   setOnHeartbeatCallback: jest.fn(() => Promise.resolve()),
   on: jest.fn(),
@@ -42,11 +44,44 @@ const ua = new UserAgent(uaOptions);
 const sipCall = new Inviter(ua, UserAgent.makeURI('sip:1234@my.stack.io') as URI);
 
 softphone.connect();
+// @ts-ignore: private method
 softphone._sendAction(SoftphoneActions.REGISTER_DONE);
 
 const invalidStateTransition = (state: string, action: string) => new InvalidStateTransition(`Invalid state transition from ${state} with action ${action}`, state, action);
 
 describe('Call', () => {
+  describe('parsing an API call', () => {
+    it('Should parse an API call and transform it to a Call instance', async () => {
+      const apiCall = new ApiCall({
+        id: '1234',
+        sipCallId: 'abcd',
+        isCaller: false,
+        isVideo: true,
+        recording: true,
+        callerName: '',
+        callerNumber: '',
+        calleeName: '',
+        calleeNumber: '0123423223',
+        dialedExtension: '',
+        lineId: null,
+        muted: true,
+        onHold: false,
+        startingTime: new Date(),
+        status: 'Up',
+        talkingToIds: [],
+      });
+      const call = Call.parseCall(apiCall);
+
+      expect(call.recording).toBeTruthy();
+      expect(call.id).toBe(apiCall.sipCallId);
+      expect(call.apiId).toBe(apiCall.id);
+      expect(call.number).toBe(apiCall.calleeNumber);
+      expect(call.answerTime).toStrictEqual(apiCall.startingTime);
+      expect(call.isMuted()).toBeTruthy();
+      expect(call.state).toStrictEqual({ [States.ESTABLISHED]: EstablishedStates.MUTED });
+    });
+  });
+
   describe('accept', () => {
     it('Should throw an error when accepting a not ringing call', async () => {
       const call = new Call(sipCall, softphone);
@@ -54,16 +89,24 @@ describe('Call', () => {
       await expect(call.accept()).rejects.toThrowError(invalidStateTransition(States.IDLE, Actions.ACCEPT));
     });
 
-    it.only('Should throw an error when the softphone is not registered', async () => {
+    it('Should throw an error when the softphone is not registered', async () => {
       const call = new Call(sipCall, softphone);
+      // @ts-ignore: private method
       call._sendAction(Actions.INCOMING_CALL);
+      // @ts-ignore: private method
       softphone._sendAction(SoftphoneActions.TRANSPORT_CLOSED);
 
       await expect(call.accept()).rejects.toThrowError(invalidStateTransition(States.RINGING, Actions.ACCEPT));
+
+      // Revert softphone state
+      softphone.connect();
+      // @ts-ignore: private method
+      softphone._sendAction(SoftphoneActions.REGISTER_DONE);
     });
 
     it('Should not throw an error when accepting a not ringing call', async () => {
       const call = new Call(sipCall, softphone);
+      // @ts-ignore: private method
       call._sendAction(Actions.INCOMING_CALL);
 
       await call.accept();
@@ -80,7 +123,9 @@ describe('Call', () => {
 
     it('Should not throw an error when terminating an established call', async () => {
       const call = new Call(sipCall, softphone);
+      // @ts-ignore: private method
       call._sendAction(Actions.MAKE_CALL);
+      // @ts-ignore: private method
       call._sendAction(Actions.REMOTLY_ACCEPTED);
 
       await call.hangup();