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

package/cometchat-calls-sdk-react-native.podspec

@@ -0,0 +1,20 @@
+require 'json'
+
+package = JSON.parse(File.read(File.join(__dir__, 'package.json')))
+
+Pod::Spec.new do |s|
+  s.name         = 'cometchat-calls-sdk-react-native'
+  s.version      = package["version"]
+  s.summary      = package["description"]
+  s.homepage     = package["homepage"]
+  s.license      = package["license"]
+  s.authors      = package["author"]
+  s.platforms    = { :ios => '13.0' }
+  s.source       = { :git => 'https://github.com/cometchat/calls-sdk-react-native.git', :tag => s.version }
+
+  s.source_files = 'ios/**/*.{h,m}'
+
+  s.dependency 'React-Core'
+  s.dependency 'react-native-webrtc'
+  s.frameworks   = 'AVFoundation', 'UIKit'
+end

package/dist/index.d.mts

@@ -804,25 +804,91 @@ 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;
+  /**
+   * Pauses the local user's video stream.
+   */
   static pauseVideo(): void;
+  /**
+   * Resumes the local user's video stream.
+   */
   static resumeVideo(): void;
+  /**
+   * Local user leaves the current session.
+   */
   static leaveSession(): void;
+  /**
+   * Starts sharing the user's screen with other participants.
+   */
   static startScreenSharing(): void;
+  /**
+   * Stops the ongoing screen sharing session.
+   */
   static stopScreenSharing(): 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;
+  /**
+   * 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;
+  /**
+   * Enables Picture-in-Picture (PIP) layout during the call.
+   */
   static enablePictureInPictureLayout(): void;
+  /**
+   * Disables Picture-in-Picture (PIP) layout.
+   */
   static disablePictureInPictureLayout(): 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
@@ -833,7 +899,7 @@ declare class SessionMethodsCore {
    */
   static stopScreenShare(): void;
   /**
-   * @deprecated switchToVideoCall is deprecated and not supported
+   * @deprecated switchToVideoCall is deprecated and not supported.
    */
   static switchToVideoCall(): void;
   /**
@@ -3896,6 +3962,12 @@ declare class CometChatCalls extends SessionMethodsCore {
   static CallSettingsBuilder: typeof CallSettingsBuilder;
   static CallAppSettingsBuilder: typeof CallAppSettingsBuilder;
   static Component: typeof App;
+  /**
+   * 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 +3979,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;
   }>;
@@ -3933,7 +4053,13 @@ 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.
+   * @returns An unsubscribe function to remove the listener.
+   */
+  static addEventListener<K$1 extends keyof MobileSDKEvents>(eventType: K$1, listener: MobileSDKEvents[K$1]): () => void;
 }
 //#endregion
 export { CometChatCalls };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import * as zustand0 from "zustand";
+import * as zustand1 from "zustand";
 import * as zustand_middleware0 from "zustand/middleware";
 import { AppStateStatus } from "react-native";
 import JitsiMeetJS from "lib-jitsi-meet";
@@ -354,7 +354,7 @@ type Actions$5 = {
   isMobileSDK: () => boolean;
   isMobile: () => boolean;
 };
