@webex/plugin-meetings 3.0.0-beta.5 → 3.0.0-beta.51

package/src/locus-info/{index.js → index.ts}

@@ -19,14 +19,14 @@ import {
 } from '../constants';
 import Metrics from '../metrics';
 import {eventType} from '../metrics/config';
-import InfoUtils from '../locus-info/infoUtils';
-import FullState from '../locus-info/fullState';
-import SelfUtils from '../locus-info/selfUtils';
-import HostUtils from '../locus-info/hostUtils';
-import ControlsUtils from '../locus-info/controlsUtils';
-import EmbeddedAppsUtils from '../locus-info/embeddedAppsUtils';
-import MediaSharesUtils from '../locus-info/mediaSharesUtils';
-import LocusDeltaParser from '../locus-info/parser';
+import InfoUtils from './infoUtils';
+import FullState from './fullState';
+import SelfUtils from './selfUtils';
+import HostUtils from './hostUtils';
+import ControlsUtils from './controlsUtils';
+import EmbeddedAppsUtils from './embeddedAppsUtils';
+import MediaSharesUtils from './mediaSharesUtils';
+import LocusDeltaParser from './parser';
 
 /**
  * @description LocusInfo extends ChildEmitter to convert locusInfo info a private emitter to parent object
@@ -35,6 +35,42 @@ import LocusDeltaParser from '../locus-info/parser';
  * @class LocusInfo
  */
 export default class LocusInfo extends EventsScope {
+  compareAndUpdateFlags: any;
+  emitChange: any;
+  locusParser: any;
+  meetingId: any;
+  parsedLocus: any;
+  updateMeeting: any;
+  webex: any;
+  aclUrl: any;
+  baseSequence: any;
+  created: any;
+  deltaParticipants: any;
+  identities: any;
+  membership: any;
+  participants: any;
+  participantsUrl: any;
+  replaces: any;
+  scheduledMeeting: any;
+  sequence: any;
+  controls: any;
+  conversationUrl: any;
+  embeddedApps: any;
+  fullState: any;
+  host: any;
+  info: any;
+  mediaShares: any;
+  replace: any;
+  url: any;
+  services: any;
+
+  /**
+   * Constructor
+   * @param {boolean} updateMeeting true if the meeting should be updated
+   * @param {object} webex
+   * @param {string} meetingId
+   * @returns {undefined}
+   */
   constructor(updateMeeting, webex, meetingId) {
     super();
     this.parsedLocus = {
@@ -55,7 +91,7 @@ export default class LocusInfo extends EventsScope {
    * @param {Meeting} meeting
    * @returns {undefined}
    */
-  applyLocusDeltaData(action, locus, meeting) {
+  applyLocusDeltaData(action: string, locus: any, meeting: any) {
     const {DESYNC, USE_CURRENT, USE_INCOMING} = LocusDeltaParser.loci;
 
     switch (action) {
@@ -94,7 +130,7 @@ export default class LocusInfo extends EventsScope {
    * @param {Meeting} meeting
    * @returns {undefined}
    */
-  handleLocusDelta(locus, meeting) {
+  handleLocusDelta(locus: any, meeting: any) {
     // register a function to process delta actions
     if (!this.locusParser.onDeltaAction) {
       // delta action, along with associated loci
@@ -112,7 +148,7 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  init(locus = {}) {
+  init(locus: any = {}) {
     this.created = locus.created || null;
     this.scheduledMeeting = locus.meeting || null;
     this.participantsUrl = locus.participantsUrl || null;
@@ -157,6 +193,7 @@ export default class LocusInfo extends EventsScope {
     this.updateSelf(locus.self, locus.participants);
     this.updateHostInfo(locus.host);
     this.updateMediaShares(locus.mediaShares);
+    this.updateServices(locus.links?.services);
   }
 
   /**
@@ -164,7 +201,7 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  initialSetup(locus) {
+  initialSetup(locus: object) {
     this.onFullLocus(locus);
 
     // Change it to true after it receives it first locus object
@@ -177,7 +214,8 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  parse(meeting, data) {
+  parse(meeting: any, data: any) {
+    // eslint-disable-next-line @typescript-eslint/no-shadow
     const {eventType} = data;
 
     LoggerProxy.logger.info(`Locus-info:index#parse --> received locus data: ${eventType}`);
@@ -217,18 +255,19 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  emitScoped(scope, eventName, args) {
+  emitScoped(scope?: any, eventName?: string, args?: any) {
     return this.emit(scope, eventName, args);
   }
 
   /**
    * updates the locus with full locus object
    * @param {object} locus locus object
-   * @param {sting} eventType particulat locus event
+   * @param {string} eventType particulat locus event
    * @returns {object} null
    * @memberof LocusInfo
    */
-  onFullLocus(locus, eventType) {
+  // eslint-disable-next-line @typescript-eslint/no-shadow
+  onFullLocus(locus: any, eventType?: string) {
     if (!locus) {
       LoggerProxy.logger.error(
         'Locus-info:index#onFullLocus --> object passed as argument was invalid, continuing.'
@@ -252,7 +291,8 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  handleOneOnOneEvent(eventType) {
+  // eslint-disable-next-line @typescript-eslint/no-shadow
+  handleOneOnOneEvent(eventType: string) {
     if (
       this.parsedLocus.fullState.type === _CALL_ ||
       this.parsedLocus.fullState.type === _SIP_BRIDGE_
@@ -295,7 +335,7 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  onDeltaLocus(locus) {
+  onDeltaLocus(locus: any) {
     this.updateLocusInfo(locus);
     this.updateParticipants(locus.participants);
     this.isMeetingActive();
@@ -307,6 +347,13 @@ export default class LocusInfo extends EventsScope {
    * @memberof LocusInfo
    */
   updateLocusInfo(locus) {
+    if (locus.self?.reason === 'MOVED' && locus.self?.state === 'LEFT') {
+      // When moved to a breakout session locus sends a message for the previous locus
+      // indicating that we have been moved. It isn't helpful to continue parsing this
+      // as it gets interpreted as if we have left the call
+      return;
+    }
+
     this.updateControls(locus.controls);
     this.updateConversationUrl(locus.conversationUrl, locus.info);
     this.updateCreated(locus.created);
@@ -324,6 +371,7 @@ export default class LocusInfo extends EventsScope {
     this.updateMemberShip(locus.membership);
     this.updateIdentifiers(locus.identities);
     this.updateEmbeddedApps(locus.embeddedApps);
+    this.updateServices(locus.links?.services);
     this.compareAndUpdate();
     // update which required to compare different objects from locus
   }
@@ -334,7 +382,7 @@ export default class LocusInfo extends EventsScope {
    * @returns {Array}
    * @memberof LocusInfo
    */
-  getLocusPartner(participants, self) {
+  getLocusPartner(participants: Array<any>, self: any) {
     if (!participants || participants.length === 0) {
       return null;
     }
@@ -345,6 +393,7 @@ export default class LocusInfo extends EventsScope {
           self &&
           participant.identity !== self.identity &&
           (participants.length <= 2 || (participant.type === _USER_ && !participant.removed))
+        // @ts-ignore
       ) || this.partner
     );
   }
@@ -359,6 +408,7 @@ export default class LocusInfo extends EventsScope {
       this.parsedLocus.fullState.type === _CALL_ ||
       this.parsedLocus.fullState.type === _SIP_BRIDGE_
     ) {
+      // @ts-ignore
       const partner = this.getLocusPartner(this.participants, this.self);
 
       this.updateMeeting({partner});
@@ -390,8 +440,7 @@ export default class LocusInfo extends EventsScope {
             shouldLeave: false,
           }
         );
-      }
-      else if (
+      } else if (
         partner.state === MEETING_STATE.STATES.LEFT &&
         this.parsedLocus.self &&
         (this.parsedLocus.self.state === MEETING_STATE.STATES.DECLINED ||
@@ -414,8 +463,7 @@ export default class LocusInfo extends EventsScope {
               this.parsedLocus.self.joinedWith && this.parsedLocus.self.joinedWith.state !== _LEFT_,
           }
         );
-      }
-      else if (
+      } else if (
         this.parsedLocus.self &&
         this.parsedLocus.self.state === MEETING_STATE.STATES.LEFT &&
         (partner.state === MEETING_STATE.STATES.LEFT ||
@@ -439,11 +487,11 @@ export default class LocusInfo extends EventsScope {
           }
         );
       }
-    }
-    else if (this.parsedLocus.fullState.type === _MEETING_) {
+    } else if (this.parsedLocus.fullState.type === _MEETING_) {
       if (
         this.fullState &&
         (this.fullState.state === LOCUS.STATE.INACTIVE ||
+          // @ts-ignore
           this.fullState.state === LOCUS.STATE.TERMINATING)
       ) {
         LoggerProxy.logger.warn(
@@ -464,8 +512,7 @@ export default class LocusInfo extends EventsScope {
             shouldLeave: false,
           }
         );
-      }
-      else if (this.fullState && this.fullState.removed) {
+      } else if (this.fullState && this.fullState.removed) {
         // user has been dropped from a meeting
         Metrics.postEvent({
           event: eventType.REMOTE_ENDED,
@@ -499,8 +546,7 @@ export default class LocusInfo extends EventsScope {
           }
         );
       }
-    }
-    else {
+    } else {
       LoggerProxy.logger.warn('Locus-info:index#isMeetingActive --> Meeting Type is unknown.');
     }
   }
@@ -543,8 +589,7 @@ export default class LocusInfo extends EventsScope {
           canAssignHost: true,
         }
       );
-    }
-    else {
+    } else {
       this.emitScoped(
         {
           file: 'locus-info',
@@ -565,13 +610,13 @@ export default class LocusInfo extends EventsScope {
    * @param {Array} [participants] - The participants to update against.
    * @returns {void}
    */
-  updateParticipantDeltas(participants = []) {
+  updateParticipantDeltas(participants: Array<any> = []) {
     // Used to find a participant within a participants collection.
     const findParticipant = (participant, collection) =>
       collection.find((item) => item.person.id === participant.person.id);
 
     // Generates an object that indicates which state properties have changed.
-    const generateDelta = (prevState = {}, newState = {}) => {
+    const generateDelta = (prevState: any = {}, newState: any = {}) => {
       // Setup deltas.
       const deltas = {
         audioStatus: prevState.audioStatus !== newState.audioStatus,
@@ -614,7 +659,7 @@ export default class LocusInfo extends EventsScope {
    * @returns {Array} updatedParticipants
    * @memberof LocusInfo
    */
-  updateParticipants(participants) {
+  updateParticipants(participants: object) {
     this.emitScoped(
       {
         file: 'locus-info',
@@ -636,7 +681,7 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  updateControls(controls) {
+  updateControls(controls: object) {
     if (controls && !isEqual(this.controls, controls)) {
       this.parsedLocus.controls = ControlsUtils.parse(controls);
       const {
@@ -646,6 +691,8 @@ export default class LocusInfo extends EventsScope {
           hasMeetingContainerChanged,
           hasTranscribeChanged,
           hasEntryExitToneChanged,
+          hasBreakoutChanged,
+          hasVideoEnabledChanged,
         },
         current,
       } = ControlsUtils.getControls(this.controls, controls);
@@ -656,13 +703,11 @@ export default class LocusInfo extends EventsScope {
         if (hasRecordingPausedChanged) {
           if (current.record.paused) {
             state = RECORDING_STATE.PAUSED;
-          }
-          else {
+          } else {
             // state will be `IDLE` if the recording is not active, even when there is a `pause` status change.
             state = current.record.recording ? RECORDING_STATE.RESUMED : RECORDING_STATE.IDLE;
           }
-        }
-        else if (hasRecordingChanged) {
+        } else if (hasRecordingChanged) {
           state = current.record.recording ? RECORDING_STATE.RECORDING : RECORDING_STATE.IDLE;
         }
 
@@ -711,9 +756,26 @@ export default class LocusInfo extends EventsScope {
         );
       }
 
+      if (hasBreakoutChanged) {
+        const {breakout} = current;
+
+        this.emitScoped(
+          {
+            file: 'locus-info',
+            function: 'updateControls',
+          },
+          LOCUSINFO.EVENTS.CONTROLS_MEETING_BREAKOUT_UPDATED,
+          {
+            breakout,
+          }
+        );
+      }
+
       if (hasEntryExitToneChanged) {
         const {entryExitTone} = current;
 
+        this.updateMeeting({entryExitTone});
+
         this.emitScoped(
           {
             file: 'locus-info',
@@ -721,11 +783,29 @@ export default class LocusInfo extends EventsScope {
           },
           LOCUSINFO.EVENTS.CONTROLS_ENTRY_EXIT_TONE_UPDATED,
           {
-            entryExitTone
+            entryExitTone,
           }
         );
+      }
 
-        this.updateMeeting({entryExitTone});
+      // videoEnabled is handled differently than other controls,
+      // to fit with audio mute status logic
+      if (hasVideoEnabledChanged) {
+        const {videoEnabled} = current;
+
+        this.updateMeeting({unmuteVideoAllowed: videoEnabled});
+
+        this.emitScoped(
+          {
+            file: 'locus-info',
+            function: 'updateControls',
+          },
+          LOCUSINFO.EVENTS.SELF_REMOTE_VIDEO_MUTE_STATUS_UPDATED,
+          {
+            // muted: not part of locus.controls
+            unmuteAllowed: videoEnabled,
+          }
+        );
       }
 
       this.controls = controls;
@@ -738,12 +818,11 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  updateConversationUrl(conversationUrl, info) {
+  updateConversationUrl(conversationUrl: string, info: any) {
     if (conversationUrl && !isEqual(this.conversationUrl, conversationUrl)) {
       this.conversationUrl = conversationUrl;
       this.updateMeeting({conversationUrl});
-    }
-    else if (
+    } else if (
       info &&
       info.conversationUrl &&
       !isEqual(this.conversationUrl, info.conversationUrl)
@@ -758,18 +837,39 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  updateCreated(created) {
+  updateCreated(created: object) {
     if (created && !isEqual(this.created, created)) {
       this.created = created;
     }
   }
 
+  /**
+   * @param {Object} services
+   * @returns {undefined}
+   * @memberof LocusInfo
+   */
+  updateServices(services: Record<'breakout' | 'record', {url: string}>) {
+    if (services && !isEqual(this.services, services)) {
+      this.services = services;
+      this.emitScoped(
+        {
+          file: 'locus-info',
+          function: 'updateServices',
+        },
+        LOCUSINFO.EVENTS.LINKS_SERVICES,
+        {
+          services,
+        }
+      );
+    }
+  }
+
   /**
    * @param {Object} fullState
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  updateFullState(fullState) {
+  updateFullState(fullState: object) {
     if (fullState && !isEqual(this.fullState, fullState)) {
       const result = FullState.getFullState(this.fullState, fullState);
 
@@ -813,7 +913,7 @@ export default class LocusInfo extends EventsScope {
    * @memberof LocusInfo
    * emits internal event locus_info_update_host
    */
-  updateHostInfo(host) {
+  updateHostInfo(host: object) {
     if (host && !isEqual(this.host, host)) {
       const parsedHosts = HostUtils.getHosts(this.host, host);
 
@@ -834,8 +934,7 @@ export default class LocusInfo extends EventsScope {
         );
       }
       this.host = host;
-    }
-    else {
+    } else {
       this.compareAndUpdateFlags.compareSelfAndHost = false;
     }
   }
@@ -846,7 +945,7 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  updateMeetingInfo(info, self) {
+  updateMeetingInfo(info: object, self?: object) {
     if (info && !isEqual(this.info, info)) {
       const roles = self ? SelfUtils.getRoles(self) : this.parsedLocus.self?.roles || [];
       const isJoined = SelfUtils.isJoined(self || this.parsedLocus.self);
@@ -894,7 +993,7 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  updateEmbeddedApps(embeddedApps) {
+  updateEmbeddedApps(embeddedApps: object) {
     // don't do anything if the arrays of apps haven't changed significantly
     if (EmbeddedAppsUtils.areSimilar(this.embeddedApps, embeddedApps)) {
       return;
@@ -922,11 +1021,13 @@ export default class LocusInfo extends EventsScope {
    * @memberof LocusInfo
    * emits internal event locus_info_update_media_shares
    */
-  updateMediaShares(mediaShares) {
+  updateMediaShares(mediaShares: object) {
     if (mediaShares && !isEqual(this.mediaShares, mediaShares)) {
       const parsedMediaShares = MediaSharesUtils.getMediaShares(this.mediaShares, mediaShares);
 
       this.updateMeeting(parsedMediaShares.current);
+      this.parsedLocus.mediaShares = parsedMediaShares.current;
+      this.mediaShares = mediaShares;
       this.emitScoped(
         {
           file: 'locus-info',
@@ -938,8 +1039,6 @@ export default class LocusInfo extends EventsScope {
           previous: parsedMediaShares.previous,
         }
       );
-      this.parsedLocus.mediaShares = parsedMediaShares.current;
-      this.mediaShares = mediaShares;
     }
   }
 
@@ -948,7 +1047,7 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  updateParticipantsUrl(participantsUrl) {
+  updateParticipantsUrl(participantsUrl: string) {
     if (participantsUrl && !isEqual(this.participantsUrl, participantsUrl)) {
       this.participantsUrl = participantsUrl;
     }
@@ -959,7 +1058,7 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  updateReplace(replace) {
+  updateReplace(replace: object) {
     if (replace && !isEqual(this.replace, replace)) {
       this.replace = replace;
     }
@@ -973,8 +1072,10 @@ export default class LocusInfo extends EventsScope {
    * @memberof LocusInfo
    * emits internal events self_admitted_guest, self_unadmitted_guest, locus_info_update_self
    */
-  updateSelf(self, participants) {
+  updateSelf(self: any, participants: Array<any>) {
+    // @ts-ignore - check where this.self come from
     if (self && !isEqual(this.self, self)) {
+      // @ts-ignore
       const parsedSelves = SelfUtils.getSelves(this.self, self, this.webex.internal.device.url);
 
       this.updateMeeting(parsedSelves.current);
@@ -1000,8 +1101,7 @@ export default class LocusInfo extends EventsScope {
 
       if (parsedSelves.updates.moderatorChanged) {
         this.compareAndUpdateFlags.compareHostAndSelf = true;
-      }
-      else {
+      } else {
         this.compareAndUpdateFlags.compareHostAndSelf = false;
       }
 
@@ -1016,6 +1116,17 @@ export default class LocusInfo extends EventsScope {
         );
       }
 
+      if (parsedSelves.updates.breakoutsChanged) {
+        this.emitScoped(
+          {
+            file: 'locus-info',
+            function: 'updateSelf',
+          },
+          LOCUSINFO.EVENTS.SELF_MEETING_BREAKOUTS_CHANGED,
+          {breakoutSessions: parsedSelves.current.breakoutSessions}
+        );
+      }
+
       if (parsedSelves.updates.isMediaInactiveOrReleased) {
         this.emitScoped(
           {
@@ -1037,6 +1148,19 @@ export default class LocusInfo extends EventsScope {
           self
         );
       }
+      if (parsedSelves.updates.isVideoMutedByOthersChanged) {
+        this.emitScoped(
+          {
+            file: 'locus-info',
+            function: 'updateSelf',
+          },
+          LOCUSINFO.EVENTS.SELF_REMOTE_VIDEO_MUTE_STATUS_UPDATED,
+          {
+            muted: parsedSelves.current.remoteVideoMuted,
+            // unmuteAllowed: not part of .self
+          }
+        );
+      }
       if (parsedSelves.updates.localAudioUnmuteRequiredByServer) {
         this.emitScoped(
           {
@@ -1100,6 +1224,7 @@ export default class LocusInfo extends EventsScope {
             file: 'locus-info',
             function: 'updateSelf',
           },
+          // @ts-ignore
           LOCUSINFO.EVENTS.MEDIA_INACTIVITY,
           SelfUtils.getMediaStatus(self.mediaSessions)
         );
@@ -1168,9 +1293,9 @@ export default class LocusInfo extends EventsScope {
         }
       );
       this.parsedLocus.self = parsedSelves.current;
+      // @ts-ignore
       this.self = self;
-    }
-    else {
+    } else {
       this.compareAndUpdateFlags.compareHostAndSelf = false;
     }
   }
@@ -1181,7 +1306,7 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    * emits internal event locus_info_update_url
    */
-  updateLocusUrl(url) {
+  updateLocusUrl(url: string) {
     if (url && this.url !== url) {
       this.url = url;
       this.updateMeeting({locusUrl: url});
@@ -1201,7 +1326,7 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  updateAclUrl(aclUrl) {
+  updateAclUrl(aclUrl: string) {
     if (aclUrl && !isEqual(this.aclUrl, aclUrl)) {
       this.aclUrl = aclUrl;
     }
@@ -1212,7 +1337,7 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  updateBasequence(baseSequence) {
+  updateBasequence(baseSequence: number) {
     if (baseSequence && !isEqual(this.baseSequence, baseSequence)) {
       this.baseSequence = baseSequence;
     }
@@ -1223,7 +1348,7 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  updateSequence(sequence) {
+  updateSequence(sequence: number) {
     if (sequence && !isEqual(this.sequence, sequence)) {
       this.sequence = sequence;
     }
@@ -1234,7 +1359,7 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  updateMemberShip(membership) {
+  updateMemberShip(membership: object) {
     if (membership && !isEqual(this.membership, membership)) {
       this.membership = membership;
     }
@@ -1245,7 +1370,7 @@ export default class LocusInfo extends EventsScope {
    * @returns {undefined}
    * @memberof LocusInfo
    */
-  updateIdentifiers(identities) {
+  updateIdentifiers(identities: Array<any>) {
     if (identities && !isEqual(this.identities, identities)) {
       this.identities = identities;
     }