@wazo/sdk 0.43.0-rc.1 → 0.43.1

package/src/domain/Incall.ts

@@ -0,0 +1,50 @@
+import newFrom from '../utils/new-from';
+import { ExtensionRelation } from './types';
+
+// Generic based on incall and user's incall payload
+export type GenericIncall = {
+  id: number;
+  extensions: ExtensionRelation[];
+  [key: string]: any;
+};
+
+export type IncallArguments = {
+  id?: number;
+  extensions?: ExtensionRelation[];
+};
+
+export default class Incall {
+  id: number | undefined;
+
+  extensions: ExtensionRelation[] | undefined;
+
+  extension: string | undefined;
+
+  // Useful to compare instead of instanceof with minified code
+  readonly type: string = 'Incall';
+
+  constructor({ id, extensions }: IncallArguments = {}) {
+    this.id = id;
+    this.extensions = extensions;
+    this.extension = extensions?.[0]?.exten;
+  }
+
+  static parse(plain: GenericIncall): Incall {
+    return new Incall({
+      id: plain.id,
+      extensions: plain.extensions,
+    });
+  }
+
+  static newFrom(profile: Incall) {
+    return newFrom(profile, Incall);
+  }
+
+  hasExtension(extension: string) {
+    if (!this.extensions) {
+      return false;
+    }
+
+    return this.extensions.some(ext => ext.exten === extension);
+  }
+}

package/src/domain/Line.ts

@@ -1,20 +1,9 @@
 import newFrom from '../utils/new-from';
+import type { ExtensionRelation, Link } from './types';
 
-type Extension = {
-  context: string;
-  exten: string;
-  id: number;
-  links?: Array<{
-    href: string;
-    rel: string;
-  }>;
-};
 export type Endpoint = {
   id: number;
-  links: Array<{
-    href: string;
-    rel: string;
-  }>;
+  links: Link[];
   username?: string;
 };
 
@@ -22,13 +11,13 @@ export type LineResponse = {
   endpoint_custom: Endpoint | null | undefined;
   endpoint_sccp: Endpoint | null | undefined;
   endpoint_sip: Endpoint | null | undefined;
-  extensions: Array<Extension>;
+  extensions: ExtensionRelation[];
   id: number;
 };
 
 type LineArguments = {
   id?: number;
-  extensions?: Array<Extension>;
+  extensions?: ExtensionRelation[];
   endpointCustom?: Endpoint | null;
   endpointSccp?: Endpoint | null;
   endpointSip?: Endpoint | null;
@@ -38,7 +27,7 @@ export default class Line {
 
   id: number | undefined;
 
-  extensions: Array<Extension> | undefined;
+  extensions: ExtensionRelation[] | undefined;
 
   endpointCustom: Endpoint | null;
 
@@ -87,5 +76,4 @@ export default class Line {
     // Useful to compare instead of instanceof with minified code
     this.type = 'Line';
   }
-
 }

package/src/domain/Phone/Phone.ts

@@ -31,7 +31,7 @@ export type AvailablePhoneOptions = {
 };
 export interface Phone extends IEmitter {
   accept(callSession: CallSession, enableVideo?: boolean): Promise<string | null>;
-  changeAudioDevice(id: string): PhoneVoid;
+  changeAudioDevice(id: string): Promise<void>;
   changeRingDevice(id: string): PhoneVoid;
   changeAudioVolume(volume: number): PhoneVoid;
   changeRingVolume(volume: number): PhoneVoid;

package/src/domain/Profile.ts

@@ -2,6 +2,7 @@ import Line, { LineResponse } from './Line';
 import ForwardOption, { FORWARD_KEYS } from './ForwardOption';
 import newFrom from '../utils/new-from';
 import SipLine from './SipLine';
+import Incall, { GenericIncall } from './Incall';
 
 export const STATE = {
   AVAILABLE: 'available',
@@ -74,6 +75,7 @@ type ProfileResponse = {
     uuid: string;
   }>;
   online_call_record_enabled: boolean | null | undefined;
+  incalls: GenericIncall[];
 };
 
 type ProfileArguments = {
@@ -108,6 +110,7 @@ type ProfileArguments = {
     uuid: string;
   }>;
   onlineCallRecordEnabled?: boolean | null | undefined;
+  incalls?: GenericIncall[];
 };
 export default class Profile {
   id: string;
@@ -122,6 +125,8 @@ export default class Profile {
 
   sipLines: Array<SipLine>;
 
+  incalls: Array<Incall>;
+
   username: string;
 
   mobileNumber: string;
@@ -167,6 +172,7 @@ export default class Profile {
       lastName: plain.lastName || plain.lastname || '',
       email: plain.email,
       lines: plain.lines.map(line => Line.parse(line)),
+      incalls: plain.incalls,
       username: plain.username,
       mobileNumber: plain.mobile_phone_number || '',
       ringSeconds: plain.ring_seconds,
@@ -206,6 +212,7 @@ export default class Profile {
     sipLines,
     callPickupTargetUsers,
     onlineCallRecordEnabled,
+    incalls,
   }: ProfileArguments) {
     this.id = id;
     this.firstName = firstName;
@@ -226,6 +233,7 @@ export default class Profile {
     this.onlineCallRecordEnabled = onlineCallRecordEnabled;
     this.ringSeconds = ringSeconds;
     this.sipLines = sipLines || [];
+    this.incalls = incalls?.map(Incall.parse) || [];
   }
 
   static getLinesState(lines: Array<Record<string, any>>) {

package/src/domain/__tests__/Profile.test.ts

@@ -54,6 +54,21 @@ describe('Profile domain', () => {
         }],
         endpoint_custom: null,
       }],
+      incalls: [{
+        id: 1,
+        extensions: [{
+          id: 3,
+          exten: '8001112222',
+          context: 'incall',
+        }],
+      }, {
+        id: 2,
+        extensions: [{
+          id: 4,
+          exten: '8001113333',
+          context: 'incall',
+        }],
+      }],
       username: 'john.doe',
       services: {
         dnd: {
@@ -121,6 +136,21 @@ describe('Profile domain', () => {
           context: 'internal',
         }],
       })],
+      incalls: [{
+        id: 1,
+        extensions: [{
+          id: 3,
+          exten: '8001112222',
+          context: 'incall',
+        }],
+      }, {
+        id: 2,
+        extensions: [{
+          id: 4,
+          exten: '8001113333',
+          context: 'incall',
+        }],
+      }],
       mobileNumber: '',
       username: 'john.doe',
       doNotDisturb: false,
@@ -134,5 +164,7 @@ describe('Profile domain', () => {
       }],
       onlineCallRecordEnabled: true,
     }));
