@cometchat/chat-uikit-react 6.0.3 → 6.0.5

package/dist/index.d.ts

@@ -1113,6 +1113,18 @@ declare class CometChatMessageOption extends CometChatOption {
     });
 }
 
+/**
+ * Class that handles the text formatting for URLs in CometChat.
+ * CometChatUrlsFormatter is a child class of CometChatTextFormatter.
+ * It extends the functionality of text formatting to specifically handle URLs.
+ * It is used in extension decorators like  link preview, message translation, and dataSource utils.
+ */
+declare class CometChatUrlsFormatter extends CometChatTextFormatter {
+    constructor(regexPatterns: Array<RegExp>);
+    protected onRegexMatch(inputText?: string | null): string;
+    registerEventListeners(element: HTMLElement, classList: DOMTokenList): HTMLElement;
+}
+
 /**
  * CometChatMessageTemplate is a pre-defined structure for creating message views
  * that can be used as a starting point or blueprint for creating message views,
@@ -1131,7 +1143,7 @@ declare class CometChatMessageTemplate {
      * and Video bubble based on the type of the message.
      * @type {(message:CometChat.BaseMessage,alignment:MessageBubbleAlignment)=> Element | JSX.Element | null}
      */
-    contentView: ((message: CometChat.BaseMessage, alignment: MessageBubbleAlignment) => Element | JSX.Element | null) | null;
+    contentView: ((message: CometChat.BaseMessage, alignment: MessageBubbleAlignment, textFormatters?: CometChatTextFormatter[]) => Element | JSX.Element | null) | null;
     /**
      * Custom component to customize the complete message bubble.
      * By default, headerView, contentView and footerView collectively form a message bubble.
@@ -1160,7 +1172,7 @@ declare class CometChatMessageTemplate {
      * By default, it displays the receipt and the timestamp.
      * @type {(message:CometChat.BaseMessage,alignment:MessageBubbleAlignment)=> Element | JSX.Element | null}
      */
