@cometchat/chat-uikit-react 5.0.0-beta2 → 5.0.0

package/dist/types/components/Calling/CometChatCallButtons/CometChatCallButtons.d.ts

@@ -1,35 +1,53 @@
 import { CometChatUIKitCalls } from "../../../CometChatUIKit/CometChatCalls";
 import { OutgoingCallConfiguration } from "../OutgoingCallConfiguration";
 interface CallButtonsProps {
-    onVoiceCallClick?: () => void;
-    onVideoCallClick?: () => void;
-    onError?: (error: CometChat.CometChatException) => void;
+    /**
+     * Boolean flag to hide the video call button.
+     */
+    hideVideoCallButton?: boolean;
+    /**
+     * Boolean flag to hide the voice call button.
+     */
+    hideVoiceCallButton?: boolean;
+    /**
+     * Builder for checking and updating call settings.
+     * @param isAudioOnlyCall - Whether it's an audio-only call.
+     * @param user - The user object for the call (optional).
+     * @param group - The group object for the call (optional).
+     */
     callSettingsBuilder?: (isAudioOnlyCall: boolean, user?: CometChat.User, group?: CometChat.Group) => typeof CometChatUIKitCalls.CallSettingsBuilder;
+    /**
+     * Configuration object for managing outgoing call settings, such as call parameters, UI behaviors, or any pre-call settings.
+     */
     outgoingCallConfiguration?: OutgoingCallConfiguration;
+    /**
+     * Callback function triggered when an error occurs in the call buttons component.
+     * @param error - An instance of `CometChat.CometChatException` representing the error.
+     * @returns void
+     */
+    onError?: ((error: CometChat.CometChatException) => void) | null;
 }
 interface CallButtonsUserProps extends CallButtonsProps {
     /**
-       * Sets the user object for Call Buttons.
-       */
-    user: CometChat.User;
+     * A CometChat.User object representing the user in which the call will be initiated.
+     */
+    user?: CometChat.User;
     /**
-     * Used to set the group object for Call Buttons.
-     *
+     * A CometChat.Group object representing the group in which the call will be initiated.
      * @default null
      */
     group?: CometChat.Group | null;
 }
 interface CallButtonsGroupProps extends CallButtonsProps {
     /**
-     * Sets the user object for Call Buttons, or null if no user is involved.
-     *
+     * A CometChat.User object representing the user in which the call will be initiated.
      * @default null
      */
     user?: CometChat.User | null;
     /**
-     * Used to set the group object for Call Buttons.
+     * A CometChat.Group object representing the group in which the call will be initiated.
      */
-    group: CometChat.Group;
+    group?: CometChat.Group;
 }
 type CallButtonsPropsType = CallButtonsUserProps | CallButtonsGroupProps;
 declare const CometChatCallButtons: (props: CallButtonsPropsType) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/Calling/CometChatCallButtons/useCallButtons.d.ts

@@ -1,5 +1,5 @@
 import React from "react";
