@webex/plugin-meetings 3.8.0 → 3.8.1-next.10

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

@@ -1,11 +1,13 @@
-import { IExternalRoles, IMediaStatus } from './types';
+import { IExternalRoles, IMediaStatus, Participant, ParticipantUrl } from './types';
+export type MemberId = string;
 /**
  * @class Member
  */
 export default class Member {
-    associatedUser: any;
+    associatedUser: MemberId | null;
+    associatedUsers: Set<MemberId>;
     canReclaimHost: boolean;
-    id: any;
+    id: MemberId;
     isAudioMuted: any;
     isContentSharing: any;
     isDevice: any;
@@ -16,11 +18,13 @@ export default class Member {
     isInMeeting: any;
     isModerator: any;
     isModeratorAssignmentProhibited: any;
+    isPresenterAssignmentProhibited: any;
     isMutable: any;
     isNotAdmitted: any;
     isRecording: any;
     isRemovable: any;
     isSelf: any;
+    isPairedWithSelf: boolean;
     isBrb: boolean;
     isUser: any;
     isVideoMuted: any;
@@ -34,6 +38,10 @@ export default class Member {
     supportLiveAnnotation: boolean;
     type: any;
     namespace: string;
+    pairedWith: {
+        participantUrl?: ParticipantUrl;
+        memberId?: MemberId;
+    };
     /**
      * @param {Object} participant - the locus participant
      * @param {Object} [options] - constructor params
@@ -44,7 +52,7 @@ export default class Member {
      * @returns {Member}
      * @memberof Member
      */
-    constructor(participant: object, options?: {
+    constructor(participant: Participant, options?: {
         selfId: string;
         hostId: string;
         contentSharingId: string;
@@ -58,6 +66,13 @@ export default class Member {
      * @memberof Member
      */
     private processParticipant;
+    /**
+     * Checks if the participant is paired with another device
+     *
+     * @param {any} participant the locus participant object
+     * @returns {void}
+     */
+    processPairedDevice(participant: Participant): void;
     /**
      * Use the members options and participant values to set on the member
      * @param {Object} participant the locus participant object
@@ -114,7 +129,7 @@ export default class Member {
      * @public
      * @memberof Member
      */
-    processIsContentSharing(participant: object, sharingId: string): void;
+    processIsContentSharing(participant: Participant, sharingId: string): void;
     /**
      * Determine if this member is recording
      * @param {Object} participant
@@ -123,7 +138,7 @@ export default class Member {
      * @public
      * @memberof Member
      */
-    processIsRecording(participant: object, recordingId: string): void;
+    processIsRecording(participant: Participant, recordingId: string): void;
     /**
      * determine if this member is the self
      * @param {Object} participant

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,2 +1,157 @@
-declare const MemberUtil: any;
+import { IExternalRoles, ServerRoles, ServerRoleShape, IMediaStatus, Participant, ParticipantUrl } from './types';
+declare const MemberUtil: {
+    /**
+     * @param {Object} participant - The locus participant object.
+     * @returns {Boolean}
+     */
+    canReclaimHost: (participant: any) => any;
+    /**
+     * @param {Object} participant - The locus participant object.
+     * @returns {[ServerRoleShape]}
+     */
+    getControlsRoles: (participant: Participant) => Array<ServerRoleShape>;
+    /**
+     * Checks if the participant has the brb status enabled.
+     *
+     * @param {Participant} participant - The locus participant object.
+     * @returns {boolean} - True if the participant has brb enabled, false otherwise.
+     */
+    isBrb: (participant: Participant) => boolean;
+    /**
+     * @param {Object} participant - The locus participant object.
+     * @param {ServerRoles} controlRole the search role
+     * @returns {Boolean}
+     */
+    hasRole: (participant: Participant, controlRole: ServerRoles) => boolean;
+    /**
+     * @param {Object} participant - The locus participant object.
+     * @returns {Boolean}
+     */
+    hasCohost: (participant: Participant) => boolean;
+    /**
+     * @param {Object} participant - The locus participant object.
+     * @returns {Boolean}
+     */
+    hasModerator: (participant: Participant) => boolean;
+    /**
+     * @param {Object} participant - The locus participant object.
+     * @returns {Boolean}
+     */
+    hasPresenter: (participant: Participant) => boolean;
+    /**
+     * @param {Object} participant - The locus participant object.
+     * @returns {IExternalRoles}
+     */
+    extractControlRoles: (participant: Participant) => IExternalRoles;
+    /**
+     * @param {Object} participant - The locus participant object.
+     * @returns {Boolean}
+     */
+    isUser: (participant: Participant) => boolean;
+    isModerator: (participant: Participant) => boolean;
+    /**
+     * @param {Object} participant - The locus participant object.
+     * @returns {Boolean}
+     */
+    isGuest: (participant: Participant) => boolean;
+    /**
+     * @param {Object} participant - The locus participant object.
+     * @returns {Boolean}
+     */
+    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
+     * @param {Object} participant - The locus participant object.
+     * @param {String} id
+     * @returns {Boolean}
+     */
+    isSame: (participant: Participant, id: string) => boolean;
+    /**
+     * @param {Object} participant - The locus participant object.
+     * @param {Boolean} isGuest
+     * @param {String} status
+     * @returns {Boolean}
+     */
+    isNotAdmitted: (participant: Participant, isGuest: boolean, status: string) => boolean;
+    /**
+     * @param {Object} participant - The locus participant object.
+     * @returns {Boolean}
+     */
+    isAudioMuted: (participant: Participant) => any;
+    /**
+     * @param {Object} participant - The locus participant object.
+     * @returns {Boolean}
+     */
+    isVideoMuted: (participant: Participant) => boolean;
+    /**
+     * @param {Object} participant - The locus participant object.
+     * @returns {Boolean}
+     */
+    isHandRaised: (participant: Participant) => boolean;
+    /**
+     * @param {Object} participant - The locus participant object.
+     * @returns {Boolean}
+     */
+    isBreakoutsSupported: (participant: any) => boolean;
+    /**
+     * @param {Object} participant - The locus participant object.
+     * @returns {Boolean}
+     */
+    isInterpretationSupported: (participant: any) => boolean;
+    /**
+     * @param {Object} participant - The locus participant object.
+     * @returns {Boolean}
+     */
+    isLiveAnnotationSupported: (participant: any) => boolean;
+    /**
+     * utility method for audio/video muted status
+     * @param {any} participant
+     * @param {String} statusAccessor
+     * @param {String} controlsAccessor
+     * @returns {Boolean | undefined}
+     */
+    isMuted: (participant: Participant, statusAccessor: string, controlsAccessor: string) => any;
+    /**
+     * utility method for getting the recording member for later comparison
+     * @param {Object} controls
+     * @returns {String|null}
+     */
+    getRecordingMember: (controls: any) => any;
+    /**
+     * @param {Object} participant - The locus participant object.
+     * @returns {Boolean}
+     */
+    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: Participant) => "IN_LOBBY" | "IN_MEETING" | "NOT_IN_MEETING";
+    /**
+     * @param {Object} participant - The locus participant object.
+     * @returns {String}
+     */
+    extractId: (participant: Participant) => string;
+    /**
+     * extracts the media status from nested participant object
+     * @param {Object} participant - The locus participant object.
+     * @returns {Object}
+     */
+    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}
+     */
+    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
      */
@@ -251,6 +225,13 @@ export default class Members extends StatelessWebexPlugin {
      * @memberof Members
      */
     cancelPhoneInvite(invitee: any): any;
+    /**
+     * Cancels an SIP call to the associated meeting
+     * @param {String} invitee
+     * @returns {Promise}
+     * @memberof Members
+     */
+    cancelSIPInvite(invitee: any): any;
     /**
      * Admits waiting members (invited guests to meeting)
      * @param {Array} memberIds
@@ -290,6 +271,14 @@ export default class Members extends StatelessWebexPlugin {
      * @memberof Members
      */
     assignRoles(memberId: string, roles: Array<ServerRoleShape>): any;
+    /**
+     * Moves a meeting member into the lobby.
+     * @param {String} memberId -- The ID of the member to move.
+     * @returns {Promise} -- Resolves with the lobby‐move response.
+     * @public
+     * @memberof Members
+     */
+    moveToLobby(memberId: string): any;
     /**
      * Raise or lower the hand of a member in a meeting
      * @param {String} memberId
@@ -331,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/types/members/request.d.ts

@@ -53,6 +53,25 @@ export default class MembersRequest extends StatelessWebexPlugin {
      * @returns {Promise}
      */
     assignRolesMember(options: any): Promise<any>;
+    /**
+     * Sends a request to move a meeting member into the lobby.
+     * *
+     * @param {Object} options - Request options.
+     * @param {string} options.locusUrl - The locus URL for the meeting.
+     * @param {string} options.memberId - The ID of the member to move.
+     * @param {Object} body - The request payload.
+     * @param {Object} body.moveToLobby - Container for move‐to‐lobby data.
+     * @param {string[]} body.moveToLobby.participantIds - Array of participant IDs to move.
+     * @returns {Promise} - Resolves with the locus‐delta response.
+     */
+    moveToLobbyMember(options: {
+        locusUrl: string;
+        memberId: string;
+    }, body: {
+        moveToLobby: {
+            participantIds: string[];
+        };
+    }): Promise<any>;
     /**
      * Sends a request to raise or lower a member's hand
      * @param {Object} options
@@ -111,4 +130,11 @@ export default class MembersRequest extends StatelessWebexPlugin {
      * @memberof MembersRequest
      */
     cancelPhoneInvite(options: any): Promise<any>;
+    /**
+     * @param {Object} options with format of {invitee: object, locusUrl: string}
+     * @returns {Promise}
+     * @throws {Error} if the options are not valid and complete, must have invitee with memberId AND locusUrl
+     * @memberof MembersRequest
+     */
+    cancelSIPInvite(options: any): Promise<any>;
 }

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

@@ -124,6 +124,19 @@ declare const MembersUtil: {
             };
         };
     };
+    getMoveMemberToLobbyRequestBody: (memberId: string) => {
+        moveToLobby: {
+            participantIds: string[];
+        };
+    };
+    getMoveMemberToLobbyRequestParams: (options: {
+        memberId: string;
+        locusUrl: string;
+    }, body: any) => {
+        method: string;
+        uri: string;
+        body: any;
+    };
     /**
      * @param {ServerRoleShape} role
      * @returns {ServerRoleShape} the role shape to be added to the body
@@ -215,5 +228,19 @@ declare const MembersUtil: {
             }[];
         };
     };
+    cancelSIPInviteOptions: (invitee: any, locusUrl: any) => {
+        invitee: any;
+        locusUrl: any;
+    };
+    generateCancelSIPInviteRequestParams: (options: any) => {
+        method: string;
+        uri: any;
+        body: {
+            actionType: string;
+            invitees: {
+                address: any;
+            }[];
+        };
+    };
 };
 export default MembersUtil;

package/dist/types/metrics/constants.d.ts

@@ -45,10 +45,19 @@ declare const BEHAVIORAL_METRICS: {
     UPLOAD_LOGS_FAILURE: string;
     UPLOAD_LOGS_SUCCESS: string;
     RECEIVE_TRANSCRIPTION_FAILURE: string;
+    MEETING_IS_IN_PROGRESS_ERROR: string;
+    STATIC_MEETING_LINK_ALREADY_EXISTS_ERROR: string;
     FETCH_MEETING_INFO_V1_SUCCESS: string;
     FETCH_MEETING_INFO_V1_FAILURE: string;
+    ENABLE_STATIC_METTING_LINK_SUCCESS: string;
+    ENABLE_STATIC_METTING_LINK_FAILURE: string;
+    DISABLE_STATIC_MEETING_LINK_SUCCESS: string;
+    DISABLE_STATIC_MEETING_LINK_FAILURE: string;
     ADHOC_MEETING_SUCCESS: string;
     ADHOC_MEETING_FAILURE: string;
+    FETCH_STATIC_MEETING_LINK_SUCCESS: string;
+    FETCH_STATIC_MEETING_LINK_FAILURE: string;
+    MEETING_LINK_DOES_NOT_EXIST_ERROR: string;
     VERIFY_PASSWORD_SUCCESS: string;
     VERIFY_PASSWORD_ERROR: string;
     VERIFY_CAPTCHA_ERROR: string;
@@ -60,6 +69,7 @@ declare const BEHAVIORAL_METRICS: {
     MEETING_INFO_POLICY_ERROR: string;
     LOCUS_DELTA_SYNC_FAILED: string;
     LOCUS_DELTA_OUT_OF_ORDER: string;
+    LOCUS_SYNC_HANDLING_FAILED: string;
     PERMISSION_TOKEN_REFRESH: string;
     PERMISSION_TOKEN_REFRESH_ERROR: string;
     TURN_DISCOVERY_LATENCY: string;

package/dist/types/multistream/remoteMediaManager.d.ts

@@ -249,13 +249,22 @@ export declare class RemoteMediaManager extends EventsScope {
     private invalidateCurrentRemoteMedia;
     /** emits Event.VideoLayoutChanged */
     private emitVideoLayoutChangedEvent;
+    /**
+     * Set multiple remote video CSIs at once
+     * @param remoteMediaCsis The remote medias and CSIs to set them to
+     * @returns {void}
+     */
+    setRemoteVideoCsis(remoteMediaCsis: {
+        remoteMedia: RemoteMedia;
+        csi?: CSI | null;
+    }[]): void;
     /**
      * Sets a new CSI on a given remote media object
      *
      * @param {RemoteMedia} remoteMedia remote Media object to modify
      * @param {CSI} csi new CSI value, can be null if we want to stop receiving media
      */
-    setRemoteVideoCsi(remoteMedia: RemoteMedia, csi: CSI | null): void;
+    setRemoteVideoCsi(remoteMedia: RemoteMedia, csi?: CSI | null): void;
     /**
      * Adds a new member video pane to the currently selected layout.
      *