@webex/plugin-meetings 3.11.0-webex-services-ready.1 → 3.12.0-mobius-socket.1

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

@@ -1,8 +1,9 @@
 /// <reference types="node" />
 import { StatelessWebexPlugin } from '@webex/webex-core';
 import { ClientEvent, ClientEventLeaveReason } from '@webex/internal-plugin-metrics';
-import { ClientEvent as RawClientEvent } from '@webex/event-dictionary-ts';
+import type { ClientEvent as RawClientEvent } from '@webex/event-dictionary-ts';
 import { MediaType, StatsAnalyzer, NetworkQualityMonitor, StatsMonitor } from '@webex/internal-media-core';
+import { DataChannelTokenType } from '@webex/internal-plugin-llm';
 import { LocalStream, LocalCameraStream, LocalDisplayStream, LocalSystemAudioStream, LocalMicrophoneStream } from '@webex/media-helpers';
 import Roap, { type TurnDiscoverySkipReason } from '../roap/index';
 import { type TurnServerInfo } from '../roap/types';
@@ -23,7 +24,7 @@ import { LocusMediaRequest } from './locusMediaRequest';
 import { BrbState } from './brbState';
 import { SetStageOptions } from './request.type';
 import { Invitee } from './type';
-import { DataSet } from '../hashTree/hashTreeParser';
+import { DataSet, HashTreeMessage, Metadata } from '../hashTree/hashTreeParser';
 import { LocusDTO } from '../locus-info/types';
 export type CaptionData = {
     id: string;
@@ -70,6 +71,7 @@ export type AddMediaOptions = {
     remoteMediaManagerConfig?: RemoteMediaManagerConfiguration;
     bundlePolicy?: BundlePolicy;
     allowMediaInLobby?: boolean;
+    allowPublishMediaInLobby?: boolean;
     additionalMediaOptions?: AdditionalMediaOptions;
 };
 export type AdditionalMediaOptions = {
@@ -346,6 +348,16 @@ type FetchMeetingInfoParams = {
  * @property {number} networkQualityScore - {1|0} 1 indicates acceptable uplink 0 indicates unacceptable uplink based on threshold
  * @memberof Meeting
  */
+/**
+ * Stores an event so all events can be later retrieved via a console command for debugging.
+ * @param {string} type
+ * @param {Object} data
+ * @returns {void}
+ */
+export declare function storeEventForDebugging(type: string, data: {
+    eventType: any;
+    stateElementsMessage?: HashTreeMessage;
+}): void;
 /**
  * @description Meeting is the crux of the plugin
  * @export
@@ -358,6 +370,7 @@ export default class Meeting extends StatelessWebexPlugin {
     breakouts: any;
     simultaneousInterpretation: any;
     annotation: any;
+    aiEnableRequest: any;
     webinar: any;
     conversationUrl: string;
     callStateForMetrics: CallStateForMetrics;
@@ -405,6 +418,10 @@ export default class Meeting extends StatelessWebexPlugin {
     keepAliveTimerId: NodeJS.Timeout;
     lastVideoLayoutInfo: any;
     locusInfo: any;
+    isUserUnadmitted?: boolean;
+    joinedWith?: any;
+    selfId?: string;
+    roles: any[];
     locusMediaRequest?: LocusMediaRequest;
     mediaProperties: MediaProperties;
     mediaRequestManagers: {
@@ -438,7 +455,6 @@ export default class Meeting extends StatelessWebexPlugin {
     endCallInitJoinReq: any;
     endJoinReqResp: any;
     endLocalSDPGenRemoteSDPRecvDelay: any;
-    joinedWith: any;
     locusId: any;
     startCallInitJoinReq: any;
     startJoinReqResp: any;
@@ -453,12 +469,11 @@ export default class Meeting extends StatelessWebexPlugin {
     permissionTokenReceivedLocalTime: number;
     resourceId: any;
     resourceUrl: string;
-    selfId: string;
     state: any;
     localAudioStreamMuteStateHandler: () => void;
     localVideoStreamMuteStateHandler: () => void;
     localOutputTrackChangeHandler: () => void;
-    roles: any[];
+    localConstraintsChangeHandler: () => void;
     environment: string;
     namespace: string;
     allowMediaInLobby: boolean;
@@ -1060,6 +1075,7 @@ export default class Meeting extends StatelessWebexPlugin {
         host: object;
         selfId: string;
         dataSets: DataSet[];
+        metadata: Metadata;
     }): void;
     /**
      * Upload logs for the current meeting
@@ -1302,6 +1318,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
@@ -1335,10 +1356,36 @@ export default class Meeting extends StatelessWebexPlugin {
      * @returns {void}
      */
     private clearLLMHealthCheckTimer;
+    /**
+     * Disconnects and cleans up the default LLM session listeners/timers.
+     * @param {Object} options
+     * @param {boolean} [options.removeOnlineListener=true] removes the one-time online listener
+     * @param {boolean} [options.throwOnError=true] rethrows disconnect errors when true
+     * @returns {Promise<void>}
+     */
+    private cleanupLLMConneciton;
+    /**
+     * Clears all data channel tokens stored in LLM.
+     * Called during meeting cleanup to ensure stale tokens are not reused.
+     * @returns {void}
+     */
+    clearDataChannelToken(): void;
+    /**
+     * Saves the data channel tokens from the join response into LLM so that
+     * updateLLMConnection / updatePSDataChannel don't need to fetch them from locusInfo.
+     * @param {Object} join - The parsed join response (from MeetingUtil.parseLocusJoin)
+     * @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
-     * @param {String} datachannelUrl
      * @returns {Promise}
      */
     updateLLMConnection(): Promise<any>;
@@ -1909,7 +1956,7 @@ export default class Meeting extends StatelessWebexPlugin {
      * @public
      * @memberof Meeting
      */
-    clearMeetingData: () => void;
+    clearMeetingData: () => Promise<void>;
     /**
      * starts keepAlives being sent
      * @returns {void}
@@ -2087,5 +2134,23 @@ export default class Meeting extends StatelessWebexPlugin {
      * @memberof Meetings
      */
     cancelSipCallOut(participantId: string): Promise<any>;
+    /**
+     * Method to get new data
+     * @returns {Promise}
+     */
+    refreshDataChannelToken(): Promise<{
+        body: {
+            datachannelToken: any;
+            dataChannelTokenType: DataChannelTokenType;
+        };
+    }>;
+    /**
+     * Determines the current data channel token type based on the meeting state.
+     *
+     * variant should be used when connecting to the LLM data channel.
+     *
+     * @returns {DataChannelTokenType} The token type representing the current session mode.
+     */
+    getDataChannelTokenType(): DataChannelTokenType;
 }
 export {};

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

@@ -1,5 +1,5 @@
 import { StatelessWebexPlugin } from '@webex/webex-core';
-import { SendReactionOptions, BrbOptions, ToggleReactionsOptions, PostMeetingDataConsentOptions, SynchronizeVideoLayout } from './request.type';
+import { SendReactionOptions, BrbOptions, ToggleReactionsOptions, PostMeetingDataConsentOptions, SynchronizeVideoLayout, fetchDataChannelTokenOptions } from './request.type';
 import { AnnotationInfo } from '../annotation/annotation.types';
 import { ClientMediaPreferences } from '../reachability/reachability.types';
 /**
@@ -364,4 +364,19 @@ export default class MeetingRequest extends StatelessWebexPlugin {
      * @returns {Promise} The API response
      */
     cancelSipCallOut(participantId: any): Promise<any>;
+    /**
+     * Sends a request to retrieve the datachannel authorization token for a participant.
+     *
+     * For regular meeting data channel:
+     *   GET /locus/api/v1/loci/{uuid:lid}/participant/{uuid:pid}/datachannel/token
+     *
+     * For practice session data channel:
+     *   GET /locus/api/v1/loci/{uuid:lid}/participant/{uuid:pid}/practiceSession/datachannel/token
+     *
+     * @param {string} locusUrl - The locus url.
+     * @param {string} requestingParticipantId - The participant UUID.
+     * @param {boolean} [isPracticeSession=false] - Whether to get the practice session token.
+     * @returns {Promise<{datachannelToken: string}>}
+     */
+    fetchDatachannelToken({ locusUrl, requestingParticipantId, isPracticeSession, }: fetchDataChannelTokenOptions): Promise<any>;
 }

package/dist/types/meeting/request.type.d.ts

@@ -94,4 +94,9 @@ export type SetStageVideoLayout = {
 export type UnsetStageVideoLayout = {
     overrideDefault: false;
 };
+export type fetchDataChannelTokenOptions = {
+    locusUrl: string;
+    requestingParticipantId: string;
+    isPracticeSession: boolean;
+};
 export type SynchronizeVideoLayout = SetStageVideoLayout | UnsetStageVideoLayout;

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

@@ -2,6 +2,34 @@ import { LocalCameraStream, LocalMicrophoneStream } from '@webex/media-helpers';
 import { SELF_POLICY, IP_VERSION } from '../constants';
 declare const MeetingUtil: {
     parseLocusJoin: (response: any) => any;
+    /**
+     * Sanitizes a WebSocket URL by extracting only protocol, host, and pathname
+     * Returns concatenated protocol + host + pathname for safe logging
+     * Note: This is used for logging only; URL matching uses partial matching via _urlsPartiallyMatch
+     * @param {string} urlString - The URL to sanitize
+     * @returns {string} Sanitized URL or empty string if parsing fails
+     */
+    sanitizeWebSocketUrl: (urlString: string) => string;
+    /**
+     * Checks if two URLs partially match using an endsWith approach
+     * Combines host and pathname, then checks if one ends with the other
+     * This handles cases where one URL goes through a proxy (e.g., /webproxy/) while the other is direct
+     * @param {string} url1 - First URL to compare
+     * @param {string} url2 - Second URL to compare
+     * @returns {boolean} True if one URL path ends with the other (partial match), false otherwise
+     */
+    _urlsPartiallyMatch: (url1: string, url2: string) => boolean;
+    /**
+     * Gets socket URL information for metrics, including whether the socket URLs match
+     * Uses partial matching to handle proxy URLs (e.g., URLs with /webproxy/ prefix)
+     * @param {Object} webex - The webex instance
+     * @returns {Object} Object with hasMismatchedSocket, mercurySocketUrl, and deviceSocketUrl properties
+     */
+    getSocketUrlInfo: (webex: any) => {
+        hasMismatchedSocket: boolean;
+        mercurySocketUrl: string;
+        deviceSocketUrl: string;
+    };
     remoteUpdateAudioVideo: (meeting: any, audioMuted?: boolean, videoMuted?: boolean) => any;
     hasOwner: (info: any) => any;
     isOwnerSelf: (owner: any, selfId: any) => boolean;
@@ -59,6 +87,7 @@ declare const MeetingUtil: {
     canUserLowerAllHands: (displayHints: any) => any;
     canUserLowerSomeoneElsesHand: (displayHints: any) => any;
     bothLeaveAndEndMeetingAvailable: (displayHints: any) => any;
+    requireHostEndMeetingBeforeLeave: (displayHints: any) => any;
     canManageBreakout: (displayHints: any) => any;
     canStartBreakout: (displayHints: any) => boolean;
     canBroadcastMessageToBreakout: (displayHints: any, policies?: {}) => boolean;
@@ -115,6 +144,8 @@ declare const MeetingUtil: {
     updateLocusFromApiResponse: (meeting: any, response: any) => any;
     generateBuildLocusDeltaRequestOptions: (originalMeeting: any) => (originalOptions: any) => any;
     generateLocusDeltaRequest: (originalMeeting: any) => (originalOptions: any) => any;
+    canAttendeeRequestAiAssistantEnabled: (displayHints?: any[], roles?: any[]) => boolean;
+    attendeeRequestAiAssistantDeclinedAll: (displayHints?: any[]) => boolean;
     selfSupportsFeature: (feature: SELF_POLICY, userPolicies: Record<SELF_POLICY, boolean>) => boolean;
     parseInterpretationInfo: (meeting: any, meetingInfo: any) => void;
     /**

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

@@ -95,6 +95,8 @@ export default class Meetings extends WebexPlugin {
     preferredWebexSite: any;
     reachability: Reachability;
     registered: any;
+    registrationPromise: Promise<void>;
+    unregistrationPromise: Promise<void>;
     request: any;
     geoHintInfo: any;
     meetingInfo: any;
@@ -150,7 +152,7 @@ export default class Meetings extends WebexPlugin {
      */
     private handleLocusEvent;
     /**
-     * handles locus events through mercury that are not roap
+     * handles locus events through mercury that are not roap or approval request events
      * @param {Object} envelope
      * @param {Object} envelope.data
      * @param {String} envelope.data.eventType
@@ -287,7 +289,7 @@ export default class Meetings extends WebexPlugin {
      * @public
      * @memberof Meetings
      */
-    unregister(): any;
+    unregister(): Promise<void>;
     /**
      * Creates a noise reduction effect
      *

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

@@ -6,6 +6,7 @@ export type MemberId = string;
 export default class Member {
     associatedUser: MemberId | null;
     associatedUsers: Set<MemberId>;
+    canApproveAIEnablement: boolean;
     canReclaimHost: boolean;
     id: MemberId;
     isAudioMuted: any;

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

@@ -5,6 +5,11 @@ declare const MemberUtil: {
      * @returns {Boolean}
      */
     canReclaimHost: (participant: any) => any;
+    /**
+     * @param {Object} participant - The locus participant object.
+     * @returns {Boolean}
+     */
+    canApproveAIEnablement: (participant: any) => boolean;
     /**
      * @param {Object} participant - The locus participant object.
      * @returns {[ServerRoleShape]}

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

@@ -87,5 +87,10 @@ declare const BEHAVIORAL_METRICS: {
     MEDIA_ISSUE_DETECTED: string;
     LOCUS_CLASSIC_VS_HASH_TREE_MISMATCH: string;
     LOCUS_HASH_TREE_UNSUPPORTED_OPERATION: string;
+    MEDIA_STILL_NOT_CONNECTED: string;
+    DEPRECATED_SET_CODEC_PARAMETERS_USED: string;
+    DEPRECATED_DELETE_CODEC_PARAMETERS_USED: string;
+    SET_CUSTOM_CODEC_PARAMETERS_USED: string;
+    MARK_CUSTOM_CODEC_PARAMETERS_FOR_DELETION_USED: string;
 };
 export { BEHAVIORAL_METRICS as default };

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

@@ -50,29 +50,12 @@ export declare class MediaRequestManager {
     private degradationPreferences;
     private sourceUpdateListener;
     private debouncedSourceUpdateListener;
-    private previousStreamRequests;
     private trimRequestsToNumOfSources;
     private numTotalSources;
     private numLiveSources;
     constructor(sendMediaRequestsCallback: SendMediaRequestsCallback, options: Options);
     setDegradationPreferences(degradationPreferences: DegradationPreferences): void;
     private getDegradedClientRequests;
-    /**
-     * Returns true if two stream requests are the same, false otherwise.
-     *
-     * @param {StreamRequest} streamRequestA - Stream request A for comparison.
-     * @param {StreamRequest} streamRequestB - Stream request B for comparison.
-     * @returns {boolean} - Whether they are equal.
-     */
-    isEqual(streamRequestA: StreamRequest, streamRequestB: StreamRequest): boolean;
-    /**
-     * Compares new stream requests to previous ones and determines
-     * if they are the same.
-     *
-     * @param {StreamRequest[]} newRequests - Array with new requests.
-     * @returns {boolean} - True if they are equal, false otherwise.
-     */
-    private checkIsNewRequestsEqualToPrev;
     /**
      * Returns the maxPayloadBitsPerSecond per Stream
      *
@@ -94,12 +77,6 @@ export declare class MediaRequestManager {
      * @returns {number} maxMbps
      */
     private getH264MaxMbps;
-    /**
-     * Clears the previous stream requests.
-     *
-     * @returns {void}
-     */
-    clearPreviousRequests(): void;
     /** Modifies the passed in clientRequests and makes sure that in total they don't ask
      *  for more streams than there are available.
      *

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

@@ -1,4 +1,4 @@
-import { SendSlot, MediaType, LocalStream, MultistreamRoapMediaConnection, NamedMediaGroup, StreamState } from '@webex/internal-media-core';
+import { SendSlot, MediaType, LocalStream, MultistreamRoapMediaConnection, NamedMediaGroup, StreamState, MediaCodecMimeType, CodecParameters } from '@webex/internal-media-core';
 /**
  * This class is used to manage the sendSlots for the given media types.
  */
@@ -69,6 +69,8 @@ export default class SendSlotManager {
      */
     setActive(mediaType: MediaType, active?: boolean): void;
     /**
+     * @deprecated Use {@link setCustomCodecParameters} instead, which requires specifying the codec MIME type.
+     *
      * This method is used to set the codec parameters for the sendSlot of the given mediaType
      * @param {MediaType} mediaType MediaType of the sendSlot for which the codec parameters needs to be set (AUDIO_MAIN/VIDEO_MAIN/AUDIO_SLIDES/VIDEO_SLIDES)
      * @param {Object} codecParameters
@@ -78,12 +80,32 @@ export default class SendSlotManager {
         [key: string]: string | undefined;
     }): Promise<void>;
     /**
+     * @deprecated Use {@link markCustomCodecParametersForDeletion} instead, which requires specifying the codec MIME type.
+     *
      * This method is used to delete the codec parameters for the sendSlot of the given mediaType
      * @param {MediaType} mediaType MediaType of the sendSlot for which the codec parameters needs to be deleted (AUDIO_MAIN/VIDEO_MAIN/AUDIO_SLIDES/VIDEO_SLIDES)
      * @param {Array<String>} parameters Array of keys of the codec parameters to be deleted
      * @returns {Promise<void>}
      */
     deleteCodecParameters(mediaType: MediaType, parameters: string[]): Promise<void>;
+    /**
+     * Sets custom codec parameters for the sendSlot of the given mediaType, scoped to a specific codec MIME type.
+     * Delegates to WCME's setCustomCodecParameters API.
+     * @param {MediaType} mediaType MediaType of the sendSlot
+     * @param {MediaCodecMimeType} codecMimeType The codec MIME type to apply parameters to (e.g. OPUS, H264, AV1)
+     * @param {CodecParameters} parameters Key-value pairs of codec parameters to set
+     * @returns {Promise<void>}
+     */
+    setCustomCodecParameters(mediaType: MediaType, codecMimeType: MediaCodecMimeType, parameters: CodecParameters): Promise<void>;
+    /**
+     * Marks custom codec parameters for deletion on the sendSlot of the given mediaType, scoped to a specific codec MIME type.
+     * Delegates to WCME's markCustomCodecParametersForDeletion API.
+     * @param {MediaType} mediaType MediaType of the sendSlot
+     * @param {MediaCodecMimeType} codecMimeType The codec MIME type whose parameters should be deleted (e.g. OPUS, H264, AV1)
+     * @param {string[]} parameters Array of parameter keys to delete
+     * @returns {Promise<void>}
+     */
+    markCustomCodecParametersForDeletion(mediaType: MediaType, codecMimeType: MediaCodecMimeType, parameters: string[]): Promise<void>;
     /**
      * This method is used to reset the SendSlotsManager by deleting all the sendSlots
      * @returns {undefined}

package/dist/types/reactions/reactions.type.d.ts

@@ -32,6 +32,7 @@ export declare enum SkinToneType {
     dark = "dark"
 }
 export type Sender = {
+    displayName: string;
     participantId: string;
 };
 export type ProcessedReaction = {

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

@@ -0,0 +1,6 @@
+/**
+ * Remove null/undefined/empty string values from an object
+ * @param {object} params
+ * @returns {object}
+ */
+export declare const sanitizeParams: (params: Record<string, any>) => Record<string, any>;