@webex/plugin-meetings 3.8.0-next.37 → 3.8.0-next.39

package/src/locus-info/index.ts

@@ -817,6 +817,8 @@ export default class LocusInfo extends EventsScope {
           hasMeetingFullChanged,
           hasPracticeSessionEnabledChanged,
           hasStageViewChanged,
+          hasAnnotationControlChanged,
+          hasRemoteDesktopControlChanged,
         },
         current,
       } = ControlsUtils.getControls(this.controls, controls);
@@ -1052,6 +1054,22 @@ export default class LocusInfo extends EventsScope {
         );
       }
 
+      if (hasAnnotationControlChanged) {
+        this.emitScoped(
+          {file: 'locus-info', function: 'updateControls'},
+          LOCUSINFO.EVENTS.CONTROLS_ANNOTATION_CHANGED,
+          {state: current.annotationControl}
+        );
+      }
+
+      if (hasRemoteDesktopControlChanged) {
+        this.emitScoped(
+          {file: 'locus-info', function: 'updateControls'},
+          LOCUSINFO.EVENTS.CONTROLS_REMOTE_DESKTOP_CONTROL_CHANGED,
+          {state: current.rdcControl}
+        );
+      }
+
       this.controls = controls;
     }
   }

package/src/meeting/in-meeting-actions.ts

