@webex/plugin-meetings 3.12.0-next.5 → 3.12.0-next.51

package/dist/types/locus-info/index.d.ts

@@ -25,10 +25,9 @@ export type HashTreeParserEntry = {
  *
  * @param {HashTreeMessage} message - The hash tree message to find the meeting for
  * @param {MeetingCollection} meetingCollection - The collection of meetings to search
- * @param {string} deviceUrl - The URL of the user's device
  * @returns {any} The meeting if found, otherwise undefined
  */
-export declare function findMeetingForHashTreeMessage(message: HashTreeMessage, meetingCollection: MeetingCollection, deviceUrl: string): any;
+export declare function findMeetingForHashTreeMessage(message: HashTreeMessage | undefined, meetingCollection: MeetingCollection): any;
 /**
  * Creates a locus object from the objects received in a hash tree message. It usually will be
  * incomplete, because hash tree messages only contain the parts of locus that have changed,
@@ -130,6 +129,7 @@ export default class LocusInfo extends EventsScope {
     private createHashTreeParser;
     /**
      * @param {Object} data - data to initialize locus info with. It may be from a join or GET /loci response or from a Mercury event that triggers a creation of meeting object
+     * @param {Function} [onLocusSynced] - optional callback that will be called at the end of initial setup, when locus info is fully synced. It will be called with the full locus snapshot as an argument (which may be null if we haven't received any full locus DTOs during the initial setup, for example in case we receive only hash tree messages without full locus DTOs)
      * @returns {undefined}
      * @memberof LocusInfo
      */
@@ -145,7 +145,13 @@ export default class LocusInfo extends EventsScope {
     } | {
         trigger: 'get-loci-response';
         locus?: LocusDTO;
-    }): Promise<void>;
+    }, onLocusSynced?: (locus: LocusDTO) => void): Promise<void>;
+    /**
+     * Builds a full locus DTO snapshot from current internal locus state.
+     *
+     * @returns {LocusDTO}
+     */
+    private getCurrentLocusSnapshot;
     /**
      * Handles HTTP response from Locus API call.
      * @param {Meeting} meeting meeting object
@@ -167,6 +173,28 @@ export default class LocusInfo extends EventsScope {
      * @returns {void}
      */
     sendClassicVsHashTreeMismatchMetric(meeting: any, message: string): void;
+    /**
+     * Helper that handles the common logic for reactivating a stopped HashTreeParser when
+     * a newer "replaces" is detected. Used by both the message and API response parser switch methods.
+     *
+     * @param {string} callerName - name of the calling method, used in log messages
+     * @param {string} locusUrl - the locus URL of the stopped parser
+     * @param {HashTreeParserEntry} stoppedEntry - the stopped parser entry
+     * @param {ReplacesInfo} replaces - replacement info extracted from self
+     * @param {Function} resumeCallback - callback to invoke after reactivation to resume the parser
+     * @returns {void}
+     */
+    private resumeStoppedParser;
+    /**
+     * Handles an API response whose locusUrl doesn't match any active HashTreeParser
+     * (either no entry exists, or the existing entry is stopped).
+     * Creates a new parser or reactivates a stopped one using initializeFromGetLociResponse.
+     *
+     * @param {string} locusUrl - the locus URL from the API response
+     * @param {LocusDTO} locus - the locus DTO from the API response
+     * @returns {void}
+     */
+    private handleHashTreeParserSwitchForAPIResponse;
     /**
      * Checks if the hash tree message should trigger a switch to a different HashTreeParser
      *
@@ -183,13 +211,19 @@ export default class LocusInfo extends EventsScope {
      * @returns {void}
      */
     private handleHashTreeMessage;
+    /**
+     * Triggers a sync of all hash tree datasets for all hash tree parsers associated with this meeting.
+     * The syncs are executed sequentially within each parser.
+     *
+     * @returns {Promise<void>}
+     */
+    syncAllHashTreeDatasets(): Promise<void>;
     /**
      * Callback registered with HashTreeParser to receive locus info updates.
      * Updates our locus info based on the data parsed by the hash tree parser.
      *
      * @param {string} locusUrl - the locus URL for which the update is received
-     * @param {LocusInfoUpdateType} updateType - The type of update received.
-     * @param {Object} [data] - Additional data for the update, if applicable.
+     * @param {LocusInfoUpdate} update - Details about the update.
      * @returns {void}
      */
     private updateFromHashTree;