-    statusInfoView: ((message: CometChat.BaseMessage, alignment: MessageBubbleAlignment, hideReceipt?: boolean, messageSentAtDateTimeFormat?: CalendarObject) => Element | JSX.Element | null) | null;
+    statusInfoView: ((message: CometChat.BaseMessage, alignment: MessageBubbleAlignment, hideReceipts?: boolean, messageSentAtDateTimeFormat?: CalendarObject) => Element | JSX.Element | null) | null;
     /**
      * List of available actions that any user can perform on a message, like reacting,
      * editing or deleting a message.
@@ -1246,18 +1258,6 @@ declare class ConversationUtils {
     static getLastMessageCall(conversation: CometChat.Conversation): any;
 }
 
-/**
- * Class that handles the text formatting for URLs in CometChat.
- * CometChatUrlsFormatter is a child class of CometChatTextFormatter.
- * It extends the functionality of text formatting to specifically handle URLs.
- * It is used in extension decorators like  link preview, message translation, and dataSource utils.
- */
-declare class CometChatUrlsFormatter extends CometChatTextFormatter {
-    constructor(regexPatterns: Array<RegExp>);
-    protected onRegexMatch(inputText?: string | null): string;
-    registerEventListeners(element: HTMLElement, classList: DOMTokenList): HTMLElement;
-}
-
 type ComposerId = {
     parentMessageId: number | null;
     user: string | null;
@@ -1298,7 +1298,7 @@ declare class MessagesDataSource implements DataSource {
   * @param {CometChat.BaseMessage} item - The message bubble for which the receipt needs to be fetched
   * @returns {JSX.Element | null} Returns JSX.Element for receipt of a message bubble or null
   */
-    getBubbleStatusInfoReceipt: (item: CometChat$1.BaseMessage, hideReceipt?: boolean) => JSX.Element | null;
+    getBubbleStatusInfoReceipt: (item: CometChat$1.BaseMessage, hideReceipts?: boolean) => JSX.Element | null;
     /**
 * Function for displaying the timestamp  next to messages.
 * @returns CalendarObject
@@ -1321,7 +1321,7 @@ declare class MessagesDataSource implements DataSource {
   * @returns {JSX.Element | null} Returns JSX.Element for status and date of a message bubble or null
   */
     getBubbleStatusInfoDate: (item: CometChat$1.BaseMessage, messageSentAtDateTimeFormat?: CalendarObject) => JSX.Element | null;
-    getStatusInfoView: (_messageObject: CometChat$1.BaseMessage, _alignment: MessageBubbleAlignment, hideReceipt?: boolean, messageSentAtDateTimeFormat?: CalendarObject) => react_jsx_runtime.JSX.Element | null;
+    getStatusInfoView: (_messageObject: CometChat$1.BaseMessage, _alignment: MessageBubbleAlignment, hideReceipts?: boolean, messageSentAtDateTimeFormat?: CalendarObject) => react_jsx_runtime.JSX.Element | null;
     getBottomView(_messageObject: CometChat$1.BaseMessage, _alignment: MessageBubbleAlignment): null;
     getTextMessageTemplate(additionalConfigurations?: additionalParams): CometChatMessageTemplate;
     getAudioMessageTemplate(): CometChatMessageTemplate;
@@ -1885,7 +1885,7 @@ declare abstract class DataSource {
     abstract getAudioMessageOptions(loggedInUser: CometChat.User, messageObject: CometChat.BaseMessage, group?: CometChat.Group, additionalParams?: Object | undefined): Array<CometChatActionsIcon | CometChatActionsView>;
     abstract getFileMessageOptions(loggedInUser: CometChat.User, messageObject: CometChat.BaseMessage, group?: CometChat.Group, additionalParams?: Object | undefined): Array<CometChatActionsIcon | CometChatActionsView>;
     abstract getBottomView(message: CometChat.BaseMessage, alignment: MessageBubbleAlignment): Element | JSX.Element | null;
-    abstract getStatusInfoView(message: CometChat.BaseMessage, alignment: MessageBubbleAlignment, hideReceipt?: boolean, messageSentAtDateTimeFormat?: CalendarObject): Element | JSX.Element | null;
+    abstract getStatusInfoView(message: CometChat.BaseMessage, alignment: MessageBubbleAlignment, hideReceipts?: boolean, messageSentAtDateTimeFormat?: CalendarObject): Element | JSX.Element | null;
     abstract getTextMessageContentView(message: CometChat.TextMessage, alignment: MessageBubbleAlignment, otherParams: Object | undefined): Element | JSX.Element;
     abstract getImageMessageContentView(message: CometChat.MediaMessage, alignment: MessageBubbleAlignment): Element | JSX.Element;
     abstract getVideoMessageContentView(message: CometChat.MediaMessage, alignment: MessageBubbleAlignment): Element | JSX.Element;
@@ -2088,7 +2088,7 @@ declare abstract class DataSourceDecorator implements DataSource {
     getVideoMessageOptions(loggedInUser: CometChat.User, messageObject: CometChat.BaseMessage, group?: CometChat.Group, additionalParams?: Object | undefined): Array<CometChatActionsIcon | CometChatActionsView>;
     getAudioMessageOptions(loggedInUser: CometChat.User, messageObject: CometChat.BaseMessage, group?: CometChat.Group, additionalParams?: Object | undefined): Array<CometChatActionsIcon | CometChatActionsView>;
     getFileMessageOptions(loggedInUser: CometChat.User, messageObject: CometChat.BaseMessage, group?: CometChat.Group, additionalParams?: Object | undefined): Array<CometChatActionsIcon | CometChatActionsView>;
-    getStatusInfoView(message: CometChat.BaseMessage, alignment: MessageBubbleAlignment, hideReceipt?: boolean, messageSentAtDateTimeFormat?: CalendarObject): JSX.Element | Element | null;
+    getStatusInfoView(message: CometChat.BaseMessage, alignment: MessageBubbleAlignment, hideReceipts?: boolean, messageSentAtDateTimeFormat?: CalendarObject): JSX.Element | Element | null;
     getBottomView(message: CometChat.BaseMessage, alignment: MessageBubbleAlignment): JSX.Element | Element | null;
     getTextMessageContentView(message: CometChat.TextMessage, alignment: MessageBubbleAlignment, additionalConfigurations?: Object | undefined): JSX.Element | Element;
     getImageMessageContentView(message: CometChat.MediaMessage, alignment: MessageBubbleAlignment): JSX.Element | Element;
@@ -2654,7 +2654,7 @@ declare class LinkPreviewExtensionDecorator extends DataSourceDecorator {
      * @param {any} [additionalConfigurations] - Additional configurations for formatting.
      * @returns {JSX.Element} The JSX element representing the message content view.
      */
-    getTextMessageContentView(message: CometChat.TextMessage, alignment: MessageBubbleAlignment, additionalConfigurations?: any): JSX.Element | Element;
+    getTextMessageContentView(message: CometChat.TextMessage, alignment: MessageBubbleAlignment, additionalConfigurations?: any): react_jsx_runtime.JSX.Element | Element;
     /**
      * Retrieves the style for the link preview wrapper.
      * @returns {object} The style object for the link preview wrapper.
@@ -2748,7 +2748,7 @@ declare class MessageTranslationExtensionDecorator extends DataSourceDecorator {
      * @param {any} [additionalConfigurations] - Optional additional configurations for the content view.
      * @returns {JSX.Element} The content view for the text message.
      */
-    getTextMessageContentView(message: CometChat.TextMessage, alignment: MessageBubbleAlignment, additionalConfigurations?: any): JSX.Element | Element;
+    getTextMessageContentView(message: CometChat.TextMessage, alignment: MessageBubbleAlignment, additionalConfigurations?: any): react_jsx_runtime.JSX.Element | Element;
     /**
      * Checks if an option with the specified ID already exists in the options list.
      *
@@ -4449,6 +4449,19 @@ interface MessageInformationProps {
      * Format for the timestamp displayed next to messages.
      */
     messageSentAtDateTimeFormat?: CalendarObject;
+    /**
+     * Template for customizing the appearance of the message.
+     */
+    template?: CometChatMessageTemplate;
+    /**
+    * Hides the visibility of receipt in the Message Information.
+    * @default false
+    */
+    hideReceipts?: boolean;
+    /**
+    * Array of text formatters for custom styling or formatting of message text bubbles.
+    */
+    textFormatters?: CometChatTextFormatter[];
 }
 declare const CometChatMessageInformation: (props: MessageInformationProps) => react_jsx_runtime.JSX.Element;
 
@@ -4641,12 +4654,14 @@ interface IOpenChat {
 }
 interface IShowOngoingCall {
     child: any;
+    message?: CometChat.CustomMessage;
 }
 interface IPanel {
     child?: any;
     configuration?: any;
     message?: CometChat.BaseMessage;
     position?: PanelAlignment;
+    composerId?: ComposerId;
 }
 interface IModal {
     child?: any;
@@ -5051,6 +5066,7 @@ interface PopoverProps {
     disableBackgroundInteraction?: boolean;
     useParentContainer?: boolean;
     useParentHeight?: boolean;
+    showTooltip?: boolean;
 }
 declare const CometChatPopover: React.ForwardRefExoticComponent<PopoverProps & React.RefAttributes<{
     openPopover: () => void;
@@ -5342,37 +5358,9 @@ declare class MessageReceiptUtils {
      * the corresponding receipt icon.
      *
      * @param {CometChat.BaseMessage} messageObject - The message object for which to get the receipt status.
-     * @returns {receipts} - The receipt status icon.
-     */
-    static getReceiptStatus: (messageObject: CometChat.BaseMessage) => receipts;
-}
-/**
- * Enum representing different receipt statuses for a message.
- *
- * @readonly
- * @enum {number}
- */
-declare enum receipts {
-    /**
-     * Status indicating that the message is waiting to be processed.
-     */
-    wait = 0,
-    /**
-     * Status indicating that the message has been sent.
-     */
-    sent = 1,
-    /**
-     * Status indicating that the message has been delivered.
-     */
-    delivered = 2,
-    /**
-     * Status indicating that the message has been read.
-     */
-    read = 3,
-    /**
-     * Status indicating that an error occurred with the message.
+     * @returns {Receipts} - The receipt status icon.
      */
-    error = 4
+    static getReceiptStatus: (messageObject: CometChat.BaseMessage) => Receipts;
 }
 
 /**
@@ -5387,7 +5375,7 @@ declare class MessageUtils {
      * @param {CometChatMessageTemplate} template - The message template to use for rendering the content view.
      * @returns {object | null} - The content view for the message, or null if not found.
      */
-    getContentView(message: CometChat.BaseMessage, template: CometChatMessageTemplate, alignment?: MessageBubbleAlignment): any;
+    getContentView(message: CometChat.BaseMessage, template: CometChatMessageTemplate, alignment?: MessageBubbleAlignment, textFormatters?: CometChatTextFormatter[]): any;
     /**
      * Retrieves the content view for a message based on the provided template.
      *
@@ -5395,7 +5383,7 @@ declare class MessageUtils {
      * @param {CometChatMessageTemplate} template - The message template to use for rendering the content view.
      * @returns {object | null} - The content view for the message, or null if not found.
      */
-    getStatusInfoView(message: CometChat.BaseMessage, template: CometChatMessageTemplate, alignment?: MessageBubbleAlignment, messageSentAtDateTimeFormat?: CalendarObject): any;
+    getStatusInfoView(message: CometChat.BaseMessage, template: CometChatMessageTemplate, alignment?: MessageBubbleAlignment, messageSentAtDateTimeFormat?: CalendarObject, hideReceipts?: boolean): any;
     /**
      * Retrieves the bubble wrapper for a message based on the provided template.
      *
@@ -5413,7 +5401,7 @@ declare class MessageUtils {
      * @param {MessageBubbleAlignment} alignment - The alignment of the message bubble (left or right).
      * @returns {JSX.Element} - The message bubble component.
      */
-    getMessageBubble(baseMessage: CometChat.BaseMessage, template: CometChatMessageTemplate, alignment: MessageBubbleAlignment, messageSentAtDateTimeFormat?: CalendarObject): any;
+    getMessageBubble(baseMessage: CometChat.BaseMessage, template: CometChatMessageTemplate, alignment: MessageBubbleAlignment, messageSentAtDateTimeFormat?: CalendarObject, hideReceipts?: boolean, textFormatters?: CometChatTextFormatter[]): any;
     /**
      *
      * @param {(CometChat.User | CometChat.GroupMember | any)} user
@@ -5810,12 +5798,16 @@ declare function sanitizeCalendarObject(calendarObject?: CalendarObject): {
     [k: string]: any;
 };
 declare function fireClickEvent(): void;
+declare const decodeHTML: (input: string) => string;
 
 /**
  * Utility class for managing local storage with change detection capabilities.
  * It is used in CometChatIncomingCall component.
  */
 declare class StorageUtils {
+    private static isWindowListenerAttached;
+    private static storageKeyToRemove;
+    private static handleBeforeUnload;
     /**
      * Attaches a callback function to the `storage` event, which is triggered when storage changes occur.
      * @param {EventListenerOrEventListenerObject} callback - The function to be called when the storage event is fired. This function will receive the storage event as an argument.
@@ -5891,6 +5883,15 @@ interface CometChatThreadHeaderProps {
    * Format for the timestamp displayed next to messages.
    */
     messageSentAtDateTimeFormat?: CalendarObject;
+    /**
+    * Hides the visibility of receipt in the Thread Header.
+    * @default false
+     */
+    hideReceipts?: boolean;
+    /**
+    * Array of text formatters for custom styling or formatting of message text bubbles.
+    */
+    textFormatters?: CometChatTextFormatter[];
 }
 declare const CometChatThreadHeader: (props: CometChatThreadHeaderProps) => react_jsx_runtime.JSX.Element;
 
@@ -6034,5 +6035,5 @@ declare function useRefSync<T>(value: T): React__default.MutableRefObject<T>;
 declare function useStateRef<T>(initialValue: T): [T, (node: T) => void];
 declare function useCometChatErrorHandler(onError?: ((error: CometChat.CometChatException) => void) | null): (error: unknown, source?: string) => void;
 
-export { AuxiliaryButtonAlignment, ButtonAction, CalendarObject, CallButtonConfiguration, CallWorkflow, CallingConfiguration, CallingDetailsUtils, CallingExtension, CallingExtensionDecorator, ChatConfigurator, ChatSdkEventInitializer, CollaborativeDocumentConfiguration, CollaborativeDocumentExtension, CollaborativeDocumentExtensionDecorator, CollaborativeWhiteBoardExtensionDecorator, CollaborativeWhiteboardConfiguration, CollaborativeWhiteboardExtension, CometChatActionBubble, CometChatActionSheet, CometChatActions, CometChatActionsIcon, CometChatActionsView, CometChatAudioBubble, CometChatAvatar, CometChatButton, CometChatCallBubble, CometChatCallButtons, CometChatCallEvents, CometChatCallLogs, CometChatChangeScope, CometChatCheckbox, CometChatConfirmDialog, CometChatContextMenu, CometChatConversationEvents, CometChatConversations, CometChatDate, CometChatDeleteBubble, CometChatDocumentBubble, CometChatDropDown, CometChatEditPreview, CometChatEmojiKeyboard, CometChatFileBubble, CometChatFullScreenViewer, CometChatGroupEvents, CometChatGroupMembers, CometChatGroups, CometChatImageBubble, CometChatIncomingCall, CometChatList, CometChatListItem, CometChatLocalize, CometChatMediaRecorder, CometChatMentionsFormatter, CometChatMessageBubble, CometChatMessageComposer, CometChatMessageComposerAction, CometChatMessageEvents, CometChatMessageHeader, CometChatMessageInformation, CometChatMessageList, CometChatMessageOption, CometChatMessageTemplate, CometChatOngoingCall, CometChatOption, CometChatOutgoingCall, CometChatPopover, CometChatRadioButton, CometChatReactionInfo, CometChatReactionList, CometChatReactions, CometChatSearchBar, CometChatTextBubble, CometChatTextFormatter, CometChatThreadHeader, CometChatToast, CometChatUIEvents, CometChatUIKit, CometChatUIKitCalls, CometChatUIKitConstants, CometChatUIKitLoginListener, CometChatUIKitUtility, CometChatUrlsFormatter, CometChatUserEvents, CometChatUserMemberWrapper, CometChatUsers, CometChatUtilityConstants, CometChatVideoBubble, ConversationUtils, DataSource, DataSourceDecorator, DateTimePickerMode, DocumentIconAlignment, ElementType, EnterKeyBehavior, ExtensionsDataSource, GroupMemberUtils, HTTPSRequestMethods, IconButtonAlignment, LabelAlignment, LinkPreviewExtension, LinkPreviewExtensionDecorator, MentionsTargetElement, MentionsVisibility, MessageBubbleAlignment, MessageListAlignment, MessageReceiptUtils, MessageStatus, MessageTranslationExtension, MessageTranslationExtensionDecorator, MessageUtils, MessagesDataSource, MouseEventSource, OutgoingCallConfiguration, PanelAlignment, Placement$1 as Placement, PollsConfiguration, PollsExtension, PollsExtensionDecorator, PreviewMessageMode, Receipts, RecordingType, SelectionMode, States, StickersExtension, StickersExtensionDecorator, StorageUtils, TabAlignment, TabsVisibility, ThumbnailGenerationExtension, ThumbnailGenerationExtensionDecorator, TimestampAlignment, TitleAlignment, UIKitSettings, UIKitSettingsBuilder, UserMemberListType, closeCurrentMediaPlayer, convertMinutesToHoursMinutesSeconds, convertSecondsToHoursMinutesSeconds, currentAudioPlayer, currentMediaPlayer, downloadRecordingFromURL, fireClickEvent, formatDateFromTimestamp, getLocalizedString, getThemeMode, getThemeVariable, isMessageSentByMe, isMissedCall, isMobileDevice, isSafari, isSentByMe, isURL, processFileForAudio, sanitizeCalendarObject, sanitizeHtml, useCometChatErrorHandler, useRefSync, useStateRef, verifyCallUser };
+export { AuxiliaryButtonAlignment, ButtonAction, CalendarObject, CallButtonConfiguration, CallWorkflow, CallingConfiguration, CallingDetailsUtils, CallingExtension, CallingExtensionDecorator, ChatConfigurator, ChatSdkEventInitializer, CollaborativeDocumentConfiguration, CollaborativeDocumentExtension, CollaborativeDocumentExtensionDecorator, CollaborativeWhiteBoardExtensionDecorator, CollaborativeWhiteboardConfiguration, CollaborativeWhiteboardExtension, CometChatActionBubble, CometChatActionSheet, CometChatActions, CometChatActionsIcon, CometChatActionsView, CometChatAudioBubble, CometChatAvatar, CometChatButton, CometChatCallBubble, CometChatCallButtons, CometChatCallEvents, CometChatCallLogs, CometChatChangeScope, CometChatCheckbox, CometChatConfirmDialog, CometChatContextMenu, CometChatConversationEvents, CometChatConversations, CometChatDate, CometChatDeleteBubble, CometChatDocumentBubble, CometChatDropDown, CometChatEditPreview, CometChatEmojiKeyboard, CometChatFileBubble, CometChatFullScreenViewer, CometChatGroupEvents, CometChatGroupMembers, CometChatGroups, CometChatImageBubble, CometChatIncomingCall, CometChatList, CometChatListItem, CometChatLocalize, CometChatMediaRecorder, CometChatMentionsFormatter, CometChatMessageBubble, CometChatMessageComposer, CometChatMessageComposerAction, CometChatMessageEvents, CometChatMessageHeader, CometChatMessageInformation, CometChatMessageList, CometChatMessageOption, CometChatMessageTemplate, CometChatOngoingCall, CometChatOption, CometChatOutgoingCall, CometChatPopover, CometChatRadioButton, CometChatReactionInfo, CometChatReactionList, CometChatReactions, CometChatSearchBar, CometChatTextBubble, CometChatTextFormatter, CometChatThreadHeader, CometChatToast, CometChatUIEvents, CometChatUIKit, CometChatUIKitCalls, CometChatUIKitConstants, CometChatUIKitLoginListener, CometChatUIKitUtility, CometChatUrlsFormatter, CometChatUserEvents, CometChatUserMemberWrapper, CometChatUsers, CometChatUtilityConstants, CometChatVideoBubble, ConversationUtils, DataSource, DataSourceDecorator, DateTimePickerMode, DocumentIconAlignment, ElementType, EnterKeyBehavior, ExtensionsDataSource, GroupMemberUtils, HTTPSRequestMethods, IconButtonAlignment, LabelAlignment, LinkPreviewExtension, LinkPreviewExtensionDecorator, MentionsTargetElement, MentionsVisibility, MessageBubbleAlignment, MessageListAlignment, MessageReceiptUtils, MessageStatus, MessageTranslationExtension, MessageTranslationExtensionDecorator, MessageUtils, MessagesDataSource, MouseEventSource, OutgoingCallConfiguration, PanelAlignment, Placement$1 as Placement, PollsConfiguration, PollsExtension, PollsExtensionDecorator, PreviewMessageMode, Receipts, RecordingType, SelectionMode, States, StickersExtension, StickersExtensionDecorator, StorageUtils, TabAlignment, TabsVisibility, ThumbnailGenerationExtension, ThumbnailGenerationExtensionDecorator, TimestampAlignment, TitleAlignment, UIKitSettings, UIKitSettingsBuilder, UserMemberListType, closeCurrentMediaPlayer, convertMinutesToHoursMinutesSeconds, convertSecondsToHoursMinutesSeconds, currentAudioPlayer, currentMediaPlayer, decodeHTML, downloadRecordingFromURL, fireClickEvent, formatDateFromTimestamp, getLocalizedString, getThemeMode, getThemeVariable, isMessageSentByMe, isMissedCall, isMobileDevice, isSafari, isSentByMe, isURL, processFileForAudio, sanitizeCalendarObject, sanitizeHtml, useCometChatErrorHandler, useRefSync, useStateRef, verifyCallUser };
 export type { IActiveChatChanged, IDialog, IGroupLeft, IGroupMemberAdded, IGroupMemberJoined, IGroupMemberKickedBanned, IGroupMemberScopeChanged, IGroupMemberUnBanned, IMentionsCountWarning, IMessages, IModal, IMouseEvent, IOpenChat, IOwnershipChanged, IPanel, IShowOngoingCall, LocalizationSettings, PollOptions };