+    expect(profile.incalls[0].extension).toBe(plain.incalls[0].extensions[0].exten);
+    expect(profile.incalls[1].extension).toBe(plain.incalls[1].extensions[0].exten);
   });
 });

package/src/domain/types.ts

@@ -1,4 +1,9 @@
-import type { Invitation, Inviter, Session as SipSession, UserAgentOptions as sipJsUserAgentOptions } from 'sip.js';
+import type {
+  Invitation,
+  Inviter,
+  Session as SipSession,
+  UserAgentOptions as sipJsUserAgentOptions,
+} from 'sip.js';
 import { SessionDescriptionHandlerFactoryOptions } from 'sip.js/lib/platform/web';
 import type { IncomingResponse as SipIncomingResponse } from 'sip.js/lib/core/messages/incoming-response';
 import { Transport } from 'sip.js/lib/api';
@@ -6,10 +11,7 @@ import WazoSessionDescriptionHandler from '../lib/WazoSessionDescriptionHandler'
 import { Websocket } from '../simple/Websocket';
 import * as WebSocketClient from '../websocket-client';
 
-const {
-  SOCKET_EVENTS,
-  ...OTHER_EVENTS
-} = WebSocketClient;
+const { SOCKET_EVENTS, ...OTHER_EVENTS } = WebSocketClient;
 
 type GenericObject = Record<string, any>;
 
@@ -79,6 +81,12 @@ export type Link = {
   href: string;
   rel: string;
 };
