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

package/src/domain/types.ts

@@ -264,11 +264,6 @@ export type PeerConnection = RTCPeerConnection & {
   addStream: (stream: MediaStream) => void;
   sfu: any;
 };
-// @TODO, rename it to SipCall
-export type WazoSession = (Invitation | Inviter) & {
-  remoteTag?: any;
-  callId?: string;
-};
 
 export type SipCall = (Invitation | Inviter) & {
   remoteTag?: any;

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';
@@ -53,6 +53,9 @@ export { default as WazoApiClient } from './api-client';
 export { default as Agent, AgentResponse, AgentArguments } from './domain/Agent';
 export { default as ExternalApp } from './domain/ExternalApp';
 export { default as SessionDescriptionHandler } from './lib/WazoSessionDescriptionHandler';
+export { default as Call } from './voice/call';
+export { Softphone } from './voice/softphone';
+
 export * from './types/WebSocketMessage';
 export * from './utils/PhoneNumberUtil';
 export * from './utils/string';

package/src/lib/WazoSessionDescriptionHandler.ts

@@ -5,7 +5,7 @@ import type { MediaStreamFactory } from 'sip.js/lib/platform/web/session-descrip
 import type { SessionDescriptionHandlerConfiguration } from 'sip.js/lib/platform/web/session-description-handler/session-description-handler-configuration';
 import { SessionDescriptionHandler } from 'sip.js/lib/platform/web/session-description-handler/session-description-handler';
 import { SessionDescriptionHandlerOptions } from 'sip.js/lib/platform/web/session-description-handler/session-description-handler-options';
-import { PeerConnection, WazoSession } from '../domain/types';
+import { PeerConnection, SipCall } from '../domain/types';
 import IssueReporter from '../service/IssueReporter';
 import { type Candidate, addIcesInAllBundles, fixSdp, parseCandidate } from '../utils/sdp';
 
@@ -36,10 +36,10 @@ class WazoSessionDescriptionHandler extends SessionDescriptionHandler {
 
   isWeb: boolean;
 
-  session: WazoSession;
+  session: SipCall;
 
   // eslint-disable-next-line @typescript-eslint/default-param-last
-  constructor(logger: Logger, mediaStreamFactory: MediaStreamFactory, sessionDescriptionHandlerConfiguration: SessionDescriptionHandlerConfiguration, isWeb: boolean, session: WazoSession) {
+  constructor(logger: Logger, mediaStreamFactory: MediaStreamFactory, sessionDescriptionHandlerConfiguration: SessionDescriptionHandlerConfiguration, isWeb: boolean, session: SipCall) {
     super(logger, mediaStreamFactory, sessionDescriptionHandlerConfiguration);
     this.eventEmitter = new EventEmitter();
     this.isWeb = isWeb;

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/Auth.ts

@@ -167,6 +167,10 @@ export class Auth {
     return this._onAuthenticated(rawSession as Session);
   }
 
+  async samlLogOut(): Promise<void | { location: string }> {
+    return await this.logout(false, true);
+  }
+
   async initiateIdpAuthentication(domain: string, redirectUrl: string): Promise<{ location: string, saml_session_id: string } | undefined> {
     try {
       return await getApiClient().auth.initiateIdpAuthentication(domain, redirectUrl);
@@ -218,20 +222,26 @@ export class Auth {
     return getApiClient().auth.refreshToken(refreshToken, '', this.expiration);
   }
 
-  async logout(deleteRefreshToken = true): Promise<void> {
+  async logout(deleteRefreshToken = true, saml = false): Promise<void | { location: string }> {
     try {
       Wazo.Websocket.close(true);
 
-      if (this.clientId && deleteRefreshToken) {
+      if (!saml && this.clientId && deleteRefreshToken) {
         await getApiClient().auth.deleteRefreshToken(this.clientId);
       }
     } catch (e: any) {
       // Nothing to
     }
 
+    let response;
+
     try {
       if (this.session?.token) {
-        await getApiClient().auth.logOut(this.session.token);
+        if (saml) {
+          response = await getApiClient().auth.samlLogOut();
+        } else {
+          await getApiClient().auth.logOut(this.session.token);
+        }
       }
     } catch (e: any) {
       // Nothing to
@@ -243,6 +253,8 @@ export class Auth {
     this.authenticated = false;
     this.usingEdgeServer = undefined;
     setFetchOptions({});
+
+    return response;
   }
 
   setOnHostFromHeaders(callback: (hostFromHeaders: string) => void) {

package/src/simple/Phone.ts

@@ -6,21 +6,22 @@ import type CallSession from '../domain/CallSession';
 import AdHocAPIConference from '../domain/AdHocAPIConference';
 import WebRTCPhone, * as PHONE_EVENTS from '../domain/Phone/WebRTCPhone';
 import { MESSAGE_TYPE_CHAT, MESSAGE_TYPE_SIGNAL } from '../domain/Phone/WebRTCPhone';
-import WazoWebRTCClient, { events as clientEvents, transportEvents } from '../web-rtc-client';
+import WebRTCClient, { events as clientEvents, transportEvents } from '../web-rtc-client';
 import IssueReporter from '../service/IssueReporter';
 import Emitter from '../utils/Emitter';
 import Wazo from './index';
 import SFUNotAvailableError from '../domain/SFUNotAvailableError';
-import { WazoSession, WebRtcConfig } from '../domain/types';
-import { getSipSessionId } from '../utils/sdp';
+import { SipCall, WebRtcConfig } from '../domain/types';
+import { getSipCallId } from '../utils/sdp';
 
 const logger = IssueReporter.loggerFor('simple-phone');
 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;
+  client: WebRTCClient;
 
   phone: WebRTCPhone | null | undefined;
 
@@ -187,7 +188,7 @@ export class Phone extends Emitter {
       options.log.connector = this._logConnector;
     }
 
-    this.client = new WazoWebRTCClient({
+    this.client = new WebRTCClient({
       host,
       port: typeof port === 'string' ? parseInt(port, 10) : port,
       displayName,
@@ -329,14 +330,14 @@ export class Phone extends Emitter {
     return this.phone ? this.phone.stopNetworkMonitoring(callSession) : null;
   }
 
-  getSipSessionId(sipSession: WazoSession): string | null | undefined {
+  getSipCallId(sipSession: SipCall): string | null | undefined {
     if (!sipSession || !this.phone) {
       return null;
     }
-    return getSipSessionId(sipSession);
+    return getSipCallId(sipSession);
   }
 
-  sendMessage(body: string, sipSession?: WazoSession, contentType = 'text/plain'): void {
+  sendMessage(body: string, sipSession?: SipCall, contentType = 'text/plain'): void {
     const toSipSession = sipSession || this.getCurrentSipSession();
 
     if (!toSipSession || !this.phone) {
@@ -346,14 +347,14 @@ export class Phone extends Emitter {
     this.phone.sendMessage(toSipSession, body, contentType);
   }
 
-  sendChat(content: string, sipSession?: WazoSession): void {
+  sendChat(content: string, sipSession?: SipCall): void {
     this.sendMessage(JSON.stringify({
       type: MESSAGE_TYPE_CHAT,
       content,
     }), sipSession, 'application/json');
   }
 
-  sendSignal(content: any, sipSession?: WazoSession): void {
+  sendSignal(content: any, sipSession?: SipCall): void {
     this.sendMessage(JSON.stringify({
       type: MESSAGE_TYPE_SIGNAL,
       content,
@@ -446,7 +447,7 @@ export class Phone extends Emitter {
     return this.phone ? this.phone.hasAVideoTrack(callSession) : false;
   }
 
-  getCurrentSipSession(): WazoSession | null {
+  getCurrentSipSession(): SipCall | null {
     return this.phone?.currentSipSession || null;
   }
 

package/src/simple/index.ts

@@ -41,7 +41,7 @@ import Features from '../domain/Features';
 import Meeting from '../domain/Meeting';
 import Checker from '../checker/Checker';
 
-import Softphone from '../voice/softphone';
+import Softphone, { Softphone as SoftphoneClass } from '../voice/softphone';
 import Call from '../voice/call';
 
 const Wazo = {
@@ -91,6 +91,7 @@ const Wazo = {
     SwitchboardCall,
     WebRTCPhone,
     Meeting,
+    SoftphoneClass,
   },
 
   // Api

package/src/simple/room/Room.ts

@@ -9,8 +9,8 @@ import Participant, { RawParticipant } from './Participant';
 import RemoteParticipant from './RemoteParticipant';
 import IssueReporter from '../../service/IssueReporter';
 import LocalParticipant from './LocalParticipant';
-import { PeerConnection, WazoSession } from '../../domain/types';
-import { getSipSessionId } from '../../utils/sdp';
+import { PeerConnection, SipCall } from '../../domain/types';
+import { getSipCallId } from '../../utils/sdp';
 
 export const SIGNAL_TYPE_PARTICIPANT_UPDATE = 'signal/PARTICIPANT_UPDATE';
 export const SIGNAL_TYPE_PARTICIPANT_REQUEST = 'signal/PARTICIPANT_REQUEST';
@@ -498,7 +498,7 @@ class Room extends Emitter {
       this.audioStream = stream;
 
       if (!this.roomAudioElement) {
-        const sessionId = getSipSessionId(Wazo.Phone.phone?.currentSipSession as WazoSession);
+        const sessionId = getSipCallId(Wazo.Phone.phone?.currentSipSession as SipCall);
         this.roomAudioElement = await Wazo.Phone.phone?.createAudioElementFor(sessionId as string) as HTMLAudioElement;
         this.roomAudioElement.srcObject = stream;
       } else {

package/src/simple/room/SipRoom.ts

@@ -3,8 +3,8 @@ import CallSession from '../../domain/CallSession';
 import IssueReporter from '../../service/IssueReporter';
 import Wazo from '../index';
 import Room from './Room';
-import { WazoSession } from '../../domain/types';
-import { getSipSessionId } from '../../utils/sdp';
+import { SipCall } from '../../domain/types';
+import { getSipCallId } from '../../utils/sdp';
 
 const logger = IssueReporter.loggerFor('sdk-sip-room');
 
@@ -157,7 +157,7 @@ class SipRoom extends Room {
   }
 
   _getCurrentSipCallIs() {
-    return getSipSessionId(Wazo.Phone.phone?.currentSipSession as WazoSession);
+    return getSipCallId(Wazo.Phone.phone?.currentSipSession as SipCall);
   }
 
 }

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',
@@ -53,7 +53,7 @@ const callMachine = setup({
     [States.IDLE]: {
       on: {
         [Actions.INCOMING_CALL]: {
-          // guard: 'isRegistered',
+          guard: 'isRegistered',
           target: States.RINGING,
         },
         [Actions.MAKE_CALL]: {

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

@@ -12,7 +12,6 @@ export const Actions = {
   REGISTER: 'register',
   REGISTER_DONE: 'registerDone',
   UNREGISTER: 'unregister',
-  UNREGISTERED: 'unregistered',
   TRANSPORT_CLOSED: 'transportClosed',
 } as const;
 
@@ -32,7 +31,7 @@ const softphoneMachine = setup({}).createMachine({
       on: {
         [Actions.REGISTER_DONE]: States.REGISTERED,
         [Actions.TRANSPORT_CLOSED]: States.UNREGISTERED,
-        [Actions.UNREGISTERED]: States.UNREGISTERED,
+        [Actions.UNREGISTER]: States.UNREGISTERED,
       },
     },
     [States.REGISTERED]: {

package/src/state-machine/utils.ts

@@ -8,16 +8,23 @@ 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 => {
   return actor.getSnapshot().can({ type: action });
 };
 
-export const hasState = (actor: SoftphoneActorRef | CallActorRef, state: SoftphoneStates | CallStates): boolean => {
-  return getState(actor) === state;
+export const hasState = (actor: SoftphoneActorRef | CallActorRef, state: SoftphoneStates | CallStates, innerState?: EstablishedStateTypes): boolean => {
+  const currentState = getState(actor);
+
+  // When using nested states, we'll have an object here
+  if (typeof currentState === 'object') {
+    return innerState ? state in currentState && currentState[state as CallStates] === innerState : state in currentState;
+  }
+
+  return currentState === state;
 };
 
 export const waitUntilState = (actor: SoftphoneActorRef | CallActorRef, state: SoftphoneStates | CallStates, timeout = 5000): Promise<unknown> => {
@@ -36,7 +43,8 @@ export const waitUntilState = (actor: SoftphoneActorRef | CallActorRef, state: S
 export const assertCan = (actor: SoftphoneActorRef | CallActorRef, action: SoftphoneActions | CallActions | EstablishedCallActions): void => {
   if (!can(actor, action)) {
     const currentState = actor.getSnapshot().value;
-    const message = `Invalid state transition from ${currentState} with action ${action}`;
+    const currentStateString = typeof currentState === 'object' ? JSON.stringify(currentState) : currentState;
+    const message = `Invalid state transition from ${currentStateString} with action ${action}`;
     logger.warn(message);
 
     throw new InvalidStateTransition(message, action, currentState as string);
@@ -45,7 +53,7 @@ export const assertCan = (actor: SoftphoneActorRef | CallActorRef, action: Softp
 
 export const assertState = (actor: SoftphoneActorRef | CallActorRef, state: SoftphoneStates | CallStates): void => {
   if (!hasState(actor, state)) {
-    const message = `Invalid state ${state}`;
+    const message = `Invalid state ${state}, has state ${getState(actor)}`;
     logger.warn(message);
 
     throw new InvalidState(message, state);

package/src/utils/sdp.ts

@@ -1,12 +1,11 @@
+/* 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';
+import { Inviter, Invitation } from 'sip.js/lib/api';
 import { URI } from 'sip.js/lib/grammar/uri';
 
 import type { SipCall } from '../domain/types';
 
-export const SIP_ID_LENGTH = 36;
-
 export type Candidate = {
   foundation: string;
   component: number;
@@ -146,25 +145,26 @@ export const addIcesInAllBundles = (sdp: string) => {
   return sdpParser.write(parsedSdp);
 };
 
-export const getSipSessionId = (sipSession: SipCall | null | undefined): string => {
+export const getSipCallId = (sipSession: SipCall | null | undefined): string => {
   if (!sipSession) {
     return '';
   }
 
-  const message = sipSession.message as Partial<{ callId?: string }>;
-  if (message?.callId) {
-    return message.callId.substring(0, SIP_ID_LENGTH);
-  }
-
   // For Inviter
   // @ts-ignore: private
   if (sipSession instanceof Inviter && sipSession.outgoingRequestMessage) {
     // @ts-ignore: private
-    return sipSession.outgoingRequestMessage.callId.substring(0, SIP_ID_LENGTH);
+    return sipSession.outgoingRequestMessage.callId;
   }
 
   // For Invitation
-  return (sipSession.id || '').substring(0, SIP_ID_LENGTH);
+  // @ts-ignore: private
+  if (sipSession instanceof Invitation && sipSession.incomingInviteRequest.message) {
+    // @ts-ignore: private
+    return sipSession.incomingInviteRequest.message.callId;
+  }
+
+  return sipSession.id;
 };
 
 // We need to replace 0.0.0.0 to 127.0.0.1 in the sdp to avoid MOH during a createOffer.
@@ -174,3 +174,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';
@@ -7,7 +7,7 @@ import { stripVideo } from 'sip.js/lib/platform/web';
 
 import WazoSessionDescriptionHandler, { wazoMediaStreamFactory } from '../lib/WazoSessionDescriptionHandler';
 import { SipCall, PeerConnection, UserAgentOptions, WebRtcConfig, UserAgentConfigOverrides } from '../domain/types';
-import { getVideoDirection, hasAnActiveVideo, makeURI, replaceLocalIpModifier } from './sdp';
+import { getSipCallId, getVideoDirection, hasAnActiveVideo, makeURI, replaceLocalIpModifier } from './sdp';
 import IssueReporter from '../service/IssueReporter';
 import { lastIndexOf } from './array';
 
@@ -246,13 +246,35 @@ 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());
 };
 
 export const setLocalMediaStream = (sipCall: SipCall, newStream: MediaStream): void => {
   logger.info('setting local media stream', {
-    id: sipCall.id,
+    id: getSipCallId(sipCall),
     tracks: newStream ? newStream.getTracks() : null,
   });
 
@@ -268,7 +290,7 @@ export const updateRemoteStream = (sipCall: SipCall, allTracks = true): void =>
   const pc = getPeerConnection(sipCall);
 
   logger.info('Updating remote stream', {
-    id: sipCall.id,
+    id: getSipCallId(sipCall),
     tracks: remoteStream ? remoteStream.getTracks() : null,
     receiverTracks: pc && pc.getReceivers ? pc.getReceivers().map((receiver) => receiver.track) : null,
   });