@webex/plugin-meetings 3.0.0-beta.25 → 3.0.0-beta.26

package/dist/types/constants.d.ts

@@ -595,6 +595,10 @@ export declare const DISPLAY_HINTS: {
     DISABLE_REACTIONS: string;
     REACTIONS_ACTIVE: string;
     REACTIONS_INACTIVE: string;
+    ENABLE_MUTE_ON_ENTRY: string;
+    DISABLE_MUTE_ON_ENTRY: string;
+    ENABLE_HARD_MUTE: string;
+    DISABLE_HARD_MUTE: string;
 };
 export declare const SELF_ROLES: {
     COHOST: string;

package/dist/types/controls-options-manager/constants.d.ts

@@ -0,0 +1,4 @@
+declare const ENABLED = "enabled";
+declare const CAN_SET = "canSet";
+declare const CAN_UNSET = "canUnset";
+export { ENABLED, CAN_SET, CAN_UNSET };

package/dist/types/controls-options-manager/enums.d.ts

@@ -0,0 +1,5 @@
+declare enum Setting {
+    disallowUnmute = "DisallowUnmute",
+    muteOnEntry = "MuteOnEntry"
+}
+export default Setting;

package/dist/types/controls-options-manager/index.d.ts

@@ -0,0 +1,120 @@
+import MeetingRequest from '../meeting/request';
+/**
+ * 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;
+    /**
+     * @instance
+     * @type {Array}
+     * @private
+     * @memberof ControlsOptionsManager
+     */
+    private displayHints;
+    /**
+     * @instance
+     * @type {string}
+     * @private
+     * @memberof ControlsOptionsManager
+     */
+    private locusUrl;
+    /**
+     * @param {MeetingRequest} request
+     * @param {Object} options
+     * @constructor
+     * @memberof ControlsOptionsManager
+     */
+    constructor(request: MeetingRequest, options?: {
+        locusUrl: string;
+        displayHints?: Array<string>;
+    });
+    /**
+     * @param {MeetingRequest} request
+     * @returns {void}
+     * @private
+     * @memberof ControlsOptionsManager
+     */
+    private initialize;
+    /**
+     * @param {Object} options
+     * @returns {void}
+     * @public
+     * @memberof ControlsOptionsManager
+     */
+    set(options?: {
+        locusUrl: string;
+        displayHints?: Array<string>;
+    }): void;
+    /**
+     * @param {string} url
+     * @returns {void}
+     * @public
+     * @memberof ControlsOptionsManager
+     */
+    setLocusUrl(url: string): void;
+    /**
+     * @param {Array} hints
+     * @returns {void}
+     * @public
+     * @memberof ControlsOptionsManager
+     */
+    setDisplayHints(hints: Array<string>): void;
+    /**
+     * @returns {string}
+     * @public
+     * @memberof ControlsOptionsManager
+     */
+    getLocusUrl(): string;
+    /**
+     * @returns {Array}
+     * @public
+     * @memberof ControlsOptionsManager
+     */
+    getDisplayHints(): string[];
+    /**
+     * @param {Object} options
+     * @returns {void}
+     * @private
+     * @memberof ControlsOptionsManager
+     */
+    private extract;
+    /**
+     * @param {Setting} setting
+     * @param {boolean} enabled
+     * @private
+     * @memberof ControlsOptionsManager
+     * @returns {Promise}
+     */
+    private setControls;
+    /**
+     * @public
+     * @param {boolean} enabled
+     * @memberof ControlsOptionsManager
+     * @returns {Promise}
+     */
+    setMuteOnEntry(enabled: boolean): Promise<any>;
+    /**
+     * @public
+     * @param {boolean} enabled
+     * @memberof ControlsOptionsManager
+     * @returns {Promise}
+     */
+    setDisallowUnmute(enabled: boolean): Promise<any>;
+}

package/dist/types/controls-options-manager/util.d.ts

