@cometchat/calls-sdk-react-native 5.0.0-beta.1 → 5.0.0-beta.11

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import * as zustand0 from "zustand";
 import * as zustand_middleware0 from "zustand/middleware";
 import { AppStateStatus } from "react-native";
-import JitsiMeetJS from "lib-jitsi-meet";
+import JitsiMeetJS from "@cometchat/calls-lib-webrtc";
 import * as v from "valibot";
 import React from "react";
 
@@ -40,6 +40,16 @@ declare function sleep(ms?: number): Promise<void>;
 declare function isArrayOfObjEqual(arr1: any[], arr2: any[]): boolean;
 declare function isDeviceEqual(device1: MediaDeviceInfo | undefined, device2: MediaDeviceInfo | undefined): boolean;
 declare function getDefaultDevice<T extends MediaDeviceInfo>(devices: T[]): T;
+/**
+ * Returns a promise that resolves when the given Zustand store
+ * satisfies the provided predicate. Resolves immediately if the
+ * condition is already met. Includes a timeout to avoid hanging
+ * forever (defaults to 5 000 ms).
+ */
+declare function waitForStoreState<T>(store: {
+  getState: () => T;
+  subscribe: (listener: (state: T) => void) => () => void;
+}, predicate: (state: T) => boolean, timeoutMs?: number): Promise<void>;
 //#endregion
 //#region calls-sdk-core/utils/constants.d.ts
 declare const MIN_ASPECT_RATIO: number;
