@webex/plugin-meetings 3.0.0-beta.144 → 3.0.0-beta.146

package/src/annotation/annotation.types.ts

@@ -1,3 +1,5 @@
+import {ANNOTATION_POLICY} from './constants';
+
 /**
  * Type for an StrokeData Object
  */
@@ -23,6 +25,13 @@ type CommandRequestBody = {
   shareInstanceId: string;
   receivers?: any[];
 };
+/**
+ * Type for an annotation Object include annotation version and privilege
+ */
+type AnnotationInfo = {
+  version: string;
+  policy: ANNOTATION_POLICY;
+};
 
 interface IAnnotationChannel {
   // === below is for presenter
@@ -40,4 +49,4 @@ interface IAnnotationChannel {
   locusUrlUpdate: (locusUrl: string) => void;
 }
 
-export type {StrokeData, RequestData, CommandRequestBody, IAnnotationChannel};
+export type {StrokeData, RequestData, CommandRequestBody, IAnnotationChannel, AnnotationInfo};

package/src/annotation/constants.ts

@@ -12,11 +12,11 @@ export const ANNOTATION_STATUS = {
   RUNNING_ANNOTATION: 'RUNNING_ANNOTATION',
 };
 
-export const ANNOTATION_POLICY = {
-  ANYONE_CAN_ANNOTATE: 'AnyoneCanAnnotate',
-  APPROVAL: 'Approval',
-  ANNOTATION_NOT_ALLOWED: 'AnnotationNotAllowed',
-};
+export enum ANNOTATION_POLICY {
+  ANYONE_CAN_ANNOTATE = 'AnyoneCanAnnotate',
+  APPROVAL = 'Approval',
+  ANNOTATION_NOT_ALLOWED = 'AnnotationNotAllowed',
+}
 
 export const ANNOTATION_REQUEST_TYPE = {
   ANNOTATION_MESSAGE: 'annotation_message',

package/src/constants.ts

@@ -842,6 +842,7 @@ export const DISPLAY_HINTS = {
 
   // breakout session
   BREAKOUT_MANAGEMENT: 'BREAKOUT_MANAGEMENT',
+  BROADCAST_MESSAGE_TO_BREAKOUT: 'BROADCAST_MESSAGE_TO_BREAKOUT',
   UCF_SUPPRESS_BREAKOUTS_SUPPORT: 'UCF_SUPPRESS_BREAKOUTS_SUPPORT',
   DISABLE_ASK_FOR_HELP: 'DISABLE_ASK_FOR_HELP',
   DISABLE_BREAKOUT_PREASSIGNMENTS: 'DISABLE_BREAKOUT_PREASSIGNMENTS',

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

@@ -42,6 +42,7 @@ interface IInMeetingActions {
   waitingForOthersToJoin?: boolean;
   canSendReactions?: boolean;
   canManageBreakout?: boolean;
+  canBroadcastMessageToBreakout?: boolean;
   canAdmitLobbyToBreakout?: boolean;
   isBreakoutPreassignmentsEnabled?: boolean;
   canUserAskForHelp?: boolean;
@@ -143,6 +144,8 @@ export default class InMeetingActions implements IInMeetingActions {
 
   canManageBreakout = null;
 
+  canBroadcastMessageToBreakout = null;
+
   canAdmitLobbyToBreakout = null;
 
   isBreakoutPreassignmentsEnabled = null;
@@ -235,6 +238,7 @@ export default class InMeetingActions implements IInMeetingActions {
     waitingForOthersToJoin: this.waitingForOthersToJoin,
     canSendReactions: this.canSendReactions,
     canManageBreakout: this.canManageBreakout,
+    canBroadcastMessageToBreakout: this.canBroadcastMessageToBreakout,
     canAdmitLobbyToBreakout: this.canAdmitLobbyToBreakout,
     isBreakoutPreassignmentsEnabled: this.isBreakoutPreassignmentsEnabled,
     canUserAskForHelp: this.canUserAskForHelp,

package/src/meeting/index.ts

@@ -124,6 +124,7 @@ import RecordingController from '../recording-controller';
 import ControlsOptionsManager from '../controls-options-manager';
 import PermissionError from '../common/errors/permission';
 import {LocusMediaRequest} from './locusMediaRequest';
+import {AnnotationInfo} from '../annotation/annotation.types';
 
 const {isBrowser} = BrowserDetection();
 
@@ -537,6 +538,7 @@ export default class Meeting extends StatelessWebexPlugin {
   roles: any[];
   environment: string;
   namespace = MEETINGS;
+  annotationInfo: AnnotationInfo;
 
   /**
    * @param {Object} attrs
@@ -2588,6 +2590,9 @@ export default class Meeting extends StatelessWebexPlugin {
             payload.info.userDisplayHints
           ),
           canManageBreakout: MeetingUtil.canManageBreakout(payload.info.userDisplayHints),
+          canBroadcastMessageToBreakout: MeetingUtil.canBroadcastMessageToBreakout(
+            payload.info.userDisplayHints
+          ),
           canAdmitLobbyToBreakout: MeetingUtil.canAdmitLobbyToBreakout(
             payload.info.userDisplayHints
           ),
@@ -6580,6 +6585,7 @@ export default class Meeting extends StatelessWebexPlugin {
           deviceUrl: this.deviceUrl,
           uri: content.url,
           resourceUrl: this.resourceUrl,
+          annotationInfo: this.annotationInfo,
         })
         .then(() => {
           this.isSharing = true;
@@ -7697,13 +7703,14 @@ export default class Meeting extends StatelessWebexPlugin {
       audio?: LocalTrack; // todo: for now screen share audio is not supported (will be done in SPARK-399690)
       video?: LocalDisplayTrack;
     };
+    annotationInfo?: AnnotationInfo;
   }): Promise<void> {
     this.checkMediaConnection();
 
     if (!this.isMultistream) {
       throw new Error('publishTracks() only supported with multistream');
     }
-
+    this.annotationInfo = tracks.annotationInfo;
     if (tracks.screenShare?.video) {
       const oldTrack = this.mediaProperties.shareTrack;
       const localDisplayTrack = tracks.screenShare?.video;

package/src/meeting/request.ts

@@ -29,6 +29,7 @@ import {
 } from '../constants';
 import {SendReactionOptions, ToggleReactionsOptions} from './request.type';
 import MeetingUtil from './util';
+import {AnnotationInfo} from '../annotation/annotation.types';
 
 /**
  * @class MeetingRequest
@@ -630,7 +631,7 @@ export default class MeetingRequest extends StatelessWebexPlugin {
           deviceUrl: string;
           resourceId: string;
           uri: string;
-          annotation: any;
+          annotationInfo: AnnotationInfo;
         }
       | any
   ) {
@@ -664,8 +665,8 @@ export default class MeetingRequest extends StatelessWebexPlugin {
     if (options?.resourceToken) {
       body.resourceToken = options?.resourceToken;
     }
-    if (options?.annotation) {
-      body.annotation = options?.annotation;
+    if (options?.annotationInfo) {
+      body.annotation = options?.annotationInfo;
     }
 
     // @ts-ignore

package/src/meeting/util.ts

@@ -365,6 +365,8 @@ const MeetingUtil = {
     displayHints.includes(DISPLAY_HINTS.LEAVE_END_MEETING),
 
   canManageBreakout: (displayHints) => displayHints.includes(DISPLAY_HINTS.BREAKOUT_MANAGEMENT),
+  canBroadcastMessageToBreakout: (displayHints) =>
+    displayHints.includes(DISPLAY_HINTS.BROADCAST_MESSAGE_TO_BREAKOUT),
 
   isSuppressBreakoutSupport: (displayHints) =>
     displayHints.includes(DISPLAY_HINTS.UCF_SUPPRESS_BREAKOUTS_SUPPORT),

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

@@ -38,6 +38,7 @@ describe('plugin-meetings', () => {
         waitingForOthersToJoin: null,
         canSendReactions: null,
         canManageBreakout: null,
+        canBroadcastMessageToBreakout: null,
         canAdmitLobbyToBreakout: null,
         canUserAskForHelp: null,
         canUserRenameSelfAndObserved: null,
@@ -108,6 +109,7 @@ describe('plugin-meetings', () => {
       'waitingForOthersToJoin',
       'canSendReactions',
       'canManageBreakout',
+      'canBroadcastMessageToBreakout',
       'canAdmitLobbyToBreakout',
       'canUserAskForHelp',
       'canUserRenameSelfAndObserved',

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

@@ -86,6 +86,7 @@ import {
   MeetingInfoV2PasswordError,
   MeetingInfoV2PolicyError,
 } from '../../../../src/meeting-info/meeting-info-v2';
+import {ANNOTATION_POLICY} from "../../../../src/annotation/constants";
 
 const {getBrowserName, getOSVersion} = BrowserDetection();
 
@@ -4130,6 +4131,14 @@ describe('plugin-meetings', () => {
             checkScreenShareVideoPublished(videoShareTrack);
           });
         });
+        it('creates instance and publishes with annotation info', async () => {
+          const annotationInfo = {
+            version: '1',
+            policy: ANNOTATION_POLICY.APPROVAL,
+          };
+          await meeting.publishTracks({annotationInfo});
+          assert.equal(meeting.annotationInfo, annotationInfo);
+        });
 
         describe('unpublishTracks', () => {
           beforeEach(async () => {

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

@@ -560,13 +560,13 @@ describe('plugin-meetings', () => {
       const deviceUrl = 'deviceUrl';
       const locusUrl = 'locusUrl';
       meetingsRequest.config.meetings.deviceType = 'deviceType';
-  
+
       await meetingsRequest.declineMeeting({
         locusUrl,
         deviceUrl,
         reason
       });
-  
+
       const expectedBody = {
         device: {
           deviceType: 'deviceType',
@@ -574,7 +574,7 @@ describe('plugin-meetings', () => {
         },
         reason,
       };
-  
+
       checkRequest({
         method: 'PUT',
         uri: `${locusUrl}/participant/decline`,
@@ -606,7 +606,7 @@ describe('plugin-meetings', () => {
         resourceId: 'resourceId',
         resourceUrl: 'resourceUrl',
         uri: 'optionsUrl',
-        annotation:{
+        annotationInfo:{
           version: '1',
           policy: 'Approval',
         },

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

@@ -590,6 +590,13 @@ describe('plugin-meetings', () => {
       });
     });
 
+    describe('canBroadcastMessageToBreakout', () => {
+      it('works as expected', () => {
+        assert.deepEqual(MeetingUtil.canBroadcastMessageToBreakout(['BROADCAST_MESSAGE_TO_BREAKOUT']), true);
+        assert.deepEqual(MeetingUtil.canBroadcastMessageToBreakout([]), false);
+      });
+    });
+
     describe('isSuppressBreakoutSupport', () => {
       it('works as expected', () => {
         assert.deepEqual(