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

package/dist/types/member/types.d.ts

@@ -12,20 +12,6 @@ export type ServerRoleShape = {
     type: ServerRoles;
     hasRole: boolean;
 };
-export type ParticipantWithRoles = {
-    controls: {
-        role: {
-            roles: Array<ServerRoleShape>;
-        };
-    };
-};
-export type ParticipantWithBrb = {
-    controls: {
-        brb?: {
-            enabled: boolean;
-        };
-    };
-};
 export declare enum MediaStatus {
     RECVONLY = "RECVONLY",
     SENDONLY = "SENDONLY",
@@ -37,3 +23,76 @@ 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;
+}
+export interface ParticipantDevice {
+    correlationId: string;
+    csis: Csi[];
+    deviceType: string;
+    intent?: Intent;
+    intents: Array<Intent | null>;
+    isVideoCallback: boolean;
+    mediaSessions: Array<MediaSession>;
+    mediaSessionsExternal: boolean;
+    state: string;
+}
+export interface ParticipantPerson {
+    id: string;
+    isExternal: boolean;
+    name: string;
+    orgId: string;
+}
+export interface ParticipantMediaStatus {
+    audioStatus: MediaStatus;
+    videoStatus: MediaStatus;
+    audioSlidesStatus?: MediaStatus;
+    videoSlidesStatus?: MediaStatus;
+    csis: Csi[];
+}
+export interface ParticipantControls {
+    role: {
+        roles: Array<ServerRoleShape>;
+    };
+    brb?: {
+        enabled: boolean;
+    };
+    hand: {
+        raised: boolean;
+    };
+    localRecord: {
+        recording: boolean;
+    };
+}
+export interface Participant {
+    canBeController: boolean;
+    controls: ParticipantControls;
+    deviceUrl: string;
+    devices: Array<ParticipantDevice>;
+    guest: boolean;
+    id: string;
+    identity: string;
+    identityTrustLevel: string;
+    isCreator: boolean;
+    moderator: boolean;
+    moderatorAssignmentNotAllowed: boolean;
+    presenterAssignmentNotAllowed: boolean;
+    person: ParticipantPerson;
+    resourceGuest: boolean;
+    state: string;
+    status: ParticipantMediaStatus;
+    type: string;
+    url: ParticipantUrl;
+}

package/dist/types/member/util.d.ts