+export type ExtensionRelation = {
+  id: number;
+  exten: string;
+  context: string;
+  links?: Link[];
+};
 type LocalLine = {
   id: number;
   endpoint_sip: {
@@ -88,12 +96,7 @@ type LocalLine = {
   };
   endpoint_sccp: string | null | undefined;
   endpoint_custom: string | null | undefined;
-  extensions: Array<{
-    id: number;
-    exten: string;
-    context: string;
-    links: Array<Link>;
-  }>;
+  extensions: ExtensionRelation[];
 };
 export type ConfdUser = {
   id: number;
@@ -169,7 +172,6 @@ export type ConfdUser = {
   // @TODO
   voicemail: string | null | undefined;
   queues: Array<Record<string, any>>; // @TODO
-
 };
 export type ListConfdUsersResponse = {
   total: number;
@@ -193,7 +195,6 @@ export type ListApplicationsResponse = {
 export type Node = {
   uuid: UUID;
   calls: Array<Record<string, any>>; // @TODO
-
 };
 export type CallNode = GenericObject;
 export type ListNodesResponse = {
@@ -206,21 +207,26 @@ export type ListCallNodesResponse = {
 export type GetTenantResponse = GenericObject;
 export type GetUserResponse = GenericObject;
 export type CTITransfer = {
-  'flow': string;
-  'id': string;
-  'initiator_call': string;
-  'initiator_uuid': string;
-  'recipient_call': string;
-  'status': string;
-  'transferred_call': string;
+  flow: string;
+  id: string;
+  initiator_call: string;
+  initiator_uuid: string;
+  recipient_call: string;
+  status: string;
+  transferred_call: string;
 };
 export type UserAgentOptions = sipJsUserAgentOptions & {
-  peerConnectionOptions?: Record<string, any>,
-  sessionDescriptionHandlerFactory: (session: SipSession, options: SessionDescriptionHandlerFactoryOptions) => WazoSessionDescriptionHandler,
+  peerConnectionOptions?: Record<string, any>;
+  sessionDescriptionHandlerFactory: (
+    session: SipSession,
+    options: SessionDescriptionHandlerFactoryOptions
+  ) => WazoSessionDescriptionHandler;
 };
-export type UserAgentConfigOverrides = Partial<UserAgentOptions & {
-  traceSip: any,
-}>;
+export type UserAgentConfigOverrides = Partial<
+UserAgentOptions & {
+  traceSip: any;
+}
+>;
 export type MediaConfig = {
   audio: Record<string, any> | boolean;
   video?: Record<string, any> | boolean;
@@ -252,21 +258,24 @@ export type WebRtcConfig = {
 export type IncomingResponse = SipIncomingResponse & { session: any };
 
 export type PeerConnection = RTCPeerConnection & {
-  getRemoteStreams: () => MediaStream[],
-  getLocalStreams: () => MediaStream[],
-  onremovestream: (func: any) => void,
-  addStream: (stream: MediaStream) => void,
-  sfu: any
+  getRemoteStreams: () => MediaStream[];
+  getLocalStreams: () => MediaStream[];
+  onremovestream: (func: any) => void;
+  addStream: (stream: MediaStream) => void;
+  sfu: any;
 };
 
-export type WazoSession = (Invitation | Inviter) & { remoteTag?: any, callId?: string };
+export type WazoSession = (Invitation | Inviter) & {
+  remoteTag?: any;
+  callId?: string;
+};
 
 export type WazoTransport = Transport & {
-  configuration: Record<string, any>,
-  connectPromise: Promise<any>,
-  disconnectPromise: Promise<any>,
-  disconnectResolve: any,
-  transitionState: any,
+  configuration: Record<string, any>;
+  connectPromise: Promise<any>;
+  disconnectPromise: Promise<any>;
+  disconnectResolve: any;
+  transitionState: any;
   transitioningState: any;
   _ws: any;
 };
@@ -299,7 +308,7 @@ export type PresenceResponse = {
   state: string;
   status: string;
   user_uuid: string;
-  last_activity?: string,
+  last_activity?: string;
 };
 
 export type QueryParams = {
@@ -317,4 +326,6 @@ export type UuidSearchableQueryParams = SearchableQueryParams & {
   uuid?: string;
 };
 
-export type WebsocketType = Websocket & typeof SOCKET_EVENTS & typeof OTHER_EVENTS;
+export type WebsocketType = Websocket &
+  typeof SOCKET_EVENTS &
+  typeof OTHER_EVENTS;

package/src/index.ts

@@ -14,6 +14,7 @@ export { default as Contact } from './domain/Contact';
 export { default as COUNTRIES } from './domain/Country';
 export { default as Features } from './domain/Features';
 export { default as ForwardOption, FORWARD_KEYS } from './domain/ForwardOption';
+export { default as Incall } from './domain/Incall';
 export { default as Line } from './domain/Line';
 export { default as NotificationOptions } from './domain/NotificationOptions';
 export { default as Profile, STATE as PROFILE_STATE, LINE_STATE } from './domain/Profile';
@@ -52,6 +53,7 @@ export { default as ExternalApp } from './domain/ExternalApp';
 export { default as SessionDescriptionHandler } from './lib/WazoSessionDescriptionHandler';
 export * from './types/WebSocketMessage';
 export * from './utils/PhoneNumberUtil';
+export * from './utils/string';
 export * from './domain/types';
 
 export default Wazo;

package/src/simple/Auth.ts

@@ -160,6 +160,11 @@ export class Auth {
     return this._onAuthenticated(rawSession as Session);
   }
 
+  async samlLogIn(samlSessionId: string): Promise<Session | null> {
+    const rawSession = await getApiClient().auth.samlLogIn(samlSessionId);
+    return this._onAuthenticated(rawSession as Session);
+  }
+
   async logInViaRefreshToken(refreshToken: string): Promise<Session | null> {
     const rawSession = await getApiClient().auth.refreshToken(refreshToken, '', this.expiration, this.mobile);
     return this._onAuthenticated(rawSession as Session);