@@ -214,8 +248,8 @@ export default class LocusInfo extends EventsScope {
      * @param {string} debugText string explaining the trigger for this call, added to logs for debugging purposes
      * @param {object} locus locus object
      * @param {object} metadata locus hash trees metadata
-     * @param {string} eventType locus event
      * @param {DataSet[]} dataSets
+     * @param {string} eventType locus event
      * @returns {void}
      */
     private onFullLocusWithHashTrees;
@@ -444,4 +478,10 @@ export default class LocusInfo extends EventsScope {
      * @memberof LocusInfo
      */
     clearMainSessionLocusCache(): void;
+    /**
+     * Cleans up all hash tree parsers and clears internal maps.
+     * @returns {void}
+     * @memberof LocusInfo
+     */
+    cleanUp(): void;
 }

package/dist/types/locus-info/types.d.ts

@@ -1,14 +1,30 @@
+import { Enum } from '../constants';
 import { HtMeta } from '../hashTree/types';
+export declare const EndMeetingReason: {
+    readonly maxMeetingDuration: "MAX_MEETING_DURATION";
+    readonly allParticipantsLeft: "ALL_PARTICIPANTS_LEFT";
+    readonly sipHostLeft: "SIP_HOST_LEFT";
+    readonly noHost: "NO_HOST";
+    readonly waitingForMpsEndMeetingTimeout: "WAITING_FOR_MPS_END_MEETING_TIMEOUT";
+    readonly fraudDetection: "FRAUD_DETECTION";
+    readonly meetingEndedByHost: "MEETING_ENDED_BY_HOST";
+    readonly meetingUpdated: "MEETING_UPDATED";
+    readonly meetingCancelled: "MEETING_CANCELLED";
+    readonly autoEndWithSingleParticipant: "AUTO_END_WITH_SINGLE_PARTICIPANT";
+    readonly breakoutEnded: "BREAKOUT_ENDED";
+};
+export type EndMeetingReason = Enum<typeof EndMeetingReason>;
 export type LocusFullState = {
     active: boolean;
     count: number;
     lastActive: string;
     locked: boolean;
     sessionId: string;
-    seessionIds: string[];
+    sessionIds: string[];
     startTime: number;
     state: string;
     type: string;
+    endMeetingReason?: EndMeetingReason;
 };
 export type Links = {
     services: Record<'breakout' | 'record', {
@@ -59,3 +75,7 @@ export type ReplacesInfo = {
     replacedAt: string;
     sessionId: string;
 };
+export declare const LocusErrorCodes: {
+    readonly LOCUS_INACTIVE: 2403004;
+};
+export type LocusErrorCodes = Enum<typeof LocusErrorCodes>;

package/dist/types/media/properties.d.ts

@@ -26,6 +26,7 @@ export default class MediaProperties {
     shareAudioStream?: LocalSystemAudioStream;
     videoDeviceId: any;
     videoStream?: LocalCameraStream;
+    srtpCipher: string | undefined;
     namespace: string;
     mediaIssueCounters: {
         [key: string]: number;

package/dist/types/meeting/in-meeting-actions.d.ts

@@ -115,6 +115,7 @@ interface IInMeetingActions {
     canDisablePollingQA?: boolean;
     canAttendeeRequestAiAssistantEnabled?: boolean;
     isAttendeeRequestAiAssistantDeclinedAll?: boolean;
+    isAnonymizeDisplayNamesEnabled?: boolean;
 }
 /**
  * @class InMeetingActions
@@ -230,6 +231,7 @@ export default class InMeetingActions implements IInMeetingActions {
     canDisablePollingQA: any;
     canAttendeeRequestAiAssistantEnabled: any;
     isAttendeeRequestAiAssistantDeclinedAll: any;
+    isAnonymizeDisplayNamesEnabled: any;
     /**
      * Returns all meeting action options
      * @returns {Object}

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

@@ -374,7 +374,7 @@ export default class Meeting extends StatelessWebexPlugin {
     webinar: any;
     conversationUrl: string;
     callStateForMetrics: CallStateForMetrics;
-    destination: string;
+    destination: string | LocusDTO;
     destinationType: DESTINATION_TYPE;
     deviceUrl: string;
     hostId: string;
@@ -412,6 +412,8 @@ export default class Meeting extends StatelessWebexPlugin {
     floorGrantPending: boolean;
     hasJoinedOnce: boolean;
     hasWebsocketConnected: boolean;
+    private mercuryOnlineHandler?;
+    private mercuryOfflineHandler?;
     inMeetingActions: InMeetingActions;
     isLocalShareLive: boolean;
     isRoapInProgress: boolean;
@@ -1051,6 +1053,13 @@ export default class Meeting extends StatelessWebexPlugin {
      * @memberof Meeting
      */
     setSipUri(sipUri: string): void;
+    /**
+     * After initial locus setup, refreshes destination with synced locus data and optionally
+     * performs deferred meeting info fetch when initial locus was incomplete.
+     * @param {LocusDTO} locus
+     * @returns {void}
+     */
+    finalizeMeetingAfterInitialLocusSetup(locus: LocusDTO): Promise<void>;
     /**
      * Set the locus info the class instance. Should be called with the parsed locus
      * we got in the join response.
@@ -1163,6 +1172,22 @@ export default class Meeting extends StatelessWebexPlugin {
      * @memberof Meeting
      */
     setMercuryListener(): void;
+    /**
+     * Removes this meeting's Mercury ONLINE/OFFLINE event listeners registered
+     * by setMercuryListener(). Must be called before Locus /leave to avoid
+     * unnecessary syncs/metrics triggered by events received while leaving
+     * (per Locus team recommendation).
+     *
+     * Mercury is a process-wide singleton shared with other plugins, so we
+     * pass the bound handler refs to .off() to avoid clearing every listener
+     * for ONLINE/OFFLINE on the shared emitter.
+     *
+     * Idempotent: subsequent calls are no-ops because the handler refs are
+     * cleared after detaching.
+     * @private
+     * @returns {void}
+     */
+    private stopListeningForMercuryEvents;
     /**
      * Close the peer connections and remove them from the class.
      * Cleanup any media connection related things.
@@ -1318,6 +1343,11 @@ export default class Meeting extends StatelessWebexPlugin {
      * @returns{void}
      */
     private triggerStopReceivingTranscriptionEvent;
+    /**
+     * Restores LLM subchannel subscriptions after reconnect when captions are active.
+     * @returns {void}
+     */
+    private restoreLLMSubscriptionsIfNeeded;
     /**
      * This is a callback for the LLM event that is triggered when it comes online
      * This method in turn will trigger an event to the developers that the LLM is connected
@@ -1351,8 +1381,41 @@ export default class Meeting extends StatelessWebexPlugin {
      * @returns {void}
      */
     private clearLLMHealthCheckTimer;
+    /**
+     * Removes LLM event listeners and clears the health check timer.
+     * Must be called before Locus /leave to avoid unnecessary syncs triggered
+     * by events received while leaving (per Locus team recommendation).
+     * Idempotent: safe to call multiple times; .off() is a no-op when no
+     * matching listener is registered.
+     * @private
+     * @returns {void}
+     */
+    private stopListeningForLLMEvents;
+    /**
+     * Stops listening on every event bus (LLM, Mercury, voicea/transcription,
+     * annotation) that could otherwise deliver events to this meeting while
+     * Locus is processing /leave or /end. Per the Locus team recommendation,
+     * this must run before the Locus request is dispatched to avoid
+     * unnecessary syncs triggered by in-flight events.
+     *
+     * Voicea (transcription) subscribes to llm 'event:relay.event' internally,
+     * and the annotation plugin subscribes to both mercury and llm, so both
+     * must be torn down alongside the direct LLM/Mercury listeners.
+     *
+     * Idempotent: safe to call multiple times; .off() is a no-op when no
+     * matching listener is registered, and stopTranscription is guarded.
+     * @private
+     * @returns {void}
+     */
+    private stopListeningForMeetingEvents;
     /**
      * Disconnects and cleans up the default LLM session listeners/timers.
+     *
+     * Ownership-aware: only calls `disconnectLLM` when this meeting is the
+     * current owner of the default LLM session (or when no owner is recorded).
+     * Event listeners belonging to this meeting instance are always detached
+     * so they do not receive another meeting's relay events.
+     *
      * @param {Object} options
      * @param {boolean} [options.removeOnlineListener=true] removes the one-time online listener
      * @param {boolean} [options.throwOnError=true] rethrows disconnect errors when true
@@ -1372,6 +1435,12 @@ export default class Meeting extends StatelessWebexPlugin {
      * @returns {void}
      */
     saveDataChannelToken(join: any): void;
+    /**
+     * Ensures default-session data channel token exists after lobby admission.
+     * Some lobby users do not receive a token until they are admitted.
+     * @returns {Promise<boolean>} true when a new token is fetched and cached
+     */
+    private ensureDefaultDatachannelTokenAfterAdmit;
     /**
      * Connects to low latency mercury and reconnects if the address has changed
      * It will also disconnect if called when the meeting has ended

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

@@ -133,6 +133,13 @@ declare const MeetingUtil: {
      * @returns {void}
      */
     addSequence: (meeting: any, requestBody: any) => void;
+    /**
+     * Checks if Locus API response contains a Locus DTO
+     *
+     * @param {any} response http response from Locus API call
+     * @returns {boolean} true if response contains a Locus DTO
+     */
+    isLocusDtoInAPIResponse(response: any): any;
     /**
      * Updates the locus info for the meeting with the locus
      * information returned from API requests made to Locus
@@ -146,6 +153,7 @@ declare const MeetingUtil: {
     generateLocusDeltaRequest: (originalMeeting: any) => (originalOptions: any) => any;
     canAttendeeRequestAiAssistantEnabled: (displayHints?: any[], roles?: any[]) => boolean;
     attendeeRequestAiAssistantDeclinedAll: (displayHints?: any[]) => boolean;
+    isAnonymizeDisplayNamesEnabled: (displayHints: any) => any;
     selfSupportsFeature: (feature: SELF_POLICY, userPolicies: Record<SELF_POLICY, boolean>) => boolean;
     parseInterpretationInfo: (meeting: any, meetingInfo: any) => void;
     /**

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

@@ -8,7 +8,7 @@ import 'webrtc-adapter';
 import { LOCUSEVENT, DESTINATION_TYPE } from '../constants';
 import { CallStateForMetrics } from '../meeting';
 import Reachability from '../reachability';
-import { INoiseReductionEffect, IVirtualBackgroundEffect, MeetingRegistrationStatus } from './meetings.types';
+import { FetchSitePreferencesMeViaSiteOptions, INoiseReductionEffect, IVirtualBackgroundEffect, MeetingRegistrationStatus, SitePreferencesResponse } from './meetings.types';
 import { HashTreeMessage } from '../hashTree/hashTreeParser';
 export type LocusEvent = {
     eventType: LOCUSEVENT;
@@ -368,6 +368,23 @@ export default class Meetings extends WebexPlugin {
      * @memberof Meetings
      */
     getPersonalMeetingRoom(): any;
+    /**
+     * Fetches site preferences for the provided Webex site, or the preferred Webex site.
+     * This is used to determine capabilities of the site, such as whether scheduling a webinar is supported.
+     *
+     * @param {object} [options]
+     * @param {string} [options.siteUrl] - Webex site URL. Defaults to preferredWebexSite, for example "cisco.webex.com".
+     * @param {string} [options.siteName] - Site name query override. Defaults to the site name derived from siteUrl, for example "cisco" for "cisco.webex.com".
+     * @param {SitePreferenceSelectOption[]} [options.selectOptions] - Preference sections to fetch. Defaults to 'scheduling'.
+     * @returns {Promise<SitePreferencesResponse>} site preferences response body
+     * @throws {ParameterError}
+     * @public
+     * @memberof Meetings
+     * @example
+     * const preferences = await webex.meetings.fetchSitePreferencesMeViaSite();
+     * const supportScheduleWebinar = preferences?.scheduling?.supportScheduleWebinar;
+     */
+    fetchSitePreferencesMeViaSite(options?: FetchSitePreferencesMeViaSiteOptions): Promise<SitePreferencesResponse>;
     /**
      * Returns basic information about a meeting that exists or
      * used to exist in the MeetingCollection
@@ -477,8 +494,9 @@ export default class Meetings extends WebexPlugin {
      * @public
      * @memberof Meetings
      */
-    syncMeetings({ keepOnlyLocusMeetings }?: {
+    syncMeetings({ keepOnlyLocusMeetings, skipHashTreeSync, }?: {
         keepOnlyLocusMeetings?: boolean;
+        skipHashTreeSync?: boolean;
     }): Promise<void>;
     /**
      * sort out locus array for initial creating

package/dist/types/meetings/meetings.types.d.ts

@@ -19,3 +19,18 @@ export type MeetingRegistrationStatus = {
     mercuryConnect: boolean;
     checkH264Support: boolean;
 };
+export declare enum SitePreferenceSelectOption {
+    SCHEDULING = "scheduling"
+}
+export type FetchSitePreferencesMeViaSiteOptions = {
+    siteUrl?: string;
+    siteName?: string;
+    selectOptions?: SitePreferenceSelectOption[];
+};
+export declare const DEFAULT_SITE_PREFERENCE_SELECT_OPTIONS: SitePreferenceSelectOption[];
+export type SitePreferencesResponse = {
+    scheduling?: {
+        supportScheduleWebinar?: boolean;
+        webinarWebLink?: string;
+    };
+};

package/dist/types/meetings/request.d.ts

@@ -1,4 +1,5 @@
 import { StatelessWebexPlugin } from '@webex/webex-core';
+import { type FetchSitePreferencesMeViaSiteOptions, type SitePreferencesResponse } from './meetings.types';
 /**
  * @class MeetingRequest
  */
@@ -18,6 +19,19 @@ export default class MeetingRequest extends StatelessWebexPlugin {
      * @returns {Promise<object>} getMeetingPreferences
      */
     getMeetingPreferences(): any;
+    /**
+     * Fetches site preferences from a given site given a select option and a siteUrl with an optional siteName. If siteName is not provided, it will be derived from the siteUrl. If siteUrl is not provided, it will throw an error. If selectOptions is not provided, it will default to scheduling.
+     *
+     * @param {object} [options]
+     * @param {string} [options.siteUrl] - Webex site URL, for example "cisco.webex.com".
+     * @param {string} [options.siteName] - Site name query override. Defaults to the site name derived from options.siteUrl, e.g., "cisco".
+     * @param {SitePreferenceSelectOption[]} [options.selectOptions] - Preference sections to fetch. Defaults to 'scheduling'.
+     * @returns {Promise<SitePreferencesResponse>} site preferences response body
+     * @throws {ParameterError}
+     * @public
+     * @memberof MeetingRequest
+     */
+    fetchSitePreferencesMeViaSite(options?: FetchSitePreferencesMeViaSiteOptions): Promise<SitePreferencesResponse>;
     /**
      *  Fetches indivdual locus rather then getting all at once
      * @param {object} responseBody determine the locus and fetch them if a remoteUrl is given

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

@@ -20,6 +20,7 @@ export default class Member {
     isModerator: any;
     isModeratorAssignmentProhibited: any;
     isPresenterAssignmentProhibited: any;
+    isAttendeeAssignmentProhibited: any;
     isMutable: any;
     isNotAdmitted: any;
     isRecording: any;

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

@@ -89,6 +89,7 @@ export interface Participant {
     moderator: boolean;
     moderatorAssignmentNotAllowed: boolean;
     presenterAssignmentNotAllowed: boolean;
+    attendeeAssignmentNotAllowed?: boolean;
     person: ParticipantPerson;
     resourceGuest: boolean;
     state: string;

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

@@ -66,6 +66,7 @@ declare const MemberUtil: {
     isDevice: (participant: Participant) => boolean;
     isModeratorAssignmentProhibited: (participant: Participant) => boolean;
     isPresenterAssignmentProhibited: (participant: Participant) => boolean;
+    isAttendeeAssignmentProhibited: (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

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

@@ -92,5 +92,6 @@ declare const BEHAVIORAL_METRICS: {
     DEPRECATED_DELETE_CODEC_PARAMETERS_USED: string;
     SET_CUSTOM_CODEC_PARAMETERS_USED: string;
     MARK_CUSTOM_CODEC_PARAMETERS_FOR_DELETION_USED: string;
+    HASH_TREE_SYNC_FAILURE: string;
 };
 export { BEHAVIORAL_METRICS as default };