@@ -1,4 +1,4 @@
-import { IExternalRoles, ParticipantWithRoles, ServerRoles, ServerRoleShape, IMediaStatus, ParticipantWithBrb } from './types';
+import { IExternalRoles, ServerRoles, ServerRoleShape, IMediaStatus, Participant, ParticipantUrl } from './types';
 declare const MemberUtil: {
     /**
      * @param {Object} participant - The locus participant object.
@@ -9,58 +9,58 @@ declare const MemberUtil: {
      * @param {Object} participant - The locus participant object.
      * @returns {[ServerRoleShape]}
      */
-    getControlsRoles: (participant: ParticipantWithRoles) => Array<ServerRoleShape>;
+    getControlsRoles: (participant: Participant) => Array<ServerRoleShape>;
     /**
      * 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;
+    isBrb: (participant: Participant) => boolean;
     /**
      * @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;
     /**
      * @param {Object} participant - The locus participant object.
      * @returns {Boolean}
      */
-    hasCohost: (participant: ParticipantWithRoles) => boolean;
+    hasCohost: (participant: Participant) => boolean;
     /**
      * @param {Object} participant - The locus participant object.
      * @returns {Boolean}
      */
-    hasModerator: (participant: ParticipantWithRoles) => boolean;
+    hasModerator: (participant: Participant) => boolean;
     /**
      * @param {Object} participant - The locus participant object.
      * @returns {Boolean}
      */
-    hasPresenter: (participant: ParticipantWithRoles) => boolean;
+    hasPresenter: (participant: Participant) => boolean;
     /**
      * @param {Object} participant - The locus participant object.
      * @returns {IExternalRoles}
      */
-    extractControlRoles: (participant: ParticipantWithRoles) => IExternalRoles;
+    extractControlRoles: (participant: Participant) => IExternalRoles;
     /**
      * @param {Object} participant - The locus participant object.
      * @returns {Boolean}
      */
-    isUser: (participant: any) => boolean;
-    isModerator: (participant: any) => any;
+    isUser: (participant: Participant) => boolean;
+    isModerator: (participant: Participant) => boolean;
     /**
      * @param {Object} participant - The locus participant object.
      * @returns {Boolean}
      */
-    isGuest: (participant: any) => any;
+    isGuest: (participant: Participant) => boolean;
     /**
      * @param {Object} participant - The locus participant object.
      * @returns {Boolean}
      */
-    isDevice: (participant: any) => boolean;
-    isModeratorAssignmentProhibited: (participant: any) => any;
-    isPresenterAssignmentProhibited: (participant: any) => any;
+    isDevice: (participant: Participant) => boolean;
+    isModeratorAssignmentProhibited: (participant: Participant) => boolean;
+    isPresenterAssignmentProhibited: (participant: Participant) => boolean;
     /**
      * checks to see if the participant id is the same as the passed id
      * there are multiple ids that can be used
@@ -68,37 +68,29 @@ declare const MemberUtil: {
      * @param {String} id
      * @returns {Boolean}
      */
-    isSame: (participant: any, id: string) => boolean;
-    /**
-     * 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) => any;
+    isSame: (participant: Participant, id: string) => boolean;
     /**
      * @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;
     /**
      * @param {Object} participant - The locus participant object.
      * @returns {Boolean}
      */
-    isAudioMuted: (participant: any) => any;
+    isAudioMuted: (participant: Participant) => any;
     /**
      * @param {Object} participant - The locus participant object.
      * @returns {Boolean}
      */
-    isVideoMuted: (participant: any) => boolean;
+    isVideoMuted: (participant: Participant) => boolean;
     /**
      * @param {Object} participant - The locus participant object.
      * @returns {Boolean}
      */
-    isHandRaised: (participant: any) => any;
+    isHandRaised: (participant: Participant) => boolean;
     /**
      * @param {Object} participant - The locus participant object.
      * @returns {Boolean}
@@ -121,7 +113,7 @@ declare const MemberUtil: {
      * @param {String} controlsAccessor
      * @returns {Boolean | undefined}
      */
-    isMuted: (participant: any, statusAccessor: string, controlsAccessor: string) => any;
+    isMuted: (participant: Participant, statusAccessor: string, controlsAccessor: string) => any;
     /**
      * utility method for getting the recording member for later comparison
      * @param {Object} controls
@@ -132,29 +124,34 @@ declare const MemberUtil: {
      * @param {Object} participant - The locus participant object.
      * @returns {Boolean}
      */
-    isRecording: (participant: any) => any;
+    isRecording: (participant: Participant) => boolean;
     isRemovable: (isSelf: any, isGuest: any, isInMeeting: any, type: any) => boolean;
     isMutable: (isSelf: any, isDevice: any, isInMeeting: any, isMuted: any, type: any) => boolean;
     /**
      * @param {Object} participant - The locus participant object.
      * @returns {String}
      */
-    extractStatus: (participant: any) => "IN_LOBBY" | "IN_MEETING" | "NOT_IN_MEETING";
+    extractStatus: (participant: Participant) => "IN_LOBBY" | "IN_MEETING" | "NOT_IN_MEETING";
     /**
      * @param {Object} participant - The locus participant object.
      * @returns {String}
      */
-    extractId: (participant: any) => any;
+    extractId: (participant: Participant) => string;
     /**
      * extracts the media status from nested participant object
      * @param {Object} participant - The locus participant object.
      * @returns {Object}
      */
-    extractMediaStatus: (participant: any) => IMediaStatus;
+    extractMediaStatus: (participant: Participant) => IMediaStatus;
+    /**
+     * @param {Object} participant - The locus participant object.
+     * @returns {String}
+     */
+    extractName: (participant: Participant) => string;
     /**
      * @param {Object} participant - The locus participant object.
      * @returns {String}
      */
-    extractName: (participant: any) => any;
+    extractPairedWithParticipantUrl: (participant: Participant) => ParticipantUrl | undefined;
 };
 export default MemberUtil;

package/dist/types/members/collection.d.ts

