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

package/dist/index.mjs

@@ -454,59 +454,125 @@ function debounce(func, delay) {
 //#endregion
 //#region calls-sdk-core/utils/session-methods-core.ts
 var SessionMethodsCore = class {
+	/**
+	* Mutes the local user's audio during the call.
+	*/
 	static muteAudio() {
 		muteAudioTrack();
 	}
+	/**
+	* Unmutes the local user's audio during the call.
+	*/
 	static unmuteAudio() {
 		unMuteAudioTrack();
 	}
+	/**
+	* Pauses the local user's video stream.
+	*/
 	static pauseVideo() {
 		pauseVideoTrack();
 	}
+	/**
+	* Resumes the local user's video stream.
+	*/
 	static resumeVideo() {
 		resumeVideoTrack();
 	}
+	/**
+	* Local user leaves the current session.
+	*/
 	static leaveSession() {
 		leaveSession();
 	}
+	/**
+	* Starts sharing the user's screen with other participants.
+	*/
 	static startScreenSharing() {
 		startScreenSharing();
 	}
+	/**
+	* Stops the ongoing screen sharing session.
+	*/
 	static stopScreenSharing() {
 		stopScreenSharing();
 	}
+	/**
+	* Raises the user's virtual hand in the call.
+	*/
 	static raiseHand() {
 		raisedHandLocal();
 	}
+	/**
+	* Lowers the user's virtual hand in the call.
+	*/
 	static lowerHand() {
 		lowerHandLocal();
 	}
+	/**
+	* Switches between the front and rear camera.
+	*/
 	static switchCamera() {
 		switchCamera();
 	}
+	/**
+	* Sets the layout type for the call.
+	* @param layout - The type of layout to set (tile, sidebar or spotlight).
+	*/
 	static setLayout(layout$1) {
 		setLayout(layout$1);
 	}
+	/**
+	* Starts recording the call.
+	*/
 	static startRecording() {}
+	/**
+	* Stops the ongoing call recording.
+	*/
 	static stopRecording() {}
+	/**
+	* Enables Picture-in-Picture (PIP) layout during the call.
+	*/
 	static enablePictureInPictureLayout() {
 		enablePictureInPictureLayout();
 	}
+	/**
+	* Disables Picture-in-Picture (PIP) layout.
+	*/
 	static disablePictureInPictureLayout() {
 		disablePictureInPictureLayout();
 	}
+	/**
+	* 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, type) {
 		pinParticipant(participantId, type);
 	}
+	/**
+	* Unpins a participant's video.
+	*/
 	static unpinParticipant() {
 		unpinParticipant();
 	}
+	/**
+	* Mutes the audio of a specific participant.
+	* @param participantId - The ID of the participant to mute.
+	*/
 	static muteParticipant(participantId) {
 		muteParticipant(participantId);
 	}
+	/**
+	* Pauses the video stream of a specific participant.
+	* @param participantId - The ID of the participant whose video to pause.
+	*/
 	static pauseParticipantVideo(participantId) {
 		pauseParticipantVideo(participantId);
 	}
+	/**
+	* Sets the unread message count displayed on the chat button.
+	* @param count - The number of unread messages.
+	*/
 	static setChatButtonUnreadCount(count) {
 		setChatButtonUnreadCount(count);
 	}
@@ -523,7 +589,7 @@ var SessionMethodsCore = class {
 		this.stopScreenSharing();
 	}
 	/**
-	* @deprecated switchToVideoCall is deprecated and not supported
+	* @deprecated switchToVideoCall is deprecated and not supported.
 	*/
 	static switchToVideoCall() {
 		console.error("switchToVideoCall method deprecated and not supported.");
@@ -10548,6 +10614,12 @@ var CometChatCalls = class extends SessionMethodsCore {
 	static CallSettingsBuilder = CallSettingsBuilder;
 	static CallAppSettingsBuilder = CallAppSettingsBuilder;
 	static Component = AppComponent;
+	/**
+	* 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 async init(appSettings) {
 		const parsedAppSettings = v.safeParse(CallAppSettingsSchema, appSettings);
 		if (!parsedAppSettings.success) {
@@ -10582,6 +10654,14 @@ var CometChatCalls = class extends SessionMethodsCore {
 			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 async login(uid, authKey) {
 		try {
 			if (this.loginInProgress) {
@@ -10639,6 +10719,12 @@ var CometChatCalls = class extends SessionMethodsCore {
 			throw cometChatError;
 		}
 	}
+	/**
+	* 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 async loginWithAuthToken(authToken) {
 		try {
 			if (this.loginInProgress) {
@@ -10681,6 +10767,11 @@ var CometChatCalls = class extends SessionMethodsCore {
 			throw cometChatError;
 		}
 	}
+	/**
+	* 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 async logout() {
 		try {
 			if (!this.loggedInUser) {
@@ -10698,24 +10789,53 @@ var CometChatCalls = class extends SessionMethodsCore {
 			throw cometChatError;
 		}
 	}
+	/**
+	* Retrieves the currently logged-in user.
+	* @returns The logged-in User object, or null if no user is logged in.
+	*/
 	static getLoggedInUser() {
 		if (this.loggedInUser && typeof this.loggedInUser === "string") {
 			this.loggedInUser = JSON.parse(this.loggedInUser);
 		}
 		return this.loggedInUser;
 	}
+	/**
+	* 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() {
 		return this.loggedInUser?.authToken || 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() {
 		return this.loggedInUser !== null && this.loggedInUser.authToken !== undefined;
 	}
+	/**
+	* 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, listener) {
 		this.loginListeners.set(listenerId, listener);
 	}
+	/**
+	* Removes a previously registered login listener.
+	* @param listenerId - The unique identifier of the listener to remove.
+	*/
 	static removeLoginListener(listenerId) {
 		this.loginListeners.delete(listenerId);
 	}
+	/**
+	* 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 async generateToken(sessionId, authToken) {
 		try {
 			if (!sessionId || sessionId.trim() === "") {
@@ -10949,6 +11069,12 @@ var CometChatCalls = class extends SessionMethodsCore {
 			}
 		});
 	}
+	/**
+	* 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.
+	* @returns An unsubscribe function to remove the listener.
+	*/
 	static addEventListener(eventType, listener) {
 		return eventBus.subscribe(eventType, listener);
 	}