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

package/esm/voice/call.js

@@ -5,9 +5,10 @@ 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 IssueReporter from '../service/IssueReporter';
-import { getSipSessionId } from '../utils/sdp';
+import softphone, { EVENT_TERMINATE_SOUND } from './softphone';
+import { getCallDisplayName, getCallNumber, getSipSessionId } 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';
@@ -33,12 +34,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 +48,52 @@ class Call extends EventEmitter {
     endTime;
     phone;
     shouldSendReinvite = false;
+    recording = false;
+    displayName;
+    number;
     currentScreenShare;
+    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._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 = { [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,6 +101,8 @@ class Call extends EventEmitter {
         this.creationTime = new Date();
         this.phone = phone;
         this.sipCall = sipCall;
+        this.number = getCallNumber(sipCall);
+        this.displayName = getCallDisplayName(sipCall);
         this._bindEvents();
     }
     async accept(options = {}) {
@@ -78,7 +124,7 @@ 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.phone.emit(EVENT_TERMINATE_SOUND, 'call rejected locally');
         this.shouldSendReinvite = false;
         return this.hangup();
     }
@@ -87,7 +133,7 @@ class Call extends EventEmitter {
         logger.info('call - hangup', { id: this.id });
         await this.phone.client.hangup(this.sipCall);
         // Remove this call from softphone's calls
-        this.phone.removeCall(this);
+        this.phone.onCallTerminated(this);
         return true;
     }
     forceCancel() {
@@ -99,7 +145,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 +163,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 +186,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 +213,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 +226,25 @@ 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);
     }
     isEstablished() {
-        return getState(this.callActor) === States.ESTABLISHED;
+        return States.ESTABLISHED in this.state;
     }
     isConference() {
         return getPeerConnection(this.sipCall)?.sfu;
@@ -320,7 +372,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;
     }
@@ -345,10 +397,13 @@ class Call extends EventEmitter {
     onError(error) {
         this.emit(EVENT_CALL_ERROR, error);
     }
+    onCallIncoming() {
+        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);
@@ -377,16 +432,21 @@ class Call extends EventEmitter {
     isVideoRemotelyHeld() {
         return isVideoRemotelyHeld(this.sipCall);
     }
+    isRinging() {
+        return this.state === States.RINGING;
+    }
     onReinvite(request, updatedCalleeName, updatedNumber, hadRemoteVideo) {
         this.emit(EVENT_REINVITE, request, updatedCalleeName, updatedNumber, hadRemoteVideo);
     }
     get id() {
         return 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 getState(this.callActor);
+    }
+    _hasEstablishedState(establishedState) {
+        const state = this.state;
+        return States.ESTABLISHED in state && state[States.ESTABLISHED] === establishedState;
     }
     _bindEvents() {
         if (this.sipCall instanceof Invitation) {
@@ -396,21 +456,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) => {
             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 +498,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 +568,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,7 +578,7 @@ 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) {
         this.callActor.send({ type: action });

package/esm/voice/softphone.js

@@ -4,19 +4,23 @@ import { createActor } from 'xstate';
 import InvalidState from '../domain/InvalidState';
 import Wazo from '..';
 import softphoneStateMachine, { Actions, States } from '../state-machine/softphone-state-machine';
-import { Actions as CallActions } from '../state-machine/call-state-machine';
 import WazoWebRTCClient from '../web-rtc-client';
 import IssueReporter from '../service/IssueReporter';
 import configureLogger from '../utils/sip-logger';
 import Call from './call';
 import { assertCan, can, getState, waitUntilState } from '../state-machine/utils';
 export const EVENT_INCOMING = 'incoming';
+export const EVENT_OUTGOING = 'outgoing';
 export const EVENT_HEARTBEAT = 'heartbeat';
 export const EVENT_HEARTBEAT_TIMEOUT = 'heartbeatTimeout';
 export const EVENT_REGISTERED = 'registered';
 export const EVENT_UNREGISTERED = 'unregistered';
 export const EVENT_DISCONNECTED = 'disconnected';
 export const EVENT_VIDEO_INPUT_CHANGE = 'videoInputChange';
+export const EVENT_TERMINATE_SOUND = 'terminateSound';
+export const EVENT_PLAY_HANGUP_SOUND = 'playHangupSound';
+export const EVENT_PLAY_RING_SOUND = 'playRingSound';
+export const EVENT_PLAY_INBOUND_CALL_SOUND = 'playInboundCallSound';
 export const EVENT_ON_MESSAGE = 'message';
 export const EVENT_ON_CHAT = 'phone/ON_CHAT';
 export const EVENT_ON_SIGNAL = 'phone/ON_SIGNAL';
@@ -28,7 +32,6 @@ export class Softphone extends EventEmitter {
     audioRingDeviceId;
     audioOutputVolume;
     audioRingVolume;
-    eventEmitter;
     calls;
     client;
     session;
@@ -36,6 +39,7 @@ export class Softphone extends EventEmitter {
     softphoneActor;
     options;
     shouldSendReinvite;
+    ringingEnabled = true;
     constructor() {
         super();
         this.calls = [];
@@ -114,19 +118,20 @@ export class Softphone extends EventEmitter {
             logger.warn('softphone -  calling with empty number, bailing.');
             return Promise.resolve(null);
         }
-        if (this.getState() !== States.UNREGISTERED) {
-            throw new InvalidState(`Invalid state ${States.UNREGISTERED}`, States.UNREGISTERED);
-        }
-        if (this.getState() !== States.REGISTERING) {
+        if (this.state === States.REGISTERING) {
             logger.info('softphone - calling when registering, waiting for Softphone to be registered ...');
             await waitUntilState(this.softphoneActor, States.REGISTERED);
         }
+        if (this.state !== States.UNREGISTERED) {
+            throw new InvalidState(`Invalid state ${States.UNREGISTERED}`, 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(sipCall, this);
+            this.emit(EVENT_OUTGOING, call);
             return call;
         }
         catch (error) {
@@ -137,6 +142,58 @@ export class Softphone extends 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?.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(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(EVENT_PLAY_RING_SOUND, this.audioRingDeviceId, this.audioRingVolume, nextCall);
+                    }
+                    else {
+                        this.emit(EVENT_PLAY_INBOUND_CALL_SOUND, this.audioOutputDeviceId, this.audioOutputVolume, nextCall);
+                    }
+                }
+                this.emit(EVENT_INCOMING, nextCall);
+            }, 100);
+        }
+        // @ts-ignore: does not exist
+        if (!call.sipCall.isCanceled) {
+            setTimeout(() => {
+                this.emit(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?.id).forEach(call => call.hold());
     }
@@ -190,24 +247,36 @@ export class Softphone extends 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 getState(this.softphoneActor);
     }
     getUserAgent() {
         return this.client?.config?.userAgentString || 'softphone';
     }
+    isRegistered() {
+        return this.state === States.REGISTERED;
+    }
     _bindEvents() {
         this.client.on(this.client.INVITE, (sipSession) => {
             const call = new Call(sipSession, this);
-            call._sendAction(CallActions.INCOMING_CALL);
+            logger.info('softphone - on invite', { callId: call.id, number: call.number });
+            call.onCallIncoming();
             this.calls.push(call);
-            this.eventEmitter.emit(EVENT_INCOMING, call);
+            this.emit(EVENT_INCOMING, call);
+            if (!this.getCurrentCall()) {
+                if (this.ringingEnabled) {
+                    this.emit(EVENT_PLAY_RING_SOUND, this.audioRingDeviceId, this.audioRingVolume, call);
+                }
+            }
+            else {
+                this.emit(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', {
@@ -220,6 +289,8 @@ export class Softphone extends EventEmitter {
             this._onCallEvent(sipCall, 'onReinvite', request, updatedCalleeName, updatedNumber, hadRemoteVideo);
         });
         this.client.on(this.client.ACCEPTED, async (sipCall) => {
+            const call = this._getCall(sipCall);
+            this.emit(EVENT_TERMINATE_SOUND, call, 'call accepted');
             this._onCallEvent(sipCall, 'onAccepted');
             if (this.audioOutputDeviceId) {
                 await this.client.changeAudioOutputDevice(this.audioOutputDeviceId);
@@ -249,12 +320,12 @@ export class Softphone extends EventEmitter {
         });
         this.client.on(this.client.UNREGISTERED, () => {
             logger.info('softphone - unregistered');
-            this.eventEmitter.emit(EVENT_UNREGISTERED);
+            this.emit(EVENT_UNREGISTERED);
             this._sendAction(Actions.UNREGISTERED);
         });
         this.client.on(this.client.ON_DISCONNECTED, () => {
             logger.info('softphone - disconnected');
-            this.eventEmitter.emit(EVENT_DISCONNECTED);
+            this.emit(EVENT_DISCONNECTED);
             this._sendAction(Actions.TRANSPORT_CLOSED);
         });
         this.client.on(this.client.REGISTERED, () => {
@@ -265,7 +336,7 @@ export class Softphone extends EventEmitter {
             }
             this.stopHeartbeat();
             this._sendAction(Actions.REGISTER_DONE);
-            this.eventEmitter.emit(EVENT_REGISTERED);
+            this.emit(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) {
@@ -281,7 +352,7 @@ export class Softphone extends EventEmitter {
         });
         this.client.on(this.client.DISCONNECTED, () => {
             logger.info('softphone - disconnected');
-            this.eventEmitter.emit(EVENT_DISCONNECTED);
+            this.emit(EVENT_DISCONNECTED);
             // Do not trigger heartbeat if already running
             if (!this.client.hasHeartbeat()) {
                 this.startHeartbeat();
@@ -290,17 +361,17 @@ export class Softphone extends EventEmitter {
             this.shouldSendReinvite = this.calls.length > 0;
         });
         this.client.on('onVideoInputChange', stream => {
-            this.eventEmitter.emit(EVENT_VIDEO_INPUT_CHANGE, stream);
+            this.emit(EVENT_VIDEO_INPUT_CHANGE, stream);
         });
         this.client.on(this.client.MESSAGE, (message) => {
             this._onMessage(message);
-            this.eventEmitter.emit(EVENT_ON_MESSAGE, message);
+            this.emit(EVENT_ON_MESSAGE, message);
         });
         this.client.setOnHeartbeatTimeout(() => {
-            this.eventEmitter.emit(EVENT_HEARTBEAT_TIMEOUT);
+            this.emit(EVENT_HEARTBEAT_TIMEOUT);
         });
         this.client.setOnHeartbeatCallback(() => {
-            this.eventEmitter.emit(EVENT_HEARTBEAT);
+            this.emit(EVENT_HEARTBEAT);
         });
     }
     _sendAction(action) {
@@ -333,11 +404,11 @@ export class Softphone extends EventEmitter {
         const { type, content, } = body;
         switch (type) {
             case MESSAGE_TYPE_CHAT:
-                this.eventEmitter.emit(EVENT_ON_CHAT, content);
+                this.emit(EVENT_ON_CHAT, content);
                 break;
             case MESSAGE_TYPE_SIGNAL:
                 {
-                    this.eventEmitter.emit(EVENT_ON_SIGNAL, content);
+                    this.emit(EVENT_ON_SIGNAL, content);
                     break;
                 }
             default:

package/lib/__tests__/__voice__/call.test.js

@@ -18,6 +18,7 @@ const softphone_1 = __importDefault(require("../../voice/softphone"));
 const call_1 = __importDefault(require("../../voice/call"));
 const call_state_machine_1 = require("../../state-machine/call-state-machine");
 const softphone_state_machine_1 = require("../../state-machine/softphone-state-machine");
+const Call_1 = __importDefault(require("../../domain/Call"));
 const InvalidStateTransition_1 = __importDefault(require("../../domain/InvalidStateTransition"));
 const uaOptions = {
     logBuiltinEnabled: false,
@@ -42,6 +43,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(),
@@ -49,22 +51,60 @@ jest.mock('../../web-rtc-client', () => jest.fn().mockImplementation(() => ({
 const ua = new sip_js_1.UserAgent(uaOptions);
 const sipCall = new sip_js_1.Inviter(ua, sip_js_1.UserAgent.makeURI('sip:1234@my.stack.io'));
 softphone_1.default.connect();
+// @ts-ignore: private method
 softphone_1.default._sendAction(softphone_state_machine_1.Actions.REGISTER_DONE);
 const invalidStateTransition = (state, action) => new InvalidStateTransition_1.default(`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', () => __awaiter(void 0, void 0, void 0, function* () {
+            const apiCall = new Call_1.default({
+                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_1.default.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({ [call_state_machine_1.States.ESTABLISHED]: call_state_machine_1.EstablishedStates.MUTED });
+        }));
+    });
     describe('accept', () => {
         it('Should throw an error when accepting a not ringing call', () => __awaiter(void 0, void 0, void 0, function* () {
             const call = new call_1.default(sipCall, softphone_1.default);
             yield expect(call.accept()).rejects.toThrowError(invalidStateTransition(call_state_machine_1.States.IDLE, call_state_machine_1.Actions.ACCEPT));
         }));
-        it.only('Should throw an error when the softphone is not registered', () => __awaiter(void 0, void 0, void 0, function* () {
+        it('Should throw an error when the softphone is not registered', () => __awaiter(void 0, void 0, void 0, function* () {
             const call = new call_1.default(sipCall, softphone_1.default);
+            // @ts-ignore: private method
             call._sendAction(call_state_machine_1.Actions.INCOMING_CALL);
+            // @ts-ignore: private method
             softphone_1.default._sendAction(softphone_state_machine_1.Actions.TRANSPORT_CLOSED);
             yield expect(call.accept()).rejects.toThrowError(invalidStateTransition(call_state_machine_1.States.RINGING, call_state_machine_1.Actions.ACCEPT));
+            // Revert softphone state
+            softphone_1.default.connect();
+            // @ts-ignore: private method
+            softphone_1.default._sendAction(softphone_state_machine_1.Actions.REGISTER_DONE);
         }));
         it('Should not throw an error when accepting a not ringing call', () => __awaiter(void 0, void 0, void 0, function* () {
             const call = new call_1.default(sipCall, softphone_1.default);
+            // @ts-ignore: private method
             call._sendAction(call_state_machine_1.Actions.INCOMING_CALL);
             yield call.accept();
             expect(softphone_1.default.client.answer).toHaveBeenCalled();
@@ -77,7 +117,9 @@ describe('Call', () => {
         }));
         it('Should not throw an error when terminating an established call', () => __awaiter(void 0, void 0, void 0, function* () {
             const call = new call_1.default(sipCall, softphone_1.default);
+            // @ts-ignore: private method
             call._sendAction(call_state_machine_1.Actions.MAKE_CALL);
+            // @ts-ignore: private method
             call._sendAction(call_state_machine_1.Actions.REMOTLY_ACCEPTED);
             yield call.hangup();
             expect(softphone_1.default.client.hangup).toHaveBeenCalled();

package/lib/domain/Phone/WebRTCPhone.js

@@ -66,6 +66,7 @@ exports.MESSAGE_TYPE_CHAT = 'message/TYPE_CHAT';
 exports.MESSAGE_TYPE_SIGNAL = 'message/TYPE_SIGNAL';
 exports.events = [exports.ON_USER_AGENT, exports.ON_REGISTERED, exports.ON_UNREGISTERED, exports.ON_PROGRESS, exports.ON_CALL_ACCEPTED, exports.ON_CALL_ANSWERED, exports.ON_CALL_INCOMING, exports.ON_CALL_OUTGOING, exports.ON_CALL_MUTED, exports.ON_CALL_UNMUTED, exports.ON_CALL_RESUMED, exports.ON_CALL_HELD, exports.ON_CALL_UNHELD, exports.ON_CAMERA_DISABLED, exports.ON_CALL_FAILED, exports.ON_CALL_ENDED, exports.ON_CALL_REJECTED, exports.ON_MESSAGE, exports.ON_REINVITE, exports.ON_TRACK, exports.ON_AUDIO_STREAM, exports.ON_VIDEO_STREAM, exports.ON_REMOVE_STREAM, exports.ON_SHARE_SCREEN_ENDED, exports.ON_TERMINATE_SOUND, exports.ON_PLAY_RING_SOUND, exports.ON_PLAY_INBOUND_CALL_SIGNAL_SOUND, exports.ON_PLAY_HANGUP_SOUND, exports.ON_PLAY_PROGRESS_SOUND, exports.ON_VIDEO_INPUT_CHANGE, exports.ON_SHARE_SCREEN_STARTED, exports.ON_CALL_ERROR, exports.ON_CHAT, exports.ON_SIGNAL, exports.ON_NETWORK_STATS, exports.ON_DISCONNECTED, exports.ON_EARLY_MEDIA];
 const logger = IssueReporter_1.default.loggerFor('webrtc-phone');
+// @deprecated: Use Wazo.Voice.Softphone instead
 class WebRTCPhone extends Emitter_1.default {
     constructor(client, audioOutputDeviceId, allowVideo = false, audioRingDeviceId) {
         super();
@@ -1468,14 +1469,12 @@ class WebRTCPhone extends Emitter_1.default {
         });
     }
     _createCallSession(sipSession, fromSession, extra = {}) {
-        // eslint-disable-next-line
-        const identity = sipSession ? sipSession.remoteIdentity || sipSession.assertedIdentity : null;
-        // @ts-ignore: private
-        const number = identity ? identity.uri._normal.user : null;
-        const { state, } = sipSession || {};
+        const number = (0, sdp_1.getCallNumber)(sipSession);
+        const displayName = (0, sdp_1.getCallDisplayName)(sipSession);
+        const { state } = sipSession || {};
         const sessionId = (0, sdp_1.getSipSessionId)(sipSession);
         fromSession = fromSession || this.callSessions[sessionId];
-        const callSession = new CallSession_1.default(Object.assign({ callId: fromSession && fromSession.callId, sipCallId: sessionId, sipStatus: state, displayName: identity ? identity.displayName || number : number, 
+        const callSession = new CallSession_1.default(Object.assign({ callId: fromSession && fromSession.callId, sipCallId: sessionId, sipStatus: state, displayName, 
             // @ts-ignore: date / number
             startTime: fromSession ? fromSession.startTime : new Date(), creationTime: fromSession ? fromSession.creationTime : null, answerTime: fromSession ? fromSession.answerTime : null, endTime: fromSession ? fromSession.endTime : null, answered: state === session_state_1.SessionState.Established, paused: this.client.isCallHeld(sipSession), isCaller: fromSession ? fromSession.isCaller : 'incoming' in extra ? !extra.incoming : false, cameraEnabled: fromSession ? fromSession.isCameraEnabled() : this.client.hasVideo(sessionId), number, ringing: false, muted: fromSession ? fromSession.isMuted() : this.client.isAudioMuted(sipSession), videoMuted: fromSession ? fromSession.isVideoMuted() : false, recording: fromSession ? fromSession.isRecording() : false, recordingPaused: false, sipSession, conference: !!fromSession && fromSession.isConference() }, extra));
         this.callSessions[sessionId] = callSession;

package/lib/simple/Phone.js

@@ -50,6 +50,7 @@ const logger = IssueReporter_1.default.loggerFor('simple-phone');
 const sipLogger = IssueReporter_1.default.loggerFor('sip.js');
 const protocolLogger = IssueReporter_1.default.loggerFor('sip');
 const protocolDebugMessages = ['Received WebSocket text message:', 'Sending WebSocket message:'];
+// @deprecated: Use Wazo.Voice.Softphone instead
 class Phone extends Emitter_1.default {
     constructor() {
         super();

package/lib/state-machine/call-state-machine.js

@@ -35,7 +35,7 @@ exports.EstablishedActions = {
 };
 const callMachine = (0, xstate_1.setup)({
     guards: {
-        isRegistered: () => softphone_1.default.getState() === softphone_state_machine_1.States.REGISTERED,
+        isRegistered: () => softphone_1.default.state === softphone_state_machine_1.States.REGISTERED,
     },
 }).createMachine({
     id: 'call',