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

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

@@ -3,112 +3,124 @@ import { SelectionMode, States } from "../../Enums/Enums";
 import { CometChatOption } from "../../modals";
 interface GroupsProps {
     /**
-     * Custom view to render on the top-right of the component
-     */
-    menu?: JSX.Element;
-    /**
-     * Title of the component
-     *
-     * @defaultValue `localize("GROUPS")`
-    */
-    title?: string;
-    /**
-     * Text to be displayed when the search input has no value
-     *
-     * @defaultValue `localize("SEARCH")`
-     */
-    searchPlaceholderText?: string;
-    /**
-     * Hide the search bar
+     * Hides the default search bar.
      *
      * @defaultValue `false`
      */
     hideSearch?: boolean;
     /**
-     * Request builder to fetch groups
-     *
-     * @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
+     * Hides the default and custom error view passed in `errorView` prop.
      *
-     * @defaultValue Default request builder having the limit set to 30
+     * @defaultValue `false`
      */
-    groupsRequestBuilder?: CometChat.GroupsRequestBuilder;
+    hideError?: boolean;
     /**
-     * Request builder with search parameters to fetch groups
+     * Hides the group type icon.
      *
-     * @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.GroupsRequestBuilder;
+    hideGroupType?: boolean;
     /**
-     * Function to call whenever the component encounters an error
+     * The group to highlight in the list.
      */
-    onError?: ((error: CometChat.CometChatException) => void) | null;
+    activeGroup?: CometChat.Group;
     /**
-     * Custom list item view to be rendered for each group in the fetched list
+     * A request builder for fetching groups.
+     *
+     * @defaultValue Default request builder having the limit set to `30`.
      */
-    listItemView?: (group: CometChat.Group) => JSX.Element;
+    groupsRequestBuilder?: CometChat.GroupsRequestBuilder;
     /**
-     * Custom subtitle view to be rendered for each group in the fetched list
+     * A request builder configured with search parameters to fetch groups.
      *
-     * @remarks
-     * This prop is used if `listItemView` prop is not provided
+     * @remarks If the search input is not empty, the search keyword of this request builder is set to the text in the search input.
      */
-    subtitleView?: (group: CometChat.Group) => JSX.Element;
+    searchRequestBuilder?: CometChat.GroupsRequestBuilder;
     /**
-     * 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 group item.
+     * @param group - An instance of `CometChat.Group` representing the group.
+     * @returns An array of `CometChatOption` objects.
      */
     options?: (group: CometChat.Group) => CometChatOption[];
     /**
-     * Selection mode to use for the default tail view
-     *
-     * @remarks
-     * This prop is used if `listItemView` prop is not provided.
+     * Selection mode to use for the default trailing view.
      *
      * @defaultValue `SelectionMode.none`
      */
     selectionMode?: SelectionMode;
     /**
-     * Function to call when a group from the fetched list is selected
+     * Callback function invoked when an error occurs in the component.
+     * @param error - An instance of `CometChat.CometChatException` representing the error that occurred.
+     * @returns void
+     */
+    onError?: ((error: CometChat.CometChatException) => void) | null;
+    /**
+     * Callback function invoked when a group is selected.
      *
-     * @remarks
-     * This prop is used if `selectionMode` prop is not `SelectionMode.none`
+     * @remarks This prop works only if `selectionMode` is not set to `SelectionMode.none`.
+     * @param group - An instance of `CometChat.Group` representing the selected group.
+     * @param selected - A boolean indicating whether the group is selected.
+     * @returns void
      */
     onSelect?: (group: CometChat.Group, selected: boolean) => void;
     /**
-     * Function to call on click of the default list item view of a group
+     * Callback function invoked when a group item is clicked.
+     *
+     * @param group - An instance of `CometChat.Group` representing the clicked group.
+     * @returns void
      */
     onItemClick?: (group: CometChat.Group) => void;
     /**
-     * Group to highlight
-     *
-     * @remarks
-     * This prop is used if `listItemView` prop is not provided
+     * A custom component to render in the top-right corner of the groups list.
      */
-    activeGroup?: CometChat.Group;
+    headerView?: JSX.Element;
     /**
-     * Custom view for the loading state of the component
+     * A custom view to display during the loading state.
      */
-    loadingStateView?: JSX.Element;
+    loadingView?: JSX.Element;
     /**
-     * Custom view for the empty state of the component
+     * Custom view for the empty state of the component.
      */
-    emptyStateView?: JSX.Element;
+    emptyView?: JSX.Element;
     /**
-     * Custom view for the error state of the component
+     * A custom view to display when an error occurs.
      */
-    errorStateView?: JSX.Element;
+    errorView?: JSX.Element;
     /**
-     * Hide error view
+     * A custom view to render for each group in the fetched list.
      *
-     * @remarks
-     * If set to true, hides the default and the custom error view
+     * @param group - An instance of `CometChat.Group` representing the group.
+     * @returns A JSX element to be rendered as the group item.
+     */
+    itemView?: (group: CometChat.Group) => JSX.Element;
+    /**
+     * A function that renders a JSX element to display the leading view.
      *
-     * @defaultValue `false`
+     * @param group - An instance of `CometChat.Group` representing the group.
+     * @returns A JSX element to be rendered as the leading view.
      */
-    hideError?: boolean;
+    leadingView?: (group: CometChat.Group) => JSX.Element;
+    /**
+     * A function that renders a JSX element to display the title view.
+     *
+     * @param group - An instance of `CometChat.Group` representing the group.
+     * @returns A JSX element to be rendered as the title view.
+     */
+    titleView?: (group: CometChat.Group) => JSX.Element;
+    /**
+     * Custom subtitle view to be rendered for each group in the fetched list.
+     *
+     * @param group - An instance of `CometChat.Group` representing the group.
+     * @returns A JSX element to be rendered as the subtitle view.
+     */
+    subtitleView?: (group: CometChat.Group) => JSX.Element;
+    /**
+     * A function that renders a JSX element to display the trailing view.
+     *
+     * @param group - An instance of `CometChat.Group` representing the group.
+     * @returns A JSX element to be rendered as the trailing view.
+     */
+    trailingView?: (group: CometChat.Group) => JSX.Element;
 }
 export type Action = {
     type: "appendGroups";

package/dist/types/components/CometChatGroups/useCometChatGroups.d.ts

@@ -10,6 +10,7 @@ type Args = {
     dispatch: React.Dispatch<Action>;
     fetchNextAndAppendGroups: (fetchId: string) => Promise<void>;
     groupsSearchText: React.MutableRefObject<string>;
+    errorHandler: (error: unknown, source?: string | undefined) => void;
 };
 export declare function useCometChatGroups(args: Args): void;
 export {};

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

@@ -1,96 +1,154 @@
 import { JSX } from "react";
 import { CometChatTextFormatter } from "../../formatters/CometChatFormatters/CometChatTextFormatter";
 import { CometChatMessageComposerAction } from "../../modals";
-import { PreviewMessageMode } from "../../Enums/Enums";
+import { EnterKeyBehavior, PreviewMessageMode } from "../../Enums/Enums";
 export type ContentToDisplay = "attachments" | "emojiKeyboard" | "voiceRecording" | "ai" | "none";
 export type ActionOnClickType = (() => void) | null;
 interface MessageComposerProps {
     /**
-     * User to send messages to
+     * The initial text pre-filled in the message input when the component mounts.
+     * @defaultValue ""
      */
-    user?: CometChat.User;
+    initialComposerText?: string;
     /**
-     * Group to send messages to
-     *
-     * @remarks
-     * This prop is used if `user` prop is not provided
+     * Disables the typing indicator for the current message composer.
+     * @defaultValue `false`
      */
-    group?: CometChat.Group;
+    disableTypingEvents?: boolean;
     /**
-     * Text to fill the message input with
-     *
-     * @remarks
-     * This prop is used only when this component mounts
-     *
-     * @defaultValue `""`
+     * Disables the mentions functionality in the message composer.
+     * @defaultValue `false`
      */
-    text?: string;
+    disableMentions?: boolean;
     /**
-     * Function to call when the message input's text value changes
+     * Hides the image attachment option in the message composer.
+     * @defaultValue `false`
      */
-    onTextChange?: (text: string) => void;
+    hideImageAttachmentOption?: boolean;
     /**
-     * Text shown in the message input when it is empty
+     * Hides the video attachment option in the message composer.
+     * @defaultValue `false`
      */
-    placeHolderText?: string;
+    hideVideoAttachmentOption?: boolean;
     /**
-     * Custom send button view
+     * Hides the audio attachment option in the message composer.
+     * @defaultValue `false`
      */
-    sendButtonView?: JSX.Element;
+    hideAudioAttachmentOption?: boolean;
     /**
-     * Function to call whenever a new text message is sent
+     * Hides the file attachment option in the message composer.
+     * @defaultValue `false`
      */
-    onSendButtonClick?: (message: CometChat.BaseMessage, previewMessageMode?: PreviewMessageMode) => void;
+    hideFileAttachmentOption?: boolean;
+    /**
+     * Hides the polls option in the message composer.
+     * @defaultValue `false`
+     */
+    hidePollsOption?: boolean;
     /**
-     * Custom secondary button view
+     * Hides the collaborative document option in the message composer.
+     * @defaultValue `false`
      */
-    secondaryButtonView?: JSX.Element;
+    hideCollaborativeDocumentOption?: boolean;
     /**
-     * Custom auxiliary button view
+     * Hides the collaborative whiteboard option in the message composer.
+     * @defaultValue `false`
      */
-    auxiliaryButtonView?: JSX.Element;
+    hideCollaborativeWhiteboardOption?: boolean;
     /**
-     * Options for the default secondary view
+     * Hides the attachment button in the message composer.
+     * @defaultValue `false`
      */
-    attachmentOptions?: CometChatMessageComposerAction[];
+    hideAttachmentButton?: boolean;
     /**
-     * Id of the parent message
+     * Hides the voice recording button in the message composer.
+     * @defaultValue `false`
+     */
+    hideVoiceRecordingButton?: boolean;
+    /**
+     * Hides the emoji keyboard button in the message composer.
+     * @defaultValue `false`
+     */
+    hideEmojiKeyboardButton?: boolean;
+    /**
+     * Hides the stickers button in the message composer.
+     * @defaultValue `false`
+     */
+    hideStickersButton?: boolean;
+    /**
+     * Hides the send button in the message composer.
+     * @defaultValue `false`
+     */
+    hideSendButton?: boolean;
+    /**
+     * The user to send messages to. This prop specifies the recipient of the message.
+     */
+    user?: CometChat.User;
+    /**
+     * The group to send messages to.
+     * @remarks This prop is used if the `user` prop is not provided.
+     */
+    group?: CometChat.Group;
+    /**
+     * The ID of the parent message. This is used for threading or replying to a specific message.
      */
     parentMessageId?: number;
     /**
-     * Preview section at the top of the message input
+     * Options for default attachments, including various attachment types available in the composer.
      */
-    headerView?: JSX.Element;
+    attachmentOptions?: CometChatMessageComposerAction[];
     /**
-     * Function to call whenever the component encounters an error
+     * Array of text formatters to apply to the message text for customization and styling.
      */
-    onError?: ((error: CometChat.CometChatException) => void) | null;
+    textFormatters?: Array<CometChatTextFormatter>;
+    /**
+     * Determines the behavior of the Enter key in the composer (e.g., send message or add a new line).
+     * @default EnterKeyBehavior.SendMessage
+     */
+    enterKeyBehavior?: EnterKeyBehavior;
     /**
-     * Disable sending typing events
+     * Disables sound for incoming messages.
      *
      * @defaultValue `false`
      */
-    disableTypingEvents?: boolean;
+    disableSoundForMessage?: boolean;
     /**
-     * Hide voice recording button
+     * Custom audio sound for incoming messages.
      */
-    hideVoiceRecording?: boolean;
+    customSoundForMessage?: string;
     /**
-     * Hide emoji  keyboard button
+     * Callback function triggered when the message input text changes.
+     *
+     * @param text - The current text value of the message input.
+     * @returns void
      */
-    hideEmojiKeyboard?: boolean;
+    onTextChange?: (text: string) => void;
     /**
-   * fotmatters for composer text
-   */
-    textFormatters?: Array<CometChatTextFormatter>;
+     * Callback function triggered when the message composer encounters an error.
+     *
+     * @param error - An instance of `CometChat.CometChatException` representing the error.
+     * @returns void
+     */
+    onError?: ((error: CometChat.CometChatException) => void) | null;
     /**
-   * boolean to hide mentions UI
-   */
-    disableMentions?: boolean;
+     * Callback function triggered when the send button is clicked.
+     *
+     * @param message - The message that was sent.
+     * @param previewMessageMode - Optionally, specify if the message is in preview mode.
+     */
+    onSendButtonClick?: (message: CometChat.BaseMessage, previewMessageMode?: PreviewMessageMode) => void;
     /**
-   * text to show when mentions limit exceeds
-   */
-    mentionsWarningText?: string;
+     * A custom view for the send button to customize its appearance or behavior.
+     */
+    sendButtonView?: JSX.Element;
+    /**
+     * A custom view for an auxiliary button, which can be used alongside the send button.
+     */
+    auxiliaryButtonView?: JSX.Element;
+    /**
+     * A custom header section displayed at the top of the message composer, often used for media previews or additional information.
+     */
+    headerView?: JSX.Element;
 }
 /**
  * Represents the state of the message composer.

package/dist/types/components/CometChatMessageComposer/useCometChatMessageComposer.d.ts

@@ -7,7 +7,7 @@ import { UserMemberListType } from "../../Enums/Enums";
 type Args = {
     dispatch: React.Dispatch<Action>;
     mySetAddToMsgInputText: (text: string) => void;
-    errorHandler: (error: unknown) => void;
+    errorHandler: (error: unknown, source?: string) => void;
     pasteHtmlAtCaret: (text: string) => void;
     textFormatters: Array<CometChatTextFormatter>;
     disableMentions: boolean;

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

@@ -3,26 +3,87 @@ import { JSX } from "react";
  * Interface for the props accepted by the CometChatMessageHeader component.
  */
 interface MessageHeaderProps {
-    /** Custom subtitle view, allowing you to render a JSX element as the subtitle */
-    subtitleView?: JSX.Element;
-    /** Disables showing the user's online/offline presence if set to true */
-    disableUsersPresence?: boolean;
-    /** Disables showing the typing indicator if set to true */
-    disableTyping?: boolean;
-    /** Custom JSX element for the menu, which can be used for additional options or actions */
-    menu?: JSX.Element;
-    /** The user object from CometChat, used to show user-specific information (e.g., status) */
+    /**
+     * Shows the conversation summary button.
+     * @default false
+     */
+    showConversationSummaryButton?: boolean;
+    /**
+     * Hides the back button in the header in mobile view.
+     * @default false
+     */
+    hideBackButton?: boolean;
+    /**
+     * Hides the video call button.
+     * @default false
+     */
+    hideVideoCallButton?: boolean;
+    /**
+     * Hides the voice call button.
+     * @default false
+     */
+    hideVoiceCallButton?: boolean;
+    /**
+     * Hides the user's online/offline status indicator.
+     * @default false
+     */
+    hideUserStatus?: boolean;
+    /**
+     * A `CometChat.User` object representing the user whose information (e.g., status) is displayed.
+     */
     user?: CometChat.User;
-    /** The group object from CometChat, used to show group-specific information (e.g., member count) */
+    /**
+     * A `CometChat.Group` object representing the group whose details (e.g., member count) are displayed.
+     */
     group?: CometChat.Group;
-    /** Custom JSX element for rendering a list item view, often used to display user/group details */
-    listItemView?: JSX.Element;
-    /** Callback function to handle any errors related to CometChat operations */
+    /**
+     * Number of messages for which the summary should be shown.
+     * @default 1000
+     */
+    summaryGenerationMessageCount?: number;
+    /**
+     * Enables the auto generation of conversation summary.
+     * @default false
+     */
+    enableAutoSummaryGeneration?: boolean;
+    /**
+     * Callback function to handle errors related to CometChat operations.
+     *
+     * @param error - An instance of `CometChat.CometChatException` representing the error.
+     * @returns void
+     */
     onError?: ((error: CometChat.CometChatException) => void) | null;
-    /** Callback function triggered when the back action is performed (e.g., navigating to the previous view) */
+    /**
+     * Callback function triggered when the back action is performed.
+     *
+     * @returns void
+     */
     onBack?: () => void;
-    /** Controls the visibility of the back button. */
-    hideBackButton?: boolean;
+    /**
+     * A custom JSX element for rendering a menu. It can be used to add options or actions.
+     */
+    auxiliaryButtonView?: JSX.Element;
+    /**
+     * A custom JSX element for rendering a list item view, typically used to show user or group details.
+     */
+    itemView?: JSX.Element;
+    /**
+     * A function that renders a JSX element to display the leading view.
+     */
+    leadingView?: JSX.Element;
+    /**
+     * A function that renders a JSX element to display the title view.
+     */
+    titleView?: JSX.Element;
+    /**
+     * Custom subtitle view, allowing you to render a JSX element as the subtitle.
+     * It can be used to provide additional information under the title.
+     */
+    subtitleView?: JSX.Element;
+    /**
+     * A function that renders a JSX element to display the trailing view.
+     */
+    trailingView?: JSX.Element;
 }
 /** Functional component for rendering the CometChatMessageHeader */
 export declare const CometChatMessageHeader: (props: MessageHeaderProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/components/CometChatMessageHeader/useCometChatMessageHeader.d.ts

@@ -1,3 +1,3 @@
 import React from "react";
-declare function useCometChatMessageHeader(loggedInUser: CometChat.User | null, setLoggedInUser: Function, attachListeners: Function, userRef: React.MutableRefObject<CometChat.User | undefined>, groupRef: React.MutableRefObject<CometChat.Group | undefined>, updateSubtitle: Function, subscribeToEvents: Function, user?: CometChat.User, group?: CometChat.Group): void;
+declare function useCometChatMessageHeader(loggedInUser: CometChat.User | null, setLoggedInUser: Function, attachListeners: Function, userRef: React.MutableRefObject<CometChat.User | undefined>, groupRef: React.MutableRefObject<CometChat.Group | undefined>, updateSubtitle: Function, subscribeToEvents: Function, onErrorCallback: (error: unknown, source?: string | undefined) => void, user?: CometChat.User, group?: CometChat.Group, enableAutoSummaryGeneration?: boolean, loadConversationSummary?: Function): void;
 export { useCometChatMessageHeader };

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

@@ -1,6 +1,11 @@
 interface MessageInformationProps {
     message: CometChat.BaseMessage;
     onClose?: () => void;
+    /**
+     * Callback triggered when an error occurs during the message receipt fetching process.
+     * @param error - CometChatException object representing the error.
+     */
+    onError?: ((error: CometChat.CometChatException) => void) | null;
 }
 declare const CometChatMessageInformation: (props: MessageInformationProps) => import("react/jsx-runtime").JSX.Element;
 export { CometChatMessageInformation };