@@ -0,0 +1,7 @@
+declare const _default: {
+    canSetMuteOnEntry: (displayHints: string[]) => boolean;
+    canSetDisallowUnmute: (displayHints: string[]) => boolean;
+    canUnsetMuteOnEntry: (displayHints: string[]) => boolean;
+    canUnsetDisallowUnmute: (displayHints: string[]) => boolean;
+};
+export default _default;

package/dist/types/meeting/in-meeting-actions.d.ts

@@ -10,6 +10,10 @@ interface IInMeetingActions {
     canAdmitParticipant?: boolean;
     canLock?: boolean;
     canUnlock?: boolean;
+    canSetMuteOnEntry?: boolean;
+    canUnsetMuteOnEntry?: boolean;
+    canSetDisallowUnmute?: boolean;
+    canUnsetDisallowUnmute?: boolean;
     canAssignHost?: boolean;
     canStartRecording?: boolean;
     canPauseRecording?: boolean;
@@ -45,6 +49,10 @@ export default class InMeetingActions implements IInMeetingActions {
     canPauseRecording: any;
     canResumeRecording: any;
     canStopRecording: any;
+    canSetMuteOnEntry: any;
+    canUnsetMuteOnEntry: any;
+    canSetDisallowUnmute: any;
+    canUnsetDisallowUnmute: any;
     canRaiseHand: any;
     canLowerAllHands: any;
     canLowerSomeoneElsesHand: any;

package/dist/types/meeting/index.d.ts

@@ -14,6 +14,7 @@ import { RemoteMediaManager } from '../multistream/remoteMediaManager';
 import { ReactionServerType, SkinToneType } from '../reactions/reactions.type';
 import InMeetingActions from './in-meeting-actions';
 import RecordingController from '../recording-controller';
+import ControlsOptionsManager from '../controls-options-manager';
 export declare const MEDIA_UPDATE_TYPE: {
     ALL: string;
     AUDIO: string;
@@ -345,6 +346,7 @@ export default class Meeting extends StatelessWebexPlugin {
     recording: any;
     remoteMediaManager: RemoteMediaManager | null;
     recordingController: RecordingController;
+    controlsOptionsManager: ControlsOptionsManager;
     requiredCaptcha: any;
     receiveSlotManager: ReceiveSlotManager;
     shareStatus: string;
@@ -1378,6 +1380,22 @@ export default class Meeting extends StatelessWebexPlugin {
      * @memberof Meeting
      */
     startRecording(): Promise<any>;
+    /**
+     * set the mute on entry flag for participants if you're the host
+     * @returns {Promise}
+     * @param {boolean} enabled
+     * @public
+     * @memberof Meeting
+     */
+    setMuteOnEntry(enabled: boolean): Promise<any>;
+    /**
+     * set the disallow unmute flag for participants if you're the host
+     * @returns {Promise}
+     * @param {boolean} enabled
+     * @public
+     * @memberof Meeting
+     */
+    setDisallowUnmute(enabled: boolean): Promise<any>;
     /**
      * End the recording of this meeting
      * @returns {Promise}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-beta.25",
+  "version": "3.0.0-beta.26",
   "description": "",
   "license": "Cisco EULA (https://www.cisco.com/c/en/us/products/end-user-license-agreement.html)",
   "contributors": [
@@ -32,12 +32,12 @@
     "build": "yarn run -T tsc --declaration true --declarationDir ./dist/types"
   },
   "devDependencies": {
-    "@webex/plugin-meetings": "3.0.0-beta.25",
-    "@webex/test-helper-chai": "3.0.0-beta.25",
-    "@webex/test-helper-mocha": "3.0.0-beta.25",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.25",
-    "@webex/test-helper-retry": "3.0.0-beta.25",
-    "@webex/test-helper-test-users": "3.0.0-beta.25",
+    "@webex/plugin-meetings": "3.0.0-beta.26",
+    "@webex/test-helper-chai": "3.0.0-beta.26",
+    "@webex/test-helper-mocha": "3.0.0-beta.26",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.26",
+    "@webex/test-helper-retry": "3.0.0-beta.26",
+    "@webex/test-helper-test-users": "3.0.0-beta.26",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "jsdom-global": "3.0.2",
@@ -45,18 +45,18 @@
     "typed-emitter": "^2.1.0"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.25",
+    "@webex/common": "3.0.0-beta.26",
     "@webex/internal-media-core": "1.33.2",
-    "@webex/internal-plugin-conversation": "3.0.0-beta.25",
-    "@webex/internal-plugin-device": "3.0.0-beta.25",
-    "@webex/internal-plugin-llm": "3.0.0-beta.25",
-    "@webex/internal-plugin-mercury": "3.0.0-beta.25",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.25",
-    "@webex/internal-plugin-support": "3.0.0-beta.25",
-    "@webex/internal-plugin-user": "3.0.0-beta.25",
-    "@webex/plugin-people": "3.0.0-beta.25",
-    "@webex/plugin-rooms": "3.0.0-beta.25",
-    "@webex/webex-core": "3.0.0-beta.25",
+    "@webex/internal-plugin-conversation": "3.0.0-beta.26",
+    "@webex/internal-plugin-device": "3.0.0-beta.26",
+    "@webex/internal-plugin-llm": "3.0.0-beta.26",
+    "@webex/internal-plugin-mercury": "3.0.0-beta.26",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.26",
+    "@webex/internal-plugin-support": "3.0.0-beta.26",
+    "@webex/internal-plugin-user": "3.0.0-beta.26",
+    "@webex/plugin-people": "3.0.0-beta.26",
+    "@webex/plugin-rooms": "3.0.0-beta.26",
+    "@webex/webex-core": "3.0.0-beta.26",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",

package/src/constants.ts

@@ -761,6 +761,10 @@ export const DISPLAY_HINTS = {
   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 = {

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/meeting/in-meeting-actions.ts

@@ -13,6 +13,10 @@ interface IInMeetingActions {
   canAdmitParticipant?: boolean;
   canLock?: boolean;
   canUnlock?: boolean;
+  canSetMuteOnEntry?: boolean;
+  canUnsetMuteOnEntry?: boolean;
+  canSetDisallowUnmute?: boolean;
+  canUnsetDisallowUnmute?: boolean;
   canAssignHost?: boolean;
   canStartRecording?: boolean;
   canPauseRecording?: boolean;
@@ -59,6 +63,14 @@ export default class InMeetingActions implements IInMeetingActions {
 
   canStopRecording = null;
 
+  canSetMuteOnEntry = null;
+
+  canUnsetMuteOnEntry = null;
+
+  canSetDisallowUnmute = null;
+
+  canUnsetDisallowUnmute = null;
+
   canRaiseHand = null;
 
   canLowerAllHands = null;
@@ -99,6 +111,10 @@ export default class InMeetingActions implements IInMeetingActions {
     canLock: this.canLock,
     canUnlock: this.canUnlock,
     canAssignHost: this.canAssignHost,
+    canSetMuteOnEntry: this.canSetMuteOnEntry,
+    canUnsetMuteOnEntry: this.canUnsetMuteOnEntry,
+    canSetDisallowUnmute: this.canSetDisallowUnmute,
+    canUnsetDisallowUnmute: this.canUnsetDisallowUnmute,
     canStartRecording: this.canStartRecording,
     canPauseRecording: this.canPauseRecording,
     canResumeRecording: this.canResumeRecording,

package/src/meeting/index.ts

@@ -37,6 +37,7 @@ import MeetingRequest from './request';
 import Members from '../members/index';
 import MeetingUtil from './util';
 import RecordingUtil from '../recording-controller/util';
+import ControlsOptionsUtil from '../controls-options-manager/util';
 import MediaUtil from '../media/util';
 import Transcription from '../transcription';
 import {Reactions, SkinTones} from '../reactions/reactions';
@@ -106,6 +107,7 @@ import Breakouts from '../breakouts';
 import InMeetingActions from './in-meeting-actions';
 import {REACTION_RELAY_TYPES} from '../reactions/constants';
 import RecordingController from '../recording-controller';
+import ControlsOptionsManager from '../controls-options-manager';
 
 const {isBrowser} = BrowserDetection();
 
@@ -485,6 +487,7 @@ export default class Meeting extends StatelessWebexPlugin {
   recording: any;
   remoteMediaManager: RemoteMediaManager | null;
   recordingController: RecordingController;
+  controlsOptionsManager: ControlsOptionsManager;
   requiredCaptcha: any;
   receiveSlotManager: ReceiveSlotManager;
   shareStatus: string;
@@ -1098,6 +1101,18 @@ export default class Meeting extends StatelessWebexPlugin {
       displayHints: [],
     });
 
+    /**
+     * The class that helps to control recording functions: start, stop, pause, resume, etc
+     * @instance
+     * @type {ControlsOptionsManager}
+     * @public
+     * @memberof Meeting
+     */
+    this.controlsOptionsManager = new ControlsOptionsManager(this.meetingRequest, {
+      locusUrl: this.locusInfo?.url,
+      displayHints: [],
+    });
+
     this.setUpLocusInfoListeners();
     this.locusInfo.init(attrs.locus ? attrs.locus : {});
     this.hasJoinedOnce = false;
@@ -2187,6 +2202,7 @@ export default class Meeting extends StatelessWebexPlugin {
       this.locusUrl = payload;
       this.locusId = this.locusUrl?.split('/').pop();
       this.recordingController.setLocusUrl(this.locusUrl);
+      this.controlsOptionsManager.setLocusUrl(this.locusUrl);
     });
   }
 
@@ -2252,6 +2268,16 @@ export default class Meeting extends StatelessWebexPlugin {
           canAdmitParticipant: MeetingUtil.canAdmitParticipant(payload.info.userDisplayHints),
           canLock: MeetingUtil.canUserLock(payload.info.userDisplayHints),
           canUnlock: MeetingUtil.canUserUnlock(payload.info.userDisplayHints),
+          canSetDisallowUnmute: ControlsOptionsUtil.canSetDisallowUnmute(
+            payload.info.userDisplayHints
+          ),
+          canUnsetDisallowUnmute: ControlsOptionsUtil.canUnsetDisallowUnmute(
+            payload.info.userDisplayHints
+          ),
+          canSetMuteOnEntry: ControlsOptionsUtil.canSetMuteOnEntry(payload.info.userDisplayHints),
+          canUnsetMuteOnEntry: ControlsOptionsUtil.canUnsetMuteOnEntry(
+            payload.info.userDisplayHints
+          ),
           canStartRecording: RecordingUtil.canUserStart(payload.info.userDisplayHints),
           canStopRecording: RecordingUtil.canUserStop(payload.info.userDisplayHints),
           canPauseRecording: RecordingUtil.canUserPause(payload.info.userDisplayHints),
@@ -2288,6 +2314,7 @@ export default class Meeting extends StatelessWebexPlugin {
         });
 
         this.recordingController.setDisplayHints(payload.info.userDisplayHints);
+        this.controlsOptionsManager.setDisplayHints(payload.info.userDisplayHints);
 
         if (changed) {
           Trigger.trigger(
@@ -6131,6 +6158,28 @@ export default class Meeting extends StatelessWebexPlugin {
     return this.recordingController.startRecording();
   }
 
+  /**
+   * set the mute on entry flag for participants if you're the host
+   * @returns {Promise}
+   * @param {boolean} enabled
+   * @public
+   * @memberof Meeting
+   */
+  public setMuteOnEntry(enabled: boolean) {
+    return this.controlsOptionsManager.setMuteOnEntry(enabled);
+  }
+
+  /**
+   * set the disallow unmute flag for participants if you're the host
+   * @returns {Promise}
+   * @param {boolean} enabled
+   * @public
+   * @memberof Meeting
+   */
+  public setDisallowUnmute(enabled: boolean) {
+    return this.controlsOptionsManager.setDisallowUnmute(enabled);
+  }
+
   /**
    * End the recording of this meeting
    * @returns {Promise}