-declare const useBaseStore: zustand0.UseBoundStore<Omit<Omit<zustand0.StoreApi<BaseState & Actions$5>, "subscribe"> & {
+declare const useBaseStore: zustand1.UseBoundStore<Omit<Omit<zustand1.StoreApi<BaseState & Actions$5>, "subscribe"> & {
   subscribe: {
     (listener: (selectedState: BaseState & Actions$5, previousSelectedState: BaseState & Actions$5) => void): () => void;
     <U>(selector: (state: BaseState & Actions$5) => U, listener: (selectedState: U, previousSelectedState: U) => void, options?: {
@@ -431,7 +431,7 @@ type Actions$4 = {
   leaveConference: () => Promise<void>;
   stopRecording: () => Promise<void>;
 };
-declare const useConferenceStore: zustand0.UseBoundStore<Omit<zustand0.StoreApi<ConferenceState & Actions$4>, "subscribe"> & {
+declare const useConferenceStore: zustand1.UseBoundStore<Omit<zustand1.StoreApi<ConferenceState & Actions$4>, "subscribe"> & {
   subscribe: {
     (listener: (selectedState: ConferenceState & Actions$4, previousSelectedState: ConferenceState & Actions$4) => void): () => void;
     <U>(selector: (state: ConferenceState & Actions$4) => U, listener: (selectedState: U, previousSelectedState: U) => void, options?: {
@@ -505,7 +505,7 @@ type ConfigState = ConfigStateInternal & ConfigStateMobile & ConfigStateWeb & Co
 type Actions$3 = {
   reset: () => void;
 };
-declare const useConfigStore: zustand0.UseBoundStore<Omit<zustand0.StoreApi<ConfigStateInternal & ConfigStateMobile & ConfigStateWeb & ConfigStateBoth & Actions$3>, "subscribe"> & {
+declare const useConfigStore: zustand1.UseBoundStore<Omit<zustand1.StoreApi<ConfigStateInternal & ConfigStateMobile & ConfigStateWeb & ConfigStateBoth & Actions$3>, "subscribe"> & {
   subscribe: {
     (listener: (selectedState: ConfigStateInternal & ConfigStateMobile & ConfigStateWeb & ConfigStateBoth & Actions$3, previousSelectedState: ConfigStateInternal & ConfigStateMobile & ConfigStateWeb & ConfigStateBoth & Actions$3) => void): () => void;
     <U>(selector: (state: ConfigStateInternal & ConfigStateMobile & ConfigStateWeb & ConfigStateBoth & Actions$3) => U, listener: (selectedState: U, previousSelectedState: U) => void, options?: {
@@ -657,7 +657,7 @@ type Actions$2 = {
   disconnect: () => Promise<void>;
   reset: () => void;
 };
-declare const useConnectionStore: zustand0.UseBoundStore<Omit<zustand0.StoreApi<ConnectionState & Actions$2>, "subscribe"> & {
+declare const useConnectionStore: zustand1.UseBoundStore<Omit<zustand1.StoreApi<ConnectionState & Actions$2>, "subscribe"> & {
   subscribe: {
     (listener: (selectedState: ConnectionState & Actions$2, previousSelectedState: ConnectionState & Actions$2) => void): () => void;
     <U>(selector: (state: ConnectionState & Actions$2) => U, listener: (selectedState: U, previousSelectedState: U) => void, options?: {
@@ -707,7 +707,7 @@ type Actions$1 = {
   getParticipantById: (pid: string) => HumanParticipant | undefined;
   reset: () => void;
 };
-declare const useParticipantStore: zustand0.UseBoundStore<Omit<zustand0.StoreApi<ParticipantsState & Actions$1>, "subscribe"> & {
+declare const useParticipantStore: zustand1.UseBoundStore<Omit<zustand1.StoreApi<ParticipantsState & Actions$1>, "subscribe"> & {
   subscribe: {
     (listener: (selectedState: ParticipantsState & Actions$1, previousSelectedState: ParticipantsState & Actions$1) => void): () => void;
     <U>(selector: (state: ParticipantsState & Actions$1) => U, listener: (selectedState: U, previousSelectedState: U) => void, options?: {
@@ -753,7 +753,7 @@ type Actions = {
   updateTrack: (originalTrack: any, updatedTrack: Partial<Track>) => void;
   updateLocalTrack: (mediaType: MediaType, updatedTrack: Partial<Track>) => void;
 };
-declare const useTracksStore: zustand0.UseBoundStore<Omit<zustand0.StoreApi<TracksState & Actions>, "subscribe"> & {
+declare const useTracksStore: zustand1.UseBoundStore<Omit<zustand1.StoreApi<TracksState & Actions>, "subscribe"> & {
   subscribe: {
     (listener: (selectedState: TracksState & Actions, previousSelectedState: TracksState & Actions) => void): () => void;
     <U>(selector: (state: TracksState & Actions) => U, listener: (selectedState: U, previousSelectedState: U) => void, options?: {
@@ -804,25 +804,91 @@ 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;
+  /**
+   * Pauses the local user's video stream.
+   */
   static pauseVideo(): void;
+  /**
+   * Resumes the local user's video stream.
+   */
   static resumeVideo(): void;
+  /**
+   * Local user leaves the current session.
+   */
   static leaveSession(): void;
+  /**
+   * Starts sharing the user's screen with other participants.
+   */
   static startScreenSharing(): void;
+  /**
+   * Stops the ongoing screen sharing session.
+   */
   static stopScreenSharing(): 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;
+  /**
+   * 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;
+  /**
+   * Enables Picture-in-Picture (PIP) layout during the call.
+   */
   static enablePictureInPictureLayout(): void;
+  /**
+   * Disables Picture-in-Picture (PIP) layout.
+   */
   static disablePictureInPictureLayout(): 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
@@ -833,7 +899,7 @@ declare class SessionMethodsCore {
    */
   static stopScreenShare(): void;
   /**
-   * @deprecated switchToVideoCall is deprecated and not supported
+   * @deprecated switchToVideoCall is deprecated and not supported.
    */
   static switchToVideoCall(): void;
   /**
@@ -1158,7 +1224,7 @@ interface TranslationState {
   translations: Record<string, typeof __json_default_export>;
   currentLocale: CometChatSupportedLocale | Omit<string, CometChatSupportedLocale>;
 }
-declare const useTranslationStore: zustand0.UseBoundStore<Omit<zustand0.StoreApi<Omit<TranslationState, "reset" | "setLocale"> & {
+declare const useTranslationStore: zustand1.UseBoundStore<Omit<zustand1.StoreApi<Omit<TranslationState, "reset" | "setLocale"> & {
   reset: () => void;
   setLocale: (locale: CometChatSupportedLocale) => void;
 }>, "subscribe"> & {
@@ -3896,6 +3962,12 @@ declare class CometChatCalls extends SessionMethodsCore {
   static CallSettingsBuilder: typeof CallSettingsBuilder;
   static CallAppSettingsBuilder: typeof CallAppSettingsBuilder;
   static Component: typeof App;
+  /**
+   * 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 +3979,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;
   }>;
@@ -3933,7 +4053,13 @@ 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.
+   * @returns An unsubscribe function to remove the listener.
+   */
+  static addEventListener<K$1 extends keyof MobileSDKEvents>(eventType: K$1, listener: MobileSDKEvents[K$1]): () => void;
 }
 //#endregion
 export { CometChatCalls };