@webex/plugin-meetings 3.12.0-next.72 → 3.12.0-next.73

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

@@ -43,6 +43,8 @@ export default class ControlsOptionsManager {
      * @memberof ControlsOptionsManager
      */
     private mainLocusUrl;
+    private getControls;
+    private isWebinar;
     /**
      * @param {MeetingRequest} request
      * @param {Object} options
@@ -52,6 +54,8 @@ export default class ControlsOptionsManager {
     constructor(request: MeetingRequest, options?: {
         locusUrl: string;
         displayHints?: Array<string>;
+        getControls?: () => Record<string, any>;
+        isWebinar?: () => boolean;
     });
     /**
      * @param {MeetingRequest} request
@@ -69,6 +73,8 @@ export default class ControlsOptionsManager {
     set(options?: {
         locusUrl: string;
         displayHints?: Array<string>;
+        getControls?: () => Record<string, any>;
+        isWebinar?: () => boolean;
     }): void;
     /**
      * @param {string} url

package/dist/webinar/index.js

@@ -869,7 +869,7 @@ var Webinar = _webexCore.WebexPlugin.extend({
       }, _callee1);
     }))();
   },
-  version: "3.12.0-next.72"
+  version: "3.12.0-next.73"
 });
 var _default = exports.default = Webinar;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -94,5 +94,5 @@
   "//": [
     "TODO: upgrade jwt-decode when moving to node 18"
   ],
-  "version": "3.12.0-next.72"
+  "version": "3.12.0-next.73"
 }

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

@@ -4,7 +4,7 @@ import PermissionError from '../common/errors/permission';
 import MeetingRequest from '../meeting/request';
 import LoggerProxy from '../common/logs/logger-proxy';
 import {Control, Setting} from './enums';
-import {ControlConfig} from './types';
+import {ControlConfig, ViewTheParticipantListProperties} from './types';
 import Util from './util';
 import {CAN_SET, CAN_UNSET, ENABLED} from './constants';
 
@@ -56,6 +56,10 @@ export default class ControlsOptionsManager {
    */
   private mainLocusUrl: string;
 
+  private getControls: () => Record<string, any> = () => ({});
+
+  private isWebinar: () => boolean = () => false;
+
   /**
    * @param {MeetingRequest} request
    * @param {Object} options
@@ -67,6 +71,8 @@ export default class ControlsOptionsManager {
     options?: {
       locusUrl: string;
       displayHints?: Array<string>;
+      getControls?: () => Record<string, any>;
+      isWebinar?: () => boolean;
     }
   ) {
     this.initialize(request);
@@ -89,7 +95,12 @@ export default class ControlsOptionsManager {
    * @public
    * @memberof ControlsOptionsManager
    */
-  public set(options?: {locusUrl: string; displayHints?: Array<string>}) {
+  public set(options?: {
+    locusUrl: string;
+    displayHints?: Array<string>;
+    getControls?: () => Record<string, any>;
+    isWebinar?: () => boolean;
+  }) {
     this.extract(options);
   }
 
@@ -141,9 +152,20 @@ export default class ControlsOptionsManager {
    * @private
    * @memberof ControlsOptionsManager
    */
-  private extract(options?: {locusUrl: string; displayHints?: Array<string>}) {
+  private extract(options?: {
+    locusUrl: string;
+    displayHints?: Array<string>;
+    getControls?: () => Record<string, any>;
+    isWebinar?: () => boolean;
+  }) {
     this.setDisplayHints(options?.displayHints);
     this.setLocusUrl(options?.locusUrl);
+    if (options?.getControls) {
+      this.getControls = options.getControls;
+    }
+    if (options?.isWebinar) {
+      this.isWebinar = options.isWebinar;
+    }
   }
 
   /**
@@ -172,8 +194,22 @@ export default class ControlsOptionsManager {
         );
       }
 
+      let {properties} = control;
+
+      if (control.scope === Control.viewTheParticipantList) {
+        const props = properties as ViewTheParticipantListProperties;
+        const current = this.getControls()?.viewTheParticipantList;
+        properties = {
+          enabled: props.enabled ?? current?.enabled ?? false,
+          ...(this.isWebinar() && {
+            panelistEnabled: props.panelistEnabled ?? current?.panelistEnabled ?? false,
+            attendeeCount: props.attendeeCount ?? Boolean(current?.attendeeCount) ?? false,
+          }),
+        };
+      }
+
       return {
-        [control.scope]: control.properties,
+        [control.scope]: properties,
       };
     });
 

package/src/meeting/index.ts

@@ -1567,6 +1567,8 @@ export default class Meeting extends StatelessWebexPlugin {
     this.controlsOptionsManager = new ControlsOptionsManager(this.meetingRequest, {
       locusUrl: this.locusInfo?.url,
       displayHints: [],
+      getControls: () => this.locusInfo?.controls,
+      isWebinar: () => this.locusInfo?.info?.isWebinar,
     });
 
     this.setUpLocusInfoListeners();

package/test/unit/spec/controls-options-manager/index.js

@@ -319,6 +319,110 @@ describe('plugin-meetings', () => {
                     Util.canUpdate = restorable;
                   });
               });
+
+              describe('viewTheParticipantList fill-in', () => {
+                let restorable;
+
+                afterEach(() => {
+                  Util.canUpdate = restorable;
+                });
+
+                describe('when meeting is a webinar', () => {
+                  beforeEach(() => {
+                    restorable = Util.canUpdate;
+                    Util.canUpdate = sinon.stub().returns(true);
+                    manager.set({
+                      locusUrl: 'test/id',
+                      displayHints: [],
+                      getControls: () => ({viewTheParticipantList: {enabled: true, panelistEnabled: true, attendeeCount: true}}),
+                      isWebinar: () => true,
+                    });
+                  });
+
+                  it('should fill in all undefined properties from current state', () => {
+                    const control = {scope: 'viewTheParticipantList', properties: {}};
+
+                    return manager.update(control).then(() => {
+                      assert.calledOnceWithExactly(request.locusDeltaRequest, {
+                        uri: 'test/id/controls',
+                        body: {
+                          viewTheParticipantList: {enabled: true, panelistEnabled: true, attendeeCount: true},
+                        },
+                        method: HTTP_VERBS.PATCH,
+                      });
+                    });
+                  });
+
+                  it('should keep explicitly provided properties and fill in the rest', () => {
+                    const control = {scope: 'viewTheParticipantList', properties: {enabled: false}};
+
+                    return manager.update(control).then(() => {
+                      assert.calledOnceWithExactly(request.locusDeltaRequest, {
+                        uri: 'test/id/controls',
+                        body: {
+                          viewTheParticipantList: {enabled: false, panelistEnabled: true, attendeeCount: true},
+                        },
+                        method: HTTP_VERBS.PATCH,
+                      });
+                    });
+                  });
+
+                  it('should not fill in properties when all are explicitly provided', () => {
+                    const control = {scope: 'viewTheParticipantList', properties: {enabled: false, panelistEnabled: false, attendeeCount: false}};
+
+                    return manager.update(control).then(() => {
+                      assert.calledOnceWithExactly(request.locusDeltaRequest, {
+                        uri: 'test/id/controls',
+                        body: {
+                          viewTheParticipantList: {enabled: false, panelistEnabled: false, attendeeCount: false},
+                        },
+                        method: HTTP_VERBS.PATCH,
+                      });
+                    });
+                  });
+                });
+
+                describe('when meeting is not a webinar', () => {
+                  beforeEach(() => {
+                    restorable = Util.canUpdate;
+                    Util.canUpdate = sinon.stub().returns(true);
+                    manager.set({
+                      locusUrl: 'test/id',
+                      displayHints: [],
+                      getControls: () => ({viewTheParticipantList: {enabled: true, panelistEnabled: true, attendeeCount: true}}),
+                      isWebinar: () => false,
+                    });
+                  });
+
+                  it('should only send enabled property', () => {
+                    const control = {scope: 'viewTheParticipantList', properties: {}};
+
+                    return manager.update(control).then(() => {
+                      assert.calledOnceWithExactly(request.locusDeltaRequest, {
+                        uri: 'test/id/controls',
+                        body: {
+                          viewTheParticipantList: {enabled: true},
+                        },
+                        method: HTTP_VERBS.PATCH,
+                      });
+                    });
+                  });
+
+                  it('should not include panelistEnabled or attendeeCount even if explicitly provided', () => {
+                    const control = {scope: 'viewTheParticipantList', properties: {enabled: false, panelistEnabled: true, attendeeCount: true}};
+
+                    return manager.update(control).then(() => {
+                      assert.calledOnceWithExactly(request.locusDeltaRequest, {
+                        uri: 'test/id/controls',
+                        body: {
+                          viewTheParticipantList: {enabled: false},
+                        },
+                        method: HTTP_VERBS.PATCH,
+                      });
+                    });
+                  });
+                });
+              });
             });
 
             describe('Mute/Unmute All', () => {