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

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

@@ -1,5 +1,5 @@
 import * as v from "valibot";
-import * as zustand9 from "zustand";
+import * as zustand3 from "zustand";
 import * as zustand_middleware0 from "zustand/middleware";
 import React from "react";
 import JitsiMeetJS from "lib-jitsi-meet";
@@ -354,7 +354,7 @@ type Actions$5 = {
   isMobileSDK: () => boolean;
   isMobile: () => boolean;
 };
-declare const useBaseStore: zustand9.UseBoundStore<Omit<Omit<zustand9.StoreApi<BaseState & Actions$5>, "subscribe"> & {
+declare const useBaseStore: zustand3.UseBoundStore<Omit<Omit<zustand3.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?: {
@@ -429,9 +429,10 @@ 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: zustand9.UseBoundStore<Omit<zustand9.StoreApi<ConferenceState & Actions$4>, "subscribe"> & {
+declare const useConferenceStore: zustand3.UseBoundStore<Omit<zustand3.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?: {
@@ -457,6 +458,7 @@ type ConfigStateInternal = {
   sessionId?: string;
   iAmRecorder: boolean;
   showFrameRate: boolean;
+  enableCompanionMode: boolean;
 };
 type ConfigStateMobile = {
   audioMode?: AudioMode$1['type'];
@@ -484,7 +486,6 @@ type ConfigStateBoth = {
   hideToggleAudioButton: boolean;
   hideToggleVideoButton: boolean;
   hideParticipantListButton: boolean;
-  hideSwitchLayoutButton: boolean;
   hideChatButton: boolean;
   hideScreenSharingButton: boolean;
   hideSessionTimer: boolean;
@@ -500,12 +501,13 @@ type ConfigStateBoth = {
   idleTimeoutPeriodAfterPrompt: number;
   enableSpotlightDrag: boolean;
   enableSpotlightSwap: boolean;
+  isPeerCall: boolean;
 };
 type ConfigState = ConfigStateInternal & ConfigStateMobile & ConfigStateWeb & ConfigStateBoth;
 type Actions$3 = {
   reset: () => void;
 };
-declare const useConfigStore: zustand9.UseBoundStore<Omit<zustand9.StoreApi<ConfigStateInternal & ConfigStateMobile & ConfigStateWeb & ConfigStateBoth & Actions$3>, "subscribe"> & {
+declare const useConfigStore: zustand3.UseBoundStore<Omit<zustand3.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 +659,7 @@ type Actions$2 = {
   disconnect: () => Promise<void>;
   reset: () => void;
 };
-declare const useConnectionStore: zustand9.UseBoundStore<Omit<zustand9.StoreApi<ConnectionState & Actions$2>, "subscribe"> & {
+declare const useConnectionStore: zustand3.UseBoundStore<Omit<zustand3.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?: {
@@ -666,6 +668,7 @@ declare const useConnectionStore: zustand9.UseBoundStore<Omit<zustand9.StoreApi<
     } | undefined): () => void;
   };
 }>;
+declare function waitForConnection(): Promise<void>;
 //#endregion
 //#region calls-sdk-core/utils/schema/human-participant.d.ts
 declare const HumanParticipantSchema: v.ObjectSchema<{
@@ -707,7 +710,7 @@ type Actions$1 = {
   getParticipantById: (pid: string) => HumanParticipant | undefined;
   reset: () => void;
 };
-declare const useParticipantStore: zustand9.UseBoundStore<Omit<zustand9.StoreApi<ParticipantsState & Actions$1>, "subscribe"> & {
+declare const useParticipantStore: zustand3.UseBoundStore<Omit<zustand3.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 +756,7 @@ type Actions = {
   updateTrack: (originalTrack: any, updatedTrack: Partial<Track>) => void;
   updateLocalTrack: (mediaType: MediaType, updatedTrack: Partial<Track>) => void;
 };
-declare const useTracksStore: zustand9.UseBoundStore<Omit<zustand9.StoreApi<TracksState & Actions>, "subscribe"> & {
+declare const useTracksStore: zustand3.UseBoundStore<Omit<zustand3.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,36 +807,78 @@ 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;
-  static startScreenSharing(): void;
-  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;
-  static enablePictureInPictureLayout(): void;
-  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;
-  static pauseParticipantVideo(participantId: string): void;
-  static setChatButtonUnreadCount(count: number): void;
   /**
-   * @deprecated use startScreenSharing() instead
+   * Pauses the video stream of a specific participant.
+   * @param participantId - The ID of the participant whose video to pause.
    */
-  static startScreenShare(): void;
+  static pauseParticipantVideo(participantId: string): void;
   /**
-   * @deprecated use stopScreenSharing() instead
+   * Sets the unread message count displayed on the chat button.
+   * @param count - The number of unread messages.
    */
-  static stopScreenShare(): void;
+  static setChatButtonUnreadCount(count: number): void;
   /**
-   * @deprecated switchToVideoCall is deprecated and not supported
+   * @deprecated switchToVideoCall is deprecated and not supported.
    */
   static switchToVideoCall(): void;
   /**
@@ -861,7 +906,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
@@ -985,17 +1030,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 +1059,9 @@ 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;
+}): Promise<void>;
 declare function leaveSessionDueToIdleTimeout(): Promise<void>;
 declare function reconnectSession(): Promise<void>;
 declare function cancelPendingReconnect(): void;
@@ -1019,6 +1069,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>;
@@ -1158,7 +1209,7 @@ interface TranslationState {
   translations: Record<string, typeof __json_default_export>;
   currentLocale: CometChatSupportedLocale | Omit<string, CometChatSupportedLocale>;
 }
-declare const useTranslationStore: zustand9.UseBoundStore<Omit<zustand9.StoreApi<Omit<TranslationState, "reset" | "setLocale"> & {
+declare const useTranslationStore: zustand3.UseBoundStore<Omit<zustand3.StoreApi<Omit<TranslationState, "reset" | "setLocale"> & {
   reset: () => void;
   setLocale: (locale: CometChatSupportedLocale) => void;
 }>, "subscribe"> & {
@@ -1296,6 +1347,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
@@ -2530,25 +2593,12 @@ 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;
-  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 {
@@ -3895,7 +3945,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 +3963,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 +4037,24 @@ 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;
+  /**
+   * Enables Picture-in-Picture (PIP) layout during the call.
+   */
+  static enablePictureInPictureLayout(): void;
+  /**
+   * Disables Picture-in-Picture (PIP) layout.
+   */
+  static disablePictureInPictureLayout(): void;
 }
 //#endregion
 export { CometChatCalls };