-declare function useCallButtons(loggedInUser: any, setLoggedInUser: Function, user: any, group: any, onErrorCallback: Function, attachListeners: Function, removeListener: Function, setActiveUser: any, setActiveGroup: any, initiateAudioCall: Function, initiateVideoCall: Function, onVoiceCallClickRef: React.MutableRefObject<Function | undefined>, onVideoCallClickRef: React.MutableRefObject<Function | undefined>, subscribeToEvents: Function): {
+declare function useCallButtons(loggedInUser: any, setLoggedInUser: Function, user: any, group: any, errorHandler: Function, attachListeners: Function, removeListener: Function, setActiveUser: any, setActiveGroup: any, initiateAudioCall: Function, initiateVideoCall: Function, onVoiceCallClickRef: React.MutableRefObject<Function | undefined>, onVideoCallClickRef: React.MutableRefObject<Function | undefined>, subscribeToEvents: Function): {
     audioCallButtonClicked: () => void;
     videoCallButtonClicked: () => void;
 };

package/dist/types/components/Calling/CometChatCallLogs/CometChatCallLogs.d.ts

@@ -2,70 +2,82 @@
 import { DatePatterns } from "../../../Enums/Enums";
 interface CallLogsProps {
     /**
-     * Title of the component
-     *
-     * @defaultValue `localize("CALLS")`
+     * Object representing the active call that is currently selected.
      */
-    title?: string;
+    activeCall?: any;
     /**
-     * Custom list item view to be rendered for each user in the fetched list
+     * Allows filtering and customizing call logs using available parameters.
+     * @defaultValue Default request builder having the limit set to 30.
      */
-    listItemView?: (call: any) => JSX.Element;
+    callLogRequestBuilder?: any;
     /**
-     * Custom subtitle view to be rendered for each user in the fetched list
-     *
-     * @remarks
-     * This prop is used if `listItemView` prop is not provided
+     * Specifies the date format for rendering dates in the call logs.
      */
-    subtitleView?: (call: any) => JSX.Element;
+    datePattern?: DatePatterns;
     /**
-     * View to be placed in the tail view
-     *
-     * @remarks
-     * This prop will be used if `listItemView` is not provided
+     * Callback function triggered when a call log list item is clicked.
+     * @returns void
      */
-    tailView?: (call: any) => JSX.Element;
+    onItemClick?: (call: any) => void;
     /**
-     * Custom view for the empty state of the component
+     * Callback function triggered when the call button in the trailing view is clicked.
+     * @returns void
      */
-    emptyStateView?: JSX.Element;
+    onCallButtonClicked?: (call: any) => void;
     /**
-     * Custom view for the error state of the component
+     * Callback function triggered when the component encounters an error.
+     *
+     * @param error - An instance of CometChat.CometChatException representing the error.
+     * @returns void
      */
-    errorStateView?: JSX.Element;
+    onError?: ((error: CometChat.CometChatException) => void) | null;
     /**
-     * Custom view for the loading state of the component
+     * A custom view to display when call logs are being loaded.
      */
-    loadingStateView?: JSX.Element;
+    loadingView?: JSX.Element;
     /**
-     * Object representing the active call that is currently selected.
-     *
+     * A custom view to display when no call logs are available.
      */
-    activeCall?: any;
+    emptyView?: JSX.Element;
     /**
-     * Allows filtering and customizing call logs using available parameters
-     *  @defaultValue Default request builder having the limit set to 30
+     * A custom view to display when an error occurs while fetching the call logs.
      */
-    callLogRequestBuilder?: any;
+    errorView?: JSX.Element;
+    /**
+     * A function that renders a JSX element to display the item view.
+     *
+     * @param call - An instance of `any` representing the CallLog.
+     * @returns A JSX element to be rendered as the item view.
+     */
+    itemView?: (call: any) => JSX.Element;
     /**
-     * Function to call on click of the default list item view of a user
+     * A function that renders a JSX element to display the leading view.
+     *
+     * @param call - An instance of `any` representing the callLog.
+     * @returns A JSX element to be rendered as the leading view.
      */
-    onItemClick?: Function;
+    leadingView?: (call: any) => JSX.Element;
     /**
-     * Function to call on click of the tail view of a user
+     * A function that renders a JSX element to display the title view.
+     *
+     * @param call - An instance of `any` representing the callLog.
+     * @returns A JSX element to be rendered as the title view.
      */
-    onCallButtonClicked?: Function;
+    titleView?: (call: any) => JSX.Element;
     /**
-     * Function to call whenever the component encounters an error
+     * A function that renders a JSX element to display the subtitle view.
+     *
+     * @param call - An instance of `any` representing the callLog.
+     * @returns A JSX element to be rendered as the subtitle view.
      */
-    onError?: Function;
+    subtitleView?: (call: any) => JSX.Element;
     /**
-     * Date format for the date component
+     * A function that renders a JSX element to display the trailing view.
      *
-     * @remarks
-     * The date component is inside the tail view of the default list item view when `selectionMode` prop is set to `SelectionMode.none`
+     * @param call - An instance of `any` representing the callLog.
+     * @returns A JSX element to be rendered as the trailing view.
      */
-    datePattern?: DatePatterns;
+    trailingView?: (call: any) => JSX.Element;
 }
 declare const CometChatCallLogs: (props: CallLogsProps) => import("react/jsx-runtime").JSX.Element;
 export { CometChatCallLogs };

package/dist/types/components/Calling/CometChatCallLogs/useCometChatCallLogs.d.ts

@@ -1,2 +1,2 @@
-declare function useCometChatCallLogs(loggedInUser: CometChat.User | null, setLoggedInUser: Function, requestBuilder: any, setCallBuilder: Function, getCallList: Function, attachListeners: Function, subscribeToEvents: Function, detachListeners: Function, onErrorCallback: Function): void;
+declare function useCometChatCallLogs(loggedInUser: CometChat.User | null, setLoggedInUser: Function, requestBuilder: any, setCallBuilder: Function, getCallList: Function, attachListeners: Function, subscribeToEvents: Function, detachListeners: Function, onErrorCallback: (error: unknown, source?: string | undefined) => void): void;
 export { useCometChatCallLogs };

package/dist/types/components/Calling/CometChatIncomingCall/CometChatIncomingCall.d.ts

@@ -2,58 +2,80 @@
 import { CometChatUIKitCalls } from "../../../CometChatUIKit/CometChatCalls";
 interface IncomingCallProps {
     /**
-     * CometChat call object consumed by the component to launch itself.
+     * The CometChat call object used to initialize and display the incoming call component.
      */
     call?: any;
     /**
-     * Used to disable/enable the sound of incoming calls.
+     * A builder function for configuring or updating call settings dynamically.
      *
-     * @default false
+     * @param call - The current CometChat call object.
+     * @returns An instance of CallSettingsBuilder.
+     */
+    callSettingsBuilder?: (call: CometChat.Call) => typeof CometChatUIKitCalls.CallSettingsBuilder;
+    /**
+     * Disables the sound for incoming calls.
+     * @defaultValue false
      */
     disableSoundForCalls?: boolean;
     /**
-     * Used to set a custom sound for incoming calls.
-     *
-     * @example customSoundForCalls='Your Custom Sound For Calls'
+     * Specifies a custom sound to play for incoming calls.
      */
     customSoundForCalls?: string;
     /**
-     * Triggered when you click the accept button of the Incoming Call component.
-     * You can override this action.
+     * Callback function triggered when the accept button is clicked. Allows overriding the default behavior.
+     *
+     * @param call - An instance of `CometChat.Call` representing the Call.
+     * @returns void
      */
-    onAccept?: Function;
+    onAccept?: (call: CometChat.Call) => void;
     /**
-     * Triggered when you click the decline button of the Incoming Call component.
-     * You can override this action.
+     * Callback function triggered when the decline button is clicked. Allows overriding the default behavior.
+     *
+     * @param call - An instance of `CometChat.Call` representing the Call.
+     * @returns void
      */
-    onDecline?: Function;
+    onDecline?: (call: CometChat.Call) => void;
     /**
-     * Used to set custom accept button text.
+     * Callback function triggered when an error occurs in the incoming call component.
+     * @param error - An instance of `CometChat.CometChatException` representing the error.
+     * @return void
+     */
+    onError?: ((error: CometChat.CometChatException) => void) | null;
+    /**
+     * A function that renders a JSX element to display the item view.
      *
-     * @example acceptButtonText='Your Custom Accept Button Text'
+     * @param call - An instance of `CometChat.Call` representing the call.
+     * @returns A JSX element to be rendered as the item view.
      */
-    acceptButtonText?: string;
+    itemView?: (call: CometChat.Call) => JSX.Element;
     /**
-     * Used to set custom decline button text.
+     * A function that renders a JSX element to display the leading view.
      *
-     * @example declineButtonText='Your Decline Button Text'
+     * @param call - An instance of `CometChat.Call` representing the call.
+     * @returns A JSX element to be rendered as the leading view.
      */
-    declineButtonText?: string;
+    leadingView?: (call: CometChat.Call) => JSX.Element;
     /**
-     * Custom subtitle view for the incoming call component.
+     * A function that renders a JSX element to display the title view.
+     *
+     * @param call - An instance of `CometChat.Call` representing the call.
+     * @returns A JSX element to be rendered as the title view.
      */
-    subtitleView?: (call: CometChat.Call) => JSX.Element;
+    titleView?: (call: CometChat.Call) => JSX.Element;
     /**
-     * Triggered when an error occurs in the Incoming Call component.
+     * A function that renders a JSX element to display the subtitle view.
+     *
+     * @param call - An instance of `CometChat.Call` representing the call.
+     * @returns A JSX element to be rendered as the subtitle view.
      */
-    onError?: Function;
+    subtitleView?: (call: CometChat.Call) => JSX.Element;
     /**
-     * Builder function for configuring and updating call settings.
+     * A function that renders a JSX element to display the trailing view.
      *
-     * @param call - The current CometChat call object.
-     * @returns An instance of CallSettingsBuilder.
+     * @param call - An instance of `CometChat.Call` representing the call.
+     * @returns A JSX element to be rendered as the trailing view.
      */
-    callSettingsBuilder?: (call: CometChat.Call) => typeof CometChatUIKitCalls.CallSettingsBuilder;
+    trailingView?: (call: CometChat.Call) => JSX.Element;
 }
 declare const CometChatIncomingCall: (props: IncomingCallProps) => import("react/jsx-runtime").JSX.Element;
 export { CometChatIncomingCall };

package/dist/types/components/Calling/CometChatIncomingCall/useCometChatIncomingCall.d.ts

@@ -1,2 +1,2 @@
-declare function useCometChatIncomingCall(loggedInUser: any, setLoggedInUser: any, call: CometChat.Call, attachListeners: Function, removeListener: Function, acceptCallButtonRef: any, rejectCallButtonRef: any, showCall: any, callRef: any, acceptIncomingCall: Function, rejectIncomingCall: Function, showIncomingCallScreen: boolean, subscribeToEvents: Function): void;
+declare function useCometChatIncomingCall(loggedInUser: any, setLoggedInUser: any, call: CometChat.Call, attachListeners: Function, removeListener: Function, acceptCallButtonRef: any, rejectCallButtonRef: any, showCall: any, callRef: any, acceptIncomingCall: Function, rejectIncomingCall: Function, showIncomingCallScreen: boolean, subscribeToEvents: Function, errorHandler: (error: unknown, source?: string) => void): void;
 export { useCometChatIncomingCall };

package/dist/types/components/Calling/CometChatOutgoingCall/CometChatOutgoingCall.d.ts

@@ -1,36 +1,52 @@
+/// <reference types="react" />
 /**
  * Props interface for the outgoing call component
  */
 interface OutgoingCallProps {
     /**
-     * Sets the call object for CometChatOutgoingCall.
+     * The CometChat call object used to set up and launch the outgoing call.
      */
-    call: CometChat.Call;
+    call?: CometChat.Call;
     /**
-     * Used to disable/enable the sound of outgoing calls.
-     *
-     * @default false
-     * @example disableSoundForCalls={false}
+     * Disables the sound of outgoing calls.
+     * @defaultValue false
      */
     disableSoundForCalls?: boolean;
     /**
-     * Used to set a custom sound for outgoing calls.
-     *
-     * @example customSoundForCalls='Your Custom Sound For Calls'
+     * Specifies a custom sound to play for outgoing calls.
      */
     customSoundForCalls?: string;
     /**
-     * Custom view for the outgoing call component.
+     * Callback function triggered when an error occurs in the outgoing call component.
+     * @param error - An instance of `CometChat.CometChatException` representing the error.
+     * @return void
      */
-    customView?: any;
+    onError?: ((error: CometChat.CometChatException) => void) | null;
     /**
-     * Triggered when an error occurs in the outgoing call component.
+     * Callback function triggered when the cancel button is clicked in the outgoing call component.
+     * @return void
      */
-    onError?: Function;
+    onCallCanceled?: Function;
     /**
-     * Triggered when the close button is clicked in the outgoing call component.
+     * This prop renders the custom title view for the outgoing call.
+     * Use this to override the existing title of user name from the outgoing call.
      */
-    onCloseClicked?: Function;
+    titleView?: JSX.Element;
+    /**
+     * This prop renders the custom sub title view for the outgoing call.
+     * Use this to override the existing sub title text from the outgoing call.
+     */
+    subtitleView?: JSX.Element;
+    /**
+     * This prop renders the custom avatar view for the outgoing call.
+     * Use this to override the existing avatar image from the outgoing call.
+     */
+    avatarView?: JSX.Element;
+    /**
+     * This prop renders the custom cancel-call button view for the outgoing call.
+     * Use this to override the existing cancel call button view from the outgoing call.
+     */
+    cancelButtonView?: JSX.Element;
 }
 declare const CometChatOutgoingCall: (props: OutgoingCallProps) => import("react/jsx-runtime").JSX.Element;
 export { CometChatOutgoingCall };

package/dist/types/components/Calling/CometChatOutgoingCall/useCometChatOutgoingCall.d.ts

@@ -3,5 +3,5 @@
  * @param playAudio - Function to play audio during the outgoing call.
  * @param call - Optional CometChat.Call object representing the outgoing call.
  */
-declare function useCometChatOutgoingCall(playAudio: Function, call?: CometChat.Call): void;
+declare function useCometChatOutgoingCall(errorHandler: (error: unknown, source?: string) => void, playAudio: Function, call?: CometChat.Call): void;
 export { useCometChatOutgoingCall };

package/dist/types/components/Calling/OutgoingCallConfiguration.d.ts

@@ -1,8 +1,12 @@
+/// <reference types="react" />
 export declare class OutgoingCallConfiguration {
     disableSoundForCalls?: boolean;
     customSoundForCalls?: string;
-    customView?: any;
-    onError?: Function;
-    onCloseClicked?: Function;
+    titleView?: (call: CometChat.Call) => JSX.Element;
+    subtitleView?: (call: CometChat.Call) => JSX.Element;
+    avatarView?: (call: CometChat.Call) => JSX.Element;
+    cancelButtonView?: (call: CometChat.Call) => JSX.Element;
+    onError?: (error: CometChat.CometChatException) => void;
+    onCallCanceled?: Function;
     constructor(configuration: OutgoingCallConfiguration);
 }