@webex/plugin-meetings 3.0.0-beta.13 → 3.0.0-beta.131

package/src/member/types.ts

@@ -0,0 +1,24 @@
+export interface IExternalRoles {
+  cohost: boolean;
+  moderator: boolean;
+  presenter: boolean;
+}
+
+export enum ServerRoles {
+  Cohost = 'COHOST',
+  Moderator = 'MODERATOR',
+  Presenter = 'PRESENTER',
+}
+
+export type ServerRoleShape = {
+  type: ServerRoles;
+  hasRole: boolean;
+};
+
+export type ParticipantWithRoles = {
+  controls: {
+    role: {
+      roles: Array<ServerRoleShape>;
+    };
+  };
+};

package/src/member/util.ts

@@ -1,3 +1,4 @@
+import {IExternalRoles, ParticipantWithRoles, ServerRoles, ServerRoleShape} from './types';
 import {
   _USER_,
   _RESOURCE_ROOM_,
@@ -13,12 +14,64 @@ import {
   VIDEO_STATUS,
   _SEND_RECEIVE_,
   _RECEIVE_ONLY_,
-  _CALL_
+  _CALL_,
 } from '../constants';
 import ParameterError from '../common/errors/parameter';
 
 const MemberUtil: any = {};
 
+/**
+ * @param {Object} participant the locus participant
+ * @returns {[ServerRoleShape]}
+ */
+MemberUtil.getControlsRoles = (participant: ParticipantWithRoles): Array<ServerRoleShape> =>
+  participant?.controls?.role?.roles;
+
+/**
+ * @param {Object} participant the locus participant
+ * @param {ServerRoles} controlRole the search role
+ * @returns {Boolean}
+ */
+MemberUtil.hasRole = (participant: any, controlRole: ServerRoles): boolean =>
+  MemberUtil.getControlsRoles(participant)?.some(
+    (role) => role.type === controlRole && role.hasRole
+  );
+
+/**
+ * @param {Object} participant the locus participant
+ * @returns {Boolean}
+ */
+MemberUtil.hasCohost = (participant: ParticipantWithRoles): boolean =>
+  MemberUtil.hasRole(participant, ServerRoles.Cohost) || false;
+
+/**
+ * @param {Object} participant the locus participant
+ * @returns {Boolean}
+ */
+MemberUtil.hasModerator = (participant: ParticipantWithRoles): boolean =>
+  MemberUtil.hasRole(participant, ServerRoles.Moderator) || false;
+
+/**
+ * @param {Object} participant the locus participant
+ * @returns {Boolean}
+ */
+MemberUtil.hasPresenter = (participant: ParticipantWithRoles): boolean =>
+  MemberUtil.hasRole(participant, ServerRoles.Presenter) || false;
+
+/**
+ * @param {Object} participant the locus participant
+ * @returns {IExternalRoles}
+ */
+MemberUtil.extractControlRoles = (participant: ParticipantWithRoles): IExternalRoles => {
+  const roles = {
+    cohost: MemberUtil.hasCohost(participant),
+    moderator: MemberUtil.hasModerator(participant),
+    presenter: MemberUtil.hasPresenter(participant),
+  };
+
+  return roles;
+};
+
 /**
  * @param {Object} participant the locus participant
  * @returns {Boolean}
@@ -39,7 +92,8 @@ MemberUtil.isGuest = (participant: any) => participant && participant.guest;
  */
 MemberUtil.isDevice = (participant: any) => participant && participant.type === _RESOURCE_ROOM_;
 
-MemberUtil.isModeratorAssignmentProhibited = (participant) => participant && participant.moderatorAssignmentNotAllowed;
+MemberUtil.isModeratorAssignmentProhibited = (participant) =>
+  participant && participant.moderatorAssignmentNotAllowed;
 
 /**
  * checks to see if the participant id is the same as the passed id
@@ -48,8 +102,8 @@ MemberUtil.isModeratorAssignmentProhibited = (participant) => participant && par
  * @param {String} id
  * @returns {Boolean}
  */
-MemberUtil.isSame = (participant: any, id: string) => participant &&
-  (participant.id === id || participant.person && participant.person.id === id);
+MemberUtil.isSame = (participant: any, id: string) =>
+  participant && (participant.id === id || (participant.person && participant.person.id === id));
 
 /**
  * checks to see if the participant id is the same as the passed id for associated devices
@@ -58,9 +112,12 @@ MemberUtil.isSame = (participant: any, id: string) => participant &&
  * @param {String} id
  * @returns {Boolean}
  */
-MemberUtil.isAssociatedSame = (participant: any, id: string) => participant &&
-participant.associatedUsers &&
-participant.associatedUsers.some((user) => (user.id === id || user.person && user.person.id === id));
+MemberUtil.isAssociatedSame = (participant: any, id: string) =>
+  participant &&
+  participant.associatedUsers &&
+  participant.associatedUsers.some(
+    (user) => user.id === id || (user.person && user.person.id === id)
+  );
 
 /**
  * @param {Object} participant the locus participant
@@ -68,11 +125,18 @@ participant.associatedUsers.some((user) => (user.id === id || user.person && use
  * @param {String} status
  * @returns {Boolean}
  */
-MemberUtil.isNotAdmitted = (participant: any, isGuest: boolean, status: string) => participant &&
-  participant.guest && ((participant.devices && participant.devices[0] &&
-  participant.devices[0].intent && participant.devices[0].intent.type === _WAIT_ &&
-  // @ts-ignore
-  isGuest && status === _IN_LOBBY_) || !status === _IN_MEETING_);
+MemberUtil.isNotAdmitted = (participant: any, isGuest: boolean, status: string): boolean =>
+  participant &&
+  participant.guest &&
+  ((participant.devices &&
+    participant.devices[0] &&
+    participant.devices[0].intent &&
+    participant.devices[0].intent.type === _WAIT_ &&
+    // @ts-ignore
+    isGuest &&
+    status === _IN_LOBBY_) ||
+    // @ts-ignore
+    !status === _IN_MEETING_);
 
 /**
  * @param {Object} participant the locus participant
@@ -120,6 +184,32 @@ MemberUtil.isHandRaised = (participant: any) => {
   return participant.controls?.hand?.raised || false;
 };
 
+/**
+ * @param {Object} participant the locus participant
+ * @returns {Boolean}
+ */
+MemberUtil.isBreakoutsSupported = (participant) => {
+  if (!participant) {
+    throw new ParameterError('Breakout support could not be processed, participant is undefined.');
+  }
+
+  return !participant.doesNotSupportBreakouts;
+};
+
+/**
+ * @param {Object} participant the locus participant
+ * @returns {Boolean}
+ */
+MemberUtil.isLiveAnnotationSupported = (participant) => {
+  if (!participant) {
+    throw new ParameterError(
+      'LiveAnnotation support could not be processed, participant is undefined.'
+    );
+  }
+
+  return !participant.annotatorAssignmentNotAllowed;
+};
+
 /**
  * utility method for audio/video muted status
  * @param {String} status
@@ -214,7 +304,10 @@ MemberUtil.extractStatus = (participant: any) => {
   }
   if (participant.state === _IDLE_) {
     if (participant.devices && participant.devices.length > 0) {
-      const foundDevice = participant.devices.find((device) => device.intent && (device.intent.type === _WAIT_ || device.intent.type === _OBSERVE_));
+      const foundDevice = participant.devices.find(
+        (device) =>
+          device.intent && (device.intent.type === _WAIT_ || device.intent.type === _OBSERVE_)
+      );
 
       return foundDevice ? _IN_LOBBY_ : _NOT_IN_MEETING_;
     }

package/src/members/collection.ts

@@ -6,7 +6,6 @@ import {MEETINGS} from '../constants';
 export default class MembersCollection {
   members: any;
   namespace = MEETINGS;
-
   /**
    * @param {Object} locus
    * @memberof Members
@@ -38,4 +37,12 @@ export default class MembersCollection {
   getAll() {
     return this.members;
   }
+
+  /**
+   * @returns {void}
+   * reset members
+   */
+  reset() {
+    this.members = {};
+  }
 }