@webex/plugin-meetings 3.0.0-beta.2 → 3.0.0-beta.200

package/src/member/{index.js → index.ts}

@@ -1,19 +1,43 @@
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
-import {
-  MEETINGS,
-  _IN_LOBBY_,
-  _NOT_IN_MEETING_,
-  _IN_MEETING_
-} from '../constants';
+import {MEETINGS, _IN_LOBBY_, _NOT_IN_MEETING_, _IN_MEETING_} from '../constants';
+import {IExternalRoles, IMediaStatus, ParticipantWithRoles} from './types';
 
-import MemberUtil from './util.js';
+import MemberUtil from './util';
 
 /**
  * @class Member
  */
 export default class Member {
+  associatedUser: any;
+  id: any;
+  isAudioMuted: any;
+  isContentSharing: any;
+  isDevice: any;
+  isGuest: any;
+  isHandRaised: any;
+  isHost: any;
+  isInLobby: any;
+  isInMeeting: any;
+  isModerator: any;
+  isModeratorAssignmentProhibited: any;
+  isMutable: any;
+  isNotAdmitted: any;
+  isRecording: any;
+  isRemovable: any;
+  isSelf: any;
+  isUser: any;
+  isVideoMuted: any;
+  roles: IExternalRoles;
+  mediaStatus: IMediaStatus;
+  name: any;
+  participant: any;
+  status: any;
+  supportsBreakouts: boolean;
+  supportsInterpretation: boolean;
+  supportLiveAnnotation: boolean;
+  type: any;
   namespace = MEETINGS;
 
   /**
@@ -26,14 +50,24 @@ export default class Member {
    * @returns {Member}
    * @memberof Member
    */
-  constructor(participant, options = {}) {
+  constructor(
+    participant: object,
+    options:
+      | {
+          selfId: string;
+          hostId: string;
+          contentSharingId: string;
+          type: string;
+        }
+      | any = {}
+  ) {
     /**
      * The server participant object
      * @instance
      * @type {Object}
      * @private
      * @memberof Member
-    */
+     */
     this.participant = null;
     /**
      * The member id
@@ -41,7 +75,7 @@ export default class Member {
      * @type {String}
      * @public
      * @memberof Member
-    */
+     */
     this.id = null;
     /**
      * The member name
@@ -49,34 +83,48 @@ export default class Member {
      * @type {String}
      * @public
      * @memberof Member
-    */
+     */
     this.name = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isAudioMuted = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isVideoMuted = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isHandRaised = null;
     /**
-      * @instance
-      * @type {Boolean}
-      * @public
-      * @memberof Member
+     * @instance
+     * @type {Boolean}
+     * @public
+     * @memberof Member
+     */
+    this.supportsBreakouts = null;
+    /**
+     * @instance
+     * @type {Boolean}
+     * @public
+     * @memberof Member
+     */
+    this.supportLiveAnnotation = null;
+    /**
+     * @instance
+     * @type {Boolean}
+     * @public
+     * @memberof Member
      */
     this.isSelf = null;
     /**
@@ -84,114 +132,135 @@ export default class Member {
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isHost = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isGuest = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isInLobby = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isInMeeting = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isNotAdmitted = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isContentSharing = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.status = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isDevice = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isUser = null;
     /**
-         * Is this member associated to another user by way of pairing (typical of devices)
+     * Is this member associated to another user by way of pairing (typical of devices)
      * @instance
      * @type {String}
      * @public
      * @memberof Member
-    */
+     */
     this.associatedUser = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isRecording = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isMutable = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isRemovable = null;
     /**
      * @instance
      * @type {String}
      * @private
      * @memberof Member
-    */
+     */
     this.type = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isModerator = null;
     /**
      * @instance
      * @type {Boolean}
      * @public
      * @memberof Member
-    */
+     */
     this.isModeratorAssignmentProhibited = null;
+
+    /**
+     * @instance
+     * @type {IExternalRoles}
+     * @public
+     * @memberof Member
+     */
+    this.roles = null;
+
+    /**
+     * @instance
+     * @type {IMediaStatus}
+     * @public
+     * @memberof Member
+     * @example {audio: MediaStatus.RECVONLY, video: MediaStatus.SENDRECV}
+     */
+    this.mediaStatus = {
+      audio: null,
+      video: null,
+    };
+
     // TODO: more participant types
     // such as native client, web client, is a device, what type of phone, etc
     this.processParticipant(participant);
@@ -206,7 +275,7 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  processParticipant(participant) {
+  private processParticipant(participant: object) {
     this.participant = participant;
     if (participant) {
       this.id = MemberUtil.extractId(participant);
@@ -214,12 +283,17 @@ export default class Member {
       this.isAudioMuted = MemberUtil.isAudioMuted(participant);
       this.isVideoMuted = MemberUtil.isVideoMuted(participant);
       this.isHandRaised = MemberUtil.isHandRaised(participant);
+      this.supportsBreakouts = MemberUtil.isBreakoutsSupported(participant);
+      this.supportsInterpretation = MemberUtil.isInterpretationSupported(participant);
+      this.supportLiveAnnotation = MemberUtil.isLiveAnnotationSupported(participant);
       this.isGuest = MemberUtil.isGuest(participant);
       this.isUser = MemberUtil.isUser(participant);
       this.isDevice = MemberUtil.isDevice(participant);
       this.isModerator = MemberUtil.isModerator(participant);
-      this.isModeratorAssignmentProhibited = MemberUtil.isModeratorAssignmentProhibited(participant);
+      this.isModeratorAssignmentProhibited =
+        MemberUtil.isModeratorAssignmentProhibited(participant);
       this.processStatus(participant);
+      this.processRoles(participant as ParticipantWithRoles);
       // must be done last
       this.isNotAdmitted = MemberUtil.isNotAdmitted(participant, this.isGuest, this.status);
     }
@@ -233,7 +307,7 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  processParticipantOptions(participant, options) {
+  private processParticipantOptions(participant: object, options: any) {
     if (participant && options) {
       this.processIsSelf(participant, options.selfId);
       this.processIsHost(participant, options.hostId);
@@ -249,11 +323,24 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  processMember() {
+  private processMember() {
     // must occur after self, guest, meeting, and type properties are calculated
-    this.isRemovable = MemberUtil.isRemovable(this.isSelf, this.isGuest, this.isInMeeting, this.type);
+    this.isRemovable = MemberUtil.isRemovable(
+      this.isSelf,
+      this.isGuest,
+      this.isInMeeting,
+      this.type
+    );
     // must occur after self, device, meeting, mute status, and type properties are calculated
-    this.isMutable = MemberUtil.isMutable(this.isSelf, this.isDevice, this.isInMeeting, this.isAudioMuted, this.type);
+    this.isMutable = MemberUtil.isMutable(
+      this.isSelf,
+      this.isDevice,
+      this.isInMeeting,
+      this.isAudioMuted,
+      this.type
+    );
+
+    this.mediaStatus = MemberUtil.extractMediaStatus(this.participant);
   }
 
   /**
@@ -263,7 +350,7 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  processStatus(participant) {
+  private processStatus(participant: object) {
     this.status = MemberUtil.extractStatus(participant);
     switch (this.status) {
       case _IN_LOBBY_:
@@ -291,7 +378,7 @@ export default class Member {
    * @public
    * @memberof Member
    */
-  setIsContentSharing(flag) {
+  public setIsContentSharing(flag: boolean) {
     this.isContentSharing = flag;
   }
 
@@ -302,7 +389,7 @@ export default class Member {
    * @public
    * @memberof Member
    */
-  setIsHost(flag) {
+  public setIsHost(flag: boolean) {
     this.isHost = flag;
   }
 
@@ -313,7 +400,7 @@ export default class Member {
    * @public
    * @memberof Member
    */
-  setIsSelf(flag) {
+  public setIsSelf(flag: boolean) {
     this.isSelf = flag;
   }
 
@@ -325,11 +412,10 @@ export default class Member {
    * @public
    * @memberof Member
    */
-  processIsContentSharing(participant, sharingId) {
+  public processIsContentSharing(participant: object, sharingId: string) {
     if (MemberUtil.isUser(participant)) {
       this.isContentSharing = MemberUtil.isSame(participant, sharingId);
-    }
-    else if (MemberUtil.isDevice(participant)) {
+    } else if (MemberUtil.isDevice(participant)) {
       this.isContentSharing = MemberUtil.isAssociatedSame(participant, sharingId);
     }
   }
@@ -342,7 +428,7 @@ export default class Member {
    * @public
    * @memberof Member
    */
-  processIsRecording(participant, recordingId) {
+  public processIsRecording(participant: object, recordingId: string) {
     this.isRecording = MemberUtil.isSame(participant, recordingId);
   }
 
@@ -354,11 +440,10 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  processIsSelf(participant, selfId) {
+  private processIsSelf(participant: object, selfId: string) {
     if (MemberUtil.isUser(participant)) {
       this.isSelf = MemberUtil.isSame(participant, selfId);
-    }
-    else if (MemberUtil.isDevice(participant)) {
+    } else if (MemberUtil.isDevice(participant)) {
       this.isSelf = MemberUtil.isAssociatedSame(participant, selfId);
       this.associatedUser = selfId;
     }
@@ -372,15 +457,25 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  processIsHost(participant, hostId) {
+  private processIsHost(participant: object, hostId: string) {
     if (MemberUtil.isUser(participant)) {
       this.isHost = MemberUtil.isSame(participant, hostId);
-    }
-    else if (MemberUtil.isDevice(participant)) {
+    } else if (MemberUtil.isDevice(participant)) {
       this.isHost = MemberUtil.isAssociatedSame(participant, hostId);
     }
   }
 
+  /**
+   * process the roles that have been applied to this member
+   * @param {Object} participant
+   * @returns {undefined}
+   * @private
+   * @memberof Member
+   */
+  private processRoles(participant: ParticipantWithRoles) {
+    this.roles = MemberUtil.extractControlRoles(participant);
+  }
+
   /**
    * set the type for the member, could be MEETING or CALL
    * @param {String} type
@@ -388,7 +483,7 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  processType(type) {
+  private processType(type: string) {
     this.type = type;
   }
 }

package/src/member/types.ts

@@ -0,0 +1,38 @@
+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>;
+    };
+  };
+};
+
+// values are inherited from locus so don't update these
+export enum MediaStatus {
+  RECVONLY = 'RECVONLY', // participant only receiving and not sending
+  SENDONLY = 'SENDONLY', // participant only sending and not receiving
+  SENDRECV = 'SENDRECV', // participant both sending and receiving
+  INACTIVE = 'INACTIVE', // participant is not connected to media source
+  UNKNOWN = 'UNKNOWN', // participant has not added media in the meeting
+}
+
+export interface IMediaStatus {
+  audio: MediaStatus;
+  video: MediaStatus;
+}