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

package/src/__tests__/api-client.test.ts

@@ -131,7 +131,6 @@ describe('With correct API results', () => {
         body: JSON.stringify({ saml_session_id: samlSessionId }),
         signal: expect.any(Object),
         headers: {
-          'X-Auth-Token': token,
           'Content-Type': 'application/json',
           Accept: 'application/json',
         },
@@ -140,6 +139,28 @@ describe('With correct API results', () => {
     });
   });
 
+  describe('samlLogIn mobile test', () => {
+    it('should retrieve user token', async () => {
+      Wazo.Auth.mobile = true;
+      const samlSessionId = 'a1b2C3d4';
+      const result = await client.auth.samlLogIn(samlSessionId);
+
+      expect(result).toBeInstanceOf(Session);
+      expect(result?.token).toBe(1);
+      expect(global.fetch).toBeCalledWith(`https://${server}/api/auth/${authVersion}/token`, {
+        method: 'post',
+        body: JSON.stringify({ saml_session_id: samlSessionId }),
+        signal: expect.any(Object),
+        headers: {
+          'Content-Type': 'application/json',
+          'Wazo-Session-Type': 'mobile',
+          Accept: 'application/json',
+        },
+        agent: null,
+      });
+    });
+  });
+
   describe('logOut test', () => {
     it('should delete the specified token', async () => {
       const oldToken = 123;

package/src/api/auth.ts

@@ -16,6 +16,12 @@ type LoginParams = {
   domainName?: string;
 };
 
+type SamlLoginBody = {
+  saml_session_id: string,
+  access_type?: 'online' | 'offline';
+  client_id?: string;
+};
+
 type SendResetPasswordArgs = {
   username?: string,
   email?: string,
@@ -110,13 +116,29 @@ export default ((client: ApiRequester, baseUrl: string): AuthD => ({
   },
 
   logOut: (token: Token): Promise<LogoutResponse> => client.delete(`${baseUrl}/token/${token}`, null, {}, ApiRequester.successResponseParser),
+
   samlLogIn: async (samlSessionId: string): Promise<Session | null | undefined> => {
-    const body = {
+    const headers: Record<string, any> = {
+      Accept: 'application/json',
+      'Content-Type': 'application/json',
+    };
+
+    const body: SamlLoginBody = {
       saml_session_id: samlSessionId,
     };
 
-    return client.post(`${baseUrl}/token`, body).then(Session.parse);
+    if (client.clientId) {
+      body.access_type = 'offline';
+      body.client_id = client.clientId;
+    }
+
+    if (Wazo.Auth.mobile) {
+      headers['Wazo-Session-Type'] = 'mobile';
+    }
+
+    return client.post(`${baseUrl}/token`, body, headers).then(Session.parse);
   },
+
   initiateIdpAuthentication: async (domain: string, redirectUrl: string) => {
     const body = {
       domain,
@@ -128,7 +150,7 @@ export default ((client: ApiRequester, baseUrl: string): AuthD => ({
       'Content-Type': 'application/json',
     };
 
-    return client.post(`${baseUrl}/saml/sso`, body, headers, (response: any) => response);
+    return client.post(`${baseUrl}/saml/sso`, body, headers);
   },
   refreshToken: (refreshToken: string, backend: string, expiration: number, isMobile?: boolean, tenantId?: string, domainName?: string): Promise<Session | null | undefined> => {
     const body: Record<string, any> = {

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

@@ -4,6 +4,8 @@ export { default as Emitter } from './utils/Emitter';
 export { default as IssueReporter } from './service/IssueReporter';
 export { default as BadResponse } from './domain/BadResponse';
 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 CallLog } from './domain/CallLog';

package/src/simple/Auth.ts

@@ -168,28 +168,21 @@ export class Auth {
   }
 
   async initiateIdpAuthentication(domain: string, redirectUrl: string): Promise<{ location: string, saml_session_id: string } | undefined> {
-    let response;
     try {
-      response = await getApiClient().auth.initiateIdpAuthentication(domain, redirectUrl);
+      return await getApiClient().auth.initiateIdpAuthentication(domain, redirectUrl);
     } catch (e: any) {
-      logger.error('Error during IdP authentication initiation:', e.message);
-      return;
-    }
+      logger.error('Error during IdP authentication initialization:', e.message);
 
-    if (!response.ok) {
-      if (response.status === 404) {
-        throw new NoSamlRouteError('No route found for saml sso');
+      if (e.status === 404) {
+        throw new NoSamlRouteError('No route found for SAML SSO');
       }
 
-      if (response.status === 500) {
+      if (e.status === 500) {
         throw new SamlConfigError('SAML/server configuration error');
       }
 
-      const error = await response.json();
-      throw new Error(error.message || error.reason);
+      throw e;
     }
-
-    return response.json();
   }
 
   async logInViaRefreshToken(refreshToken: string): Promise<Session | null> {

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

@@ -1,3 +1,5 @@
+import BadResponse from '../../domain/BadResponse';
+import ServerError from '../../domain/ServerError';
 import getApiClient, { setRefreshToken } from '../../service/getApiClient';
 import { Auth as AuthClass } from '../Auth';
 
@@ -124,13 +126,8 @@ describe('simple/Auth', () => {
   describe('initiateIdpAuthentication', () => {
     const validResponse = { location: 'idp.com/auth', saml_session_id: 'a1b2C3d4' };
 
-    it('should return a `location` and `saml_session_id` if the response is ok', async () => {
-      const initiateIdpAuthentication = jest.fn(() =>
-        Promise.resolve({
-          ok: true,
-          status: 303,
-          json: () => Promise.resolve(validResponse),
-        }));
+    it('should return a `location` and `saml_session_id` if the response is valid', async () => {
+      const initiateIdpAuthentication = jest.fn(() => validResponse);
 
       (getApiClient as any).mockImplementation(() => ({
         auth: {
@@ -141,48 +138,9 @@ describe('simple/Auth', () => {
       const response = await Auth.initiateIdpAuthentication('example.com', 'https://myapp.xyz');
       expect(response).toBe(validResponse);
     });
-    it('should return a `NoSamlRouteError` if the response is a 404', async () => {
-      const initiateIdpAuthentication = jest.fn(() =>
-        Promise.resolve({
-          ok: false,
-          status: 404,
-        }));
-
-      (getApiClient as any).mockImplementation(() => ({
-        auth: {
-          initiateIdpAuthentication,
-        },
-      }));
-
-      await expect(Auth.initiateIdpAuthentication('example.com', 'https://myapp.xyz')).rejects.toThrow(
-        'No route found for saml sso',
-      );
-    });
 
-    it('should return an error `message` if the response is NOT ok', async () => {
-      const initiateIdpAuthentication = jest.fn(() =>
-        Promise.resolve({
-          ok: false,
-          json: () => Promise.resolve({ message: 'an error message', reason: 'an error reason' }),
-        }));
-
-      (getApiClient as any).mockImplementation(() => ({
-        auth: {
-          initiateIdpAuthentication,
-        },
-      }));
-
-      await expect(Auth.initiateIdpAuthentication('example.com', 'https://myapp.xyz')).rejects.toThrow(
-        'an error message',
-      );
-    });
-
-    it('should return an error `reason` if there is no `message` and the response is NOT ok', async () => {
-      const initiateIdpAuthentication = jest.fn(() =>
-        Promise.resolve({
-          ok: false,
-          json: () => Promise.resolve({ reason: 'an error reason' }),
-        }));
+    it('should return a `NoSamlRouteError` if the response is a 404', async () => {
+      const initiateIdpAuthentication = jest.fn(() => { throw BadResponse.fromText('an error message', 404); });
 
       (getApiClient as any).mockImplementation(() => ({
         auth: {
@@ -191,48 +149,12 @@ describe('simple/Auth', () => {
       }));
 
       await expect(Auth.initiateIdpAuthentication('example.com', 'https://myapp.xyz')).rejects.toThrow(
-        'an error reason',
+        'No route found for SAML SSO',
       );
     });
 
-    it('should return an error with a null message if there is no `message` and `reason`', async () => {
-      const initiateIdpAuthentication = jest.fn(() =>
-        Promise.resolve({
-          ok: false,
-          json: () => Promise.resolve({}),
-        }));
-
-      (getApiClient as any).mockImplementation(() => ({
-        auth: {
-          initiateIdpAuthentication,
-        },
-      }));
-
-      await expect(Auth.initiateIdpAuthentication('example.com', 'https://myapp.xyz')).rejects.toThrow('');
-    });
-
-    it('should return a NoSAMLRouteError if the response is a 404', async () => {
-      const initiateIdpAuthentication = jest.fn(() =>
-        Promise.resolve({
-          ok: false,
-          status: 404,
-        }));
-
-      (getApiClient as any).mockImplementation(() => ({
-        auth: {
-          initiateIdpAuthentication,
-        },
-      }));
-
-      await expect(Auth.initiateIdpAuthentication('example.com', 'https://myapp.xyz')).rejects.toThrow('No route found for saml sso');
-    });
-
-    it('should return a SamlConfigError if the response is a 500', async () => {
-      const initiateIdpAuthentication = jest.fn(() =>
-        Promise.resolve({
-          ok: false,
-          status: 500,
-        }));
+    it('should return a `SamlConfigError` if the response is a 500', async () => {
+      const initiateIdpAuthentication = jest.fn(() => { throw ServerError.fromText('an error message', 500); });
 
       (getApiClient as any).mockImplementation(() => ({
         auth: {

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/__tests__/api-requester.test.ts

@@ -158,3 +158,23 @@ describe('With a refresh token', () => {
     });
   });
 });
+
+describe('base64Encode', () => {
+  it('should encode a string using base64', () => {
+    const input = 'Hello World!';
+    const expectedOutput = 'SGVsbG8gV29ybGQh';
+    expect(ApiRequester.base64Encode(input)).toBe(expectedOutput);
+  });
+
+  it('should handle special characters', () => {
+    const input = 'éà$@€';
+    const expectedOutput = 'w6nDoCRA4oKs';
+    expect(ApiRequester.base64Encode(input)).toBe(expectedOutput);
+  });
+
+  it('should handle empty string', () => {
+    const input = '';
+    const expectedOutput = '';
+    expect(ApiRequester.base64Encode(input)).toBe(expectedOutput);
+  });
+});

package/src/utils/api-requester.ts

@@ -64,7 +64,15 @@ export default class ApiRequester {
   }
 
   static base64Encode(str: string): string {
-    return typeof btoa !== 'undefined' ? btoa(str) : Base64.encode(str);
+    if (typeof btoa !== 'undefined') {
+      try {
+        return btoa(str);
+      } catch (error) {
+        // fall back to Base64.encode if btoa fails
+      }
+    }
+
+    return Base64.encode(str);
   }
 
   // @see https://github.com/facebook/flow/issues/183#issuecomment-358607052

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());
 };
@@ -329,7 +351,7 @@ export const getMediaConfiguration = (enableVideo: boolean, conference = false,
   return {
     constraints: {
       // Exact constraint are not supported with `getDisplayMedia` and we must have a video=false in desktop screenshare
-      audio: screenSharing ? !isDesktop : constraints?.audio,
+      audio: screenSharing ? !isDesktop : withAudio ? getAudioConstraints(true) : false,
       video: screenSharing ? isDesktop ? {
         mandatory: {
           chromeMediaSource: 'desktop',