@webex/plugin-meetings 3.0.0-beta.3 → 3.0.0-beta.300

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

@@ -1,4 +1,6 @@
+/* eslint-disable default-param-last */
 
+import {isEqual} from 'lodash';
 import {
   _IDLE_,
   _JOINED_,
@@ -11,11 +13,11 @@ import {
   MEDIA_STATE,
   AUDIO,
   VIDEO,
-  MediaContent
+  MediaContent,
 } from '../constants';
 import ParameterError from '../common/errors/parameter';
 
-const SelfUtils = {};
+const SelfUtils: any = {};
 const PSTN_DEVICE_TYPE = 'PROVISIONAL';
 
 /**
@@ -24,15 +26,17 @@ const PSTN_DEVICE_TYPE = 'PROVISIONAL';
  * @param {String} deviceId
  * @returns {undefined}
  */
-SelfUtils.parse = (self, deviceId) => {
+SelfUtils.parse = (self: any, deviceId: string) => {
   if (self) {
     const joinedWith = self.devices.find((device) => deviceId === device.url);
     const pstnDevices = self.devices.filter((device) => PSTN_DEVICE_TYPE === device.deviceType);
 
     return {
+      remoteVideoMuted: SelfUtils.getRemoteVideoMuted(self),
       remoteMuted: SelfUtils.getRemoteMuted(self),
       unmuteAllowed: SelfUtils.getUnmuteAllowed(self),
       localAudioUnmuteRequested: SelfUtils.getLocalAudioUnmuteRequested(self),
+      localAudioUnmuteRequestedTimeStamp: SelfUtils.getLocalAudioUnmuteRequestedTimeStamp(self),
       localAudioUnmuteRequired: SelfUtils.getLocalAudioUnmuteRequired(self),
       lastModified: SelfUtils.getLastModified(self),
       modifiedBy: SelfUtils.getModifiedBy(self),
@@ -48,9 +52,7 @@ SelfUtils.parse = (self, deviceId) => {
       joinedWith,
       pstnDevices,
       // current media stats is for the current device who has joined
-      currentMediaStatus: SelfUtils.getMediaStatus(
-        joinedWith?.mediaSessions
-      ),
+      currentMediaStatus: SelfUtils.getMediaStatus(joinedWith?.mediaSessions),
       creator: self.isCreator, // check if its used,
       selfId: self.id,
       selfIdentity: SelfUtils.getSelfIdentity(self),
@@ -60,22 +62,31 @@ SelfUtils.parse = (self, deviceId) => {
       isUserUnadmitted: self.state === _IDLE_ && joinedWith?.intent?.type === _WAIT_,
       layout: SelfUtils.getLayout(self),
       canNotViewTheParticipantList: SelfUtils.canNotViewTheParticipantList(self),
-      isSharingBlocked: SelfUtils.isSharingBlocked(self)
+      isSharingBlocked: SelfUtils.isSharingBlocked(self),
+      breakoutSessions: SelfUtils.getBreakoutSessions(self),
+      breakout: SelfUtils.getBreakout(self),
+      interpretation: SelfUtils.getInterpretation(self),
     };
   }
 
   return null;
 };
 
-SelfUtils.getLayout = (self) => (Array.isArray(self?.controls?.layouts) ? self.controls.layouts[0].type : undefined);
+SelfUtils.getBreakoutSessions = (self) => self?.controls?.breakout?.sessions;
+SelfUtils.getBreakout = (self) => self?.controls?.breakout;
+SelfUtils.getInterpretation = (self) => self?.controls?.interpretation;
 
-SelfUtils.getRoles = (self) => (self?.controls?.role?.roles || []).reduce((roles, role) => {
-  if (role.hasRole) {
-    roles.push(role.type);
-  }
+SelfUtils.getLayout = (self) =>
+  Array.isArray(self?.controls?.layouts) ? self.controls.layouts[0].type : undefined;
+
+SelfUtils.getRoles = (self) =>
+  (self?.controls?.role?.roles || []).reduce((roles, role) => {
+    if (role.hasRole) {
+      roles.push(role.type);
+    }
 
-  return roles;
-}, []);
+    return roles;
+  }, []);
 
 SelfUtils.canNotViewTheParticipantList = (self) => !!self?.canNotViewTheParticipantList;
 
@@ -84,30 +95,44 @@ SelfUtils.isSharingBlocked = (self) => !!self?.isSharingBlocked;
 SelfUtils.getSelves = (oldSelf, newSelf, deviceId) => {
   const previous = oldSelf && SelfUtils.parse(oldSelf, deviceId);
   const current = newSelf && SelfUtils.parse(newSelf, deviceId);
-  const updates = {};
+  const updates: any = {};
 
   updates.isUserUnadmitted = SelfUtils.isUserUnadmitted(current);
   updates.isUserAdmitted = SelfUtils.isUserAdmitted(previous, current);
+  updates.isVideoMutedByOthersChanged = SelfUtils.videoMutedByOthersChanged(previous, current);
   updates.isMutedByOthersChanged = SelfUtils.mutedByOthersChanged(previous, current);
-  updates.localAudioUnmuteRequestedByServer = SelfUtils.localAudioUnmuteRequestedByServer(previous, current);
-  updates.localAudioUnmuteRequiredByServer = SelfUtils.localAudioUnmuteRequiredByServer(previous, current);
+  updates.localAudioUnmuteRequestedByServer = SelfUtils.localAudioUnmuteRequestedByServer(
+    previous,
+    current
+  );
+  updates.localAudioUnmuteRequiredByServer = SelfUtils.localAudioUnmuteRequiredByServer(
+    previous,
+    current
+  );
   updates.moderatorChanged = SelfUtils.moderatorChanged(previous, current);
+  updates.isRolesChanged = SelfUtils.isRolesChanged(previous, current);
   updates.isMediaInactiveOrReleased = SelfUtils.wasMediaInactiveOrReleased(previous, current);
   updates.isUserObserving = SelfUtils.isDeviceObserving(previous, current);
   updates.layoutChanged = SelfUtils.layoutChanged(previous, current);
 
   updates.isMediaInactive = SelfUtils.isMediaInactive(previous, current);
-  updates.audioStateChange = previous?.currentMediaStatus.audio !== current.currentMediaStatus.audio;
-  updates.videoStateChange = previous?.currentMediaStatus.video !== current.currentMediaStatus.video;
-  updates.shareStateChange = previous?.currentMediaStatus.share !== current.currentMediaStatus.share;
-
-  updates.canNotViewTheParticipantListChanged = previous?.canNotViewTheParticipantList !== current.canNotViewTheParticipantList;
+  updates.audioStateChange =
+    previous?.currentMediaStatus.audio !== current.currentMediaStatus.audio;
+  updates.videoStateChange =
+    previous?.currentMediaStatus.video !== current.currentMediaStatus.video;
+  updates.shareStateChange =
+    previous?.currentMediaStatus.share !== current.currentMediaStatus.share;
+
+  updates.canNotViewTheParticipantListChanged =
+    previous?.canNotViewTheParticipantList !== current.canNotViewTheParticipantList;
   updates.isSharingBlockedChanged = previous?.isSharingBlocked !== current.isSharingBlocked;
+  updates.breakoutsChanged = SelfUtils.breakoutsChanged(previous, current);
+  updates.interpretationChanged = SelfUtils.interpretationChanged(previous, current);
 
   return {
     previous,
     current,
-    updates
+    updates,
   };
 };
 
@@ -115,18 +140,24 @@ SelfUtils.getSelves = (oldSelf, newSelf, deviceId) => {
  * Checks if user has joined the meeting
  * @param {Object} self
  * @returns {boolean} isJoined
-*/
-SelfUtils.isJoined = (self) => self?.state === _JOINED_;
+ */
+SelfUtils.isJoined = (self: any) => self?.state === _JOINED_;
 
 /**
  * Validate if the Meeting Layout Controls Layout has changed.
  *
  * @param {Self} previous - Previous self state
  * @param {Self} current - Current self state [per event]
- * @returns {boolean} - If the MEeting Layout Controls Layout has changed.
+ * @returns {boolean} - If the Meeting Layout Controls Layout has changed.
  */
-SelfUtils.layoutChanged = (previous, current) => current?.layout && previous?.layout !== current?.layout;
+SelfUtils.layoutChanged = (previous: any, current: any) =>
+  current?.layout && previous?.layout !== current?.layout;
 
+SelfUtils.breakoutsChanged = (previous, current) =>
+  !isEqual(previous?.breakoutSessions, current?.breakoutSessions) && !!current?.breakout;
+
+SelfUtils.interpretationChanged = (previous, current) =>
+  !isEqual(previous?.interpretation, current?.interpretation) && !!current?.interpretation;
 
 SelfUtils.isMediaInactive = (previous, current) => {
   if (
@@ -137,15 +168,12 @@ SelfUtils.isMediaInactive = (previous, current) => {
     current.joinedWith &&
     current.joinedWith.mediaSessions
   ) {
-    const previousMediaStatus = SelfUtils.getMediaStatus(
-      previous.joinedWith.mediaSessions
-    );
-    const currentMediaStatus = SelfUtils.getMediaStatus(
-      current.joinedWith.mediaSessions
-    );
+    const previousMediaStatus = SelfUtils.getMediaStatus(previous.joinedWith.mediaSessions);
+    const currentMediaStatus = SelfUtils.getMediaStatus(current.joinedWith.mediaSessions);
 
     if (
-      previousMediaStatus.audio && currentMediaStatus.audio &&
+      previousMediaStatus.audio &&
+      currentMediaStatus.audio &&
       previousMediaStatus.audio.state !== MEDIA_STATE.inactive &&
       currentMediaStatus.audio.state === MEDIA_STATE.inactive &&
       currentMediaStatus.audio.direction !== MEDIA_STATE.inactive
@@ -154,7 +182,8 @@ SelfUtils.isMediaInactive = (previous, current) => {
     }
 
     if (
-      previousMediaStatus.video && currentMediaStatus.video &&
+      previousMediaStatus.video &&
+      currentMediaStatus.video &&
       previousMediaStatus.video.state !== MEDIA_STATE.inactive &&
       currentMediaStatus.video.state === MEDIA_STATE.inactive &&
       currentMediaStatus.video.direction !== MEDIA_STATE.inactive
@@ -163,7 +192,8 @@ SelfUtils.isMediaInactive = (previous, current) => {
     }
 
     if (
-      previousMediaStatus.share && currentMediaStatus.share &&
+      previousMediaStatus.share &&
+      currentMediaStatus.share &&
       previousMediaStatus.share.state !== MEDIA_STATE.inactive &&
       currentMediaStatus.share.state === MEDIA_STATE.inactive &&
       currentMediaStatus.share.direction !== MEDIA_STATE.inactive
@@ -178,7 +208,13 @@ SelfUtils.isMediaInactive = (previous, current) => {
 };
 
 SelfUtils.getLastModified = (self) => {
-  if (!self || !self.controls || !self.controls.audio || !self.controls.audio.meta || !self.controls.audio.meta.lastModified) {
+  if (
+    !self ||
+    !self.controls ||
+    !self.controls.audio ||
+    !self.controls.audio.meta ||
+    !self.controls.audio.meta.lastModified
+  ) {
     return null;
   }
 
@@ -186,7 +222,13 @@ SelfUtils.getLastModified = (self) => {
 };
 
 SelfUtils.getModifiedBy = (self) => {
-  if (!self || !self.controls || !self.controls.audio || !self.controls.audio.meta || !self.controls.audio.meta.modifiedBy) {
+  if (
+    !self ||
+    !self.controls ||
+    !self.controls.audio ||
+    !self.controls.audio.meta ||
+    !self.controls.audio.meta.modifiedBy
+  ) {
     return null;
   }
 
@@ -198,7 +240,7 @@ SelfUtils.getModifiedBy = (self) => {
  * @param {Object} self
  * @returns {String}
  */
-SelfUtils.getSelfIdentity = (self) => {
+SelfUtils.getSelfIdentity = (self: any) => {
   if (!self && !self.person) {
     return null;
   }
@@ -206,12 +248,25 @@ SelfUtils.getSelfIdentity = (self) => {
   return self.person.id;
 };
 
+/**
+ * get the "remote video mute" property from the self object
+ * @param {Object} self
+ * @returns {Boolean}
+ */
+SelfUtils.getRemoteVideoMuted = (self: any) => {
+  if (!self || !self.controls || !self.controls.video) {
+    return null;
+  }
+
+  return self.controls.video.muted;
+};
+
 /**
  * get the "remote mute" property from the self object
  * @param {Object} self
  * @returns {Boolean}
  */
-SelfUtils.getRemoteMuted = (self) => {
+SelfUtils.getRemoteMuted = (self: any) => {
   if (!self || !self.controls || !self.controls.audio) {
     return null;
   }
@@ -221,6 +276,10 @@ SelfUtils.getRemoteMuted = (self) => {
 
 SelfUtils.getLocalAudioUnmuteRequested = (self) => !!self?.controls?.audio?.requestedToUnmute;
 
+// requestedToUnmute timestamp
+SelfUtils.getLocalAudioUnmuteRequestedTimeStamp = (self) =>
+  Date.parse(self?.controls?.audio?.lastModifiedRequestedToUnmute) || 0;
+
 SelfUtils.getUnmuteAllowed = (self) => {
   if (!self || !self.controls || !self.controls.audio) {
     return null;
@@ -229,43 +288,47 @@ SelfUtils.getUnmuteAllowed = (self) => {
   return !self.controls.audio.disallowUnmute;
 };
 
-
 SelfUtils.getLocalAudioUnmuteRequired = (self) => !!self?.controls?.audio?.localAudioUnmuteRequired;
 
 SelfUtils.getStatus = (status) => ({
   audio: status.audioStatus,
   video: status.videoStatus,
-  slides: status.videoSlidesStatus
+  slides: status.videoSlidesStatus,
 });
 
-
 /**
  * @param {Object} oldSelf
  * @param {Object} changedSelf
  * @returns {Boolean}
  */
-SelfUtils.wasMediaInactiveOrReleased = (oldSelf = {}, changedSelf) => oldSelf.joinedWith && oldSelf.joinedWith.state === _JOINED_ && changedSelf.joinedWith.state === _LEFT_ &&
- (changedSelf.joinedWith.reason === MEETING_END_REASON.INACTIVE || changedSelf.joinedWith.reason === MEETING_END_REASON.MEDIA_RELEASED);
-
+SelfUtils.wasMediaInactiveOrReleased = (oldSelf: any = {}, changedSelf: any) =>
+  oldSelf.joinedWith &&
+  oldSelf.joinedWith.state === _JOINED_ &&
+  changedSelf.joinedWith &&
+  changedSelf.joinedWith.state === _LEFT_ &&
+  (changedSelf.joinedWith.reason === MEETING_END_REASON.INACTIVE ||
+    changedSelf.joinedWith.reason === MEETING_END_REASON.MEDIA_RELEASED);
 
 /**
  * @param {Object} check
  * @returns {Boolean}
  */
-SelfUtils.isLocusUserUnadmitted = (check) => check && check.joinedWith?.intent?.type === _WAIT_ && check.state === _IDLE_;
+SelfUtils.isLocusUserUnadmitted = (check: any) =>
+  check && check.joinedWith?.intent?.type === _WAIT_ && check.state === _IDLE_;
 
 /**
  * @param {Object} check
  * @returns {Boolean}
  */
-SelfUtils.isLocusUserAdmitted = (check) => check && check.joinedWith?.intent?.type !== _WAIT_ && check.state === _JOINED_;
+SelfUtils.isLocusUserAdmitted = (check: any) =>
+  check && check.joinedWith?.intent?.type !== _WAIT_ && check.state === _JOINED_;
 
 /**
  * @param {Object} self
  * @returns {Boolean}
  * @throws {Error} when self is undefined
  */
-SelfUtils.isUserUnadmitted = (self) => {
+SelfUtils.isUserUnadmitted = (self: object) => {
   if (!self) {
     throw new ParameterError('self must be defined to determine if self is unadmitted as guest.');
   }
@@ -278,20 +341,39 @@ SelfUtils.moderatorChanged = (oldSelf, changedSelf) => {
     return true;
   }
   if (!changedSelf) {
-    throw new ParameterError('New self must be defined to determine if self transitioned moderator status.');
+    throw new ParameterError(
+      'New self must be defined to determine if self transitioned moderator status.'
+    );
   }
 
   return oldSelf.moderator !== changedSelf.moderator;
 };
 
+/**
+ * determine whether the roles of self is changed or not
+ * @param {Object} oldSelf
+ * @param {Object} changedSelf
+ * @returns {Boolean}
+ */
+SelfUtils.isRolesChanged = (oldSelf, changedSelf) => {
+  if (!changedSelf) {
+    // no new self means no change
+    return false;
+  }
 
+  return !isEqual(oldSelf?.roles, changedSelf?.roles);
+};
 /**
  * @param {Object} oldSelf
  * @param {Object} changedSelf
  * @returns {Boolean}
  * @throws {Error} if changed self was undefined
  */
-SelfUtils.isDeviceObserving = (oldSelf, changedSelf) => oldSelf && oldSelf.joinedWith?.intent?.type === _MOVE_MEDIA_ && changedSelf && changedSelf.joinedWith?.intent?.type === _OBSERVE_;
+SelfUtils.isDeviceObserving = (oldSelf: any, changedSelf: any) =>
+  oldSelf &&
+  oldSelf.joinedWith?.intent?.type === _MOVE_MEDIA_ &&
+  changedSelf &&
+  changedSelf.joinedWith?.intent?.type === _OBSERVE_;
 
 /**
  * @param {Object} oldSelf
@@ -299,24 +381,45 @@ SelfUtils.isDeviceObserving = (oldSelf, changedSelf) => oldSelf && oldSelf.joine
  * @returns {Boolean}
  * @throws {Error} if changed self was undefined
  */
-SelfUtils.isUserAdmitted = (oldSelf, changedSelf) => {
+SelfUtils.isUserAdmitted = (oldSelf: object, changedSelf: object) => {
   if (!oldSelf) {
     // if there was no previous locus, it couldn't have been admitted yet
     return false;
   }
   if (!changedSelf) {
-    throw new ParameterError('New self must be defined to determine if self transitioned to admitted as guest.');
+    throw new ParameterError(
+      'New self must be defined to determine if self transitioned to admitted as guest.'
+    );
   }
 
   return SelfUtils.isLocusUserUnadmitted(oldSelf) && SelfUtils.isLocusUserAdmitted(changedSelf);
 };
 
+SelfUtils.videoMutedByOthersChanged = (oldSelf, changedSelf) => {
+  if (!changedSelf) {
+    throw new ParameterError(
+      'New self must be defined to determine if self was video muted by others.'
+    );
+  }
+
+  if (!oldSelf || oldSelf.remoteVideoMuted === null) {
+    if (changedSelf.remoteVideoMuted) {
+      return true; // this happens when host disables "Allow start video"
+    }
+
+    // we don't want to be sending the 'meeting:self:videoUnmutedByOthers' notification on meeting join
+    return false;
+  }
+
+  return oldSelf.remoteVideoMuted !== changedSelf.remoteVideoMuted;
+};
+
 SelfUtils.mutedByOthersChanged = (oldSelf, changedSelf) => {
   if (!changedSelf) {
     throw new ParameterError('New self must be defined to determine if self was muted by others.');
   }
 
-  if (!oldSelf || (oldSelf.remoteMuted === null)) {
+  if (!oldSelf || oldSelf.remoteMuted === null) {
     if (changedSelf.remoteMuted) {
       return true; // this happens when mute on-entry is enabled
     }
@@ -325,25 +428,38 @@ SelfUtils.mutedByOthersChanged = (oldSelf, changedSelf) => {
     return false;
   }
 
-  return (changedSelf.remoteMuted !== null) &&
-    ((oldSelf.remoteMuted !== changedSelf.remoteMuted) || (changedSelf.remoteMuted && (oldSelf.unmuteAllowed !== changedSelf.unmuteAllowed)));
+  return (
+    changedSelf.remoteMuted !== null &&
+    (oldSelf.remoteMuted !== changedSelf.remoteMuted ||
+      (changedSelf.remoteMuted && oldSelf.unmuteAllowed !== changedSelf.unmuteAllowed))
+  );
 };
 
-SelfUtils.localAudioUnmuteRequestedByServer = (oldSelf = {}, changedSelf) => {
+SelfUtils.localAudioUnmuteRequestedByServer = (oldSelf: any = {}, changedSelf: any) => {
   if (!changedSelf) {
-    throw new ParameterError('New self must be defined to determine if self received request to unmute.');
+    throw new ParameterError(
+      'New self must be defined to determine if self received request to unmute.'
+    );
   }
 
-  return changedSelf.localAudioUnmuteRequested && !oldSelf.localAudioUnmuteRequested;
+  return (
+    changedSelf.localAudioUnmuteRequested &&
+    changedSelf.localAudioUnmuteRequestedTimeStamp > oldSelf.localAudioUnmuteRequestedTimeStamp
+  );
 };
 
-
-SelfUtils.localAudioUnmuteRequiredByServer = (oldSelf = {}, changedSelf) => {
+SelfUtils.localAudioUnmuteRequiredByServer = (oldSelf: any = {}, changedSelf: any) => {
   if (!changedSelf) {
-    throw new ParameterError('New self must be defined to determine if localAudioUnmuteRequired changed.');
+    throw new ParameterError(
+      'New self must be defined to determine if localAudioUnmuteRequired changed.'
+    );
   }
 
-  return !changedSelf.remoteMuted && changedSelf.localAudioUnmuteRequired && (oldSelf.localAudioUnmuteRequired !== changedSelf.localAudioUnmuteRequired);
+  return (
+    !changedSelf.remoteMuted &&
+    changedSelf.localAudioUnmuteRequired &&
+    oldSelf.localAudioUnmuteRequired !== changedSelf.localAudioUnmuteRequired
+  );
 };
 
 /**
@@ -353,7 +469,7 @@ SelfUtils.localAudioUnmuteRequiredByServer = (oldSelf = {}, changedSelf) => {
  * @returns {Object}
  */
 
-SelfUtils.getSipUrl = (partner, type, sipUri) => {
+SelfUtils.getSipUrl = (partner: any, type, sipUri) => {
   // For webex meeting the sipUrl gets updated in info parser
   if (partner && type === _CALL_) {
     return {sipUri: partner.person.sipUrl || partner.person.id};
@@ -366,15 +482,30 @@ SelfUtils.getMediaStatus = (mediaSessions = []) => {
   const mediaStatus = {
     audio: {},
     video: {},
-    share: {}
+    share: {},
   };
 
-  mediaStatus.audio = mediaSessions.find((media) => media.mediaType === AUDIO && media.mediaContent === MediaContent.main);
-  mediaStatus.video = mediaSessions.find((media) => media.mediaType === VIDEO && media.mediaContent === MediaContent.main);
-  mediaStatus.share = mediaSessions.find((media) => media.mediaType === VIDEO && media.mediaContent === MediaContent.slides);
+  mediaStatus.audio = mediaSessions.find(
+    (media) => media.mediaType === AUDIO && media.mediaContent === MediaContent.main
+  );
+  mediaStatus.video = mediaSessions.find(
+    (media) => media.mediaType === VIDEO && media.mediaContent === MediaContent.main
+  );
+  mediaStatus.share = mediaSessions.find(
+    (media) => media.mediaType === VIDEO && media.mediaContent === MediaContent.slides
+  );
 
   return mediaStatus;
 };
 
+SelfUtils.getReplacedBreakoutMoveId = (self: any, deviceId: string) => {
+  if (self && Array.isArray(self.devices)) {
+    const joinedDevice = self.devices.find((device) => deviceId === device.url);
+    if (Array.isArray(joinedDevice?.replaces)) {
+      return joinedDevice.replaces[0]?.breakoutMoveId;
+    }
+  }
 
+  return null;
+};
 export default SelfUtils;