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

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,45 @@ 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 });
+      expect(call.isEstablished()).toBeTruthy();
+    });
+  });
+
   describe('accept', () => {
     it('Should throw an error when accepting a not ringing call', async () => {
       const call = new Call(sipCall, softphone);
@@ -54,16 +90,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 +124,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();

package/src/domain/Phone/CTIPhone.ts

@@ -1,5 +1,6 @@
 import Session from '../Session';
 import Call from '../Call';
+import SoftphoneCall from '../../voice/call';
 import Line from '../Line';
 import CallSession from '../CallSession';
 import type { Phone, AvailablePhoneOptions } from './Phone';
@@ -141,7 +142,7 @@ export default class CTIPhone extends Emitter implements Phone {
     });
 
     try {
-      await CallApi.cancelCall(callSession);
+      await CallApi.cancelCall({ apiId: callSession.getId() } as SoftphoneCall);
 
       if (this.currentCall && callSession.callId === this.currentCall.id) {
         this.endCurrentCall(callSession);
@@ -167,7 +168,7 @@ export default class CTIPhone extends Emitter implements Phone {
       callId: callSession.getId(),
       number: callSession.number,
     });
-    await CallApi.cancelCall(callSession);
+    await CallApi.cancelCall({ id: callSession.getId() } as SoftphoneCall);
     this.eventEmitter.emit('onCallEnded', callSession);
   }
 

package/src/domain/Phone/WebRTCPhone.ts

@@ -12,7 +12,7 @@ import WazoWebRTCClient from '../../web-rtc-client';
 import Emitter from '../../utils/Emitter';
 import IssueReporter from '../../service/IssueReporter';
 import { PeerConnection, WazoSession } from '../types';
-import { getSipSessionId } from '../../utils/sdp';
+import { getCallDisplayName, getCallNumber, getSipSessionId } from '../../utils/sdp';
 import { downgradeToAudio, getStreamFromConstraints, getWebRtcStats, setLocalMediaStream, upgradeToVideo } from '../../utils/webrtc';
 
 export const ON_USER_AGENT = 'onUserAgent';
@@ -61,6 +61,8 @@ export const MESSAGE_TYPE_CHAT = 'message/TYPE_CHAT';
 export const MESSAGE_TYPE_SIGNAL = 'message/TYPE_SIGNAL';
 export const events = [ON_USER_AGENT, ON_REGISTERED, ON_UNREGISTERED, ON_PROGRESS, ON_CALL_ACCEPTED, ON_CALL_ANSWERED, ON_CALL_INCOMING, ON_CALL_OUTGOING, ON_CALL_MUTED, ON_CALL_UNMUTED, ON_CALL_RESUMED, ON_CALL_HELD, ON_CALL_UNHELD, ON_CAMERA_DISABLED, ON_CALL_FAILED, ON_CALL_ENDED, ON_CALL_REJECTED, ON_MESSAGE, ON_REINVITE, ON_TRACK, ON_AUDIO_STREAM, ON_VIDEO_STREAM, ON_REMOVE_STREAM, ON_SHARE_SCREEN_ENDED, ON_TERMINATE_SOUND, ON_PLAY_RING_SOUND, ON_PLAY_INBOUND_CALL_SIGNAL_SOUND, ON_PLAY_HANGUP_SOUND, ON_PLAY_PROGRESS_SOUND, ON_VIDEO_INPUT_CHANGE, ON_SHARE_SCREEN_STARTED, ON_CALL_ERROR, ON_CHAT, ON_SIGNAL, ON_NETWORK_STATS, ON_DISCONNECTED, ON_EARLY_MEDIA];
 const logger = IssueReporter.loggerFor('webrtc-phone');
+
+// @deprecated: Use Wazo.Voice.Softphone instead
 export default class WebRTCPhone extends Emitter implements Phone {
   client: WazoWebRTCClient;
 
@@ -1783,20 +1785,17 @@ export default class WebRTCPhone extends Emitter implements Phone {
   }
 
   _createCallSession(sipSession: WazoSession, fromSession?: CallSession | null | undefined, extra: Record<string, any> = {}): CallSession {
-    // 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 = getCallNumber(sipSession);
+    const displayName = getCallDisplayName(sipSession);
+    const { state } = sipSession || {};
     const sessionId = getSipSessionId(sipSession);
+
     fromSession = fromSession || this.callSessions[sessionId];
     const callSession = new CallSession({
       callId: fromSession && fromSession.callId,
       sipCallId: sessionId,
       sipStatus: state,
-      displayName: identity ? identity.displayName || number : number,
+      displayName,
       // @ts-ignore: date / number
       startTime: fromSession ? fromSession.startTime : new Date(),
       creationTime: fromSession ? fromSession.creationTime : null,
@@ -1817,6 +1816,7 @@ export default class WebRTCPhone extends Emitter implements Phone {
       ...extra,
     });
     this.callSessions[sessionId] = callSession;
+
     return callSession;
   }
 

package/src/index.ts

@@ -7,7 +7,7 @@ export { default as ServerError } from './domain/ServerError';
 export { default as InvalidStateTransition } from './domain/InvalidStateTransition';
 export { default as InvalidState } from './domain/InvalidState';
 export { default as SFUNotAvailableError } from './domain/SFUNotAvailableError';
-export { default as Call } from './domain/Call';
+export { default as ApiCall } from './domain/Call';
 export { default as CallLog } from './domain/CallLog';
 export { default as Recording } from './domain/Recording';
 export { default as ChatMessage } from './domain/ChatMessage';

package/src/service/CallApi.ts

@@ -1,9 +1,9 @@
-import Call from '../domain/Call';
+import ApiCall from '../domain/Call';
+import Call from '../voice/call';
 import CallLog from '../domain/CallLog';
 import Line from '../domain/Line';
 import Session from '../domain/Session';
 import Relocation from '../domain/Relocation';
-import CallSession from '../domain/CallSession';
 import getApiClient from './getApiClient';
 import Transfer from '../domain/IndirectTransfer';
 
@@ -16,7 +16,7 @@ export default class CallApi {
     return getApiClient().callLogd.listDistinctCallLogs(offset, limit, distinct);
   }
 
-  static async fetchActiveCalls(): Promise<Call[]> {
+  static async fetchActiveCalls(): Promise<ApiCall[]> {
     return getApiClient().calld.listCalls();
   }
 
@@ -37,14 +37,14 @@ export default class CallApi {
     return getApiClient().confd.getUserLineSip(session.uuid as string, lineToUse ? <unknown>lineToUse.id as string : '');
   }
 
-  static async cancelCall(callSession: CallSession): Promise<boolean> {
-    return getApiClient().calld.cancelCall(callSession.callId);
+  static async cancelCall(call: Call): Promise<boolean> {
+    return getApiClient().calld.cancelCall(call.apiId || '');
   }
 
-  static async makeCall(callFromLine: Line, extension: string, isMobile = false, callbackAllLines = false): Promise<Call | null | undefined> {
+  static async makeCall(callFromLine: Line, extension: string, isMobile = false, callbackAllLines = false): Promise<ApiCall | null | undefined> {
     const lineId = callFromLine ? callFromLine.id : null;
     const response = await getApiClient().calld.makeCall(extension, isMobile, lineId, callbackAllLines);
-    return Call.parse(response);
+    return ApiCall.parse(response);
   }
 
   static async relocateCall(callId: string, line: number, contactIdentifier?: string): Promise<Relocation> {

package/src/simple/Phone.ts

@@ -19,6 +19,7 @@ const sipLogger = IssueReporter.loggerFor('sip.js');
 const protocolLogger = IssueReporter.loggerFor('sip');
 const protocolDebugMessages = ['Received WebSocket text message:', 'Sending WebSocket message:'];
 
+// @deprecated: Use Wazo.Voice.Softphone instead
 export class Phone extends Emitter {
   client: WazoWebRTCClient;
 

package/src/state-machine/call-state-machine.ts

@@ -43,7 +43,7 @@ export type EstablishedActionTypes = typeof EstablishedActions[keyof typeof Esta
 
 const callMachine = setup({
   guards: {
-    isRegistered: () => softphone.getState() === SoftphoneStates.REGISTERED,
+    isRegistered: () => softphone.state === SoftphoneStates.REGISTERED,
   },
 }).createMachine({
   id: 'call',

package/src/state-machine/utils.ts

@@ -8,8 +8,8 @@ import IssueReporter from '../service/IssueReporter';
 
 const logger = IssueReporter.loggerFor('state-machine');
 
-export const getState = (actor: SoftphoneActorRef | CallActorRef): SoftphoneStates | CallStates | EstablishedStateTypes => {
-  return actor.getSnapshot().value as SoftphoneStates | CallStates | EstablishedStateTypes;
+export const getState = (actor: SoftphoneActorRef | CallActorRef): SoftphoneStates | CallStates | EstablishedStateTypes | Record<CallStates, EstablishedStateTypes> => {
+  return actor.getSnapshot().value as SoftphoneStates | CallStates | EstablishedStateTypes | Record<CallStates, EstablishedStateTypes>;
 };
 
 export const can = (actor: SoftphoneActorRef | CallActorRef, action: SoftphoneActions | CallActions | EstablishedCallActions): boolean => {

package/src/utils/sdp.ts

@@ -1,3 +1,4 @@
+/* eslint-disable no-underscore-dangle */
 import sdpParser from 'sdp-transform';
 import { UserAgent } from 'sip.js/lib/api/user-agent';
 import { Inviter } from 'sip.js/lib/api';
@@ -174,3 +175,18 @@ export const replaceLocalIpModifier = (description: Record<string, any>) => Prom
 });
 
 export const makeURI = (target: string, host: string): URI | undefined => UserAgent.makeURI(`sip:${target}@${host}`);
+
+export const getCallNumber = (sipCall: SipCall): string => {
+  // eslint-disable-next-line
+  const identity = sipCall ? sipCall.remoteIdentity || sipCall.assertedIdentity : null;
+  // @ts-ignore: private
+  return identity ? identity.uri._normal.user : null;
+};
+
+export const getCallDisplayName = (sipCall: SipCall): string => {
+  // eslint-disable-next-line
+  const identity = sipCall ? sipCall.remoteIdentity || sipCall.assertedIdentity : null;
+  const number = getCallNumber(sipCall);
+
+  return identity ? identity.displayName || number : number;
+};

package/src/utils/webrtc.ts

@@ -1,4 +1,4 @@
-/* eslint-disable no-underscore-dangle, no-param-reassign */
+/* eslint-disable no-underscore-dangle, no-param-reassign, no-restricted-syntax */
 import type { SessionDescriptionHandler } from 'sip.js/lib/platform/web/session-description-handler/session-description-handler';
 import type { SessionDescriptionHandlerFactoryOptions } from 'sip.js/lib/platform/web/session-description-handler/session-description-handler-factory-options';
 import type { SessionDescriptionHandlerConfiguration } from 'sip.js/lib/platform/web/session-description-handler/session-description-handler-configuration';
@@ -246,6 +246,28 @@ export const toggleVideo = (sipCall: SipCall, muteCamera: boolean): void => {
   }
 };
 
+export const isVideoMuted = (sipCall: SipCall): boolean => {
+  const sdh = sipCall.sessionDescriptionHandler as SessionDescriptionHandler;
+  const pc = sdh?.peerConnection as PeerConnection;
+
+  if (pc?.getSenders) {
+    for (const sender of pc.getSenders()) {
+      if (sender && sender.track && sender.track.kind === 'video') {
+        return !sender.track.enabled;
+      }
+    }
+  } else {
+    for (const stream of pc.getLocalStreams()) {
+      // eslint-disable-next-line no-unreachable-loop
+      for (const track of stream.getVideoTracks()) {
+        return !track.enabled;
+      }
+    }
+  }
+
+  return true;
+};
+
 export const cleanupStream = (stream: MediaStream): void => {
   stream.getTracks().filter(track => track.enabled).forEach(track => track.stop());
 };