@wazo/sdk 0.43.14 → 0.44.0

package/src/domain/Session.ts

@@ -1,297 +0,0 @@
-/* eslint-disable no-nested-ternary */
-import { KEYUTIL, KJUR, b64utoutf8 } from 'jsrsasign';
-import moment from 'moment';
-import swarmPublicKey from '../pubkey';
-import Profile from './Profile';
-import Contact from './Contact';
-import Line from './Line';
-import SipLine from './SipLine';
-import type { UUID, Token } from './types';
-import newFrom from '../utils/new-from';
-import compareVersions from '../utils/compare-version';
-
-const { jws } = KJUR;
-
-const swarmKey = <unknown>(KEYUTIL.getKey(swarmPublicKey)) as string;
-const MINIMUM_WAZO_ENGINE_VERSION_FOR_DEFAULT_CONTEXT = '19.08';
-
-export type Response = {
-  _headers: Headers,
-  data: {
-    token: Token;
-    refresh_token?: Token;
-    session_uuid: UUID;
-    acls?: Array<string>;
-    // deprecated
-    acl?: Array<string>;
-    utc_expires_at: string;
-    xivo_uuid: string;
-    issued_at: string;
-    auth_id: string;
-    expires_at: string;
-    xivo_user_uuid: string | null | undefined;
-    metadata: {
-      jwt?: string;
-      username?: string;
-      uuid: UUID;
-      tenant_uuid?: UUID;
-      xivo_user_uuid?: UUID;
-      groups?: Array<string>;
-      xivo_uuid?: UUID;
-      tenants?: Array<{
-        uuid: UUID;
-      }>;
-      auth_id?: UUID;
-    } | null | undefined;
-  };
-};
-
-type Authorization = {
-  uuid: string;
-  rules: Array<{
-    name: string;
-    options: Record<string, any>;
-  }>;
-  service: string | null | undefined;
-};
-
-type SessionArguments = {
-  acl?: string[];
-  token: string;
-  refreshToken?: string | null | undefined;
-  sessionUuid?: string | null | undefined;
-  uuid?: string | null | undefined;
-  tenantUuid?: string | null | undefined;
-  profile?: Profile | null | undefined;
-  expiresAt: Date;
-  authorizations?: Array<Authorization>;
-  engineVersion?: string | null | undefined;
-  // Deprecated, use `stackUuid`
-  engineUuid?: string | null | undefined;
-  stackUuid?: string | null | undefined;
-  stackHostFromHeader?: string | null | undefined;
-};
-
-export default class Session {
-  acl: string[];
-
-  contact?: Contact;
-
-  token: string;
-
-  refreshToken: string | null | undefined;
-
-  uuid: string | null | undefined;
-
-  tenantUuid: string | null | undefined;
-
-  stackUuid: string | null | undefined;
-
-  sessionUuid: string | null | undefined;
-
-  engineVersion: string | null | undefined;
-
-  _stackHostFromHeader: string | undefined | null;
-
-  profile: Profile | null | undefined;
-
-  expiresAt: Date;
-
-  authorizations: Array<Authorization>;
-
-  static parse(plain: Response): Session | null | undefined {
-    const token = plain.data.metadata ? plain.data.metadata.jwt : null;
-    let authorizations = [];
-
-    // Add authorizations from JWT
-    if (token) {
-      const isValid = jws.JWS.verifyJWT(token, swarmKey, {
-        alg: ['RS256'],
-        // @ts-ignore: date / number
-        verifyAt: new Date(),
-      });
-
-      if (isValid) {
-        const decodedToken: any = jws.JWS.readSafeJSONString(b64utoutf8(token.split('.')[1]));
-        authorizations = decodedToken ? decodedToken.authorizations : [];
-      }
-    }
-
-    return new Session({
-      token: plain.data.token,
-      refreshToken: plain.data.refresh_token || null,
-      uuid: plain.data.metadata ? plain.data.metadata.uuid : null,
-      sessionUuid: plain.data.session_uuid,
-      authorizations,
-      acl: plain.data.acls ? plain.data.acls : plain.data.acl ? plain.data.acl : [],
-      tenantUuid: plain.data.metadata ? plain.data.metadata.tenant_uuid : undefined,
-      expiresAt: moment.utc(plain.data.utc_expires_at).toDate(),
-      stackUuid: plain.data.xivo_uuid,
-      // eslint-disable-next-line
-      stackHostFromHeader: plain._headers?.get?.('wazo-stack-host'),
-    });
-  }
-
-  static newFrom(profile: Session) {
-    return newFrom(profile, Session);
-  }
-
-  constructor({
-    token,
-    uuid,
-    tenantUuid,
-    profile,
-    expiresAt,
-    authorizations,
-    acl,
-    engineVersion,
-    refreshToken,
-    sessionUuid,
-    stackUuid,
-    stackHostFromHeader = undefined,
-  }: SessionArguments) {
-    this.token = token;
-    this.uuid = uuid;
-    this.tenantUuid = tenantUuid || null;
-    this.profile = profile;
-    this.expiresAt = expiresAt;
-    this.authorizations = authorizations || [];
-    this.acl = acl || [];
-    this.engineVersion = engineVersion;
-    this.refreshToken = refreshToken;
-    this.sessionUuid = sessionUuid;
-    this.stackUuid = stackUuid;
-    this._stackHostFromHeader = stackHostFromHeader;
-  }
-
-  hasExpired(date: Date = new Date()): boolean {
-    return date >= this.expiresAt;
-  }
-
-  is(contact: Contact): boolean {
-    return Boolean(contact) && this.uuid === contact.uuid;
-  }
-
-  using(profile: Profile): Session {
-    this.profile = profile;
-    return this;
-  }
-
-  hasAuthorizations() {
-    return this.authorizations && !!this.authorizations.length;
-  }
-
-  displayName(): string {
-    return this.profile ? `${this.profile.firstName} ${this.profile.lastName}` : '';
-  }
-
-  hasAccessToVoicemail(): boolean {
-    if (!this.profile) {
-      return false;
-    }
-
-    return !!this.profile.voicemail;
-  }
-
-  primaryLine(): Line | null | undefined {
-    return this.profile && this.profile.lines.length > 0 ? this.profile.lines[0] : null;
-  }
-
-  primarySipLine(): SipLine | null | undefined {
-    return this.profile && this.profile.sipLines.length > 0 ? this.profile.sipLines[0] : null;
-  }
-
-  primaryWebRtcLine(): SipLine | null | undefined {
-    return this.profile && (this.profile.sipLines || []).find(sipLine => sipLine && sipLine.isWebRtc());
-  }
-
-  primaryCtiLine(): SipLine | null | undefined {
-    return this.profile && (this.profile.sipLines || []).find(sipLine => sipLine && !sipLine.isWebRtc());
-  }
-
-  getContact(): Contact {
-    if (this.contact) {
-      return this.contact;
-    }
-
-    const { email, firstName, lastName, mobileNumber, state, status } = this.profile || {};
-    const number = this.primaryNumber() || '';
-    const numbers = [{ label: 'primary', number }];
-
-    if (mobileNumber) {
-      numbers.push({ label: 'mobile', number: mobileNumber });
-    }
-
-    return new Contact({
-      uuid: this.uuid || '',
-      email,
-      name: `${firstName} ${lastName}`,
-      number,
-      numbers,
-      state: state || '',
-      status,
-      backend: 'wazo',
-      source: 'default',
-    });
-  }
-
-  primaryContext(): string {
-    if (this.engineVersion) {
-      if (this.hasEngineVersionGte(MINIMUM_WAZO_ENGINE_VERSION_FOR_DEFAULT_CONTEXT)) {
-        return 'default';
-      }
-    }
-
-    const line = this.primaryLine();
-    return line && Array.isArray(line.extensions) && line.extensions.length > 0 ? line.extensions[0].context : 'default';
-  }
-
-  hasEngineVersionGte(version: string): boolean {
-    return !!this.engineVersion && compareVersions(String(this.engineVersion), String(version)) >= 0;
-  }
-
-  primaryNumber(): string | null | undefined {
-    const line = this.primaryLine();
-    return line && Array.isArray(line.extensions) && line.extensions.length ? line.extensions[0].exten : null;
-  }
-
-  allLines(): Line[] {
-    return this.profile ? this.profile.lines || [] : [];
-  }
-
-  allNumbers(): string[] {
-    const extensions = this.allLines().map(line => line.extensions?.map(extension => extension.exten) || []);
-
-    if (!extensions.length) {
-      return [];
-    }
-
-    return extensions.reduce((a, b) => a.concat(b));
-  }
-
-  hasExtension(extension: string): boolean {
-    return this.allNumbers().some(number => number === extension);
-  }
-
-  getHostFromHeader() {
-    return this._stackHostFromHeader;
-  }
-
-  get acls(): Array<string> | null | undefined {
-    console.warn('`acls` property of Session has been removed in Wazo\'s SDK, please use `acl` instead.');
-    return this.acl;
-  }
-
-  get engineUuid(): string | null | undefined {
-    console.warn('`engineUuid` property of Session has been removed in Wazo\'s SDK, please use `stackUuid` instead.');
-    return this.stackUuid;
-  }
-
-  toJSON() {
-    return {
-      ...this,
-      // Added `engineUuid` because of the getter, it won't be included in `JSON.stringify()` methods.
-      engineUuid: this.engineUuid,
-    };
-  }
-}

