@wazo/sdk 0.43.12 → 0.43.14

package/src/domain/Contact.ts

@@ -15,16 +15,16 @@ export interface NewContact {
   firstName: string;
   lastName: string;
   phoneNumber: string;
-  email: string | null | undefined;
-  address: string | null | undefined;
-  entreprise: string | null | undefined;
-  birthday: string | null | undefined;
-  note: string | null | undefined;
+  email?: string;
+  address?: string;
+  entreprise?: string;
+  birthday?: string;
+  note?: string;
   sessions: Array<{
     uuid: string;
     mobile: boolean;
   }> | null | undefined;
-  connected: boolean | null | undefined;
+  connected?: boolean;
 }
 export type ContactResponse = {
   source: string;
@@ -33,7 +33,7 @@ export type ContactResponse = {
   relations: {
     user_id: number;
     xivo_id: string;
-    agent_id: number | null | undefined;
+    agent_id?: number | null;
     endpoint_id: number;
     user_uuid: string;
     source_entry_id: string;
@@ -47,22 +47,22 @@ export type ContactsResponse = {
 };
 export type ContactPersonalResponse = {
   id: string;
-  firstName: string | null | undefined;
-  lastName: string | null | undefined;
-  number: string | null | undefined;
+  firstName?: string;
+  lastName?: string;
+  number?: string;
   numbers: Array<{
     label?: string;
     number: string;
   }> | null | undefined;
-  email: string | null | undefined;
-  entreprise: string | null | undefined;
-  birthday: string | null | undefined;
-  address: string | null | undefined;
-  note: string | null | undefined;
+  email?: string;
+  entreprise?: string;
+  birthday?: string;
+  address?: string;
+  note?: string;
   // @TODO: legacy ?
-  firstname: string | null | undefined;
-  lastname: string | null | undefined;
-  backend: string | null | undefined;
+  firstname?: string;
+  lastname?: string;
+  backend?: string;
   favorited: boolean;
 };
 export type ContactsGraphQlResponse = {
@@ -127,6 +127,8 @@ type ContactArguments = {
   id?: string;
   uuid?: string;
   name?: string;
+  firstName?: string;
+  lastName?: string;
   number?: string;
   numbers?: Array<{
     label?: string;
@@ -146,7 +148,7 @@ type ContactArguments = {
   personal?: boolean;
   state?: string;
   source?: string;
-  sourceId?: string | null | undefined;
+  sourceId?: string;
   lineState?: string;
   previousPresential?: string;
   lastActivity?: string;
@@ -233,6 +235,8 @@ type GoogleResponse = {
   emails: string[];
   id: string;
   name: string;
+  firstname: string;
+  lastname: string;
   numbers: string[];
   numbers_by_label: any;
 };
@@ -243,57 +247,61 @@ export default class Contact {
 
   type: string;
 
-  id: string | null | undefined;
+  id?: string;
+
+  uuid?: string;
 
-  uuid: string | null | undefined;
+  name?: string;
 
-  name: string | null | undefined;
+  firstName?: string;
 
-  number: string | null | undefined;
+  lastName?: string;
+
+  number?: string;
 
   numbers: Array<{
     label?: string;
     number: string;
   }> | null | undefined;
 
-  favorited: boolean | null | undefined;
+  favorited?: boolean;
 
-  email: string | null | undefined;
+  email?: string;
 
   emails: Array<{
     label?: string;
     email: string;
   }> | null | undefined;
 
-  entreprise: string | null | undefined;
+  entreprise?: string;
 
-  birthday: string | null | undefined;
+  birthday?: string;
 
-  address: string | null | undefined;
+  address?: string;
 
-  note: string | null | undefined;
+  note?: string;
 
-  endpointId: number | null | undefined;
+  endpointId?: number;
 
-  personal: boolean | null | undefined;
+  personal?: boolean;
 
-  state: string | null | undefined;
+  state?: string;
 
-  lineState: string | null | undefined;
+  lineState?: string;
 
-  previousPresential: string | null | undefined;
+  previousPresential?: string;
 
-  lastActivity: string | null | undefined;
+  lastActivity?: string;
 
-  mobile: boolean | null | undefined;
+  mobile?: boolean;
 
-  source: string | null | undefined;
+  source?: string;
 
-  sourceId: string | null | undefined;
+  sourceId?: string;
 
-  status: string | null | undefined;
+  status?: string;
 
-  backend: string | null | undefined;
+  backend?: string;
 
   personalStatus: string;
 
@@ -302,11 +310,11 @@ export default class Contact {
     mobile: boolean;
   }> | null | undefined;
 
-  connected: boolean | null | undefined;
+  connected?: boolean;
 
-  doNotDisturb: boolean | null | undefined;
+  doNotDisturb?: boolean;
 
-  ringing: boolean | null | undefined;
+  ringing?: boolean;
 
   lines: Record<string, any>[];
 
@@ -357,6 +365,8 @@ export default class Contact {
         const name = edge.node.firstname && edge.node.lastname ? `${edge.node.firstname || ''} ${edge.node.lastname || ''}` : edge.node.wazoReverse;
         return new Contact({
           name,
+          firstName: edge.node.firstname,
+          lastName: edge.node.lastname,
           number: numbers[i],
           numbers: [{
             label: 'primary',
@@ -389,6 +399,8 @@ export default class Contact {
     const email = plain.column_values[columns.indexOf('email')];
     return new Contact({
       name: plain.column_values[columns.indexOf('name')],
+      firstName: plain.column_values[columns.indexOf('firstname')],
+      lastName: plain.column_values[columns.indexOf('lastname')],
       number: numbers.length ? numbers[0] : '',
       numbers: numbers.map((number, i) => ({
         label: i === 0 ? 'primary' : 'secondary',
@@ -420,6 +432,8 @@ export default class Contact {
   static parsePersonal(plain: ContactPersonalResponse): Contact {
     return new Contact({
       name: `${plain.firstName || plain.firstname || ''} ${plain.lastName || plain.lastname || ''}`,
+      firstName: plain.firstName || plain.firstname,
+      lastName: plain.lastName || plain.lastname,
       number: plain.number || '',
       numbers: plain.number ? [{
         label: 'primary',
@@ -458,6 +472,8 @@ export default class Contact {
 
     return new Contact({
       name,
+      firstName,
+      lastName,
       number: plain.phoneNumbers.length ? plain.phoneNumbers[0].number : '',
       // Make numbers unique
       numbers: [...new Map(plain.phoneNumbers.map(item => [item.number, item])).values()].map((item, idx) => ({
@@ -523,6 +539,8 @@ export default class Contact {
     return new Contact({
       sourceId: single.id || '',
       name: single.displayName || '',
+      firstName: single.givenName,
+      lastName: single.surname,
       number: numbers.length ? numbers[0].number : '',
       numbers,
       emails,
@@ -568,6 +586,8 @@ export default class Contact {
     return new Contact({
       sourceId: single.id || '',
       name: single.name || '',
+      firstName: single.lastname || '',
+      lastName: single.firstname || '',
       number: numbers.length ? numbers[0].number : '',
       numbers,
       emails,
@@ -609,6 +629,8 @@ export default class Contact {
       uuid: single.uuid,
       sourceId: String(single.id) || '',
       name: `${single.firstname}${single.lastname ? ` ${single.lastname}` : ''}`,
+      firstName: single.firstname,
+      lastName: single.lastname,
       number: numbers.length ? numbers[0].number : '',
       numbers,
       emails,
@@ -651,6 +673,8 @@ export default class Contact {
     id,
     uuid,
     name,
+    firstName,
+    lastName,
     number,
     numbers,
     email,
@@ -681,6 +705,8 @@ export default class Contact {
     this.id = id;
     this.uuid = uuid;
     this.name = name || '';
+    this.firstName = firstName || '';
+    this.lastName = lastName || '';
     this.number = number;
     this.numbers = numbers;
     this.email = email;

package/src/domain/Session.ts

@@ -56,8 +56,6 @@ type Authorization = {
 };
 
 type SessionArguments = {
-  acls?: string[];
-  // deprecated
   acl?: string[];
   token: string;
   refreshToken?: string | null | undefined;

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

@@ -1,63 +1,203 @@
 import moment from 'moment';
-import CallLog from '../CallLog';
+import CallLog, { Response, CallLogResponse, CALL_LOG_VALID_REQUESTED_VERSION } from '../CallLog';
 import Recording from '../Recording';
+import Session from '../Session';
+import Profile from '../Profile';
+import Line from '../Line';
 
-describe('CallLog domain', () => {
-  it('can parse a plain call log to domain', () => {
-    const response = {
-      filtered: 6,
-      items: [{
-        answer: moment('2017-08-07T13:51:18.892002+00:00').toDate(),
-        answered: true,
-        call_direction: 'outbound',
-        source_extension: '8020',
-        source_name: 'Jonathan Lessard',
-        source_user_uuid: '123',
-        destination_extension: '4182250459',
-        destination_name: null,
-        destination_user_uuid: '456',
-        duration: 4,
-        start: '2017-08-06T13:50:55.819057+00:00',
-        end: '2017-08-08T13:51:23.822529+00:00',
-        requested_extension: '',
-        requested_name: '',
-        id: 215,
-        recordings: [{
-          deleted: false,
-          end_time: '2021-08-11T13:22:50.519733+00:00',
-          filename: '2021-08-11T13_22_45UTC-61886-xxxx-5c72-4072-8503-e3ad9a41c0a0.wav',
-          start_time: '2021-08-11T13:22:45.161954+00:00',
-          uuid: '0394ad6f-5c72-4072-8503-e3ad9a41c0a0',
+const ALICE_EXTENSION = '41';
+const ALICE_UUID = '11111111-1111-1111-1111-111111111111';
+
+const BOB_EXTENSION = '42';
+const BOB_UUID = '22222222-2222-2222-2222-222222222222';
+
+const CHARLIE_EXTENSION = '43';
+const CHARLIE_UUID = '33333333-3333-3333-3333-333333333333';
+
+// Default scenario: Alice > Bob (No anwser forward) > Charlie
+const CALL_LOG_RESPONSE: CallLogResponse = {
+  id: 1,
+  answer: '2024-01-02T00:00:00.000000+00:00',
+  answered: true,
+  call_direction: 'internal',
+  source_name: 'Alice',
+  source_extension: ALICE_EXTENSION,
+  source_user_uuid: ALICE_UUID,
+  requested_name: 'Bob',
+  requested_extension: BOB_EXTENSION,
+  requested_user_uuid: BOB_UUID,
+  destination_name: 'Charlie',
+  destination_extension: CHARLIE_EXTENSION,
+  destination_user_uuid: CHARLIE_UUID,
+  duration: 4,
+  start: '2024-01-01T00:00:00.000000+00:00',
+  end: '2024-01-01T00:00:04.000000+00:00',
+  recordings: [{
+    uuid: '0394ad6f-5c72-4072-8503-e3ad9a41c0a0',
+    start_time: '2024-01-01T00:00:00.000000+00:00',
+    end_time: '2024-01-01T00:00:04.000000+00:00',
+    filename: '2024-01-01T00_00_04UTC-61886-0394ad6f-5c72-4072-8503-e3ad9a41c0a0.wav',
+    deleted: false,
+  }],
+};
+const CALL_LOG = CallLog.parse(CALL_LOG_RESPONSE);
+
+const generateBobSession = (opts?: Partial<Session>): Session =>
+  new Session({
+    acl: [],
+    token: 'ref-12345',
+    uuid: BOB_UUID,
+    expiresAt: new Date(9999, 0, 1),
+    engineVersion: CALL_LOG_VALID_REQUESTED_VERSION,
+    profile: new Profile({
+      lines: [new Line({
+        id: 1,
+        extensions: [{
+          id: 1,
+          exten: BOB_EXTENSION,
+          context: 'internal',
         }],
-      }],
-      total: 233,
-    };
-    const logs = CallLog.parseMany(response as any);
-    expect(logs).toEqual([new CallLog({
-      answer: moment('2017-08-07T13:51:18.892002+00:00').toDate(),
-      answered: true,
-      callDirection: 'outbound',
-      destination: {
-        extension: '4182250459',
-        name: '',
-        uuid: '456',
-      },
-      source: {
-        extension: '8020',
-        name: 'Jonathan Lessard',
-        uuid: '123',
-      },
-      id: 215,
-      duration: 4000,
-      start: moment('2017-08-06T13:50:55.819057+00:00').toDate(),
-      end: moment('2017-08-08T13:51:23.822529+00:00').toDate(),
-      recordings: [new Recording({
-        deleted: false,
-        end: moment('2021-08-11T13:22:50.519733+00:00').toDate(),
-        fileName: '2021-08-11T13_22_45UTC-61886-xxxx-5c72-4072-8503-e3ad9a41c0a0.wav',
-        start: moment('2021-08-11T13:22:45.161954+00:00').toDate(),
-        uuid: '0394ad6f-5c72-4072-8503-e3ad9a41c0a0',
       })],
-    })]);
+    } as any),
+    ...(opts || {}),
+  });
+
+const BOB_SESSION = generateBobSession();
+
+describe('CallLog Domain', () => {
+  describe('parseMany', () => {
+    it('can parse a plain call log to domain', () => {
+      const response: Response = {
+        filtered: 6,
+        items: [CALL_LOG_RESPONSE],
+        total: 233,
+      };
+
+      const logs = CallLog.parseMany(response);
+      expect(logs).toEqual([new CallLog({
+        id: 1,
+        answer: moment(CALL_LOG_RESPONSE.answer).toDate(),
+        answered: true,
+        callDirection: 'internal',
+        source: {
+          uuid: ALICE_UUID,
+          name: 'Alice',
+          extension: ALICE_EXTENSION,
+        },
+        requested: {
+          uuid: BOB_UUID,
+          name: 'Bob',
+          extension: BOB_EXTENSION,
+        },
+        destination: {
+          uuid: CHARLIE_UUID,
+          name: 'Bob',
+          extension: BOB_EXTENSION,
+          plainExtension: CHARLIE_EXTENSION,
+          plainName: 'Charlie',
+        },
+        duration: 4000,
+        start: moment(CALL_LOG_RESPONSE.start).toDate(),
+        end: moment(CALL_LOG_RESPONSE.end).toDate(),
+        recordings: [new Recording({
+          uuid: CALL_LOG_RESPONSE.recordings[0].uuid,
+          start: moment(CALL_LOG_RESPONSE.recordings[0].start_time).toDate(),
+          end: moment(CALL_LOG_RESPONSE.recordings[0].end_time).toDate(),
+          fileName: CALL_LOG_RESPONSE.recordings[0].filename,
+          deleted: false,
+        })],
+      })]);
+    });
+  });
+
+  describe('isIconming', () => {
+    it('should be TRUE', () => {
+      // When requested is set to the same user session extension
+      expect(CALL_LOG.isIncomingAndForwarded(BOB_SESSION)).toBe(true);
+
+      // When destination is set to the same user session extension
+      const destinationCallLog = CallLog.parse({
+        ...CALL_LOG_RESPONSE,
+        destination_extension: CALL_LOG_RESPONSE.requested_extension,
+        destination_name: CALL_LOG_RESPONSE.requested_name,
+        destination_user_uuid: CALL_LOG_RESPONSE.requested_user_uuid,
+        requested_extension: CALL_LOG_RESPONSE.destination_extension,
+        requested_name: CALL_LOG_RESPONSE.destination_name,
+        requested_user_uuid: CALL_LOG_RESPONSE.destination_user_uuid,
+      });
+      expect(destinationCallLog.isIncomingAndForwarded(BOB_SESSION)).toBe(true);
+
+      // When destination is set to the same user with a changed extension
+      const destinationExtensionChangedCallLog = CallLog.parse({
+        ...CALL_LOG_RESPONSE,
+        destination_extension: `${CALL_LOG_RESPONSE.requested_extension}9`,
+        destination_name: CALL_LOG_RESPONSE.requested_name,
+        destination_user_uuid: CALL_LOG_RESPONSE.requested_user_uuid,
+        requested_extension: `${CALL_LOG_RESPONSE.destination_extension}9`,
+        requested_name: CALL_LOG_RESPONSE.destination_name,
+        requested_user_uuid: CALL_LOG_RESPONSE.destination_user_uuid,
+      });
+      expect(destinationExtensionChangedCallLog.isIncomingAndForwarded(BOB_SESSION)).toBe(true);
+
+      // When call direction is inbound
+      const inboundCallLog = CallLog.parse({ ...CALL_LOG_RESPONSE, call_direction: 'inbound' });
+      expect(inboundCallLog.isIncomingAndForwarded(BOB_SESSION)).toBe(true);
+
+    });
+
+    it('should be FALSE', () => {
+      // When call direction is outbound
+      const outboundCallLog = CallLog.parse({ ...CALL_LOG_RESPONSE, call_direction: 'outbound' });
+      expect(outboundCallLog.isIncomingAndForwarded(BOB_SESSION)).toBe(false);
+    });
+  });
+
+  describe('isIncomingAndForwarded', () => {
+    it('should be TRUE when requested is current user extension and destination is another extesnion', () => {
+      // Internal call (requested contact)
+      expect(CALL_LOG.isIncomingAndForwarded(BOB_SESSION)).toBe(true);
+
+      // Inbound call (requested contact)
+      const inboundCallLog = CallLog.parse({
+        ...CALL_LOG_RESPONSE,
+        call_direction: 'inbound',
+        source_extension: '18004444444',
+        source_name: '',
+        source_user_uuid: null,
+      });
+      expect(inboundCallLog.isIncomingAndForwarded(BOB_SESSION)).toBe(true);
+
+      // Current user is the final destination
+      const destinationCallLog = CallLog.parse({
+        ...CALL_LOG_RESPONSE,
+        destination_extension: CALL_LOG_RESPONSE.requested_extension,
+        destination_name: CALL_LOG_RESPONSE.requested_name,
+        destination_user_uuid: CALL_LOG_RESPONSE.requested_user_uuid,
+        requested_extension: CALL_LOG_RESPONSE.destination_extension,
+        requested_name: CALL_LOG_RESPONSE.destination_name,
+        requested_user_uuid: CALL_LOG_RESPONSE.destination_user_uuid,
+      });
+      expect(destinationCallLog.isIncomingAndForwarded(BOB_SESSION)).toBe(true);
+    });
+
+    it('should be FALSE', () => {
+      // Requested and destination are same
+      const directCallLog = CallLog.parse({
+        ...CALL_LOG_RESPONSE,
+        requested_extension: CALL_LOG_RESPONSE.destination_extension,
+        requested_name: CALL_LOG_RESPONSE.destination_name,
+        requested_user_uuid: CALL_LOG_RESPONSE.destination_user_uuid,
+      });
+
+      expect(directCallLog.isIncomingAndForwarded(BOB_SESSION)).toBe(false);
+
+      // Not incoming call
+      const outboundCallLog = CallLog.parse({ ...CALL_LOG_RESPONSE, call_direction: 'outbound' });
+      expect(outboundCallLog.isIncomingAndForwarded(BOB_SESSION)).toBe(false);
+
+      // Stack version
+      const oldStackSession = generateBobSession({ engineVersion: CALL_LOG_VALID_REQUESTED_VERSION.replace('14', '10') });
+      expect(CALL_LOG.isIncomingAndForwarded(oldStackSession)).toBe(false);
+    });
   });
 });

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

@@ -3,6 +3,8 @@ import Contact from '../Contact';
 const genericContactResponse = {
   column_types: [
     'name',
+    'firstname',
+    'lastname',
     'number',
     'callable',
     'voicemail',
@@ -13,6 +15,8 @@ const genericContactResponse = {
   term: 'a',
   column_headers: [
     'Nom',
+    'Pr\u00e9nom',
+    'Nom de famille',
     'Num\u00e9ro',
     'Mobile',
     'Bo\u00eete vocale',
@@ -27,6 +31,8 @@ const contact1 = {
   source: 'internal',
   column_values: [
     'Jonathan Lessard',
+    'Jonathan',
+    'Lessard',
     '8020',
     '06800880',
     null,
@@ -49,6 +55,8 @@ const contact2 = {
   source: 'internal',
   column_values: [
     'John Doe',
+    'John',
+    'Doe',
     '8021',
     '06800881',
     null,
@@ -69,6 +77,8 @@ const contact2 = {
 
 const parsedContact1 = new Contact({
   name: 'Jonathan Lessard',
+  firstName: 'Jonathan',
+  lastName: 'Lessard',
   number: '8020',
   numbers: [
     {
@@ -102,6 +112,8 @@ const parsedContact1 = new Contact({
 
 const parsedContact2 = new Contact({
   name: 'John Doe',
+  firstName: 'John',
+  lastName: 'Doe',
   number: '8021',
   numbers: [
     {