@@ -1,26 +1,27 @@
+import Member from '../member';
 /**
  * @class MembersCollection
  */
 export default class MembersCollection {
-    members: any;
+    members: Record<string, Member>;
     namespace: string;
     /**
      * @param {Object} locus
      * @memberof Members
      */
     constructor();
-    set(id: any, member: any): void;
-    setAll(members: any): void;
+    set(id: string, member: Member): void;
+    setAll(members: Record<string, Member>): void;
     /**
      * @param {String} id
      * @returns {Member}
      */
-    get(id: string): any;
+    get(id: string): Member;
     /**
      * @returns {Object} returns an object map of Member instances
      * @memberof MembersCollection
      */
-    getAll(): any;
+    getAll(): Record<string, Member>;
     /**
      * @returns {void}
      * reset members

package/dist/types/members/index.d.ts

@@ -1,45 +1,9 @@
 import { StatelessWebexPlugin } from '@webex/webex-core';
+import Member from '../member';
+import MembersCollection from './collection';
 import { ReceiveSlotManager } from '../multistream/receiveSlotManager';
 import { MediaRequestManager } from '../multistream/mediaRequestManager';
 import { ServerRoleShape } from './types';
-/**
- * Members Update Event
- * Emitted when something in the roster list needs to be updated
- * @event members:update
- * @instance
- * @property {Object} delta the changes to the members list
- * @property {Array} delta.updated array only the updates, includes removals, as they will have updated status and member properties
- * @property {Array} delta.added array added members to the meeting
- * @property {Array} full array the full members collection
- * @memberof Members
- */
-/**
- * Members Content Update Event
- * Emitted when who is sharing changes
- * @event members:content:update
- * @instance
- * @property {String} activeContentSharingId
- * @property {String} endedContentSharingId
- * @memberof Members
- */
-/**
- * Members Host Update Event
- * Emitted when who is the host changes
- * @event members:host:update
- * @instance
- * @property {String} activeHostId
- * @property {String} endedHostId
- * @memberof Members
- */
-/**
- * Members Self Update Event
- * Emitted when who is the self changes
- * @event members:self:update
- * @instance
- * @property {String} activeSelfId
- * @property {String} endedSelfId
- * @memberof Members
- */
 /**
  * @class Members
  */
@@ -48,7 +12,7 @@ export default class Members extends StatelessWebexPlugin {
     locusUrl: any;
     mediaShareContentId: any;
     mediaShareWhiteboardId: any;
-    membersCollection: any;
+    membersCollection: MembersCollection;
     membersRequest: any;
     receiveSlotManager: ReceiveSlotManager;
     mediaRequestManagers: {
@@ -99,6 +63,15 @@ export default class Members extends StatelessWebexPlugin {
      * @memberof Members
      */
     clearMembers(): void;
+    /**
+     * Updates properties on members that rely on information from other members.
+     * This function MUST be called only after the membersCollection has been fully updated
+     * @param {UpdatedMembers} membersUpdate
+     * @returns {Object} membersCollection
+     * @private
+     * @memberof Members
+     */
+    private updateRelationsBetweenMembers;
     /**
      * when new participant updates come in, both delta and full participants, update them in members collection
      * delta object in the event will have {updated, added} and full will be the full membersCollection
@@ -147,7 +120,7 @@ export default class Members extends StatelessWebexPlugin {
     }): void;
     /**
      * sets values in the members collection for updated and added properties from delta
-     * @param {Object} membersUpdate {updated: [], added: []}
+     * @param {UpdatedMembers} membersUpdate
      * @returns {Object} membersCollection
      * @private
      * @memberof Members
@@ -156,6 +129,7 @@ export default class Members extends StatelessWebexPlugin {
     /**
      * set members to the member collection from each updated/added lists as passed in
      * @param {Array} list
+     * @param {boolean} isUpdate
      * @returns {undefined}
      * @private
      * @memberof Members
@@ -164,7 +138,7 @@ export default class Members extends StatelessWebexPlugin {
     /**
      * Internal update the participants value
      * @param {Object} payload
-     * @returns {Object}
+     * @returns {UpdatedMembers}
      * @private
      * @memberof Members
      */
@@ -231,7 +205,7 @@ export default class Members extends StatelessWebexPlugin {
      * Removed/left members will end up in updates
      * Each array contains only members
      * @param {Array} participants the locus participants
-     * @returns {Object} {added: {Array}, updated: {Array}}
+     * @returns {UpdatedMembers} {added: {Array}, updated: {Array}}
      * @private
      * @memberof Members
      */
@@ -346,7 +320,7 @@ export default class Members extends StatelessWebexPlugin {
      * @param {number} csi
      * @returns {Member}
      */
-    findMemberByCsi(csi: any): unknown;
+    findMemberByCsi(csi: any): Member;
     /**
      * Returns an array of a member's CSIs matching the mediaType and mediaContent
      *

package/dist/webinar/index.js

@@ -458,7 +458,7 @@ var Webinar = _webexCore.WebexPlugin.extend({
       }, _callee7);
     }))();
   },
-  version: "3.8.0-next.82"
+  version: "3.8.0-next.83"
 });
 var _default = exports.default = Webinar;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -43,7 +43,7 @@
     "@webex/eslint-config-legacy": "0.0.0",
     "@webex/jest-config-legacy": "0.0.0",
     "@webex/legacy-tools": "0.0.0",
-    "@webex/plugin-meetings": "3.8.0-next.82",
+    "@webex/plugin-meetings": "3.8.0-next.83",
     "@webex/plugin-rooms": "3.8.0-next.28",
     "@webex/test-helper-chai": "3.8.0-next.23",
     "@webex/test-helper-mocha": "3.8.0-next.23",
@@ -71,7 +71,7 @@
     "@webex/internal-plugin-metrics": "3.8.0-next.23",
     "@webex/internal-plugin-support": "3.8.0-next.28",
     "@webex/internal-plugin-user": "3.8.0-next.23",
-    "@webex/internal-plugin-voicea": "3.8.0-next.82",
+    "@webex/internal-plugin-voicea": "3.8.0-next.83",
     "@webex/media-helpers": "3.8.0-next.29",
     "@webex/plugin-people": "3.8.0-next.25",
     "@webex/plugin-rooms": "3.8.0-next.28",
@@ -93,5 +93,5 @@
   "//": [
     "TODO: upgrade jwt-decode when moving to node 18"
   ],
-  "version": "3.8.0-next.82"
+  "version": "3.8.0-next.83"
 }

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);
   }