@@ -79,6 +89,7 @@ declare const VIDEO_PAUSE_AUTHORITY: {
 };
 declare const CONFERENCE_COMMANDS: {
   userInfo: string;
+  initialConfig: string;
 };
 declare const VIDEO_QUALITY_LEVELS: {
   ULTRA: number;
@@ -87,10 +98,12 @@ declare const VIDEO_QUALITY_LEVELS: {
   LOW: number;
   NONE: number;
 };
-declare const PLATFORM: {
+declare const SDK_PLATFORM: {
   readonly WEB: "web";
   readonly ANDROID: "android";
   readonly IOS: "ios";
+  readonly REACT_NATIVE_ANDROID: "react-native-android";
+  readonly REACT_NATIVE_IOS: "react-native-ios";
 };
 declare const EVENT_LISTENER_METHODS: {
   readonly SessionStatusListener: {
@@ -288,12 +301,15 @@ type AudioOutputDevice = MediaDeviceInfo & {
 type VideoInputDevice = MediaDeviceInfo & {
   kind: Extract<MediaDeviceKind, 'videoinput'>;
 };
+type Subscription = (() => void) | {
+  remove: () => void;
+};
 type BaseState = {
   participantListVisible: boolean;
   moreMenuVisible: boolean;
-  subscriptions: any[];
+  subscriptions: Subscription[];
   isPIPLayoutEnabled: boolean;
-  audioModes: AudioMode$1[];
+  audioModes: AudioMode[];
   audioInputDevices: AudioInputDevice[];
   audioOutputDevices: AudioOutputDevice[];
   videoInputDevices: VideoInputDevice[];
@@ -305,7 +321,7 @@ type BaseState = {
     skipSubscribe: boolean;
   };
   previewVideoInputDevice?: VideoInputDevice;
-  selectedAudioModeType?: AudioMode$1['type'];
+  selectedAudioModeType?: AudioMode['type'];
   audioModeMenuVisible: boolean;
   layout: Layout;
   sidebarLayoutSetProgrammatically: boolean;
@@ -322,8 +338,9 @@ type BaseState = {
   desktopSharingFrameRate: 5 | 15 | 30;
   chatButtonUnreadCount: number;
   enableNoiseReduction: boolean;
-  sdkPlatform: Platform;
-  webOSName?: WebOSName;
+  sdkPlatform: SDKPlatform;
+  platformVersion?: string | number;
+  userAgent?: string;
   previewVideoTrack?: any;
   isMobileBrowser: boolean;
   mainAreaDimension: {
@@ -342,12 +359,16 @@ type BaseState = {
     startIndex: number;
     endIndex: number;
   };
+  sidebarVisibleParticipants: {
+    startIndex: number;
+    endIndex: number;
+  };
 };
 type Actions$5 = {
   toggleParticipantListVisible: () => void;
   reset: () => void;
   toggleMoreMenuVisible: () => void;
-  addSubscriptions: (subscriptions: any[]) => void;
+  addSubscriptions: (subscriptions: Subscription[]) => void;
   incrementConnectionRetryCount: () => void;
   clearIdealTimeoutTimer: () => void;
   restartIdealTimeoutTimer: () => void;
@@ -386,6 +407,7 @@ declare const useBaseStore: zustand0.UseBoundStore<Omit<Omit<zustand0.StoreApi<B
 declare const toggleParticipantListVisible: () => void;
 declare const hideParticipantList: () => void;
 declare const showParticipantList: () => void;
+declare const toggleParticipantList: () => void;
 declare const toggleMoreMenuVisible: () => void;
 declare const toggleAudioModeMenuVisible: () => void;
 declare const setLayout: (layout: Layout, sidebarLayoutSetProgrammatically?: boolean) => void;
@@ -400,6 +422,7 @@ declare const hideVirtualBackgroundDialog: () => void;
 declare const toggleMirrorLocalVideo: () => void;
 declare const toggleEnableNoiseReduction: () => void;
 declare const setChatButtonUnreadCount: (count: number) => void;
+declare const setAudioMode: (mode: AudioMode["type"]) => void;
 declare const getLayout: () => Layout;
 declare function initBaseStoreSubscriptions(): void;
 //#endregion
@@ -429,6 +452,7 @@ type Actions$4 = {
   raiseHand: (participantId: string, timestamp: number) => void;
   lowerHand: (participantId: string) => void;
   leaveConference: () => Promise<void>;
+  endConference: () => Promise<void>;
   stopRecording: () => Promise<void>;
 };
 declare const useConferenceStore: zustand0.UseBoundStore<Omit<zustand0.StoreApi<ConferenceState & Actions$4>, "subscribe"> & {
@@ -457,9 +481,11 @@ type ConfigStateInternal = {
   sessionId?: string;
   iAmRecorder: boolean;
   showFrameRate: boolean;
+  enableCompanionMode: boolean;
+  sdkPlatform?: SDKPlatform;
 };
 type ConfigStateMobile = {
-  audioMode?: AudioMode$1['type'];
+  audioMode?: AudioMode['type'];
   hideAudioModeButton: boolean;
 };
 type ConfigStateWeb = {
@@ -467,7 +493,16 @@ type ConfigStateWeb = {
   audioInputDeviceId?: string;
   audioOutputDeviceId?: string;
   videoInputDeviceId?: string;
+  hideScreenSharingButton: boolean;
   hideVirtualBackgroundButton: boolean;
+  /**
+   * @unstable This API may change or be removed in a future release.
+   * When enabled, the SDK renders only remote audio elements without any
+   * visual UI (no video tiles, controls, or overlays). This allows the
+   * host app to provide its own custom UI while the SDK handles the
+   * underlying call connection and audio playback.
+   */
+  unstable_renderAudioOnly: boolean;
 };
 type ConfigStateBoth = {
   sessionType: SessionType;
@@ -484,9 +519,7 @@ type ConfigStateBoth = {
   hideToggleAudioButton: boolean;
   hideToggleVideoButton: boolean;
   hideParticipantListButton: boolean;
-  hideSwitchLayoutButton: boolean;
   hideChatButton: boolean;
-  hideScreenSharingButton: boolean;
   hideSessionTimer: boolean;
   hideNetworkIndicator: boolean;
   hideRecordingStatusIndicator: boolean;
@@ -500,6 +533,8 @@ type ConfigStateBoth = {
   idleTimeoutPeriodAfterPrompt: number;
   enableSpotlightDrag: boolean;
   enableSpotlightSwap: boolean;
+  isPeerCall: boolean;
+  enableNotifications: boolean;
 };
 type ConfigState = ConfigStateInternal & ConfigStateMobile & ConfigStateWeb & ConfigStateBoth;
 type Actions$3 = {
@@ -666,6 +701,7 @@ declare const useConnectionStore: zustand0.UseBoundStore<Omit<zustand0.StoreApi<
     } | undefined): () => void;
   };
 }>;
+declare function waitForConnection(): Promise<void>;
 //#endregion
 //#region calls-sdk-core/utils/schema/human-participant.d.ts
 declare const HumanParticipantSchema: v.ObjectSchema<{
@@ -729,6 +765,38 @@ declare const getMainParticipantFromState: (state: {
   localParticipant: HumanParticipant;
 }) => Participant$2;
 //#endregion
+//#region calls-sdk-core/store/toast.d.ts
+interface ToastAction {
+  label: string;
+  onPress: () => void;
+}
+interface ToastItem {
+  id: string;
+  message: string;
+  type: NotificationType;
+  duration: number;
+  position: 'top' | 'bottom';
+  action?: ToastAction;
+  createdAt: number;
+}
+interface ToastState {
+  toasts: ToastItem[];
+}
+interface ToastActions {
+  addToast: (toast: Omit<ToastItem, 'id' | 'createdAt'>) => string;
+  removeToast: (id: string) => void;
+  clearAll: () => void;
+  reset: () => void;
+}
+declare const useToastStore: zustand0.UseBoundStore<zustand0.StoreApi<ToastState & ToastActions>>;
+declare function showToast(params: {
+  message: string;
+  type?: NotificationType;
+  duration?: number;
+  position?: 'top' | 'bottom';
+  action?: ToastAction;
+}): string;
+//#endregion
 //#region calls-sdk-core/store/tracks.d.ts
 type Track = {
   local: boolean;
@@ -798,42 +866,122 @@ declare const useNonRecoverableError: () => any;
 declare const useIsSwitchCameraEnabledBrowser: () => any;
 declare const useIsAudioInputSelectionSupported: () => boolean;
 declare const useIsVideoInputSelectionSupported: () => boolean;
+declare const useShouldMirrorLocalVideo: () => boolean;
 //#endregion
 //#region calls-sdk-core/store/utils/switch-camera.d.ts
 declare const switchCamera: () => void;
 //#endregion
 //#region calls-sdk-core/utils/session-methods-core.d.ts
 declare class SessionMethodsCore {
+  /**
+   * Mutes the local user's audio during the call.
+   */
   static muteAudio(): void;
+  /**
+   * Unmutes the local user's audio during the call.
+   */
   static unmuteAudio(): void;
+  /**
+   * Toggles the local user's audio mute state.
+   * If audio is muted, it will be unmuted, and vice versa.
+   */
+  static toggleAudio(): void;
+  /**
+   * Pauses the local user's video stream.
+   */
   static pauseVideo(): void;
+  /**
+   * Resumes the local user's video stream.
+   */
   static resumeVideo(): void;
+  /**
+   * Toggles the local user's video stream.
+   * If video is paused, it will be resumed, and vice versa.
+   */
+  static toggleVideo(): void;
+  /**
+   * Local user leaves the current session.
+   */
   static leaveSession(): void;
-  static startScreenSharing(): void;
-  static stopScreenSharing(): void;
+  /**
+   * Ends the current session for all participants.
+   * This will terminate the conference and disconnect everyone.
+   */
+  static endSessionForAll(): void;
+  /**
+   * Raises the user's virtual hand in the call.
+   */
   static raiseHand(): void;
+  /**
+   * Lowers the user's virtual hand in the call.
+   */
   static lowerHand(): void;
+  /**
+   * Toggles the user's virtual hand state.
+   * If the hand is raised, it will be lowered, and vice versa.
+   */
+  static toggleHand(): void;
+  /**
+   * Switches between the front and rear camera.
+   */
   static switchCamera(): void;
+  /**
+   * Sets the layout type for the call.
+   * @param layout - The type of layout to set (tile, sidebar or spotlight).
+   */
   static setLayout(layout: Layout): void;
+  /**
+   * Starts recording the call.
+   */
   static startRecording(): void;
+  /**
+   * Stops the ongoing call recording.
+   */
   static stopRecording(): void;
-  static enablePictureInPictureLayout(): void;
-  static disablePictureInPictureLayout(): void;
+  /**
+   * Toggles the call recording state.
+   * If recording is active, it will be stopped, and vice versa.
+   */
+  static toggleRecording(): void;
+  /**
+   * Pins a participant's video to focus on them.
+   * @param participantId - The ID of the participant to pin.
+   * @param type - The type of the participant.
+   */
   static pinParticipant(participantId: string, type: Participant$2['type']): void;
+  /**
+   * Unpins a participant's video.
+   */
   static unpinParticipant(): void;
+  /**
+   * Mutes the audio of a specific participant.
+   * @param participantId - The ID of the participant to mute.
+   */
   static muteParticipant(participantId: string): void;
+  /**
+   * Pauses the video stream of a specific participant.
+   * @param participantId - The ID of the participant whose video to pause.
+   */
   static pauseParticipantVideo(participantId: string): void;
+  /**
+   * Sets the unread message count displayed on the chat button.
+   * @param count - The number of unread messages.
+   */
   static setChatButtonUnreadCount(count: number): void;
   /**
-   * @deprecated use startScreenSharing() instead
+   * Toggles the visibility of the participant list panel.
+   */
+  static toggleParticipantList(): void;
+  /**
+   * Shows the participant list panel.
    */
-  static startScreenShare(): void;
+  static showParticipantList(): void;
   /**
-   * @deprecated use stopScreenSharing() instead
+   * Hides the participant list panel.
    */
-  static stopScreenShare(): void;
+  static hideParticipantList(): void;
   /**
-   * @deprecated switchToVideoCall is deprecated and not supported
+   * @deprecated switchToVideoCall is deprecated and not supported.
    */
   static switchToVideoCall(): void;
   /**
@@ -861,7 +1009,7 @@ type Failure<E> = {
   error: E;
 };
 type Result<T, E = Error> = Success<T> | Failure<E>;
-declare function tryCatch<T, E = Error>(promise: Promise<T>): Promise<Result<T, E>>;
+declare function tryCatch<T, E = Error>(promise: Promise<T>, timeoutMs?: number): Promise<Result<T, E>>;
 declare function tryCatchSync<T, E = Error>(fn: () => T): Result<T, E>;
 //#endregion
 //#region calls-sdk-core/utils/update-config.d.ts
@@ -869,7 +1017,7 @@ declare function updateConfig(config: Partial<ConfigState>): void;
 //#endregion
 //#region calls-sdk-core/types/common.d.ts
 type AudioModeType = 'BLUETOOTH' | 'EARPIECE' | 'HEADPHONES' | 'SPEAKER';
-type AudioMode$1 = {
+type AudioMode = {
   type: AudioModeType;
   selected: boolean;
   uid?: string;
@@ -882,8 +1030,7 @@ type MediaType = ValueOf<typeof MEDIA_TYPE>;
 type ValueOf<T> = T[keyof T];
 type ParticipantRole = ValueOf<typeof PARTICIPANT_ROLE>;
 type NotificationType = 'info' | 'success' | 'warning' | 'error';
-type Platform = ValueOf<typeof PLATFORM>;
-type WebOSName = 'android' | 'ios' | 'macos' | 'windows' | 'linux' | 'unknown';
+type SDKPlatform = ValueOf<typeof SDK_PLATFORM>;
 interface ITrackOptions {
   cameraDeviceId?: string | null;
   constraints?: {
@@ -929,7 +1076,7 @@ type SDKEvents = Omit<_SDKEvents, 'onParticipantListChanged'> & {
   onParticipantListChanged: (payload: Participant$1[]) => void;
 };
 type MobileSDKEvents = SDKEvents & {
-  onAudioModeChanged: (payload: AudioMode$1['type']) => void;
+  onAudioModeChanged: (payload: AudioMode['type']) => void;
   onCameraFacingChanged: (payload: CameraFacing) => void;
   onSwitchCameraButtonClicked: () => void;
   onPictureInPictureLayoutEnabled: () => void;
@@ -985,17 +1132,20 @@ declare class EventBus {
   startEmitting(): void;
   stopEmitting(): void;
   publish<K$1 extends keyof AllEvents>(action: EventBusAction<K$1>, forceEmit?: boolean): void;
-  subscribe<K$1 extends keyof AllEvents>(actionType: K$1, listener: AllEvents[K$1]): () => void;
+  subscribe<K$1 extends keyof AllEvents>(actionType: K$1, listener: AllEvents[K$1], options?: {
+    signal?: AbortSignal;
+  }): () => void;
 }
 declare const eventBus: EventBus;
 //#endregion
 //#region calls-sdk-core/handlers/conference.d.ts
-declare function createConference(connection: any, roomName: string): Promise<void>;
+declare function _createConference(): Promise<void>;
+declare function createConference(): Promise<void>;
 declare function muteParticipant(participantId: string): void;
 declare function pauseParticipantVideo(participantId: string): void;
 //#endregion
 //#region calls-sdk-core/handlers/connection.d.ts
-declare function connect(roomName: string): void;
+declare function connect(autoJoinConference?: boolean): Promise<void>;
 //#endregion
 //#region calls-sdk-core/handlers/devices.d.ts
 declare function areDevicesDifferent(existingDevices?: MediaDeviceInfo[], newDevices?: MediaDeviceInfo[]): boolean;
@@ -1011,7 +1161,10 @@ declare function removeScreenShareParticipant(participantId: string): void;
 //#endregion
 //#region calls-sdk-core/handlers/session.d.ts
 declare function startSession(): void;
-declare function leaveSession(): Promise<void>;
+declare function leaveSession(options?: {
+  forceLeave?: boolean;
+  shouldEndSession?: boolean;
+}): Promise<void>;
 declare function leaveSessionDueToIdleTimeout(): Promise<void>;
 declare function reconnectSession(): Promise<void>;
 declare function cancelPendingReconnect(): void;
@@ -1019,6 +1172,7 @@ declare function cancelPendingReconnect(): void;
 //#region calls-sdk-core/handlers/track.d.ts
 declare function createLocalTrackF(type: 'audio' | 'video', deviceId?: string | null, timeout?: number | null, additionalOptions?: ITrackOptions): Promise<any>;
 declare function createLocalTrack(type: 'audio' | 'video', deviceId?: string | null, cameraFacing?: CameraFacingInternal): Promise<void>;
+declare function createLocalTracks(): void;
 declare function updateAudioInputDevice(deviceId: string): void;
 declare function updateAudioInputDeviceState(device?: AudioInputDevice, skipSubscribe?: boolean): void;
 declare function updateVideoInputDevice(deviceId: string | null, cameraFacing?: CameraFacingInternal): Promise<void>;
@@ -1296,6 +1450,18 @@ declare const useTranslation: () => {
   }>;
 };
 //#endregion
+//#region src/app-settings.d.ts
+declare const RegionSchema: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, string>, v.UnionSchema<[v.LiteralSchema<"eu", undefined>, v.LiteralSchema<"us", undefined>, v.LiteralSchema<"in", undefined>, v.LiteralSchema<"EU", undefined>, v.LiteralSchema<"US", undefined>, v.LiteralSchema<"IN", undefined>], undefined>]>;
+declare const CallAppSettingsSchema: v.ObjectSchema<{
+  readonly appId: v.StringSchema<undefined>;
+  readonly region: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, string>, v.UnionSchema<[v.LiteralSchema<"eu", undefined>, v.LiteralSchema<"us", undefined>, v.LiteralSchema<"in", undefined>, v.LiteralSchema<"EU", undefined>, v.LiteralSchema<"US", undefined>, v.LiteralSchema<"IN", undefined>], undefined>]>;
+  readonly authKey: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+  readonly adminHost: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+  readonly clientHost: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+  readonly host: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
+}, undefined>;
+type CallAppSettings = v.InferOutput<typeof CallAppSettingsSchema>;
+//#endregion
 //#region src/native-communication/native-to-js.native.d.ts
 declare function setupNativeEventListeners(): void;
 //#endregion
@@ -2037,7 +2203,7 @@ type _Region = keyof typeof REGION;
 type Region = _Region | Omit<string, _Region>;
 type _THost = `rtc-${_Region}.cometchat.io`;
 type Host = _THost | Omit<string, _THost>;
-interface AudioMode {
+interface AudioMode$1 {
   isSelected: boolean;
   mode: string;
 }
@@ -2530,25 +2696,16 @@ declare class MainVideoContainerSetting {
   setUserListButtonParams(position?: Position, visibility?: boolean): void;
 }
 //#endregion
-//#region src/AppRN.d.ts
+//#region src/AppReactNativeSDK.d.ts
 interface AppProps extends Partial<ConfigStateMobile & ConfigStateBoth> {
   callToken: string;
+  /**
+   * @deprecated Use `sessionSettings` instead.
+   */
   callSettings?: CallSettings | Partial<ConfigStateMobile & ConfigStateBoth>;
+  sessionSettings?: CallSettings | Partial<ConfigStateMobile & ConfigStateBoth>;
 }
-declare function App(props: AppProps): React.JSX.Element;
-declare const AppComponent: typeof App;
-//#endregion
-//#region src/app-settings.d.ts
-declare const RegionSchema: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, string>, v.UnionSchema<[v.LiteralSchema<"eu", undefined>, v.LiteralSchema<"us", undefined>, v.LiteralSchema<"in", undefined>, v.LiteralSchema<"EU", undefined>, v.LiteralSchema<"US", undefined>, v.LiteralSchema<"IN", undefined>], undefined>]>;
-declare const CallAppSettingsSchema: v.ObjectSchema<{
-  readonly appId: v.StringSchema<undefined>;
-  readonly region: v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, string>, v.UnionSchema<[v.LiteralSchema<"eu", undefined>, v.LiteralSchema<"us", undefined>, v.LiteralSchema<"in", undefined>, v.LiteralSchema<"EU", undefined>, v.LiteralSchema<"US", undefined>, v.LiteralSchema<"IN", undefined>], undefined>]>;
-  readonly authKey: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
-  readonly adminHost: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
-  readonly clientHost: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
-  readonly host: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
-}, undefined>;
-type CallAppSettings = v.InferOutput<typeof CallAppSettingsSchema>;
+declare function AppReactNativeSDK(props: AppProps): React.JSX.Element;
 //#endregion
 //#region src/v4/models/ListnerHandler.d.ts
 interface IMultiOngoingCallListener extends OngoingCallListener {
@@ -3697,7 +3854,7 @@ declare class CometChatCalls$1 {
    * Method to get all the available audio output devices.
    * @returns {Promise<AudioMode[]>}
    */
-  static getAudioOutputModes(): Promise<AudioMode[]>;
+  static getAudioOutputModes(): Promise<AudioMode$1[]>;
   /**
    * Method to switch from audio call to video call.
    * @returns {void}
@@ -3895,7 +4052,13 @@ declare class CometChatCalls extends SessionMethodsCore {
   static OngoingCallListener: typeof OngoingCallListener;
   static CallSettingsBuilder: typeof CallSettingsBuilder;
   static CallAppSettingsBuilder: typeof CallAppSettingsBuilder;
-  static Component: typeof App;
+  static Component: typeof AppReactNativeSDK;
+  /**
+   * Initializes the CometChat Calls SDK with the provided app settings.
+   * Must be called before any other SDK methods.
+   * @param appSettings - The application settings for configuring the SDK.
+   * @returns An object indicating success or failure with error details.
+   */
   static init(appSettings: CallAppSettings | CallAppSettings$1): Promise<{
     readonly success: false;
     readonly error: {
@@ -3907,14 +4070,62 @@ declare class CometChatCalls extends SessionMethodsCore {
     readonly success: true;
     readonly error: null;
   }>;
+  /**
+   * Logs in a user with their UID and an optional auth key.
+   * If no auth key is provided, the one from app settings is used.
+   * @param uid - The unique identifier of the user.
+   * @param authKey - The authentication key. Falls back to the key provided in app settings.
+   * @returns A Promise that resolves to the logged-in User object.
+   * @throws {CometChatException} If login fails or validation errors occur.
+   */
   static login(uid: string, authKey?: string): Promise<User>;
+  /**
+   * Logs in a user directly with an auth token.
+   * @param authToken - The authentication token for the user.
+   * @returns A Promise that resolves to the logged-in User object.
+   * @throws {CometChatException} If login fails or the token is invalid.
+   */
   static loginWithAuthToken(authToken: string): Promise<User>;
+  /**
+   * Logs out the currently logged-in user and clears local session data.
+   * @returns A Promise that resolves to a success message string.
+   * @throws {CometChatException} If no user is logged in or logout fails.
+   */
   static logout(): Promise<string>;
+  /**
+   * Retrieves the currently logged-in user.
+   * @returns The logged-in User object, or null if no user is logged in.
+   */
   static getLoggedInUser(): User | null;
+  /**
+   * Retrieves the auth token of the currently logged-in user.
+   * @returns The auth token string, or null if no user is logged in.
+   */
   static getUserAuthToken(): string | null;
+  /**
+   * Checks whether a user is currently logged in.
+   * @returns True if a user is logged in with a valid auth token, false otherwise.
+   */
   static isUserLoggedIn(): boolean;
+  /**
+   * Registers a login listener to receive login/logout lifecycle callbacks.
+   * @param listenerId - A unique identifier for the listener.
+   * @param listener - The listener object with callback methods.
+   */
   static addLoginListener(listenerId: string, listener: LoginListener): void;
+  /**
+   * Removes a previously registered login listener.
+   * @param listenerId - The unique identifier of the listener to remove.
+   */
   static removeLoginListener(listenerId: string): void;
+  /**
+   * Generates a call token for the given session.
+   * Uses the provided auth token or falls back to the logged-in user's token.
+   * @param sessionId - The session ID to generate a token for.
+   * @param authToken - Optional auth token. If omitted, the logged-in user's token is used.
+   * @returns A Promise that resolves to an object containing the generated token.
+   * @throws {CometChatException} If the session ID is missing, no auth token is available, or the SDK is not initialized.
+   */
   static generateToken(sessionId: string, authToken?: string): Promise<{
     token: string;
   }>;
@@ -3924,6 +4135,7 @@ declare class CometChatCalls extends SessionMethodsCore {
   private static logoutInternal;
   private static callGenerateTokenAPI;
   private static callVerifyTokenAPI;
+  private static getStorageKey;
   private static saveUser;
   private static getSavedUser;
   private static clearSavedUser;
@@ -3933,8 +4145,29 @@ declare class CometChatCalls extends SessionMethodsCore {
   private static notifyLoginFailure;
   private static notifyLogoutSuccess;
   private static notifyLogoutFailure;
-  static addEventListener<K$1 extends keyof WebSDKEvents>(eventType: K$1, listener: WebSDKEvents[K$1]): () => void;
+  /**
+   * Adds an event listener for SDK events.
+   * @param eventType - The type of event to listen for.
+   * @param listener - The callback function to invoke when the event fires.
+   * @param options - Optional configuration including an AbortSignal for automatic cleanup.
+   * @returns An unsubscribe function to remove the listener.
+   */
+  static addEventListener<K$1 extends keyof MobileSDKEvents>(eventType: K$1, listener: MobileSDKEvents[K$1], options?: {
+    signal?: AbortSignal;
+  }): () => void;
+  /**
+   * Sets the audio output mode (mobile only).
+   * @param mode - The audio mode to set (e.g., 'SPEAKER', 'EARPIECE', 'BLUETOOTH', 'HEADPHONES').
+   */
+  static setAudioMode(mode: AudioMode['type']): void;
+  /**
+   * Enables Picture-in-Picture (PIP) layout during the call.
+   */
+  static enablePictureInPictureLayout(): void;
+  /**
+   * Disables Picture-in-Picture (PIP) layout.
+   */
+  static disablePictureInPictureLayout(): void;
 }
 //#endregion
-export { CometChatCalls };
-//# sourceMappingURL=index.d.ts.map
+export { CometChatCalls };