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

package/dist/types/components/CometChatConversations/CometChatConversations.d.ts

@@ -4,151 +4,152 @@ import { DatePatterns, SelectionMode, States } from "../../Enums/Enums";
 import { CometChatOption } from "../../modals";
 interface ConversationsProps {
     /**
-     * Custom view to render on the top-right of the component
-     */
-    menu?: JSX.Element;
-    /**
-     * Title of the component
+     * Disables the display of message read receipts.
      *
-     * @defaultValue `localize("CHATS")`
-     */
-    title?: string;
-    /**
-     * Request builder to fetch conversations
-     * @defaultValue Default request builder having the limit set to 30
-     */
-    conversationsRequestBuilder?: CometChat.ConversationsRequestBuilder;
-    /**
-     * Function to call whenever the component encounters an error
+     * @remarks If set to `true`, the receipt status of the sent message won't be displayed.
+     * @defaultValue `false`
      */
-    onError?: (error: CometChat.CometChatException) => void;
+    hideReceipts?: boolean;
     /**
-     * Custom list item view to be rendered for each conversation in the fetched list
+     * Hides the default and the custom error view passed in the `errorView` prop.
+     *
+     * @defaultValue `false`
      */
-    listItemView?: (conversation: CometChat.Conversation) => JSX.Element;
+    hideError?: boolean;
     /**
-     * Custom subtitle view to be rendered for each conversation in the fetched list
+     * Hides the delete conversation option in the default context menu.
      *
-     * @remarks
-     * This prop is used if `listItemView` prop is not provided
+     * @defaultValue `false`
      */
-    subtitleView?: (conversation: CometChat.Conversation) => JSX.Element;
+    hideDeleteConversation?: boolean;
     /**
-     * Custom tail view to be rendered for each conversation in the fetched list
+     * Hides the user's online/offline status indicator.
      *
-     * @remarks
-     * This prop is used if `listItemView` prop is not provided
+     * @defaultValue `false`
      */
-    tailView?: (conversation: CometChat.Conversation) => JSX.Element;
+    hideUserStatus?: boolean;
     /**
-     * Hide user presence
-     *
-     * @remarks
-     * If set to true, the status indicator of the default list item view is not displayed for conversation objects related to users
+     * Hides the group type icon.
      *
      * @defaultValue `false`
      */
-    disableUsersPresence?: boolean;
+    hideGroupType?: boolean;
     /**
-     * Conversation to highlight
+     * A request builder to fetch conversations.
      *
-     * @remarks
-     * This prop is used if `listItemView` prop is not provided
+     * @defaultValue Default request builder with the limit set to 30.
+     */
+    conversationsRequestBuilder?: CometChat.ConversationsRequestBuilder;
+    /**
+     * Specifies the conversation to highlight in the list.
      */
     activeConversation?: CometChat.Conversation;
     /**
-     * Selection mode to use for the default tail view
-     *
-     * @remarks
-     * This prop is used if `listItemView` prop is not provided.
+     * Allows the user to pass custom formatters for text.
      *
-     * @defaultValue `SelectionMode.none`
+     * These formatters should be an array of `CometChatTextFormatter` instances, enabling customized text rendering and processing.
      */
-    selectionMode?: SelectionMode;
+    textFormatters?: CometChatTextFormatter[];
     /**
-     * Disable receipt status
+     * Determines the selection mode for the component.
      *
-     * @remarks
-     * If set to true, the receipt status of the sent message won't be displayed, and received messages won't be marked as delivered
-     *
-     * @defaultValue `false`
+     * @defaultValue `SelectionMode.none`
      */
-    hideReceipt?: boolean;
+    selectionMode?: SelectionMode;
     /**
-     * List of actions available on mouse over on the default list item component
+     * A function that returns a list of actions available when hovering over a conversation item.
+     * @param conversation - An instance of `CometChat.Conversation` representing the conversation.
+     * @returns An array of `CometChatOption` objects.
      */
     options?: ((conversation: CometChat.Conversation) => CometChatOption[]) | null;
     /**
-     * Date format for the date component
-     *
-     * @remarks
-     * The date component is inside the tail view of the default list item view when `selectionMode` prop is set to `SelectionMode.none`
+     * Specifies the format for displaying dates within the component.
      */
     datePattern?: DatePatterns;
     /**
-     * Custom view for the loading state of the component
-     */
-    loadingStateView?: JSX.Element;
-    /**
-     * Custom view for the empty state of the component
+     * Disables sound for incoming messages.
+     *
+     * @defaultValue `false`
      */
-    emptyStateView?: JSX.Element;
+    disableSoundForMessages?: boolean;
     /**
-     * Custom view for the error state of the component
+     * Custom audio sound for incoming messages.
      */
-    errorStateView?: JSX.Element;
+    customSoundForMessages?: string;
     /**
-     * Hide error view
+     * Callback function triggered when the component encounters an error.
      *
-     * @remarks
-     * If set to true, hides the default and the custom error view
-     *
-     * @defaultValue `false`
+     * @param error - An instance of `CometChat.CometChatException` representing the error.
+     * @returns void
      */
-    hideError?: boolean;
+    onError?: ((error: CometChat.CometChatException) => void) | null;
     /**
-     * Function to call on click of the default list item view of a conversation
+     * Callback function invoked when a conversation item is clicked.
+     *
+     * @param conversation - An instance of `CometChat.Conversation` representing the clicked conversation.
+     * @returns void
      */
     onItemClick?: (conversation: CometChat.Conversation) => void;
     /**
-     * Function to call when a conversation from the fetched list is selected
+     * Callback function invoked when a conversation item is selected.
      *
-     * @remarks
-     * This prop is used if `selectionMode` prop is not `SelectionMode.none`
+     * @param conversation - An instance of `CometChat.Conversation` representing the selected conversation.
+     * @param selected - A boolean indicating whether the item is selected.
+     * @returns void
+     * @remarks This prop works only if `selectionMode` is not set to `SelectionMode.none`.
      */
     onSelect?: (conversation: CometChat.Conversation, selected: boolean) => void;
     /**
-     * Disable typing indicator display
-     *
-     * @defaultValue `false`
+     * A custom component to render in the top-right corner of the Conversations UI.
      */
-    disableTyping?: boolean;
+    headerView?: JSX.Element;
     /**
-     * Title of the confirmation dialog.
-     *
+     * A custom component to display during the loading state.
+     */
+    loadingView?: JSX.Element;
+    /**
+     * A custom component to display when there are no conversations available.
      */
-    confirmDialogTitle?: string;
+    emptyView?: JSX.Element;
     /**
-     * Message displayed in the confirmation dialog.
+     * A custom component to display when an error occurs.
+     */
+    errorView?: JSX.Element;
+    /**
+     * A custom view to render each conversation in the list.
      *
+     * @param conversation - An instance of `CometChat.Conversation` representing the conversation.
+     * @returns A JSX element to be rendered as the conversation item.
      */
-    confirmDialogMessage?: string;
+    itemView?: (conversation: CometChat.Conversation) => JSX.Element;
     /**
-    * Text for the cancel button in the confirmation dialog.
-    */
-    cancelButtonText?: string;
+     * A function that renders a JSX element to display the leading view.
+     *
+     * @param conversation - An instance of `CometChat.Conversation` representing the conversation.
+     * @returns A JSX element to be rendered as the leading view.
+     */
+    leadingView?: (conversation: CometChat.Conversation) => JSX.Element;
     /**
-     * Text for the confirm button in the confirmation dialog.
+     * A function that renders a JSX element to display the title view.
+     *
+     * @param conversation - An instance of `CometChat.Conversation` representing the conversation.
+     * @returns A JSX element to be rendered as the title view.
      */
-    confirmButtonText?: string;
+    titleView?: (conversation: CometChat.Conversation) => JSX.Element;
     /**
-     * Disable mentions in conversation. Default value is set to false
+     * A custom view to render the subtitle for each conversation.
+     *
+     * @param conversation - An instance of `CometChat.Conversation` representing the conversation.
+     * @returns A JSX element to be rendered as the subtitle view.
      */
-    disableMentions?: boolean;
+    subtitleView?: (conversation: CometChat.Conversation) => JSX.Element;
     /**
-     * Allows user to pass custom formatters
+     * A custom view to render at the end of each conversation item.
+     *
+     * @param conversation - An instance of `CometChat.Conversation` representing the conversation.
+     * @returns A JSX element to be rendered as the trailing view.
      */
-    textFormatters?: CometChatTextFormatter[];
+    trailingView?: (conversation: CometChat.Conversation) => JSX.Element;
 }
 export type Action = {
     type: "appendConversations";

package/dist/types/components/CometChatConversations/controller.d.ts

@@ -1,11 +1,13 @@
 import { CometChat } from '@cometchat/chat-sdk-javascript';
 type Args = {
     conversationsRequestBuilder: CometChat.ConversationsRequestBuilder | null;
+    errorHandler: (error: unknown, source?: string) => void;
 };
 export declare class ConversationsManager {
     private static limit;
     private conversationsRequest;
     private static conversationType;
+    private static errorHandler;
     /**
      * Set `conversationsRequest` of the instance
      */
@@ -19,49 +21,49 @@ export declare class ConversationsManager {
      *
      * @returns Function to call to remove the attached SDK user listener
      */
-    static attachUserListener(callback: (user: CometChat.User) => void): () => void;
+    static attachUserListener(callback: (user: CometChat.User) => void): (() => void) | undefined;
     /**
      * Attaches an SDK group listener
      *
      * @returns Function to call to remove the attached SDK group listener
      */
-    static attachGroupListener(callback: (message: CometChat.BaseMessage, remove?: boolean) => Promise<void>, loggedInUser: CometChat.User | null): () => void;
+    static attachGroupListener(callback: (message: CometChat.BaseMessage, remove?: boolean) => Promise<void>, loggedInUser: CometChat.User | null): (() => void) | undefined;
     /**
      * Attaches an SDK message received listener
      *
      * @returns - Function to remove the added SDK message received listener
      */
-    static attachMessageReceivedListener(callback: (message: CometChat.BaseMessage) => Promise<void>): () => void;
+    static attachMessageReceivedListener(callback: (message: CometChat.BaseMessage) => Promise<void>): (() => void) | undefined;
     /**
      * Attaches an SDK message receipt listener
      *
      * @returns - Function to remove the added SDK message receipt listener
      */
-    static attachMessageReceiptListener(callback: (receipt: CometChat.MessageReceipt, updateReadAt: boolean) => void): () => void;
+    static attachMessageReceiptListener(callback: (receipt: CometChat.MessageReceipt, updateReadAt: boolean) => void): (() => void) | undefined;
     /**
      * Attaches an SDK message typing listener
      *
      * @returns - Function to remove the added SDK message typing listener
      */
-    static attachMessageTypingListener(callback: (typingIndicator: CometChat.TypingIndicator, typingStarted: boolean) => void): () => void;
+    static attachMessageTypingListener(callback: (typingIndicator: CometChat.TypingIndicator, typingStarted: boolean) => void): (() => void) | undefined;
     /**
      * Attaches an SDK message modified listener
      *
      * @returns - Function to remove the added SDK message modified listener
      */
-    static attachMessageModifiedListener(callback: (message: CometChat.BaseMessage) => void): () => void;
+    static attachMessageModifiedListener(callback: (message: CometChat.BaseMessage) => void): (() => void) | undefined;
     /**
      * Attaches an SDK call listener
      *
      * @returns - Function to remove the added SDK call listener
      */
-    static attachCallListener(callback: (message: CometChat.BaseMessage) => void): () => void;
+    static attachCallListener(callback: (message: CometChat.BaseMessage) => void): (() => void) | undefined;
     /**
   * Attaches an SDK websocket  listener
   *
   * @returns - Function to remove the added SDK websocket listener
   */
-    static attachConnestionListener(callback: () => void): () => void;
+    static attachConnestionListener(callback: () => void): (() => void) | undefined;
     /**
      * Determines if the last message should trigger an update based on its category and type.
      *

package/dist/types/components/CometChatConversations/useCometChatConversations.d.ts

@@ -8,18 +8,15 @@ type Args = {
     fetchNextAndAppendConversations: (fetchId: string) => Promise<void>;
     fetchNextIdRef: React.MutableRefObject<string>;
     dispatch: React.Dispatch<Action>;
-    conversationToBeDeleted: CometChat.Conversation | null;
-    errorHandler: (error: unknown) => void;
+    errorHandler: (error: unknown, source?: string) => void;
     refreshSingleConversation: (message: CometChat.BaseMessage, remove?: boolean) => Promise<void>;
     onMessageReceived: (message: CometChat.BaseMessage) => Promise<void>;
     setReceipts: (messageReceipt: CometChat.MessageReceipt, updateReadAt: boolean) => void;
     setTypingIndicator: (typingIndicator: CometChat.TypingIndicator, typingStarted: boolean) => void;
-    disableTyping: boolean;
     loggedInUser: CometChat.User | null;
-    isFirstReload: boolean;
-    disableUsersPresence?: boolean;
     activeConversation: Conversation | null;
     setActiveConversationState: React.Dispatch<React.SetStateAction<Conversation | null>>;
+    hideUserStatus?: boolean;
 };
 export declare function useCometChatConversations(args: Args): void;
 export {};

package/dist/types/components/CometChatGroupMembers/CometChatGroupMembers.d.ts

@@ -4,140 +4,158 @@ import { SelectionMode, States } from "../../Enums/Enums";
 import { CometChatOption } from "../../modals";
 interface GroupMembersProps {
     /**
-     * Custom view to render on the top-right of the component
+     * Hides the default search bar.
+     *
+     * @defaultValue `false`
      */
-    menu?: JSX.Element;
+    hideSearch?: boolean;
     /**
-     * Title of the component
+     * Hides the default and custom error view passed in `errorView` prop.
      *
-     * @defaultValue `localize("MEMBERS")`
+     * @defaultValue `false`
      */
-    title?: string;
+    hideError?: boolean;
     /**
-     * Text to be displayed when the search input has no value
+     * Disables the loading state while fetching users.
      *
-     * @defaultValue `localize("SEARCH")`
+     * @defaultValue `false`
      */
-    searchPlaceholderText?: string;
+    disableLoadingState?: boolean;
     /**
-     * Hide the search bar
+     * Hides the option to kick a member from the group.
      *
      * @defaultValue `false`
      */
-    hideSearch?: boolean;
+    hideKickMemberOption?: boolean;
     /**
-     * Request builder to fetch group members
+     * Hides the option to ban a member from the group.
      *
-     * @remarks
-     * If the search input is not empty and the `searchRequestBuilder` prop is not provided,
-     * the search keyword of this request builder is set to the text in the search input
+     * @defaultValue `false`
+     */
+    hideBanMemberOption?: boolean;
+    /**
+     * Hides the option to change the scope of a group member.
      *
-     * @defaultValue Default request builder having the limit set to 30
+     * @defaultValue `false`
      */
-    groupMemberRequestBuilder?: CometChat.GroupMembersRequestBuilder;
+    hideScopeChangeOption?: boolean;
     /**
-     * Request builder with search parameters to fetch group members
+     * Hides the user's online/offline status indicator.
      *
-     * @remarks
-     * If the search input is not empty,
-     * the search keyword of this request builder is set to the text in the search input
+     * @defaultValue `false`
      */
-    searchRequestBuilder?: CometChat.GroupMembersRequestBuilder;
+    hideUserStatus?: boolean;
     /**
-     * Group the fetched groupMembers belong to
+     * The group for which members are being fetched.
      */
     group: CometChat.Group;
     /**
-     * Function to call whenever the component encounters an error
+     * Request builder to fetch group members.
+     *
+     * @defaultValue Default request builder having the limit set to `30`.
      */
-    onError?: ((error: CometChat.CometChatException) => void) | null;
+    groupMemberRequestBuilder?: CometChat.GroupMembersRequestBuilder;
     /**
-     * Custom view for the loading state of the component
+     * Request builder with search parameters to fetch group members.
+     *
+     * @remarks If the search input is not empty, the search keyword of this request builder is set to the text in the search input.
      */
-    loadingStateView?: JSX.Element;
+    searchRequestBuilder?: CometChat.GroupMembersRequestBuilder;
     /**
-     * Custom view for the empty state of the component
+     * The keyword used to filter the group members list.
+     *
+     * @defaultValue `""`
      */
-    emptyStateView?: JSX.Element;
+    searchKeyword?: string;
     /**
-     * Custom view for the error state of the component
+     * A function that returns a list of actions available when hovering over a group member item.
+     *
+     * @param group - The group instance.
+     * @param groupMember - An instance of `CometChat.GroupMember` representing the group member.
+     * @returns An array of `CometChatOption`.
      */
-    errorStateView?: JSX.Element;
+    options?: (group: CometChat.Group, groupMember: CometChat.GroupMember) => CometChatOption[];
     /**
-     * Hide error view
-     *
-     * @remarks
-     * If set to true, hides the default and the custom error view
+     * Selection mode to use for the default list item view.
      *
-     * @defaultValue `false`
+     * @defaultValue `SelectionMode.none`
      */
-    hideError?: boolean;
+    selectionMode?: SelectionMode;
     /**
-     * Hide user presence
-     *
-     * @remarks
-     * If set to true, the status indicator of the default list item view is not displayed
+     * Callback function invoked when an error occurs in the component.
+     */
+    onError?: ((error: CometChat.CometChatException) => void) | null;
+    /**
+     * Callback function invoked when a group member item is clicked.
      *
-     * @defaultValue `false`
+     * @param groupMember - An instance of `CometChat.GroupMember` representing the group member.
+     * returns void
      */
-    disableUsersPresence?: boolean;
+    onItemClick?: (groupMember: CometChat.GroupMember) => void;
     /**
-     * Custom subtitle view to be rendered for each group member in the fetched list
+     * Callback function invoked when a group member is selected or deselected.
      *
-     * @remarks
-     * This prop is used if `listItemView` prop is not provided
+     * @param groupMember - An instance of `CometChat.GroupMember` representing the group member.
+     * @param selected - Boolean value to identify if the member is selected or removed.
+     * @returns void
      */
-    subtitleView?: (groupMember: CometChat.GroupMember) => JSX.Element;
+    onSelect?: (groupMember: CometChat.GroupMember, selected: boolean) => void;
     /**
-     * Custom list item view to be rendered for each group member in the fetched list
+     * Callback function invoked when the group members list is empty.
+     * @returns void
      */
-    listItemView?: (groupMember: CometChat.GroupMember) => JSX.Element;
+    onEmpty?: () => void;
     /**
-     * List of actions available on mouse over on the default list item component
+     * A custom component to render in the top-right corner of the group members list.
      */
-    options?: (group: CometChat.Group, groupMember: CometChat.GroupMember) => CometChatOption[];
+    headerView?: JSX.Element;
     /**
-     * View to be placed in the tail view
-     *
-     * @remarks
-     * This prop will be used if `listItemView` is not provided
+     * A custom view to display during the loading state.
      */
-    tailView?: (groupMember: CometChat.GroupMember) => JSX.Element;
+    loadingView?: JSX.Element;
     /**
-     * Selection mode to use for the default list item view
-     *
-     * @remarks
-     * This prop is used if `listItemView` prop is not provided
-     *
-     * @defaultValue `SelectionMode.none`
+     * Custom view for the error state of the component.
      */
-    selectionMode?: SelectionMode;
+    errorView?: JSX.Element;
     /**
-     * Function to call on click of the default list item view of a group member
+     * A custom view to display when no group members are available in the list.
      */
-    onItemClick?: (groupMember: CometChat.GroupMember) => void;
+    emptyView?: JSX.Element;
     /**
-     * Function to call when a group member from the fetched list is selected
+     * A custom view to render for each group member in the fetched list.
      *
-     * @remarks
-     * This prop is used if `selectionMode` prop is not `SelectionMode.none`
+     * @param groupMember - An instance of `CometChat.GroupMember` representing the group member.
+     * @returns A JSX element to be rendered as the group member item.
      */
-    onSelect?: (groupMember: CometChat.GroupMember, selected: boolean) => void;
+    itemView?: (groupMember: CometChat.GroupMember) => JSX.Element;
     /**
-     * Search keyword to filter the list of users.
+     * A function that renders a JSX element to display the leading view.
      *
-     * @defaultValue `""`
+     * @param groupMember - An instance of `CometChat.GroupMember` representing the group member.
+     * @returns A JSX element to be rendered as the leading view.
      */
-    searchKeyword?: string;
+    leadingView?: (groupMember: CometChat.GroupMember) => JSX.Element;
     /**
-     * Callback function to be executed when the user list is empty.
+     * A function that renders a JSX element to display the title view.
+     *
+     * @param groupMember - An instance of `CometChat.GroupMember` representing the group member.
+     * @returns A JSX element to be rendered as the title view.
      */
-    onEmpty?: () => void;
+    titleView?: (groupMember: CometChat.GroupMember) => JSX.Element;
     /**
-     * Flag to indicate whether to disable loading state while fetching users.
-     * @defaultValue `false`
+     * A function that renders a JSX element to display the subtitle view.
+     *
+     * @param groupMember - An instance of `CometChat.GroupMember` representing the group member.
+     * @returns A JSX element to be rendered as the subtitle view.
      */
-    disableLoadingState?: boolean;
+    subtitleView?: (groupMember: CometChat.GroupMember) => JSX.Element;
+    /**
+     * A function that renders a JSX element to display the trailing view.
+     *
+     * @param groupMember - An instance of `CometChat.GroupMember` representing the group member.
+     * @returns A JSX element to be rendered as the trailing view.
+     */
+    trailingView?: (groupMember: CometChat.GroupMember) => JSX.Element;
 }
 export type Action = {
     type: "appendGroupMembers";

package/dist/types/components/CometChatGroupMembers/useCometChatGroupMembers.d.ts

@@ -11,12 +11,12 @@ type Args = {
     fetchNextIdRef: React.MutableRefObject<string>;
     dispatch: React.Dispatch<Action>;
     loggedInUserRef: React.MutableRefObject<CometChat.User | null>;
-    errorHandler: (error: unknown) => void;
+    errorHandler: (error: unknown, source?: string | undefined) => void;
     updateGroupMemberScope: (newScope: string) => Promise<void>;
     searchKeyword: string;
     disableLoadingState: boolean;
     groupMembersSearchText: React.MutableRefObject<string>;
-    disableUsersPresence?: boolean;
+    hideUserStatus?: boolean;
 };
 export declare function Hooks(args: Args): void;
 export {};