@webex/plugin-meetings 3.8.0-next.81 → 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.81"
+  version: "3.8.0-next.83"
 });
 var _default = exports.default = Webinar;
 //# sourceMappingURL=index.js.map

package/package.json

@@ -43,13 +43,13 @@
     "@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.81",
-    "@webex/plugin-rooms": "3.8.0-next.27",
-    "@webex/test-helper-chai": "3.8.0-next.22",
-    "@webex/test-helper-mocha": "3.8.0-next.22",
-    "@webex/test-helper-mock-webex": "3.8.0-next.22",
-    "@webex/test-helper-retry": "3.8.0-next.22",
-    "@webex/test-helper-test-users": "3.8.0-next.22",
+    "@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",
+    "@webex/test-helper-mock-webex": "3.8.0-next.23",
+    "@webex/test-helper-retry": "3.8.0-next.23",
+    "@webex/test-helper-test-users": "3.8.0-next.23",
     "chai": "^4.3.4",
     "chai-as-promised": "^7.1.1",
     "eslint": "^8.24.0",
@@ -61,23 +61,23 @@
     "typescript": "^4.7.4"
   },
   "dependencies": {
-    "@webex/common": "3.8.0-next.22",
+    "@webex/common": "3.8.0-next.23",
     "@webex/event-dictionary-ts": "^1.0.1753",
     "@webex/internal-media-core": "2.17.1",
-    "@webex/internal-plugin-conversation": "3.8.0-next.27",
-    "@webex/internal-plugin-device": "3.8.0-next.22",
-    "@webex/internal-plugin-llm": "3.8.0-next.25",
-    "@webex/internal-plugin-mercury": "3.8.0-next.24",
-    "@webex/internal-plugin-metrics": "3.8.0-next.22",
-    "@webex/internal-plugin-support": "3.8.0-next.27",
-    "@webex/internal-plugin-user": "3.8.0-next.22",
-    "@webex/internal-plugin-voicea": "3.8.0-next.81",
-    "@webex/media-helpers": "3.8.0-next.28",
-    "@webex/plugin-people": "3.8.0-next.24",
-    "@webex/plugin-rooms": "3.8.0-next.27",
+    "@webex/internal-plugin-conversation": "3.8.0-next.28",
+    "@webex/internal-plugin-device": "3.8.0-next.23",
+    "@webex/internal-plugin-llm": "3.8.0-next.26",
+    "@webex/internal-plugin-mercury": "3.8.0-next.25",
+    "@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.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",
     "@webex/ts-sdp": "^1.8.1",
     "@webex/web-capabilities": "^1.4.0",
-    "@webex/webex-core": "3.8.0-next.22",
+    "@webex/webex-core": "3.8.0-next.23",
     "ampersand-collection": "^2.0.2",
     "bowser": "^2.11.0",
     "btoa": "^1.2.1",
@@ -93,5 +93,5 @@
   "//": [
     "TODO: upgrade jwt-decode when moving to node 18"
   ],
-  "version": "3.8.0-next.81"
+  "version": "3.8.0-next.83"
 }