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

package/src/constants.ts

@@ -1,3 +1,4 @@
+// @ts-ignore
 import {hydraTypes} from '@webex/common';
 
 // *********** LOWERCASE / CAMELCASE STRINGS ************
@@ -287,6 +288,7 @@ export const EVENT_TRIGGERS = {
   MEETING_STOPPED_RECORDING: 'meeting:recording:stopped',
   MEETING_STARTED_RECEIVING_TRANSCRIPTION: 'meeting:receiveTranscription:started',
   MEETING_STOPPED_RECEIVING_TRANSCRIPTION: 'meeting:receiveTranscription:stopped',
+  MEETING_RECEIVE_REACTIONS: 'meeting:receiveReactions',
   MEETING_PAUSED_RECORDING: 'meeting:recording:paused',
   MEETING_RESUMED_RECORDING: 'meeting:recording:resumed',
   MEETING_ADDED: 'meeting:added',
@@ -303,6 +305,9 @@ export const EVENT_TRIGGERS = {
   MEETING_SELF_IS_SHARING_BLOCKED: 'meeting:self:isSharingBlocked',
   MEETING_CONTROLS_LAYOUT_UPDATE: 'meeting:layout:update',
   MEETING_ENTRY_EXIT_TONE_UPDATE: 'meeting:entryExitTone:update',
+  MEETING_BREAKOUTS_UPDATE: 'meeting:breakouts:update',
+  MEETING_BREAKOUTS_CLOSING: 'meeting:breakouts:closing',
+  MEETING_BREAKOUTS_MESSAGE: 'meeting:breakouts:message',
   MEMBERS_UPDATE: 'members:update',
   MEMBERS_CONTENT_UPDATE: 'members:content:update',
   MEMBERS_HOST_UPDATE: 'members:host:update',
@@ -330,7 +335,7 @@ export const EVENT_TRIGGERS = {
   REMOTE_VIDEO_SOURCE_COUNT_CHANGED: 'media:remoteVideoSourceCountChanged',
   REMOTE_AUDIO_SOURCE_COUNT_CHANGED: 'media:remoteAudioSourceCountChanged',
   REMOTE_MEDIA_AUDIO_CREATED: 'media:remoteAudio:created',
-  REMOTE_MEDIA_SCREEN_SHARE_AUDIO_CREATED: 'media:remoteScrenShareAudio:created',
+  REMOTE_MEDIA_SCREEN_SHARE_AUDIO_CREATED: 'media:remoteScreenShareAudio:created',
   REMOTE_MEDIA_VIDEO_LAYOUT_CHANGED: 'media:remoteVideo:layoutChanged',
 };
 
@@ -513,11 +518,34 @@ export const LOCUS = {
   SYNCDEBUG: 'sync_debug',
 };
 
+export const BREAKOUTS = {
+  STATUS: {
+    CLOSING: 'CLOSING',
+  },
+  EVENTS: {
+    BREAKOUTS_CLOSING: 'BREAKOUTS_CLOSING',
+    MESSAGE: 'MESSAGE',
+    MEMBERS_UPDATE: 'MEMBERS_UPDATE',
+  },
+  SESSION_TYPES: {
+    MAIN: 'MAIN',
+  },
+  SESSION_STATES: {
+    ACTIVE: 'active',
+    ASSIGNED: 'assigned',
+    ALLOWED: 'allowed',
+    ASSIGNED_CURRENT: 'assignedCurrent',
+    REQUESTED: 'requested',
+  },
+  BREAKOUTS_SUPPORTED: 'BREAKOUTS_SUPPORTED',
+};
+
 export const LOCUSINFO = {
   EVENTS: {
     CONTROLS_MEETING_LAYOUT_UPDATED: 'CONTROLS_MEETING_LAYOUT_UPDATED',
     CONTROLS_RECORDING_UPDATED: 'CONTROLS_RECORDING_UPDATED',
     CONTROLS_MEETING_TRANSCRIBE_UPDATED: 'CONTROLS_MEETING_TRANSCRIBE_UPDATED',
+    CONTROLS_MEETING_BREAKOUT_UPDATED: 'CONTROLS_MEETING_BREAKOUT_UPDATED',
     CONTROLS_MEETING_CONTAINER_UPDATED: 'CONTROLS_MEETING_CONTAINER_UPDATED',
     CONTROLS_ENTRY_EXIT_TONE_UPDATED: 'CONTROLS_ENTRY_EXIT_TONE_UPDATED',
     SELF_UNADMITTED_GUEST: 'SELF_UNADMITTED_GUEST',
@@ -539,6 +567,9 @@ export const LOCUSINFO = {
     EMBEDDED_APPS_UPDATED: 'EMBEDDED_APPS_UPDATED',
     SELF_CANNOT_VIEW_PARTICIPANT_LIST_CHANGE: 'SELF_CANNOT_VIEW_PARTICIPANT_LIST_CHANGE',
     SELF_IS_SHARING_BLOCKED_CHANGE: 'SELF_IS_SHARING_BLOCKED_CHANGE',
+    SELF_MEETING_BREAKOUTS_CHANGED: 'SELF_MEETING_BREAKOUTS_CHANGED',
+    MEDIA_INACTIVITY: 'MEDIA_INACTIVITY',
+    LINKS_SERVICES: 'LINKS_SERVICES',
   },
 };
 
@@ -551,6 +582,9 @@ export const LOCUSEVENT = {
   // delta events
   DIFFERENCE: 'locus.difference',
 
+  // Breakout sessions
+  BREAKOUT_ROSTER: 'breakout.roster',
+
   // screen sharing
   FLOOR_GRANTED: 'locus.floor_granted',
   FLOOR_RELEASED: 'locus.floor_released',
@@ -723,6 +757,14 @@ export const DISPLAY_HINTS = {
   TRANSCRIPTION_CONTROL_STOP: 'TRANSCRIPTION_CONTROL_STOP',
   WEBEX_ASSISTANT_STATUS_ACTIVE: 'WEBEX_ASSISTANT_STATUS_ACTIVE',
   WAITING_FOR_OTHERS: 'WAITING_FOR_OTHERS',
+  ENABLE_REACTIONS: 'ENABLE_REACTIONS',
+  DISABLE_REACTIONS: 'DISABLE_REACTIONS',
+  REACTIONS_ACTIVE: 'REACTIONS_ACTIVE',
+  REACTIONS_INACTIVE: 'REACTIONS_INACTIVE',
+  ENABLE_MUTE_ON_ENTRY: 'ENABLE_MUTE_ON_ENTRY',
+  DISABLE_MUTE_ON_ENTRY: 'DISABLE_MUTE_ON_ENTRY',
+  ENABLE_HARD_MUTE: 'ENABLE_HARD_MUTE',
+  DISABLE_HARD_MUTE: 'DISABLE_HARD_MUTE',
 };
 
 export const SELF_ROLES = {
@@ -813,6 +855,7 @@ export const RESOURCE = {
 
 export const REACHABILITY = {
   localStorage: 'reachability.result',
+  namespace: 'Reachability',
 };
 
 export const ROAP = {
@@ -847,9 +890,6 @@ export const NETWORK_TYPE = {
 };
 
 export const STATS = {
-  AUDIO_CORRELATE: 'audio',
-  VIDEO_CORRELATE: 'video',
-  SHARE_CORRELATE: 'share',
   SEND_DIRECTION: 'send',
   RECEIVE_DIRECTION: 'recv',
   REMOTE: 'remote',

package/src/controls-options-manager/constants.ts

@@ -0,0 +1,5 @@
+const ENABLED = 'enabled';
+const CAN_SET = 'canSet';
+const CAN_UNSET = 'canUnset';
+
+export {ENABLED, CAN_SET, CAN_UNSET};

package/src/controls-options-manager/enums.ts

@@ -0,0 +1,6 @@
+enum Setting {
+  disallowUnmute = 'DisallowUnmute',
+  muteOnEntry = 'MuteOnEntry',
+}
+
+export default Setting;

package/src/controls-options-manager/index.ts

@@ -0,0 +1,183 @@
+import {camelCase} from 'lodash';
+import PermissionError from '../common/errors/permission';
+import {CONTROLS, HTTP_VERBS} from '../constants';
+import MeetingRequest from '../meeting/request';
+import LoggerProxy from '../common/logs/logger-proxy';
+import Setting from './enums';
+import Util from './util';
+import {CAN_SET, CAN_UNSET, ENABLED} from './constants';
+
+/**
+ * docs
+ * https://sqbu-github.cisco.com/pages/WebExSquared/locus/guides/mute.html
+ * https://confluence-eng-gpk2.cisco.com/conf/display/LOCUS/Hard+Mute+and+Audio+Privacy#HardMuteandAudioPrivacy-SelfMuteonEntry
+ * https://confluence-eng-gpk2.cisco.com/conf/pages/viewpage.action?spaceKey=UC&title=WEBEX-124454%3A+UCF%3A+Hard+mute+support+for+Teams+joining+Webex+meeting
+ * https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-180867
+ * https://jira-eng-gpk2.cisco.com/jira/browse/SPARK-393351
+ */
+
+/**
+ * @description ControlsOptionsManager is responsible for handling the behavior of participant controls when somebody joins a meeting
+ * @export
+ * @private
+ * @class Recording
+ */
+export default class ControlsOptionsManager {
+  /**
+   * @instance
+   * @type {MeetingRequest}
+   * @private
+   * @memberof ControlsOptionsManager
+   */
+  private request: MeetingRequest;
+
+  /**
+   * @instance
+   * @type {Array}
+   * @private
+   * @memberof ControlsOptionsManager
+   */
+  private displayHints: Array<string> = [];
+
+  /**
+   * @instance
+   * @type {string}
+   * @private
+   * @memberof ControlsOptionsManager
+   */
+  private locusUrl: string;
+
+  /**
+   * @param {MeetingRequest} request
+   * @param {Object} options
+   * @constructor
+   * @memberof ControlsOptionsManager
+   */
+  constructor(
+    request: MeetingRequest,
+    options?: {
+      locusUrl: string;
+      displayHints?: Array<string>;
+    }
+  ) {
+    this.initialize(request);
+    this.set(options);
+  }
+
+  /**
+   * @param {MeetingRequest} request
+   * @returns {void}
+   * @private
+   * @memberof ControlsOptionsManager
+   */
+  private initialize(request: MeetingRequest) {
+    this.request = request;
+  }
+
+  /**
+   * @param {Object} options
+   * @returns {void}
+   * @public
+   * @memberof ControlsOptionsManager
+   */
+  public set(options?: {locusUrl: string; displayHints?: Array<string>}) {
+    this.extract(options);
+  }
+
+  /**
+   * @param {string} url
+   * @returns {void}
+   * @public
+   * @memberof ControlsOptionsManager
+   */
+  public setLocusUrl(url: string) {
+    this.locusUrl = url;
+  }
+
+  /**
+   * @param {Array} hints
+   * @returns {void}
+   * @public
+   * @memberof ControlsOptionsManager
+   */
+  public setDisplayHints(hints: Array<string>) {
+    this.displayHints = hints;
+  }
+
+  /**
+   * @returns {string}
+   * @public
+   * @memberof ControlsOptionsManager
+   */
+  public getLocusUrl() {
+    return this.locusUrl;
+  }
+
+  /**
+   * @returns {Array}
+   * @public
+   * @memberof ControlsOptionsManager
+   */
+  public getDisplayHints() {
+    return this.displayHints;
+  }
+
+  /**
+   * @param {Object} options
+   * @returns {void}
+   * @private
+   * @memberof ControlsOptionsManager
+   */
+  private extract(options?: {locusUrl: string; displayHints?: Array<string>}) {
+    this.setDisplayHints(options?.displayHints);
+    this.setLocusUrl(options?.locusUrl);
+  }
+
+  /**
+   * @param {Setting} setting
+   * @param {boolean} enabled
+   * @private
+   * @memberof ControlsOptionsManager
+   * @returns {Promise}
+   */
+  private setControls(setting: Setting, enabled: boolean): Promise<any> {
+    LoggerProxy.logger.log(`ControlsOptionsManager:index#setControls --> ${setting} [${enabled}]`);
+
+    if (Util?.[`${enabled ? CAN_SET : CAN_UNSET}${setting}`](this.displayHints)) {
+      // @ts-ignore
+      return this.request.request({
+        uri: `${this.locusUrl}/${CONTROLS}`,
+        body: {
+          [camelCase(setting)]: {
+            [ENABLED]: enabled,
+          },
+        },
+        method: HTTP_VERBS.PATCH,
+      });
+    }
+
+    return Promise.reject(
+      new PermissionError(`${setting} [${enabled}] not allowed, due to moderator property.`)
+    );
+  }
+
+  /**
+   * @public
+   * @param {boolean} enabled
+   * @memberof ControlsOptionsManager
+   * @returns {Promise}
+   */
+  public setMuteOnEntry(enabled: boolean): Promise<any> {
+    return this.setControls(Setting.muteOnEntry, enabled);
+  }
+
+  /**
+   * @public
+   * @param {boolean} enabled
+   * @memberof ControlsOptionsManager
+   * @returns {Promise}
+   */
+  public setDisallowUnmute(enabled: boolean): Promise<any> {
+    return this.setControls(Setting.disallowUnmute, enabled);
+  }
+}

package/src/controls-options-manager/util.ts

@@ -0,0 +1,20 @@
+import {DISPLAY_HINTS} from '../constants';
+
+const canSetMuteOnEntry = (displayHints: Array<string>): boolean =>
+  displayHints.includes(DISPLAY_HINTS.ENABLE_MUTE_ON_ENTRY);
+
+const canSetDisallowUnmute = (displayHints: Array<string>): boolean =>
+  displayHints.includes(DISPLAY_HINTS.ENABLE_HARD_MUTE);
+
+const canUnsetMuteOnEntry = (displayHints: Array<string>): boolean =>
+  displayHints.includes(DISPLAY_HINTS.DISABLE_MUTE_ON_ENTRY);
+
+const canUnsetDisallowUnmute = (displayHints: Array<string>): boolean =>
+  displayHints.includes(DISPLAY_HINTS.DISABLE_HARD_MUTE);
+
+export default {
+  canSetMuteOnEntry,
+  canSetDisallowUnmute,
+  canUnsetMuteOnEntry,
+  canUnsetDisallowUnmute,
+};

package/src/index.js

@@ -5,11 +5,12 @@ import Meetings from './meetings';
 import config from './config';
 
 registerPlugin('meetings', Meetings, {
-  config
+  config,
 });
 
 export default Meetings;
 
 export * as CONSTANTS from './constants';
+export * as REACTIONS from './reactions/reactions';
 
 export {default as TriggerProxy} from './common/events/trigger-proxy';

package/src/locus-info/controlsUtils.ts

@@ -0,0 +1,114 @@
+import {isEqual} from 'lodash';
+
+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;
+  }
+
+  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: {
+      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),
+    },
+  };
+};
+
+/**
+ * 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;
+};
+
+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;
   }