@webex/plugin-meetings 3.0.0-beta.4 → 3.0.0-beta.400

package/src/locus-info/controlsUtils.ts

@@ -0,0 +1,222 @@
+import {isEqual} from 'lodash';
+import {BREAKOUTS} from '../constants';
+
+const ControlsUtils: any = {};
+
+/**
+ * Controls
+ * @typedef {Object} LocusControls
+ * @property {Object} record
+ * @property {Boolean} record.recording
+ * @property {Object} record.meta
+ * @property {String} record.meta.modifiedBy
+ */
+
+/**
+ * parse the relevant host values that we care about: id
+ * @param {LocusControls} controls
+ * @returns {Object} parsedObject - parsed host or null if host was undefined
+ * @returns {String} parsedObject.recordingId
+ */
+ControlsUtils.parse = (controls: any) => {
+  const parsedControls = {...controls};
+
+  if (controls && controls.record) {
+    parsedControls.record = {
+      modifiedBy: ControlsUtils.getId(controls),
+      paused: controls.record.paused ? controls.record.paused : false,
+      recording: controls.record.recording,
+      lastModified: controls.record.meta.lastModified,
+    };
+  }
+
+  if (controls && controls.meetingContainer) {
+    parsedControls.meetingContainer = {
+      meetingContainerUrl: controls.meetingContainer.meetingContainerUrl,
+    };
+  }
+
+  if (controls && controls.transcribe) {
+    parsedControls.transcribe = {
+      transcribing: controls.transcribe.transcribing,
+      caption: controls.transcribe.caption,
+    };
+  }
+
+  if (controls && controls.entryExitTone) {
+    parsedControls.entryExitTone = controls.entryExitTone.enabled
+      ? controls.entryExitTone.mode
+      : null;
+  }
+
+  if (controls && controls.video) {
+    parsedControls.videoEnabled = controls.video.enabled;
+  }
+
+  if (controls?.muteOnEntry) {
+    parsedControls.muteOnEntry = {enabled: controls.muteOnEntry.enabled};
+  }
+
+  if (controls?.shareControl) {
+    parsedControls.shareControl = {control: controls.shareControl.control};
+  }
+
+  if (controls?.disallowUnmute) {
+    parsedControls.disallowUnmute = {enabled: controls.disallowUnmute.enabled};
+  }
+
+  if (controls?.reactions) {
+    parsedControls.reactions = {
+      enabled: controls.reactions.enabled,
+      showDisplayNameWithReactions: controls.reactions.showDisplayNameWithReactions,
+    };
+  }
+
+  if (controls?.viewTheParticipantList) {
+    parsedControls.viewTheParticipantList = {enabled: controls.viewTheParticipantList.enabled};
+  }
+
+  if (controls?.raiseHand) {
+    parsedControls.raiseHand = {enabled: controls.raiseHand.enabled};
+  }
+
+  if (controls?.video) {
+    parsedControls.video = {enabled: controls.video.enabled};
+  }
+
+  return parsedControls;
+};
+
+/**
+ * parses and returns previous state vs current state and triggers the changes.
+ * @param {LocusControls} oldControls previous state
+ * @param {LocusControls} newControls current state
+ * @returns {Object} combination of state plus the changes
+ */
+ControlsUtils.getControls = (oldControls: any, newControls: any) => {
+  const previous = ControlsUtils.parse(oldControls);
+  const current = ControlsUtils.parse(newControls);
+
+  return {
+    previous,
+    current,
+    updates: {
+      hasMuteOnEntryChanged: current?.muteOnEntry?.enabled !== previous?.muteOnEntry?.enabled,
+
+      hasShareControlChanged: current?.shareControl?.control !== previous?.shareControl?.control,
+
+      hasDisallowUnmuteChanged:
+        current?.disallowUnmute?.enabled !== previous?.disallowUnmute?.enabled,
+
+      hasReactionsChanged: current?.reactions?.enabled !== previous?.reactions?.enabled,
+
+      hasReactionDisplayNamesChanged:
+        current?.reactions?.showDisplayNameWithReactions !==
+        previous?.reactions?.showDisplayNameWithReactions,
+
+      hasViewTheParticipantListChanged:
+        current?.viewTheParticipantList?.enabled !== previous?.viewTheParticipantList?.enabled,
+
+      hasRaiseHandChanged: current?.raiseHand?.enabled !== previous?.raiseHand?.enabled,
+
+      hasVideoChanged: current?.video?.enabled !== previous?.video?.enabled,
+
+      hasRecordingPausedChanged:
+        current?.record &&
+        !isEqual(previous?.record?.paused, current.record.paused) &&
+        (previous?.record?.recording || current?.record?.recording), // see comments directly below
+
+      hasRecordingChanged:
+        current?.record &&
+        !isEqual(previous?.record?.recording, current?.record?.recording) && // upon first join, previous?.record?.recording = undefined; thus, never going to be equal and will always return true
+        (previous?.record?.recording || current?.record?.recording), // therefore, condition added to prevent false firings of #meeting:recording:stopped upon first joining a meeting
+
+      hasMeetingContainerChanged:
+        current?.meetingContainer &&
+        !isEqual(
+          previous?.meetingContainer?.meetingContainerUrl,
+          current?.meetingContainer?.meetingContainerUrl
+        ),
+
+      hasTranscribeChanged:
+        current?.transcribe &&
+        !isEqual(previous?.transcribe?.transcribing, current?.transcribe?.transcribing) && // upon first join, previous?.record?.recording = undefined; thus, never going to be equal and will always return true
+        (previous?.transcribe?.transcribing || current?.transcribe?.transcribing), // therefore, condition added to prevent false firings of #meeting:recording:stopped upon first joining a meeting
+
+      hasEntryExitToneChanged: !!(
+        newControls.entryExitTone &&
+        !isEqual(previous?.entryExitTone, current?.entryExitTone) &&
+        (previous?.entryExitTone || current?.entryExitTone)
+      ),
+
+      hasBreakoutChanged: !isEqual(previous?.breakout, current?.breakout),
+
+      hasInterpretationChanged: !isEqual(previous?.interpretation, current?.interpretation),
+
+      hasVideoEnabledChanged:
+        newControls.video?.enabled !== undefined &&
+        !isEqual(previous?.videoEnabled, current?.videoEnabled),
+    },
+  };
+};
+
+/**
+ * Extract the id from the record controls object
+ * @param {LocusControls} controls
+ * @returns {String|null}
+ */
+ControlsUtils.getId = (controls: any) => {
+  if (controls.record.meta) {
+    return controls.record.meta.modifiedBy;
+  }
+
+  return null;
+};
+
+/**
+ * check whether to replace the meeting's members or not.
+ * For case joined breakout session, need replace meeting's members
+ * @param {LocusControls} oldControls
+ * @param {LocusControls} controls
+ * @returns {Boolean}
+ */
+ControlsUtils.isNeedReplaceMembers = (oldControls: any, controls: any) => {
+  // no breakout case
+  if (!oldControls?.breakout || !controls?.breakout) {
+    return false;
+  }
+
+  return (
+    oldControls.breakout.groupId !== controls.breakout.groupId ||
+    oldControls.breakout.sessionId !== controls.breakout.sessionId
+  );
+};
+
+/**
+ * determine the switch status between breakout session and main session.
+ * @param {LocusControls} oldControls
+ * @param {LocusControls} controls
+ * @returns {Object}
+ */
+ControlsUtils.getSessionSwitchStatus = (oldControls: any, controls: any) => {
+  const status = {isReturnToMain: false, isJoinToBreakout: false};
+  // no breakout case
+  if (!oldControls?.breakout || !controls?.breakout) {
+    return status;
+  }
+
+  status.isReturnToMain =
+    oldControls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.BREAKOUT &&
+    controls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.MAIN;
+  status.isJoinToBreakout =
+    oldControls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.MAIN &&
+    controls.breakout.sessionType === BREAKOUTS.SESSION_TYPES.BREAKOUT;
+
+  return status;
+};
+
+ControlsUtils.isMainSessionDTO = (locus: any) => {
+  return locus?.controls?.breakout?.sessionType !== BREAKOUTS.SESSION_TYPES.BREAKOUT;
+};
+
+export default ControlsUtils;

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

