@webex/plugin-meetings 3.8.0-next.82 → 3.8.0-next.84

package/src/member/index.ts

@@ -1,18 +1,20 @@
 /*!
  * Copyright (c) 2015-2020 Cisco Systems, Inc. See LICENSE file.
  */
-import {MEETINGS, _IN_LOBBY_, _NOT_IN_MEETING_, _IN_MEETING_} from '../constants';
-import {IExternalRoles, IMediaStatus, ParticipantWithBrb, ParticipantWithRoles} from './types';
+import {MEETINGS, _IN_LOBBY_, _NOT_IN_MEETING_, _IN_MEETING_, _OBSERVE_} from '../constants';
+import {IExternalRoles, IMediaStatus, Participant, ParticipantUrl} from './types';
 
 import MemberUtil from './util';
 
+export type MemberId = string;
 /**
  * @class Member
  */
 export default class Member {
-  associatedUser: any;
+  associatedUser: MemberId | null; // deprecated, use associatedUsers instead
+  associatedUsers: Set<MemberId>; // users associated with this device, empty if this member is not a device
   canReclaimHost: boolean;
-  id: any;
+  id: MemberId;
   isAudioMuted: any;
   isContentSharing: any;
   isDevice: any;
@@ -29,6 +31,7 @@ export default class Member {
   isRecording: any;
   isRemovable: any;
   isSelf: any;
+  isPairedWithSelf: boolean; // true for a device that we are paired with
   isBrb: boolean;
   isUser: any;
   isVideoMuted: any;
@@ -42,6 +45,10 @@ export default class Member {
   supportLiveAnnotation: boolean;
   type: any;
   namespace = MEETINGS;
+  pairedWith: {
+    participantUrl?: ParticipantUrl;
+    memberId?: MemberId;
+  };
 
   /**
    * @param {Object} participant - the locus participant
@@ -54,7 +61,7 @@ export default class Member {
    * @memberof Member
    */
   constructor(
-    participant: object,
+    participant: Participant,
     options:
       | {
           selfId: string;
@@ -201,13 +208,23 @@ export default class Member {
      */
     this.isUser = null;
     /**
+     * Deprecated: use associatedUsers instead
      * Is this member associated to another user by way of pairing (typical of devices)
      * @instance
-     * @type {String}
+     * @type {MemberId|null}
+     * @deprecated
      * @public
      * @memberof Member
      */
     this.associatedUser = null;
+    /**
+     * Is this member associated to another user by way of pairing (typical of devices)
+     * @instance
+     * @type {String}
+     * @public
+     * @memberof Member
+     */
+    this.associatedUsers = new Set<MemberId>();
     /**
      * @instance
      * @type {Boolean}
@@ -266,6 +283,14 @@ export default class Member {
      */
     this.isPresenterAssignmentProhibited = null;
 
+    /**
+     * @instance
+     * @type {Boolean}
+     * @public
+     * @memberof Member
+     */
+    this.isPairedWithSelf = false;
+
     /**
      * @instance
      * @type {IExternalRoles}
@@ -274,6 +299,10 @@ export default class Member {
      */
     this.roles = null;
 
+    this.pairedWith = {
+      participantUrl: undefined,
+      memberId: undefined,
+    };
     /**
      * @instance
      * @type {IMediaStatus}
@@ -299,9 +328,10 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  private processParticipant(participant: object) {
+  private processParticipant(participant: Participant) {
     this.participant = participant;
     if (participant) {
+      this.processPairedDevice(participant);
       this.canReclaimHost = MemberUtil.canReclaimHost(participant);
       this.id = MemberUtil.extractId(participant);
       this.name = MemberUtil.extractName(participant);
@@ -312,7 +342,7 @@ export default class Member {
       this.supportsInterpretation = MemberUtil.isInterpretationSupported(participant);
       this.supportLiveAnnotation = MemberUtil.isLiveAnnotationSupported(participant);
       this.isGuest = MemberUtil.isGuest(participant);
-      this.isBrb = MemberUtil.isBrb(participant as ParticipantWithBrb);
+      this.isBrb = MemberUtil.isBrb(participant);
       this.isUser = MemberUtil.isUser(participant);
       this.isDevice = MemberUtil.isDevice(participant);
       this.isModerator = MemberUtil.isModerator(participant);
@@ -321,12 +351,24 @@ export default class Member {
       this.isPresenterAssignmentProhibited =
         MemberUtil.isPresenterAssignmentProhibited(participant);
       this.processStatus(participant);
-      this.processRoles(participant as ParticipantWithRoles);
+      this.processRoles(participant);
       // must be done last
       this.isNotAdmitted = MemberUtil.isNotAdmitted(participant, this.isGuest, this.status);
     }
   }
 
+  /**
+   * Checks if the participant is paired with another device
+   *
+   * @param {any} participant the locus participant object
+   * @returns {void}
+   */
+  processPairedDevice(participant: Participant) {
+    // we can't populate this.pairedWith.memberId here because the member for that device might not yet exist
+    // so only populating the participantUrl and memberId will be set later
+    this.pairedWith.participantUrl = MemberUtil.extractPairedWithParticipantUrl(participant);
+  }
+
   /**
    * Use the members options and participant values to set on the member
    * @param {Object} participant the locus participant object
@@ -335,7 +377,7 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  private processParticipantOptions(participant: object, options: any) {
+  private processParticipantOptions(participant: Participant, options: any) {
     if (participant && options) {
       this.processIsSelf(participant, options.selfId);
       this.processIsHost(participant, options.hostId);
@@ -378,7 +420,7 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  private processStatus(participant: object) {
+  private processStatus(participant: Participant) {
     this.status = MemberUtil.extractStatus(participant);
     switch (this.status) {
       case _IN_LOBBY_:
@@ -440,11 +482,9 @@ export default class Member {
    * @public
    * @memberof Member
    */
-  public processIsContentSharing(participant: object, sharingId: string) {
+  public processIsContentSharing(participant: Participant, sharingId: string) {
     if (MemberUtil.isUser(participant)) {
       this.isContentSharing = MemberUtil.isSame(participant, sharingId);
-    } else if (MemberUtil.isDevice(participant)) {
-      this.isContentSharing = MemberUtil.isAssociatedSame(participant, sharingId);
     }
   }
 
@@ -456,7 +496,7 @@ export default class Member {
    * @public
    * @memberof Member
    */
-  public processIsRecording(participant: object, recordingId: string) {
+  public processIsRecording(participant: Participant, recordingId: string) {
     this.isRecording = MemberUtil.isSame(participant, recordingId);
   }
 
@@ -468,12 +508,9 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  private processIsSelf(participant: object, selfId: string) {
+  private processIsSelf(participant: Participant, selfId: string) {
     if (MemberUtil.isUser(participant)) {
       this.isSelf = MemberUtil.isSame(participant, selfId);
-    } else if (MemberUtil.isDevice(participant)) {
-      this.isSelf = MemberUtil.isAssociatedSame(participant, selfId);
-      this.associatedUser = selfId;
     }
   }
 
@@ -485,11 +522,9 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  private processIsHost(participant: object, hostId: string) {
+  private processIsHost(participant: Participant, hostId: string) {
     if (MemberUtil.isUser(participant)) {
       this.isHost = MemberUtil.isSame(participant, hostId);
-    } else if (MemberUtil.isDevice(participant)) {
-      this.isHost = MemberUtil.isAssociatedSame(participant, hostId);
     }
   }
 
@@ -500,7 +535,7 @@ export default class Member {
    * @private
    * @memberof Member
    */
-  private processRoles(participant: ParticipantWithRoles) {
+  private processRoles(participant: Participant) {
     this.roles = MemberUtil.extractControlRoles(participant);
   }
 

package/src/member/types.ts

@@ -15,22 +15,6 @@ export type ServerRoleShape = {
   hasRole: boolean;
 };
 
-export type ParticipantWithRoles = {
-  controls: {
-    role: {
-      roles: Array<ServerRoleShape>;
-    };
-  };
-};
-
-export type ParticipantWithBrb = {
-  controls: {
-    brb?: {
-      enabled: boolean;
-    };
-  };
-};
-
 // values are inherited from locus so don't update these
 export enum MediaStatus {
   RECVONLY = 'RECVONLY', // participant only receiving and not sending
@@ -44,3 +28,85 @@ export interface IMediaStatus {
   audio: MediaStatus;
   video: MediaStatus;
 }
+
+export type Csi = number;
+export type Direction = 'inactive' | 'sendrecv' | 'sendonly' | 'recvonly';
+export type ParticipantUrl = string;
+export interface MediaSession {
+  csi: Csi;
+  direction: Direction;
+  mediaContent: 'main' | 'slides';
+  mediaType: 'audio' | 'video';
+  state: string;
+}
+
+export interface Intent {
+  associatedWith: ParticipantUrl;
+  id: string;
+  type: string; // could be "WAIT" or "OBSERVE" or other....
+}
+export interface ParticipantDevice {
+  correlationId: string;
+  csis: Csi[];
+  deviceType: string; // WDM device type, could be "WEB", "TP_ENDPOINT", "MAC" or other things, don't know the full list, so keeping it as string
+  intent?: Intent;
+  intents: Array<Intent | null>;
+  isVideoCallback: boolean;
+  mediaSessions: Array<MediaSession>;
+  mediaSessionsExternal: boolean;
+  state: string; // probably one of MEETING_STATE.STATES
+}
+
+// this is not a complete type, Locus may send more fields
+export interface ParticipantPerson {
+  id: string;
+  isExternal: boolean;
+  name: string;
+  orgId: string;
+}
+
+export interface ParticipantMediaStatus {
+  audioStatus: MediaStatus;
+  videoStatus: MediaStatus;
+  audioSlidesStatus?: MediaStatus;
+  videoSlidesStatus?: MediaStatus;
+  csis: Csi[];
+}
+
+// this is not a complete type, Locus may send more fields
+export interface ParticipantControls {
+  role: {
+    roles: Array<ServerRoleShape>;
+  };
+  brb?: {
+    enabled: boolean;
+  };
+  hand: {
+    raised: boolean;
+  };
+  localRecord: {
+    recording: boolean;
+  };
+}
+
+// this is not a complete type, Locus may send more fields
+export interface Participant {
+  canBeController: boolean;
+  controls: ParticipantControls;
+  deviceUrl: string;
+  devices: Array<ParticipantDevice>;
+  guest: boolean;
+  id: string;
+  identity: string;
+  identityTrustLevel: string; // could be 'INTERNAL', 'EXTERNAL' or other....
+  isCreator: boolean;
+  moderator: boolean; // Locus docs say this is deprecated and role control should be used instead
+  moderatorAssignmentNotAllowed: boolean;
+  presenterAssignmentNotAllowed: boolean;
+  person: ParticipantPerson;
+  resourceGuest: boolean;
+  state: string; // probably one of MEETING_STATE.STATES
+  status: ParticipantMediaStatus;
+  type: string;
+  url: ParticipantUrl;
+}

package/src/member/util.ts

@@ -1,10 +1,10 @@
 import {
   IExternalRoles,
-  ParticipantWithRoles,
   ServerRoles,
   ServerRoleShape,
   IMediaStatus,
-  ParticipantWithBrb,
+  Participant,
+  ParticipantUrl,
 } from './types';
 import {
   _USER_,
@@ -46,23 +46,23 @@ const MemberUtil = {
    * @param {Object} participant - The locus participant object.
    * @returns {[ServerRoleShape]}
    */
-  getControlsRoles: (participant: ParticipantWithRoles): Array<ServerRoleShape> =>
+  getControlsRoles: (participant: Participant): Array<ServerRoleShape> =>
     participant?.controls?.role?.roles,
 
   /**
    * Checks if the participant has the brb status enabled.
    *
-   * @param {ParticipantWithBrb} participant - The locus participant object.
+   * @param {Participant} participant - The locus participant object.
    * @returns {boolean} - True if the participant has brb enabled, false otherwise.
    */
-  isBrb: (participant: ParticipantWithBrb): boolean => participant.controls?.brb?.enabled || false,
+  isBrb: (participant: Participant): boolean => participant.controls?.brb?.enabled || false,
 
   /**
    * @param {Object} participant - The locus participant object.
    * @param {ServerRoles} controlRole the search role
    * @returns {Boolean}
    */
-  hasRole: (participant: any, controlRole: ServerRoles): boolean =>
+  hasRole: (participant: Participant, controlRole: ServerRoles): boolean =>
     MemberUtil.getControlsRoles(participant)?.some(
       (role) => role.type === controlRole && role.hasRole
     ),
@@ -71,28 +71,28 @@ const MemberUtil = {
    * @param {Object} participant - The locus participant object.
    * @returns {Boolean}
    */
-  hasCohost: (participant: ParticipantWithRoles): boolean =>
+  hasCohost: (participant: Participant): boolean =>
     MemberUtil.hasRole(participant, ServerRoles.Cohost) || false,
 
   /**
    * @param {Object} participant - The locus participant object.
    * @returns {Boolean}
    */
-  hasModerator: (participant: ParticipantWithRoles): boolean =>
+  hasModerator: (participant: Participant): boolean =>
     MemberUtil.hasRole(participant, ServerRoles.Moderator) || false,
 
   /**
    * @param {Object} participant - The locus participant object.
    * @returns {Boolean}
    */
-  hasPresenter: (participant: ParticipantWithRoles): boolean =>
+  hasPresenter: (participant: Participant): boolean =>
     MemberUtil.hasRole(participant, ServerRoles.Presenter) || false,
 
   /**
    * @param {Object} participant - The locus participant object.
    * @returns {IExternalRoles}
    */
-  extractControlRoles: (participant: ParticipantWithRoles): IExternalRoles => {
+  extractControlRoles: (participant: Participant): IExternalRoles => {
     const roles = {
       cohost: MemberUtil.hasCohost(participant),
       moderator: MemberUtil.hasModerator(participant),
@@ -106,26 +106,26 @@ const MemberUtil = {
    * @param {Object} participant - The locus participant object.
    * @returns {Boolean}
    */
-  isUser: (participant: any) => participant && participant.type === _USER_,
+  isUser: (participant: Participant) => participant && participant.type === _USER_,
 
-  isModerator: (participant) => participant && participant.moderator,
+  isModerator: (participant: Participant) => participant && participant.moderator,
 
   /**
    * @param {Object} participant - The locus participant object.
    * @returns {Boolean}
    */
-  isGuest: (participant: any) => participant && participant.guest,
+  isGuest: (participant: Participant) => participant && participant.guest,
 
   /**
    * @param {Object} participant - The locus participant object.
    * @returns {Boolean}
    */
-  isDevice: (participant: any) => participant && participant.type === _RESOURCE_ROOM_,
+  isDevice: (participant: Participant) => participant && participant.type === _RESOURCE_ROOM_,
 
-  isModeratorAssignmentProhibited: (participant) =>
+  isModeratorAssignmentProhibited: (participant: Participant) =>
     participant && participant.moderatorAssignmentNotAllowed,
 
-  isPresenterAssignmentProhibited: (participant) =>
+  isPresenterAssignmentProhibited: (participant: Participant) =>
     participant && participant.presenterAssignmentNotAllowed,
 
   /**
@@ -135,30 +135,16 @@ const MemberUtil = {
    * @param {String} id
    * @returns {Boolean}
    */
-  isSame: (participant: any, id: string) =>
+  isSame: (participant: Participant, 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
-   * there are multiple ids that can be used
-   * @param {Object} participant - The locus participant object.
-   * @param {String} id
-   * @returns {Boolean}
-   */
-  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 object.
    * @param {Boolean} isGuest
    * @param {String} status
    * @returns {Boolean}
    */
-  isNotAdmitted: (participant: any, isGuest: boolean, status: string): boolean =>
+  isNotAdmitted: (participant: Participant, isGuest: boolean, status: string): boolean =>
     participant &&
     participant.guest &&
     ((participant.devices &&
@@ -175,7 +161,7 @@ const MemberUtil = {
    * @param {Object} participant - The locus participant object.
    * @returns {Boolean}
    */
-  isAudioMuted: (participant: any) => {
+  isAudioMuted: (participant: Participant) => {
     if (!participant) {
       throw new ParameterError('Audio could not be processed, participant is undefined.');
     }
@@ -187,7 +173,7 @@ const MemberUtil = {
    * @param {Object} participant - The locus participant object.
    * @returns {Boolean}
    */
-  isVideoMuted: (participant: any): boolean => {
+  isVideoMuted: (participant: Participant): boolean => {
     if (!participant) {
       throw new ParameterError('Video could not be processed, participant is undefined.');
     }
@@ -199,7 +185,7 @@ const MemberUtil = {
    * @param {Object} participant - The locus participant object.
    * @returns {Boolean}
    */
-  isHandRaised: (participant: any) => {
+  isHandRaised: (participant: Participant) => {
     if (!participant) {
       throw new ParameterError('Raise hand could not be processed, participant is undefined.');
     }
@@ -256,7 +242,7 @@ const MemberUtil = {
    * @param {String} controlsAccessor
    * @returns {Boolean | undefined}
    */
-  isMuted: (participant: any, statusAccessor: string, controlsAccessor: string) => {
+  isMuted: (participant: Participant, statusAccessor: string, controlsAccessor: string) => {
     // check remote mute
     const remoteMute = participant?.controls?.[controlsAccessor]?.muted;
     if (remoteMute === true) {
@@ -295,7 +281,7 @@ const MemberUtil = {
    * @param {Object} participant - The locus participant object.
    * @returns {Boolean}
    */
-  isRecording: (participant: any) => {
+  isRecording: (participant: Participant) => {
     if (!participant) {
       throw new ParameterError('Recording could not be processed, participant is undefined.');
     }
@@ -341,7 +327,7 @@ const MemberUtil = {
    * @param {Object} participant - The locus participant object.
    * @returns {String}
    */
-  extractStatus: (participant: any) => {
+  extractStatus: (participant: Participant) => {
     if (!(participant && participant.devices && participant.devices.length)) {
       return _NOT_IN_MEETING_;
     }
@@ -371,7 +357,7 @@ const MemberUtil = {
    * @param {Object} participant - The locus participant object.
    * @returns {String}
    */
-  extractId: (participant: any) => {
+  extractId: (participant: Participant) => {
     if (participant) {
       return participant.id;
     }
@@ -384,7 +370,7 @@ const MemberUtil = {
    * @param {Object} participant - The locus participant object.
    * @returns {Object}
    */
-  extractMediaStatus: (participant: any): IMediaStatus => {
+  extractMediaStatus: (participant: Participant): IMediaStatus => {
     if (!participant) {
       throw new ParameterError('Media status could not be extracted, participant is undefined.');
     }
@@ -399,12 +385,30 @@ const MemberUtil = {
    * @param {Object} participant - The locus participant object.
    * @returns {String}
    */
-  extractName: (participant: any) => {
+  extractName: (participant: Participant) => {
     if (participant && participant.person) {
       return participant.person.name;
     }
 
     return null;
   },
+
+  /**
+   * @param {Object} participant - The locus participant object.
+   * @returns {String}
+   */
+  extractPairedWithParticipantUrl: (participant: Participant): ParticipantUrl | undefined => {
+    let participantUrl;
+
+    participant?.devices?.forEach((device) => {
+      device?.intents?.forEach((intent) => {
+        if (intent?.type === _OBSERVE_ && intent?.associatedWith) {
+          participantUrl = intent.associatedWith;
+        }
+      });
+    });
+
+    return participantUrl;
+  },
 };
 export default MemberUtil;

package/src/members/collection.ts

@@ -1,10 +1,11 @@
 import {MEETINGS} from '../constants';
+import Member from '../member';
 
 /**
  * @class MembersCollection
  */
 export default class MembersCollection {
-  members: any;
+  members: Record<string, Member>;
   namespace = MEETINGS;
   /**
    * @param {Object} locus
@@ -14,11 +15,11 @@ export default class MembersCollection {
     this.members = {};
   }
 
-  set(id, member) {
+  set(id: string, member: Member) {
     this.members[id] = member;
   }
 
-  setAll(members) {
+  setAll(members: Record<string, Member>) {
     this.members = members;
   }