package/src/domain/SipLine.ts

@@ -1,154 +0,0 @@
-import newFrom from '../utils/new-from';
-import type { Endpoint } from './Line';
-
-const availableCodecs = ['vp8', 'vp9', 'h264'];
-type SipLineResponse = {
-  id: string;
-  uuid: string;
-  tenant_uuid: string;
-  username: string;
-  secret: string;
-  type: string;
-  host: string;
-  options: string[][] | null | undefined;
-  auth_section_options: string[][] | null | undefined;
-  endpoint_section_options: string[][] | null | undefined;
-  links: Array<Record<string, any>>;
-  trunk: string | null | undefined;
-  line: Endpoint;
-};
-type SipLineArguments = {
-  id: string;
-  uuid: string;
-  tenantUuid: string;
-  username: string;
-  secret: string;
-  type: string;
-  host: string;
-  options: string[][] | null | undefined;
-  endpointSectionOptions: string[][] | null | undefined;
-  links: Array<Record<string, any>>;
-  trunk: string | null | undefined;
-  line: Endpoint;
-};
-export default class SipLine {
-  id: string;
-
-  uuid: string;
-
-  tenantUuid: string;
-
-  username: string;
-
-  secret: string;
-
-  type: string;
-
-  host: string;
-
-  options: string[][] | null | undefined;
-
-  endpointSectionOptions: string[][] | null | undefined;
-
-  links: Array<Record<string, any>>;
-
-  trunk: string | null | undefined;
-
-  line: Endpoint;
-
-  static parse(plain: SipLineResponse): SipLine {
-    let {
-      username,
-      secret,
-      host,
-    } = plain;
-
-    // Since 20.13 engine so options are now in section
-    if (plain.auth_section_options) {
-      const findOption = (options: string[][], name: string) => options.find(option => option[0] === name);
-
-      const usernameOption = findOption(plain.auth_section_options, 'username');
-      const secretOption = findOption(plain.auth_section_options, 'password');
-      const hostOption = findOption(plain.endpoint_section_options as string[][], 'media_address');
-      username = usernameOption ? usernameOption[1] : '';
-      secret = secretOption ? secretOption[1] : '';
-      host = hostOption ? hostOption[1] : '';
-    }
-
-    return new SipLine({
-      id: plain.id,
-      uuid: plain.uuid,
-      tenantUuid: plain.tenant_uuid,
-      username,
-      secret,
-      type: plain.type,
-      host,
-      options: plain.options,
-      endpointSectionOptions: plain.endpoint_section_options,
-      links: plain.links,
-      trunk: plain.trunk,
-      line: plain.line,
-    });
-  }
-
-  static newFrom(sipLine: SipLine) {
-    return newFrom(sipLine, SipLine);
-  }
-
-  is(line: SipLine) {
-    if (line.uuid) {
-      return this.uuid === line.uuid;
-    }
-
-    return this.id === line.id;
-  }
-
-  getOptions(): Array<Record<string, any>> {
-    // `options` params have beend remove since 20.13... we should now use endpointSectionOptions
-    return this.endpointSectionOptions || this.options || [];
-  }
-
-  isWebRtc() {
-    return this.getOptions().some(option => option[0] === 'webrtc' && option[1] === 'yes');
-  }
-
-  hasVideo() {
-    const allow = this.getOptions().find(option => option[0] === 'allow');
-    return Array.isArray(allow) && allow[1].split(',').some((codec: string) => availableCodecs.some(c => c === codec));
-  }
-
-  hasVideoConference() {
-    return this.getOptions().some(option => option[0] === 'max_audio_streams' && parseInt(option[1], 10) > 0) && this.getOptions().some(option => option[0] === 'max_video_streams' && parseInt(option[1], 10) > 1);
-  }
-
-  constructor({
-    id,
-    uuid,
-    tenantUuid,
-    username,
-    secret,
-    type,
-    host,
-    options,
-    endpointSectionOptions,
-    links,
-    trunk,
-    line,
-  }: SipLineArguments) {
-    this.id = id;
-    this.uuid = uuid;
-    this.tenantUuid = tenantUuid;
-    this.username = username;
-    this.secret = secret;
-    this.type = type;
-    this.host = host;
-    this.options = options;
-    this.endpointSectionOptions = endpointSectionOptions;
-    this.links = links;
-    this.trunk = trunk;
-    this.line = line;
-    // Useful to compare instead of instanceof with minified code
-    this.type = 'SipLine';
-  }
-
-}