@@ -1,7 +1,6 @@
 import {EMBEDDED_APP_TYPES} from '../constants';
 
-const EmbeddedAppsUtils = {};
-
+const EmbeddedAppsUtils: any = {};
 const SLIDO_REGEX = /.sli.do\//;
 
 /**
@@ -9,8 +8,8 @@ const SLIDO_REGEX = /.sli.do\//;
  * @param {Object} embeddedApp - raw embedded app object
  * @returns {Object} parsedObject - parsed embedded app object
  */
-EmbeddedAppsUtils.parseApp = (embeddedApp) => {
-  const parsedApp = {...embeddedApp};
+EmbeddedAppsUtils.parseApp = (embeddedApp: object) => {
+  const parsedApp: any = {...embeddedApp};
 
   parsedApp.type = EMBEDDED_APP_TYPES.OTHER;
   const url = parsedApp.instanceInfo?.appInstanceUrl;
@@ -29,7 +28,7 @@ EmbeddedAppsUtils.parseApp = (embeddedApp) => {
  * @param {any[]} apps2 - an array of apps
  * @returns {boolean} true if the arrays are different
  */
-EmbeddedAppsUtils.areSimilar = (apps1, apps2) => {
+EmbeddedAppsUtils.areSimilar = (apps1: any[], apps2: any[]) => {
   if (!apps1 || !apps2) {
     return apps1 === apps2;
   }
@@ -52,7 +51,7 @@ EmbeddedAppsUtils.areSimilar = (apps1, apps2) => {
  * @param {array} embeddedApps
  * @returns {array} result - new array of parsed embedded app objects
  */
-EmbeddedAppsUtils.parse = (embeddedApps) =>
+EmbeddedAppsUtils.parse = (embeddedApps: Array<any>) =>
   embeddedApps && embeddedApps.map(EmbeddedAppsUtils.parseApp);
 
 export default EmbeddedAppsUtils;

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

@@ -1,14 +1,13 @@
 import {FULL_STATE} from '../constants';
 
-const FullState = {};
+const FullState: any = {};
 
 FullState.parse = (fullState) => ({
   type: fullState.type || FULL_STATE.UNKNOWN,
   meetingState: fullState.state,
-  locked: fullState.locked
+  locked: fullState.locked,
 });
 
-
 FullState.getFullState = (oldFullState, newFullState) => {
   const previous = oldFullState && FullState.parse(oldFullState);
   const current = newFullState && FullState.parse(newFullState);
@@ -20,16 +19,19 @@ FullState.getFullState = (oldFullState, newFullState) => {
       isMeetingEnded: FullState.isMeetingEnded(previous, current),
       isMeetingTerminating: FullState.isMeetingTerminating(previous, current),
       meetingTypeChangedTo: FullState.isTypeChanged(previous, current),
-      meetingStateChangedTo: FullState.meetingStateChange(previous, current)
-    }
+      meetingStateChangedTo: FullState.meetingStateChange(previous, current),
+    },
   };
 };
 
 FullState.isMeetingEnded = (previous, current) => {
-  if (current.state === FULL_STATE.INACTIVE && previous &&
-   (previous.state === FULL_STATE.ACTIVE ||
-    previous.state === FULL_STATE.INITIALIZING ||
-    previous.state === FULL_STATE.TERMINATING)) {
+  if (
+    current.state === FULL_STATE.INACTIVE &&
+    previous &&
+    (previous.state === FULL_STATE.ACTIVE ||
+      previous.state === FULL_STATE.INITIALIZING ||
+      previous.state === FULL_STATE.TERMINATING)
+  ) {
     return true;
   }
 
@@ -37,9 +39,11 @@ FullState.isMeetingEnded = (previous, current) => {
 };
 
 FullState.isMeetingTerminating = (previous, current) => {
-  if (current.state === FULL_STATE.TERMINATING && previous &&
-  (previous.state === FULL_STATE.ACTIVE ||
-    previous.state === FULL_STATE.INITIALIZING)) {
+  if (
+    current.state === FULL_STATE.TERMINATING &&
+    previous &&
+    (previous.state === FULL_STATE.ACTIVE || previous.state === FULL_STATE.INITIALIZING)
+  ) {
     return true;
   }
 

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

@@ -1,14 +1,14 @@
-const HostUtils = {};
+const HostUtils: any = {};
 
 /**
  * parse the relevant host values that we care about: id
  * @param {Object} host
  * @returns {Object} parsed host or null if host was undefined
  */
-HostUtils.parse = (host) => {
+HostUtils.parse = (host: object) => {
   if (host) {
     return {
-      hostId: HostUtils.getId(host)
+      hostId: HostUtils.getId(host),
     };
   }
 
@@ -22,7 +22,7 @@ HostUtils.parse = (host) => {
  * @returns {Object}
  * previous: {Object} old host, current: {Object} new host, updates: {isNewHost: {boolean}} boolean update values
  */
-HostUtils.getHosts = (oldHost, newHost) => {
+HostUtils.getHosts = (oldHost: object, newHost: object) => {
   const previous = oldHost && HostUtils.parse(oldHost);
   const current = newHost && HostUtils.parse(newHost);
 
@@ -30,8 +30,9 @@ HostUtils.getHosts = (oldHost, newHost) => {
     previous,
     current,
     updates: {
-      isNewHost: previous && current ? HostUtils.isDifferentHosts(previous.hostId, current.hostId) : true
-    }
+      isNewHost:
+        previous && current ? HostUtils.isDifferentHosts(previous.hostId, current.hostId) : true,
+    },
   };
 };
 
@@ -41,14 +42,14 @@ HostUtils.getHosts = (oldHost, newHost) => {
  * @param {String} currentId
  * @returns {Boolean}
  */
-HostUtils.isDifferentHosts = (previousId, currentId) => previousId !== currentId;
+HostUtils.isDifferentHosts = (previousId: string, currentId: string) => previousId !== currentId;
 
 /**
  * Extract the id from the host object
  * @param {Object} host
  * @returns {String}
  */
-HostUtils.getId = (host) => {
+HostUtils.getId = (host: any) => {
   if (!host) {
     return null;
   }