@webex/plugin-meetings 3.0.0-beta.80 → 3.0.0-beta.82

package/dist/types/constants.d.ts

@@ -631,7 +631,10 @@ export declare const DISPLAY_HINTS: {
     DISABLE_REACTIONS: string;
     REACTIONS_ACTIVE: string;
     REACTIONS_INACTIVE: string;
+    SHARE_CONTROL: string;
     ENABLE_MUTE_ON_ENTRY: string;
+    ENABLE_SHOW_DISPLAY_NAME: string;
+    DISABLE_SHOW_DISPLAY_NAME: string;
     DISABLE_MUTE_ON_ENTRY: string;
     ENABLE_HARD_MUTE: string;
     DISABLE_HARD_MUTE: string;
@@ -645,6 +648,8 @@ export declare const DISPLAY_HINTS: {
     DISABLE_ASK_FOR_HELP: string;
     DISABLE_BREAKOUT_PREASSIGNMENTS: string;
     DISABLE_LOBBY_TO_BREAKOUT: string;
+    DISABLE_VIEW_THE_PARTICIPANT_LIST: string;
+    ENABLE_VIEW_THE_PARTICIPANT_LIST: string;
 };
 export declare const SELF_ROLES: {
     COHOST: string;

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

@@ -3,4 +3,11 @@ declare enum Setting {
     muteOnEntry = "MuteOnEntry",
     muted = "Muted"
 }
+declare enum Control {
+    audio = "audio",
+    reactions = "reactions",
+    shareControl = "shareControl",
+    viewTheParticipantList = "viewTheParticipantList"
+}
+export { Control, Setting };
 export default Setting;

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

@@ -1,4 +1,5 @@
 import MeetingRequest from '../meeting/request';
+import { ControlConfig } from './types';
 /**
  * docs
  * https://sqbu-github.cisco.com/pages/WebExSquared/locus/guides/mute.html
@@ -95,6 +96,13 @@ export default class ControlsOptionsManager {
      * @memberof ControlsOptionsManager
      */
     private extract;
+    /**
+     * Set controls for this meeting.
+     *
+     * @param {Array<ControlConfig>} controls - Spread Array of ControlConfigs
+     * @returns {Promise<Array<any>>}- Promise resolving if the request was successful.
+     */
+    protected update(...controls: Array<ControlConfig>): any;
     /**
      * @param {Setting} setting
      * @private

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

@@ -0,0 +1,37 @@
+import { Control } from './enums';
+export interface ControlProperties {
+    /**
+     * A list of additional properties that apply to various specific settings.
+     *
+     * @remarks
+     * The values stored here, per the service, are fully ambiguous, an can vary
+     * depending on which control scope is being configured.
+     */
+    [key: string]: boolean;
+}
+export interface AudioProperties {
+    muted?: boolean;
+    disallowUnmute?: boolean;
+    muteOnEntry?: boolean;
+}
+export interface ReactionsProperties {
+    enabled?: boolean;
+    showDisplayNameWithReactions?: boolean;
+}
+export interface ShareControlProperties {
+    control?: 'ANYONE' | 'MODERATOR_PRESENTER';
+}
+export interface ViewTheParticipantListProperties {
+    enabled?: boolean;
+}
+export type Properties = AudioProperties | ReactionsProperties | ShareControlProperties | ViewTheParticipantListProperties;
+export interface ControlConfig<Props = Properties> {
+    /**
+     * The scope of the control within this object.
+     */
+    scope: Control;
+    /**
+     * The properties to assign to this control.
+     */
+    properties: Props;
+}

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

@@ -1,9 +1,103 @@
-declare const _default: {
-    canSetMuteOnEntry: (displayHints: string[]) => boolean;
-    canSetDisallowUnmute: (displayHints: string[]) => boolean;
-    canSetMuted: (displayHints: string[]) => boolean;
-    canUnsetMuteOnEntry: (displayHints: string[]) => boolean;
-    canUnsetDisallowUnmute: (displayHints: string[]) => boolean;
-    canUnsetMuted: (displayHints: string[]) => boolean;
-};
-export default _default;
+import { ControlConfig, AudioProperties, ReactionsProperties, ViewTheParticipantListProperties } from './types';
+/**
+ * The Controls Options Manager utilities
+ *
+ * @internal
+ */
+declare class Utils {
+    /**
+     * Validate if enabling mute on entry can be set.
+     *
+     * @param {Array<string>} displayHints - Display Hints to use when validating.
+     * @returns {boolean} - True if the action is allowed.
+     */
+    static canSetMuteOnEntry(displayHints: Array<string>): boolean;
+    /**
+     * Validate if allowing unmuting can be set.
+     *
+     * @param {Array<string>} displayHints - Display Hints to use when validating.
+     * @returns {boolean} - True if the action is allowed.
+     */
+    static canSetDisallowUnmute(displayHints: Array<string>): boolean;
+    /**
+     * Validate if disabling mute on entry can be set.
+     *
+     * @param {Array<string>} displayHints - Display Hints to use when validating.
+     * @returns {boolean} - True if the action is allowed.
+     */
+    static canUnsetMuteOnEntry(displayHints: Array<string>): boolean;
+    /**
+     * Validate if enabling muting can be set.
+     *
+     * @param {Array<string>} displayHints - Display Hints to use when validating.
+     * @returns {boolean} - True if the action is allowed.
+     */
+    static canUnsetDisallowUnmute(displayHints: Array<string>): boolean;
+    /**
+     * Validate if muting all can be set.
+     *
+     * @param {Array<string>} displayHints - Display Hints to use when validating.
+     * @returns {boolean} - True if the action is allowed.
+     */
+    static canSetMuted(displayHints: Array<string>): boolean;
+    /**
+     * Validate if unmuting all can be set.
+     *
+     * @param {Array<string>} displayHints - Display Hints to use when validating.
+     * @returns {boolean} - True if the action is allowed.
+     */
+    static canUnsetMuted(displayHints: Array<string>): boolean;
+    /**
+     * Validate an array of hints are allowed based on a full collection of hints.
+     *
+     * @param {Object} config - Configuration Object.
+     * @param {Array<string>} config.requiredHints - Hints required for validation.
+     * @param {Array<string>} config.displayHints - All available hints.
+     * @returns {boolean} - True if all of the actions are allowed.
+     */
+    static hasHints(config: {
+        requiredHints: Array<string>;
+        displayHints: Array<string>;
+    }): boolean;
+    /**
+     * Validate if an audio-scoped control is allowed to be sent to the service.
+     *
+     * @param {ControlConfig<AudioProperties>} control - Audio control config to validate.
+     * @param {Array<string>} displayHints - All available hints.
+     * @returns {boolean} - True if all of the actions are allowed.
+     */
+    static canUpdateAudio(control: ControlConfig<AudioProperties>, displayHints: Array<string>): boolean;
+    /**
+     * Validate if an reactions-scoped control is allowed to be sent to the service.
+     *
+     * @param {ControlConfig<ReactionsProperties>} control - Reaction control config to validate.
+     * @param {Array<string>} displayHints - All available hints.
+     * @returns {boolean} - True if all of the actions are allowed.
+     */
+    static canUpdateReactions(control: ControlConfig<ReactionsProperties>, displayHints: Array<string>): boolean;
+    /**
+     * Validate if an share-control-scoped control is allowed to be sent to the service.
+     *
+     * @param {Array<string>} displayHints - All available hints.
+     * @returns {boolean} - True if all of the actions are allowed.
+     */
+    static canUpdateShareControl(displayHints: Array<string>): boolean;
+    /**
+     * Validate if an view-the-participants-list-scoped control is allowed to be sent to the service.
+     *
+     * @param {ControlConfig<ViewTheParticipantListProperties>} control - View Participants List control config to validate.
+     * @param {Array<string>} displayHints - All available hints.
+     * @returns {boolean} - True if all of the actions are allowed.
+     */
+    static canUpdateViewTheParticipantsList(control: ControlConfig<ViewTheParticipantListProperties>, displayHints: Array<string>): boolean;
+    /**
+     * Validate that a control can be sent to the service based on the provided
+     * display hints.
+     *
+     * @param {ControlConfig} control - Control to validate.
+     * @param {Array<string>} displayHints - All available hints.
+     * @returns {boolean} - True if all of the actions are allowed.
+     */
+    static canUpdate(control: ControlConfig, displayHints: Array<string>): boolean;
+}
+export default Utils;

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

@@ -1,6 +1,8 @@
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
+import { MultistreamRoapMediaConnection } from '@webex/internal-media-core';
+export type BundlePolicy = ConstructorParameters<typeof MultistreamRoapMediaConnection>[0]['bundlePolicy'];
 /**
  * MediaDirection
  * @typedef {Object} MediaDirection

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

@@ -1180,9 +1180,10 @@ export default class Meeting extends StatelessWebexPlugin {
      * Creates a webrtc media connection
      *
      * @param {Object} turnServerInfo TURN server information
+     * @param {BundlePolicy} [bundlePolicy] Bundle policy settings
      * @returns {RoapMediaConnection | MultistreamRoapMediaConnection}
      */
-    createMediaConnection(turnServerInfo: any): any;
+    createMediaConnection(turnServerInfo: any, bundlePolicy: any): any;
     /**
      * Listens for an event emitted by eventEmitter and emits it from the meeting object
      *
@@ -1200,6 +1201,7 @@ export default class Meeting extends StatelessWebexPlugin {
      * @param {MediaDirection} options.mediaSettings pass media options
      * @param {MediaStream} options.localStream
      * @param {MediaStream} options.localShare
+     * @param {BundlePolicy} options.bundlePolicy bundle policy for multistream meetings
      * @param {RemoteMediaManagerConfig} options.remoteMediaManagerConfig only applies if multistream is enabled
      * @returns {Promise}
      * @public

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webex/plugin-meetings",
-  "version": "3.0.0-beta.80",
+  "version": "3.0.0-beta.82",
   "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.80",
-    "@webex/test-helper-chai": "3.0.0-beta.80",
-    "@webex/test-helper-mocha": "3.0.0-beta.80",
-    "@webex/test-helper-mock-webex": "3.0.0-beta.80",
-    "@webex/test-helper-retry": "3.0.0-beta.80",
-    "@webex/test-helper-test-users": "3.0.0-beta.80",
+    "@webex/plugin-meetings": "3.0.0-beta.82",
+    "@webex/test-helper-chai": "3.0.0-beta.82",
+    "@webex/test-helper-mocha": "3.0.0-beta.82",
+    "@webex/test-helper-mock-webex": "3.0.0-beta.82",
+    "@webex/test-helper-retry": "3.0.0-beta.82",
+    "@webex/test-helper-test-users": "3.0.0-beta.82",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "jsdom-global": "3.0.2",
@@ -46,18 +46,18 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@webex/common": "3.0.0-beta.80",
+    "@webex/common": "3.0.0-beta.82",
     "@webex/internal-media-core": "1.36.0",
-    "@webex/internal-plugin-conversation": "3.0.0-beta.80",
-    "@webex/internal-plugin-device": "3.0.0-beta.80",
-    "@webex/internal-plugin-llm": "3.0.0-beta.80",
-    "@webex/internal-plugin-mercury": "3.0.0-beta.80",
-    "@webex/internal-plugin-metrics": "3.0.0-beta.80",
-    "@webex/internal-plugin-support": "3.0.0-beta.80",
-    "@webex/internal-plugin-user": "3.0.0-beta.80",
-    "@webex/plugin-people": "3.0.0-beta.80",
-    "@webex/plugin-rooms": "3.0.0-beta.80",
-    "@webex/webex-core": "3.0.0-beta.80",
+    "@webex/internal-plugin-conversation": "3.0.0-beta.82",
+    "@webex/internal-plugin-device": "3.0.0-beta.82",
+    "@webex/internal-plugin-llm": "3.0.0-beta.82",
+    "@webex/internal-plugin-mercury": "3.0.0-beta.82",
+    "@webex/internal-plugin-metrics": "3.0.0-beta.82",
+    "@webex/internal-plugin-support": "3.0.0-beta.82",
+    "@webex/internal-plugin-user": "3.0.0-beta.82",
+    "@webex/plugin-people": "3.0.0-beta.82",
+    "@webex/plugin-rooms": "3.0.0-beta.82",
+    "@webex/webex-core": "3.0.0-beta.82",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",

package/src/constants.ts

@@ -797,7 +797,10 @@ export const DISPLAY_HINTS = {
   DISABLE_REACTIONS: 'DISABLE_REACTIONS',
   REACTIONS_ACTIVE: 'REACTIONS_ACTIVE',
   REACTIONS_INACTIVE: 'REACTIONS_INACTIVE',
+  SHARE_CONTROL: 'SHARE_CONTROL',
   ENABLE_MUTE_ON_ENTRY: 'ENABLE_MUTE_ON_ENTRY',
+  ENABLE_SHOW_DISPLAY_NAME: 'ENABLE_SHOW_DISPLAY_NAME',
+  DISABLE_SHOW_DISPLAY_NAME: 'DISABLE_SHOW_DISPLAY_NAME',
   DISABLE_MUTE_ON_ENTRY: 'DISABLE_MUTE_ON_ENTRY',
   ENABLE_HARD_MUTE: 'ENABLE_HARD_MUTE',
   DISABLE_HARD_MUTE: 'DISABLE_HARD_MUTE',
@@ -813,6 +816,10 @@ export const DISPLAY_HINTS = {
   DISABLE_ASK_FOR_HELP: 'DISABLE_ASK_FOR_HELP',
   DISABLE_BREAKOUT_PREASSIGNMENTS: 'DISABLE_BREAKOUT_PREASSIGNMENTS',
   DISABLE_LOBBY_TO_BREAKOUT: 'DISABLE_LOBBY_TO_BREAKOUT',
+
+  // participants list
+  DISABLE_VIEW_THE_PARTICIPANT_LIST: 'DISABLE_VIEW_THE_PARTICIPANT_LIST',
+  ENABLE_VIEW_THE_PARTICIPANT_LIST: 'ENABLE_VIEW_THE_PARTICIPANT_LIST',
 };
 
 export const SELF_ROLES = {

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

@@ -4,4 +4,13 @@ enum Setting {
   muted = 'Muted',
 }
 
+enum Control {
+  audio = 'audio',
+  reactions = 'reactions',
+  shareControl = 'shareControl',
+  viewTheParticipantList = 'viewTheParticipantList',
+}
+
+export {Control, Setting};
+
 export default Setting;

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

@@ -3,7 +3,8 @@ 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 {Control, Setting} from './enums';
+import {ControlConfig} from './types';
 import Util from './util';
 import {CAN_SET, CAN_UNSET, ENABLED} from './constants';
 
@@ -133,6 +134,40 @@ export default class ControlsOptionsManager {
     this.setLocusUrl(options?.locusUrl);
   }
 
+  /**
+   * Set controls for this meeting.
+   *
+   * @param {Array<ControlConfig>} controls - Spread Array of ControlConfigs
+   * @returns {Promise<Array<any>>}- Promise resolving if the request was successful.
+   */
+  protected update(...controls: Array<ControlConfig>) {
+    const payload = controls.reduce((output, control) => {
+      if (!Object.keys(Control).includes(control.scope)) {
+        throw new Error(
+          `updating meeting control scope "${control.scope}" is not a supported scope`
+        );
+      }
+
+      if (!Util.canUpdate(control, this.displayHints)) {
+        throw new PermissionError(
+          `updating meeting control scope "${control.scope}" not allowed, due to moderator property.`
+        );
+      }
+
+      return {
+        ...output,
+        [control.scope]: control.properties,
+      };
+    }, {});
+
+    // @ts-ignore
+    return this.request.request({
+      uri: `${this.locusUrl}/${CONTROLS}`,
+      body: payload,
+      method: HTTP_VERBS.PATCH,
+    });
+  }
+
   /**
    * @param {Setting} setting
    * @private

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

@@ -0,0 +1,49 @@
+import {Control} from './enums';
+
+export interface ControlProperties {
+  /**
+   * A list of additional properties that apply to various specific settings.
+   *
+   * @remarks
+   * The values stored here, per the service, are fully ambiguous, an can vary
+   * depending on which control scope is being configured.
+   */
+  [key: string]: boolean;
+}
+
+export interface AudioProperties {
+  muted?: boolean;
+  disallowUnmute?: boolean;
+  muteOnEntry?: boolean;
+}
+
+export interface ReactionsProperties {
+  enabled?: boolean;
+  showDisplayNameWithReactions?: boolean;
+}
+
+export interface ShareControlProperties {
+  control?: 'ANYONE' | 'MODERATOR_PRESENTER';
+}
+
+export interface ViewTheParticipantListProperties {
+  enabled?: boolean;
+}
+
+export type Properties =
+  | AudioProperties
+  | ReactionsProperties
+  | ShareControlProperties
+  | ViewTheParticipantListProperties;
+
+export interface ControlConfig<Props = Properties> {
+  /**
+   * The scope of the control within this object.
+   */
+  scope: Control;
+
+  /**
+   * The properties to assign to this control.
+   */
+  properties: Props;
+}