package/src/domain/Subscription.ts

@@ -1,95 +0,0 @@
-type SubscriptionResponse = {
-  config: Record<string, any>;
-  events: string[];
-  events_user_uuid: string;
-  events_wazo_uuid: string;
-  metadata: Record<string, any>;
-  name: string;
-  owner_tenant_uuid: string;
-  owner_user_uuid: string;
-  service: string;
-  uuid: string;
-};
-
-type SubscriptionArguments = {
-  name: string;
-  events: string[];
-  config: Record<string, any>;
-  uuid: string;
-  service: string;
-  eventsUserUuid: string;
-  eventsWazoUuid: string;
-  metadata: Record<string, any>;
-  ownerTenantUuid: string;
-  ownerUserUuid: string;
-};
-
-class Subscription {
-  name: string;
-
-  events: string[];
-
-  config: Record<string, any>;
-
-  uuid: string;
-
-  service: string;
-
-  eventsUserUuid: string;
-
-  eventsWazoUuid: string;
-
-  metadata: Record<string, any>;
-
-  ownerTenantUuid: string;
-
-  ownerUserUuid: string;
-
-  static parse(plain: SubscriptionResponse): Subscription {
-    return new Subscription({
-      name: plain.name,
-      events: plain.events,
-      config: plain.config,
-      uuid: plain.uuid,
-      service: plain.service,
-      eventsUserUuid: plain.events_user_uuid,
-      eventsWazoUuid: plain.events_wazo_uuid,
-      metadata: plain.metadata,
-      ownerTenantUuid: plain.owner_tenant_uuid,
-      ownerUserUuid: plain.owner_user_uuid,
-    });
-  }
-
-  static parseMany(response: {
-    items: [];
-  }): Subscription[] {
-    return response.items.map(payload => Subscription.parse(payload));
-  }
-
-  constructor({
-    name,
-    events,
-    config,
-    uuid,
-    service,
-    eventsUserUuid,
-    eventsWazoUuid,
-    metadata,
-    ownerTenantUuid,
-    ownerUserUuid,
-  }: SubscriptionArguments) {
-    this.name = name;
-    this.events = events;
-    this.config = config;
-    this.uuid = uuid;
-    this.service = service;
-    this.eventsUserUuid = eventsUserUuid;
-    this.eventsWazoUuid = eventsWazoUuid;
-    this.metadata = metadata;
-    this.ownerTenantUuid = ownerTenantUuid;
-    this.ownerUserUuid = ownerUserUuid;
-  }
-
-}
-
-export default Subscription;