@@ -99,6 +99,10 @@ interface IInMeetingActions {
   isPracticeSessionOff?: boolean;
   canStartPracticeSession?: boolean;
   canStopPracticeSession?: boolean;
+  canEnableAnnotation?: boolean;
+  canDisableAnnotation?: boolean;
+  canEnableRemoteDesktopControl?: boolean;
+  canDisableRemoteDesktopControl?: boolean;
 }
 
 /**
@@ -285,6 +289,14 @@ export default class InMeetingActions implements IInMeetingActions {
 
   canStopPracticeSession = null;
 
+  canEnableAnnotation = null;
+
+  canDisableAnnotation = null;
+
+  canEnableRemoteDesktopControl = null;
+
+  canDisableRemoteDesktopControl = null;
+
   /**
    * Returns all meeting action options
    * @returns {Object}
@@ -379,6 +391,10 @@ export default class InMeetingActions implements IInMeetingActions {
     isPracticeSessionOff: this.isPracticeSessionOff,
     canStartPracticeSession: this.canStartPracticeSession,
     canStopPracticeSession: this.canStopPracticeSession,
+    canEnableAnnotation: this.canEnableAnnotation,
+    canDisableAnnotation: this.canDisableAnnotation,
+    canEnableRemoteDesktopControl: this.canEnableRemoteDesktopControl,
+    canDisableRemoteDesktopControl: this.canDisableRemoteDesktopControl,
   });
 
   /**

package/src/meeting/index.ts

@@ -2871,6 +2871,24 @@ export default class Meeting extends StatelessWebexPlugin {
         {state}
       );
     });
+
+    this.locusInfo.on(LOCUSINFO.EVENTS.CONTROLS_ANNOTATION_CHANGED, ({state}) => {
+      Trigger.trigger(
+        this,
+        {file: 'meeting/index', function: 'setupLocusControlsListener'},
+        EVENT_TRIGGERS.MEETING_CONTROLS_ANNOTATION_UPDATED,
+        {state}
+      );
+    });
+
+    this.locusInfo.on(LOCUSINFO.EVENTS.CONTROLS_REMOTE_DESKTOP_CONTROL_CHANGED, ({state}) => {
+      Trigger.trigger(
+        this,
+        {file: 'meeting/index', function: 'setupLocusControlsListener'},
+        EVENT_TRIGGERS.MEETING_CONTROLS_REMOTE_DESKTOP_CONTROL_UPDATED,
+        {state}
+      );
+    });
   }
 
   /**
@@ -4269,6 +4287,22 @@ export default class Meeting extends StatelessWebexPlugin {
             requiredPolicies: [SELF_POLICY.SUPPORT_ANNOTATION],
             policies: this.selfUserPolicies,
           }),
+          canEnableAnnotation: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.ENABLE_ANNOTATION_MEETING_OPTION],
+            displayHints: this.userDisplayHints,
+          }),
+          canDisableAnnotation: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.DISABLE_ANNOTATION_MEETING_OPTION],
+            displayHints: this.userDisplayHints,
+          }),
+          canEnableRemoteDesktopControl: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.ENABLE_RDC_MEETING_OPTION],
+            displayHints: this.userDisplayHints,
+          }),
+          canDisableRemoteDesktopControl: ControlsOptionsUtil.hasHints({
+            requiredHints: [DISPLAY_HINTS.DISABLE_RDC_MEETING_OPTION],
+            displayHints: this.userDisplayHints,
+          }),
         }) || changed;
     }
     if (changed) {

package/src/meeting/util.ts

@@ -575,7 +575,8 @@ const MeetingUtil = {
 
   canUserRenameOthers: (displayHints) => displayHints.includes(DISPLAY_HINTS.CAN_RENAME_OTHERS),
 
-  canShareWhiteBoard: (displayHints, policies) =>
+  // Default empty value for policies if we get an undefined value (ie permissionToken is not available)
+  canShareWhiteBoard: (displayHints, policies = {}) =>
     displayHints.includes(DISPLAY_HINTS.SHARE_WHITEBOARD) &&
     !!policies[SELF_POLICY.SUPPORT_WHITEBOARD],
 

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

@@ -406,6 +406,74 @@ describe('plugin-meetings', () => {
         });
       });
 
+      describe('canUpdateAnnotation()', () => {
+        beforeEach(() => {
+          sinon.stub(ControlsOptionsUtil, 'hasHints').returns(true);
+        });
+
+        it('should call hasHints() with proper hints when `enabled` is true', () => {
+          ControlsOptionsUtil.canUpdateAnnotation({properties: {enabled: true}}, []);
+
+          assert.calledWith(ControlsOptionsUtil.hasHints, {
+            requiredHints: [DISPLAY_HINTS.ENABLE_ANNOTATION_MEETING_OPTION],
+            displayHints: [],
+          });
+        });
+
+        it('should call hasHints() with proper hints when `enabled` is false', () => {
+          ControlsOptionsUtil.canUpdateAnnotation({properties: {enabled: false}}, []);
+
+          assert.calledWith(ControlsOptionsUtil.hasHints, {
+            requiredHints: [DISPLAY_HINTS.DISABLE_ANNOTATION_MEETING_OPTION],
+            displayHints: [],
+          });
+        });
+
+        it('should return the resolution of hasHints()', () => {
+          const expected = 'example-return-value';
+          ControlsOptionsUtil.hasHints.returns(expected);
+
+          const results = ControlsOptionsUtil.canUpdateAnnotation({properties: {}}, []);
+
+          assert.calledOnce(ControlsOptionsUtil.hasHints);
+          assert.equal(results, expected);
+        });
+      });
+
+      describe('canUpdateRemoteDesktopControl()', () => {
+        beforeEach(() => {
+          sinon.stub(ControlsOptionsUtil, 'hasHints').returns(true);
+        });
+
+        it('should call hasHints() with proper hints when `enabled` is true', () => {
+          ControlsOptionsUtil.canUpdateRemoteDesktopControl({properties: {enabled: true}}, []);
+
+          assert.calledWith(ControlsOptionsUtil.hasHints, {
+            requiredHints: [DISPLAY_HINTS.ENABLE_RDC_MEETING_OPTION],
+            displayHints: [],
+          });
+        });
+
+        it('should call hasHints() with proper hints when `enabled` is false', () => {
+          ControlsOptionsUtil.canUpdateRemoteDesktopControl({properties: {enabled: false}}, []);
+
+          assert.calledWith(ControlsOptionsUtil.hasHints, {
+            requiredHints: [DISPLAY_HINTS.DISABLE_RDC_MEETING_OPTION],
+            displayHints: [],
+          });
+        });
+
+        it('should return the resolution of hasHints()', () => {
+          const expected = 'example-return-value';
+          ControlsOptionsUtil.hasHints.returns(expected);
+
+          const results = ControlsOptionsUtil.canUpdateRemoteDesktopControl({properties: {}}, []);
+
+          assert.calledOnce(ControlsOptionsUtil.hasHints);
+          assert.equal(results, expected);
+        });
+      });
+
       describe('canUpdate()', () => {
         const displayHints = [];
 
@@ -416,6 +484,8 @@ describe('plugin-meetings', () => {
           ControlsOptionsUtil.canUpdateShareControl = sinon.stub().returns(true);
           ControlsOptionsUtil.canUpdateVideo = sinon.stub().returns(true);
           ControlsOptionsUtil.canUpdateViewTheParticipantsList = sinon.stub().returns(true);
+          ControlsOptionsUtil.canUpdateAnnotation = sinon.stub().returns(true);
+          ControlsOptionsUtil.canUpdateRemoteDesktopControl = sinon.stub().returns(true);
         });
 
         it('should only call canUpdateAudio() if the scope is audio', () => {
@@ -429,6 +499,8 @@ describe('plugin-meetings', () => {
           assert.callCount(ControlsOptionsUtil.canUpdateShareControl, 0);
           assert.callCount(ControlsOptionsUtil.canUpdateVideo, 0);
           assert.callCount(ControlsOptionsUtil.canUpdateViewTheParticipantsList, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateAnnotation, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateRemoteDesktopControl, 0);
           assert.isTrue(results);
         });
 
@@ -443,6 +515,8 @@ describe('plugin-meetings', () => {
           assert.callCount(ControlsOptionsUtil.canUpdateShareControl, 0);
           assert.callCount(ControlsOptionsUtil.canUpdateVideo, 0);
           assert.callCount(ControlsOptionsUtil.canUpdateViewTheParticipantsList, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateAnnotation, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateRemoteDesktopControl, 0);
           assert.isTrue(results);
         });
 
@@ -457,6 +531,8 @@ describe('plugin-meetings', () => {
           assert.callCount(ControlsOptionsUtil.canUpdateShareControl, 0);
           assert.callCount(ControlsOptionsUtil.canUpdateVideo, 0);
           assert.callCount(ControlsOptionsUtil.canUpdateViewTheParticipantsList, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateAnnotation, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateRemoteDesktopControl, 0);
           assert.isTrue(results);
         });
 
@@ -471,6 +547,8 @@ describe('plugin-meetings', () => {
           assert.calledWith(ControlsOptionsUtil.canUpdateShareControl, displayHints);
           assert.callCount(ControlsOptionsUtil.canUpdateVideo, 0);
           assert.callCount(ControlsOptionsUtil.canUpdateViewTheParticipantsList, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateAnnotation, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateRemoteDesktopControl, 0);
           assert.isTrue(results);
         });
 
@@ -485,6 +563,8 @@ describe('plugin-meetings', () => {
           assert.callCount(ControlsOptionsUtil.canUpdateShareControl, 0);
           assert.calledWith(ControlsOptionsUtil.canUpdateVideo, control, displayHints);
           assert.callCount(ControlsOptionsUtil.canUpdateViewTheParticipantsList, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateAnnotation, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateRemoteDesktopControl, 0);
           assert.isTrue(results);
         });
 
@@ -503,6 +583,44 @@ describe('plugin-meetings', () => {
             control,
             displayHints
           );
+          assert.callCount(ControlsOptionsUtil.canUpdateAnnotation, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateRemoteDesktopControl, 0);
+          assert.isTrue(results);
+        });
+
+        it('should only call canUpdateAnnotation() if the scope is annotation', () => {
+          const control = {scope: 'annotation'};
+
+          const results = ControlsOptionsUtil.canUpdate(control, displayHints);
+
+          assert.callCount(ControlsOptionsUtil.canUpdateAudio, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateRaiseHand, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateReactions, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateShareControl, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateVideo, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateViewTheParticipantsList, 0);
+          assert.calledWith(ControlsOptionsUtil.canUpdateAnnotation, control, displayHints);
+          assert.callCount(ControlsOptionsUtil.canUpdateRemoteDesktopControl, 0);
+          assert.isTrue(results);
+        });
+
+        it('should only call canUpdateRemoteDesktopControl() if the scope is rdc', () => {
+          const control = {scope: 'rdc'};
+
+          const results = ControlsOptionsUtil.canUpdate(control, displayHints);
+
+          assert.callCount(ControlsOptionsUtil.canUpdateAudio, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateRaiseHand, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateReactions, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateShareControl, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateVideo, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateViewTheParticipantsList, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateAnnotation, 0);
+          assert.calledWith(
+            ControlsOptionsUtil.canUpdateRemoteDesktopControl,
+            control,
+            displayHints
+          );
           assert.isTrue(results);
         });
 
@@ -517,6 +635,8 @@ describe('plugin-meetings', () => {
           assert.callCount(ControlsOptionsUtil.canUpdateShareControl, 0);
           assert.callCount(ControlsOptionsUtil.canUpdateVideo, 0);
           assert.callCount(ControlsOptionsUtil.canUpdateViewTheParticipantsList, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateAnnotation, 0);
+          assert.callCount(ControlsOptionsUtil.canUpdateRemoteDesktopControl, 0);
           assert.isFalse(results);
         });
       });

package/test/unit/spec/locus-info/controlsUtils.js

@@ -144,7 +144,25 @@ describe('plugin-meetings', () => {
         assert.equal(parsedControls.videoLayout.overrideDefault, newControls.videoLayout.overrideDefault);
         assert.equal(parsedControls.videoLayout.lockAttendeeViewOnStageOnly, newControls.videoLayout.lockAttendeeViewOnStageOnly);
         assert.equal(parsedControls.videoLayout.stageParameters, newControls.videoLayout.stageParameters);
+      });
+
+      it('should parse the annotationControl control', () => {
+        const newControls = {annotationControl: {enabled: true}};
+
+        const parsedControls = ControlsUtils.parse(newControls);
 
+        assert.equal(
+          parsedControls.annotationControl.enabled,
+          newControls.annotationControl.enabled
+        );
+      });
+
+      it('should parse the rdcControl control', () => {
+        const newControls = {rdcControl: {enabled: true}};
+
+        const parsedControls = ControlsUtils.parse(newControls);
+
+        assert.equal(parsedControls.rdcControl.enabled, newControls.rdcControl.enabled);
       });
 
       describe('videoEnabled', () => {
@@ -377,6 +395,22 @@ describe('plugin-meetings', () => {
         assert.equal(updates.hasManualCaptionChanged, false);
       });
 
+      it('returns hasAnnotationControlChanged = true when changed', () => {
+        const newControls = {annotationControl: {enabled: true}};
+
+        const {updates} = ControlsUtils.getControls(defaultControls, newControls);
+
+        assert.equal(updates.hasAnnotationControlChanged, true);
+      });
+
+      it('returns hasRemoteDesktopControlChanged = true when changed', () => {
+        const newControls = {rdcControl: {enabled: true}};
+
+        const {updates} = ControlsUtils.getControls(defaultControls, newControls);
+
+        assert.equal(updates.hasRemoteDesktopControlChanged, true);
+      });
+
       describe('videoEnabled', () => {
         const testVideoEnabled = (oldControls, newControls, updatedProperty) => {
           const result = ControlsUtils.getControls(oldControls, newControls);
@@ -464,31 +498,31 @@ describe('plugin-meetings', () => {
           self: { isCreator: true },
           controls: { breakout: { sessionType: BREAKOUTS.SESSION_TYPES.MAIN} },
         };
-    
+
         const newLocus = {
           participants: [
-            { isCreator: true, state: MEETING_STATE.STATES.JOINED }, 
+            { isCreator: true, state: MEETING_STATE.STATES.JOINED },
           ],
           controls: {
             breakout: {
-              sessionType: BREAKOUTS.SESSION_TYPES.MAIN, 
-              groups: [{ id: 'group1' }] 
+              sessionType: BREAKOUTS.SESSION_TYPES.MAIN,
+              groups: [{ id: 'group1' }]
             },
           },
         };
-    
+
         assert.deepEqual(controlsUtils.getSessionSwitchStatus(oldLocus, newLocus), {
-          isReturnToMain: true, 
+          isReturnToMain: true,
           isJoinToBreakout: false
         });
       });
-    
+
       it('if needUseCache conditions are not met, return newLocus and isReturnToMain as false', () => {
         const oldLocus = {
-          self: { isCreator: false }, 
+          self: { isCreator: false },
           controls: { breakout: { sessionType: BREAKOUTS.SESSION_TYPES.BREAKOUT} },
         };
-    
+
         const newLocus = {
           participants: [
             { isCreator: true, state: MEETING_STATE.STATES.JOINED },
@@ -496,13 +530,13 @@ describe('plugin-meetings', () => {
           controls: {
             breakout: {
               sessionType: BREAKOUTS.SESSION_TYPES.BREAKOUT,
-              groups: [] 
+              groups: []
             },
           },
         };
-    
+
         assert.deepEqual(controlsUtils.getSessionSwitchStatus(oldLocus, newLocus), {
-          isReturnToMain: false, 
+          isReturnToMain: false,
           isJoinToBreakout: false
         });
       });

package/test/unit/spec/locus-info/index.js

@@ -111,6 +111,8 @@ describe('plugin-meetings', () => {
           },
           webcastControl: {streaming: false},
           practiceSession: {enabled: true},
+          annotationControl: {enabled: true},
+          rdcControl: {enabled: true},
         };
       });
 
@@ -278,6 +280,32 @@ describe('plugin-meetings', () => {
         });
       });
 
+      it('should trigger the CONTROLS_ANNOTATION_CHANGED event when necessary', () => {
+        locusInfo.controls = {};
+        locusInfo.emitScoped = sinon.stub();
+        locusInfo.updateControls(newControls);
+
+        assert.calledWith(
+          locusInfo.emitScoped,
+          {file: 'locus-info', function: 'updateControls'},
+          LOCUSINFO.EVENTS.CONTROLS_ANNOTATION_CHANGED,
+          {state: newControls.annotationControl}
+        );
+      });
+
+      it('should trigger the CONTROLS_REMOTE_DESKTOP_CONTROL_CHANGED event when necessary', () => {
+        locusInfo.controls = {};
+        locusInfo.emitScoped = sinon.stub();
+        locusInfo.updateControls(newControls);
+
+        assert.calledWith(
+          locusInfo.emitScoped,
+          {file: 'locus-info', function: 'updateControls'},
+          LOCUSINFO.EVENTS.CONTROLS_REMOTE_DESKTOP_CONTROL_CHANGED,
+          {state: newControls.rdcControl}
+        );
+      });
+
       it('should keep the recording state to `IDLE`', () => {
         locusInfo.controls = {
           record: {

package/test/unit/spec/meeting/in-meeting-actions.ts

@@ -94,6 +94,10 @@ describe('plugin-meetings', () => {
         isPracticeSessionOff : null,
         canStartPracticeSession: null,
         canStopPracticeSession: null,
+        canEnableAnnotation: null,
+        canDisableAnnotation: null,
+        canEnableRemoteDesktopControl: null,
+        canDisableRemoteDesktopControl: null,
 
         ...expected,
       };
@@ -194,7 +198,10 @@ describe('plugin-meetings', () => {
       'isPracticeSessionOff',
       'canStartPracticeSession',
       'canStopPracticeSession',
-
+      'canEnableAnnotation',
+      'canDisableAnnotation',
+      'canEnableRemoteDesktopControl',
+      'canDisableRemoteDesktopControl',
   ].forEach((key) => {
       it(`get and set for ${key} work as expected`, () => {
         const inMeetingActions = new InMeetingActions();

package/test/unit/spec/meeting/index.js

@@ -9791,6 +9791,42 @@ describe('plugin-meetings', () => {
           );
         });
 
+        it('listens to CONTROLS_ANNOTATION_CHANGED', async () => {
+          const state = {example: 'value'};
+
+          await meeting.locusInfo.emitScoped(
+            {function: 'test', file: 'test'},
+            LOCUSINFO.EVENTS.CONTROLS_ANNOTATION_CHANGED,
+            {state}
+          );
+
+          assert.calledWith(
+            TriggerProxy.trigger,
+            meeting,
+            {file: 'meeting/index', function: 'setupLocusControlsListener'},
+            EVENT_TRIGGERS.MEETING_CONTROLS_ANNOTATION_UPDATED,
+            {state}
+          );
+        });
+
+        it('listens to CONTROLS_REMOTE_DESKTOP_CONTROL_CHANGED', async () => {
+          const state = {example: 'value'};
+
+          await meeting.locusInfo.emitScoped(
+            {function: 'test', file: 'test'},
+            LOCUSINFO.EVENTS.CONTROLS_REMOTE_DESKTOP_CONTROL_CHANGED,
+            {state}
+          );
+
+          assert.calledWith(
+            TriggerProxy.trigger,
+            meeting,
+            {file: 'meeting/index', function: 'setupLocusControlsListener'},
+            EVENT_TRIGGERS.MEETING_CONTROLS_REMOTE_DESKTOP_CONTROL_UPDATED,
+            {state}
+          );
+        });
+
         it('listens to the locus interpretation update event', () => {
           const interpretation = {
             siLanguages: [{languageCode: 20, languageName: 'en'}],
@@ -11348,6 +11384,22 @@ describe('plugin-meetings', () => {
             requiredPolicies: [SELF_POLICY.SUPPORT_VOIP],
             policies: selfUserPolicies,
           });
+          assert.calledWith(ControlsOptionsUtil.hasHints, {
+            requiredHints: [DISPLAY_HINTS.ENABLE_ANNOTATION_MEETING_OPTION],
+            displayHints: userDisplayHints,
+          });
+          assert.calledWith(ControlsOptionsUtil.hasHints, {
+            requiredHints: [DISPLAY_HINTS.DISABLE_ANNOTATION_MEETING_OPTION],
+            displayHints: userDisplayHints,
+          });
+          assert.calledWith(ControlsOptionsUtil.hasHints, {
+            requiredHints: [DISPLAY_HINTS.ENABLE_RDC_MEETING_OPTION],
+            displayHints: userDisplayHints,
+          });
+          assert.calledWith(ControlsOptionsUtil.hasHints, {
+            requiredHints: [DISPLAY_HINTS.DISABLE_RDC_MEETING_OPTION],
+            displayHints: userDisplayHints,
+          });
 
           assert.calledWith(
             TriggerProxy.trigger,

package/test/unit/spec/meeting/utils.js

@@ -777,6 +777,10 @@ describe('plugin-meetings', () => {
           }),
           false
         );
+        assert.deepEqual(
+          MeetingUtil.canShareWhiteBoard(['SHARE_WHITEBOARD'], undefined),
+          false
+        );
       });
     });