@webex/plugin-meetings 3.12.0-next.4 → 3.12.0-next.41

package/dist/types/hashTree/hashTreeParser.d.ts

@@ -45,9 +45,13 @@ export declare const LocusInfoUpdateType: {
     readonly MEETING_ENDED: "MEETING_ENDED";
 };
 export type LocusInfoUpdateType = Enum<typeof LocusInfoUpdateType>;
-export type LocusInfoUpdateCallback = (updateType: LocusInfoUpdateType, data?: {
+export type LocusInfoUpdate = {
+    updateType: typeof LocusInfoUpdateType.OBJECTS_UPDATED;
     updatedObjects: HashTreeObject[];
-}) => void;
+} | {
+    updateType: typeof LocusInfoUpdateType.MEETING_ENDED;
+};
+export type LocusInfoUpdateCallback = (update: LocusInfoUpdate) => void;
 /**
  * This error is thrown if we receive information that the meeting has ended while we're processing some hash messages.
  * It's handled internally by HashTreeParser and results in MEETING_ENDED being sent up.
@@ -67,6 +71,10 @@ declare class HashTreeParser {
     heartbeatIntervalMs?: number;
     private excludedDataSets;
     state: 'active' | 'stopped';
+    private syncQueue;
+    private isSyncInProgress;
+    private isSyncAllInProgress;
+    private syncQueueProcessingPromise;
     /**
      * Constructor for HashTreeParser
      * @param {Object} options
@@ -120,14 +128,6 @@ declare class HashTreeParser {
      * @returns {Promise}
      */
     private initializeNewVisibleDataSet;
-    /**
-     * Sends a special sync request to Locus with all leaves empty - this is a way to get all the data for a given dataset.
-     *
-     * @param {string} datasetName - name of the dataset for which to send the request
-     * @param {string} debugText - text to include in logs
-     * @returns {Promise}
-     */
-    private sendInitializationSyncRequestToLocus;
     /**
      * Queries Locus for all up-to-date information about all visible data sets
      *
@@ -298,11 +298,35 @@ declare class HashTreeParser {
      * Performs a sync for the given data set.
      *
      * @param {InternalDataSet} dataSet - The data set to sync
-     * @param {string} rootHash - Our current root hash for this data set
      * @param {string} reason - The reason for the sync (used for logging)
+     * @param {boolean} [isInitialization] - Whether this is an initialization sync (sends empty leaves data instead of comparing hashes)
      * @returns {Promise<void>}
      */
     private performSync;
+    /**
+     * Enqueues a sync for the given data set. If the data set is already in the queue, the request is ignored.
+     * This ensures that all syncs are executed sequentially and no more than 1 sync runs at a time.
+     *
+     * @param {string} dataSetName - The name of the data set to sync
+     * @param {string} reason - The reason for the sync (used for logging)
+     * @param {boolean} [isInitialization=false] - Whether this is an initialization sync (uses empty leaves data instead of hash comparison)
+     * @returns {void}
+     */
+    private enqueueSyncForDataset;
+    /**
+     * Processes the sync queue sequentially. Only one instance of this method runs at a time.
+     *
+     * @returns {Promise<void>}
+     */
+    private processSyncQueue;
+    /**
+     * Syncs all data sets that have hash trees, one by one in sequence, using the priority order
+     * provided by sortByInitPriority(). Does nothing if the parser is stopped or if a syncAllDatasets
+     * call is already in progress.
+     *
+     * @returns {Promise<void>}
+     */
+    syncAllDatasets(): Promise<void>;
     /**
      * Runs the sync algorithm for the given data set.
      *
@@ -333,24 +357,38 @@ declare class HashTreeParser {
      */
     stop(): void;
     /**
-     * Resumes the HashTreeParser that was previously stopped.
+     * Cleans up the HashTreeParser, stopping all timers and clearing all internal state.
+     * After calling this, the parser should not be used anymore.
+     * @returns {void}
+     */
+    cleanUp(): void;
+    /**
+     * Resumes the HashTreeParser that was previously stopped, using a hash tree message.
      * @param {HashTreeMessage} message - The message to resume with, it must contain metadata with visible data sets info
      * @returns {void}
      */
-    resume(message: HashTreeMessage): void;
+    resumeFromMessage(message: HashTreeMessage): void;
+    /**
+     * Resumes the HashTreeParser that was previously stopped, using a Locus API response.
+     * Unlike resumeFromMessage(), this does not require metadata/dataSets in the input,
+     * as it fetches all necessary information from Locus via initializeFromGetLociResponse.
+     * @param {LocusDTO} locus - locus object from an API response
+     * @returns {Promise}
+     */
+    resumeFromApiResponse(locus: LocusDTO): Promise<void>;
     private checkForSentinelHttpResponse;
     /**
      * Gets the current hashes from the locus for a specific data set.
      * @param {string} dataSetName
      * @param {string} currentRootHash
-     * @returns {string[]}
+     * @returns {Object|null} An object containing the hashes and leaf count, or null if the hashes match and no sync is needed
      */
     private getHashesFromLocus;
     /**
      * Sends a sync request to Locus for the specified data set.
      *
      * @param {InternalDataSet} dataSet The data set to sync.
-     * @param {Record<number, LeafDataItem[]>} mismatchedLeavesData The mismatched leaves data to include in the sync request.
+     * @param {Object} options Either `{ isInitialization: true }` for init syncs (uses leafCount=1 with empty leaf data) or `{ mismatchedLeavesData }` for normal syncs.
      * @returns {Promise<HashTreeMessage|null>}
      */
     private sendSyncRequestToLocus;

package/dist/types/hashTree/utils.d.ts

@@ -20,3 +20,14 @@ export declare function isMetadata(object: HashTreeObject): boolean;
  * @returns {void}
  */
 export declare const deleteNestedObjectsWithHtMeta: (currentLocusPart: any, parent?: any, currentKey?: string | number) => void;
+/**
+ * Reorders items so that those matching the given priority list come first (in priority order),
+ * followed by everything else in their original order.
+ *
+ * @param {Array<T>} items - The items to reorder
+ * @param {string[]} priority - Ordered list of names that should come first
+ * @returns {Array<T>} A new array with prioritized items first
+ */
+export declare function sortByInitPriority<T extends {
+    name: string;
+}>(items: T[], priority: string[]): T[];

package/dist/types/interceptors/locusRetry.d.ts

@@ -11,11 +11,11 @@ export default class LocusRetryStatusInterceptor extends Interceptor {
      */
     static create(): LocusRetryStatusInterceptor;
     /**
-     * Handle response errors
-     * @param {Object} options
-     * @param {WebexHttpError} reason
-     * @returns {Promise<WebexHttpError>}
+     * Check whether a URI is a Locus /hashtree or /sync endpoint.
+     * @param {string} uri
+     * @returns {boolean}
      */
+    private static isLocusHashtreeOrSync;
     onResponseError(options: any, reason: any): Promise<unknown>;
     /**
      * Handle retries for locus service unavailable errors

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', {

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,6 +1381,33 @@ 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.
      * @param {Object} options
@@ -1372,6 +1429,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/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