package/src/domain/SwitchboardCall.ts

@@ -1,127 +0,0 @@
-import CallSession from './CallSession';
-import newFrom from '../utils/new-from';
-import updateFrom from '../utils/update-from';
-
-export type SwitchboardCallItem = {
-  caller_id_name: string;
-  caller_id_number: string;
-  id: string;
-};
-export type SwitchboardCallItems = {
-  items: Array<SwitchboardCallItem>;
-  switchboard_uuid: string;
-};
-export type SwitchboardAnwseredQueuedCall = {
-  operator_call_id: string;
-  queued_call_id: string;
-  switchboard_uuid: string;
-};
-export type SwitchboardAnwseredHeldCall = {
-  held_call_id: string;
-  operator_call_id: string;
-  switchboard_uuid: string;
-};
-type SwitchboardCallArguments = {
-  id: string;
-  callSession: CallSession | null | undefined;
-  callerIdName: string | null | undefined;
-  callerIdNumber: string | null | undefined;
-  answerTime: Date | null | undefined;
-  participantId: string | null | undefined;
-  state: string;
-  switchboardName: string;
-  switchboardUuid: string;
-};
-export type SwitchboardCallResponse = {
-  callSession: CallSession | null | undefined;
-  caller_id_name: string | null | undefined;
-  caller_id_number: string | null | undefined;
-  id: string;
-  participantId: string | null | undefined;
-  startTime: Date | null | undefined;
-  state: string;
-  switchboardName: string;
-  switchboardUuid: string;
-};
-
-class SwitchboardCall {
-  static STATE: Record<string, any>;
-
-  id: string;
-
-  callSession: CallSession | null | undefined;
-
-  callerIdName: string | null | undefined;
-
-  callerIdNumber: string | null | undefined;
-
-  answerTime: Date | null | undefined;
-
-  participantId: string | null | undefined;
-
-  state: string;
-
-  switchboardName: string;
-
-  switchboardUuid: string;
-
-  type: string;
-
-  static parse(plain: SwitchboardCallResponse): SwitchboardCall {
-    return new SwitchboardCall({
-      id: plain.id,
-      callSession: plain.callSession || null,
-      callerIdName: plain.caller_id_name || null,
-      callerIdNumber: plain.caller_id_number || null,
-      participantId: plain.participantId || null,
-      answerTime: plain.startTime,
-      state: plain.state,
-      switchboardName: plain.switchboardName,
-      switchboardUuid: plain.switchboardUuid,
-    });
-  }
-
-  constructor({
-    id,
-    callSession,
-    callerIdName,
-    callerIdNumber,
-    participantId,
-    answerTime,
-    state,
-    switchboardName,
-    switchboardUuid,
-  }: SwitchboardCallArguments) {
-    this.id = id;
-    this.callSession = callSession;
-    this.callerIdName = callerIdName;
-    this.callerIdNumber = callerIdNumber;
-    this.participantId = participantId;
-    this.answerTime = answerTime;
-    this.state = state;
-    this.switchboardName = switchboardName;
-    this.switchboardUuid = switchboardUuid;
-    // Useful to compare instead of instanceof with minified code
-    this.type = 'SwitchboardCall';
-  }
-
-  updateFrom(switchboardCall: SwitchboardCall) {
-    updateFrom(this, switchboardCall);
-  }
-
-  getId() {
-    return this.id;
-  }
-
-  static newFrom(switchboardCall: SwitchboardCall) {
-    return newFrom(switchboardCall, SwitchboardCall);
-  }
-
-}
-
-SwitchboardCall.STATE = {
-  INCOMING: 'incoming',
-  ONGOING: 'ongoing',
-  HELD: 'held',
-};
-export default SwitchboardCall;