@cometchat/chat-uikit-react 6.3.4 → 6.3.6

package/dist/assets/file_unsupported.svg

@@ -0,0 +1,3 @@
+<svg width="22" height="27" viewBox="0 0 22 27" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M21.5996 6.66895V24.5361C21.5995 25.7142 20.6449 26.6689 19.4668 26.6689H2.13379C0.955654 26.6689 0.000105137 25.7142 0 24.5361V2.13574C0.000106552 0.957623 0.955645 0.00292969 2.13379 0.00292969H14.9336L21.5996 6.66895ZM10.1338 19V20.333H11.4668V19H10.1338ZM10.8672 9.66699C10.4005 9.66699 9.99961 9.73291 9.59961 9.86621C9.13322 9.9996 8.79999 10.2 8.4668 10.5332C8.1335 10.7999 7.8667 11.1335 7.7334 11.4668C7.60002 11.8002 7.4668 12.3334 7.4668 13H8.7998C8.79982 11.6667 9.46671 10.7335 10.7998 10.7334C11.3998 10.7334 11.8669 10.9333 12.2002 11.2666C12.5336 11.6 12.7334 11.9337 12.7334 12.4004C12.7333 12.8668 12.6001 13.2004 12.4668 13.4004C12.3334 13.6004 11.9996 13.9339 11.5332 14.4004C11.0667 14.8668 10.8669 15.2003 10.667 15.4668C10.4671 15.7334 10.3333 15.9998 10.2666 16.333C10.1999 16.6663 10.1338 17.0004 10.1338 17.667H11.4668C11.4668 17.0004 11.3998 16.7999 11.5332 16.5332C11.6665 16.2665 11.7336 15.9998 11.9336 15.7998C12.1335 15.5998 12.334 15.2663 12.8672 14.7998C13.4003 14.3332 13.7339 13.9328 13.8672 13.5996C14.0004 13.2664 14.1338 12.933 14.1338 12.5332C14.1338 11.6666 13.8001 11.0001 13.2002 10.4668C12.5337 9.93357 11.8003 9.66707 10.8672 9.66699Z" fill="#CCCCCC"/>
+</svg>

package/dist/assets/warning_neutral.svg

@@ -0,0 +1,3 @@
+<svg width="24" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path d="M11.9982 16.918C12.2447 16.918 12.4485 16.8384 12.6095 16.6792C12.7706 16.5201 12.8512 16.3172 12.8512 16.0707C12.8512 15.8244 12.7716 15.6206 12.6125 15.4595C12.4533 15.2985 12.2506 15.218 12.0042 15.218C11.7577 15.218 11.554 15.2976 11.393 15.4567C11.2318 15.6159 11.1512 15.8186 11.1512 16.065C11.1512 16.3113 11.2308 16.5151 11.39 16.6762C11.5491 16.8374 11.7519 16.918 11.9982 16.918ZM12.0625 13.118C12.2828 13.118 12.4693 13.0409 12.622 12.8867C12.7748 12.7326 12.8512 12.5443 12.8512 12.322V7.75547C12.8512 7.53964 12.7736 7.35439 12.6185 7.19972C12.4633 7.04522 12.2774 6.96797 12.0607 6.96797C11.8377 6.96797 11.6498 7.04522 11.497 7.19972C11.3443 7.35439 11.268 7.53964 11.268 7.75547V12.322C11.268 12.5443 11.3453 12.7326 11.5 12.8867C11.6546 13.0409 11.8421 13.118 12.0625 13.118ZM12.0067 21.8345C10.6494 21.8345 9.37347 21.5754 8.17897 21.0572C6.98447 20.5389 5.94305 19.8347 5.05472 18.9447C4.16622 18.0546 3.46297 17.0128 2.94497 15.8195C2.42697 14.626 2.16797 13.3508 2.16797 11.994C2.16797 10.6356 2.42705 9.35889 2.94522 8.16372C3.46355 6.96839 4.16772 5.92789 5.05772 5.04222C5.94789 4.15655 6.98964 3.45605 8.18297 2.94072C9.37647 2.42555 10.6516 2.16797 12.0085 2.16797C13.3668 2.16797 14.6436 2.42639 15.839 2.94322C17.0343 3.45989 18.0748 4.16122 18.9605 5.04722C19.846 5.93322 20.5464 6.9738 21.0617 8.16897C21.5769 9.36414 21.8345 10.6397 21.8345 11.9957C21.8345 13.3531 21.5767 14.629 21.0612 15.8235C20.5457 17.018 19.8444 18.0584 18.9572 18.9447C18.0699 19.8311 17.0286 20.5343 15.8335 21.0545C14.6383 21.5745 13.3627 21.8345 12.0067 21.8345ZM12.009 20.2512C14.2955 20.2512 16.2408 19.4466 17.845 17.8372C19.4491 16.2279 20.2512 14.28 20.2512 11.9935C20.2512 9.70697 19.4504 7.76164 17.8487 6.15747C16.2469 4.5533 14.2979 3.75122 12.0017 3.75122C9.72089 3.75122 7.77555 4.55205 6.16572 6.15372C4.55605 7.75555 3.75122 9.70455 3.75122 12.0007C3.75122 14.2816 4.55589 16.2269 6.16522 17.8367C7.77455 19.4464 9.72247 20.2512 12.009 20.2512Z" fill="#A1A1A1"/>
+</svg>

package/dist/index.d.ts

@@ -338,7 +338,7 @@ interface MentionsProps {
      * @param user - The clicked user (CometChat.User) or group member (CometChat.GroupMember)
      * @returns void
      */
-    onItemClick?: (user: CometChat.User | CometChat.GroupMember) => void;
+    onItemClick?: (user: CometChat.User | CometChat.GroupMember | null) => void;
     /**
      * A custom view to render each user or group member item in the list.
      *
@@ -386,6 +386,20 @@ interface MentionsProps {
      * @defaultValue `false`
      */
     showScrollbar?: boolean;
+    /**
+     * Disables the mentions functionality in the message composer.
+     * @defaultValue `false`
+     */
+    disableMentions?: boolean;
+    /**
+     * Boolean to show or hide '@all' mention option in the mentions list.
+     * @defaultValue `false`
+     */
+    disableMentionAll?: boolean;
+    /** The mentionAll label for the app used to render "@all" mentions
+     * @defaultValue "all"
+    */
+    mentionAllLabel?: string;
 }
 declare function CometChatUserMemberWrapper(props: MentionsProps): react_jsx_runtime.JSX.Element;
 
@@ -1415,6 +1429,7 @@ interface additionalParamsOptions {
     hideMessagePrivatelyOption?: boolean;
     hideCopyMessageOption?: boolean;
     hideMessageInfoOption?: boolean;
+    hideFlagMessageOption?: boolean;
 }
 declare class MessagesDataSource implements DataSource {
     getEditOption(): CometChatActionsIcon;
@@ -1425,6 +1440,7 @@ declare class MessagesDataSource implements DataSource {
     getSendMessagePrivatelyOption(): CometChatActionsIcon;
     getCopyOption(): CometChatActionsIcon;
     getMessageInfoOption(): CometChatActionsIcon;
+    getReportOption(): CometChatActionsIcon;
     isSentByMe(loggedInUser: CometChat.User, message: CometChat.BaseMessage): boolean;
     getTextMessageOptions(loggedInUser: CometChat.User, messageObject: CometChat.BaseMessage, group?: CometChat.Group, additionalParams?: additionalParamsOptions): Array<CometChatActionsIcon | CometChatActionsView>;
     getIsSentByMe(message: CometChat.BaseMessage): boolean;
@@ -1729,9 +1745,10 @@ declare abstract class CometChatTextFormatter {
      * @param {string|null} inputText - The text to format.
      * @return {string|void} - The original or formatted input text, or void if editing was done based on cursor position.
      */
-    getFormattedText(inputText: string | null, params: {
+    getFormattedText(inputText: string, params: {
         mentionsTargetElement: MentionsTargetElement;
     }): string | void;
+    getFormattedTextForEntity(entity: any): void;
     /**
      * Sets the message object.
      *
@@ -1777,7 +1794,7 @@ declare abstract class CometChatTextFormatter {
      * @param {string|null} inputText - The text to apply regex match.
      * @return {string} - The replaced text.
      */
-    protected onRegexMatch(inputText?: string | null): string;
+    protected onRegexMatch(inputText?: string | null, entity?: any): string;
     /**
      * Debounce function.
      * @param {Function} func - The function to debounce.
@@ -1846,6 +1863,7 @@ declare class CometChatMentionsFormatter extends CometChatTextFormatter {
      * List of users for mentions.
      */
     private cometChatUserGroupMembers;
+    private mentionedChannels;
     /**
      * Mapping of CSS classes for mentions.
      */
@@ -1944,6 +1962,20 @@ declare class CometChatMentionsFormatter extends CometChatTextFormatter {
      */
     setCometChatUserGroupMembers(CometChatUserGroupMembers: Array<CometChat.User | CometChat.GroupMember>): void;
     resetCometChatUserGroupMembers(): void;
+    /**
+     * Retrieves the mentioned channels.
+     * @returns {string[]} - The current mentioned channels.
+     */
+    getCometChatMentionedChannels(): string[];
+    /**
+     * Sets the mentioned channels.
+     * @param {string[]} mentionAllLabels - The mentionAll labels to be set as mentioned channels.
+     */
+    setCometChatMentionedChannels(mentionAllLabels: string[]): void;
+    /**
+     * Resets the mentioned channels.
+     */
+    resetCometChatMentionedChannels(): void;
     /**
      * Sets the callback function for handling key down events.
      *
@@ -1968,12 +2000,13 @@ declare class CometChatMentionsFormatter extends CometChatTextFormatter {
     stopTracking(): void;
     /**
      * Formats the input text if provided, otherwise edits the text at the cursor position.
-     * @param {string|null} inputText - The input text to be formatted.
+     * @param {string} inputText - The input text to be formatted.
      * @returns {string|void} - The formatted input text, or void if inputText is not provided.
      */
-    getFormattedText(inputText: string | null, params?: {
+    getFormattedText(inputText: string, params?: {
         mentionsTargetElement: MentionsTargetElement;
     }): string | void;
+    getFormattedTextForEntity(entity: CometChat.User | CometChat.GroupMember | string): void;
     /**
      * This function adds the mention span to the input text.
      * @param {string} inputText - The input text where the span needs to be added.
@@ -2023,12 +2056,13 @@ declare class CometChatMentionsFormatter extends CometChatTextFormatter {
      */
     protected addAtCaretPosition(newHtml: string, currentCaretPosition: Selection, currentRange: Range): void;
     /**
-     * Matches the regex with the given inputText and replaces the matched text with respective spans
+     * Matches the regex with the given inputText and replaces the matched text with respective spans of the provided entity
      *
-     * @param {string | null} inputText - The text in which the regex patterns needs to be matched
+     * @param {string} inputText - The text in which the regex patterns needs to be matched
+     * @param {CometChat.User | CometChat.GroupMember | string} entity - The entity to be used for replacing the matched text
      * @return {string} - The text after replacing the matched text with spans
      */
-    onRegexMatch(inputText?: string | null): string;
+    onRegexMatch(inputText: string, entity: CometChat.User | CometChat.GroupMember | string): string;
     /**
      * Retrieves the original text after replacing mentions span with UIDs
      *
@@ -4229,6 +4263,15 @@ interface MessageComposerProps {
    * @defaultValue ""
    */
     placeholderText?: string;
+    /**
+     * Boolean to show or hide "@all" mention functionality in group chats.
+      * @defaultValue `false`
+    */
+    disableMentionAll?: boolean;
+    /** The mentionAll label for the app used to render "@all" mentions
+     * @defaultValue "all"
+    */
+    mentionAllLabel?: string;
     /**
      * Custom request builder for mentions user list.
      * @defaultValue `undefined` - Uses default internal request builder.
@@ -4598,6 +4641,16 @@ interface MessageListProps {
       * @defaultValue `false`
     */
     isAgentChat?: boolean;
+    /**
+     * hides the "Flag Message" option from message actions menu
+     * @defaultValue `false`
+     */
+    hideFlagMessageOption?: boolean;
+    /**
+     * hides the remark text area in the flag dialog
+     * @defaultValue `false`
+     */
+    hideFlagRemarkField?: boolean;
 }
 declare const CometChatMessageList: (props: MessageListProps) => react_jsx_runtime.JSX.Element;
 
@@ -4803,6 +4856,35 @@ interface MessageInformationProps {
 }
 declare const CometChatMessageInformation: (props: MessageInformationProps) => react_jsx_runtime.JSX.Element;
 
+interface CometChatFlagMessageDialogProps {
+    message: CometChat.BaseMessage;
+    /**
+     * Callback triggered when the dialog is closed.
+     * @returns void
+     */
+    onClose?: () => void;
+    /**
+     * Callback triggered when an error occurs when trying to flag a message.
+     * @param error - An instance of `CometChat.CometChatException` representing the error.
+     * @returns void
+     */
+    onError?: ((error: CometChat.CometChatException) => void) | null;
+    /**
+     * Callback triggered when the flag report is submitted.
+     * @param messageId - ID of the message being flagged.
+     * @param reasonId - ID of the reason for flagging the message.
+     * @param remark - Optional remark provided by the user.
+     * @returns A promise that resolves to a boolean indicating the success of the flagging operation.
+     */
+    onSubmit?: (messageId: string, reasonId: string, remark?: string) => Promise<boolean>;
+    /**
+     * Boolean to hide the remark input field.
+     * @defaultValue `false`
+     */
+    hideFlagRemarkField?: boolean;
+}
+declare const CometChatFlagMessageDialog: (props: CometChatFlagMessageDialogProps) => react_jsx_runtime.JSX.Element;
+
 declare class CometChatUIKitConstants {
     static MessageCategory: Readonly<{
         message: string;
@@ -4864,6 +4946,7 @@ declare class CometChatUIKitConstants {
         translateMessage: "translate";
         reactToMessage: "react";
         messageInformation: "messageInformation";
+        flagMessage: "flagMessage";
         copyMessage: "copy";
         shareMessage: "share";
         forwardMessage: "forward";
@@ -6912,5 +6995,5 @@ interface CometChatAIAssistantChatHistoryProps {
 }
 declare const CometChatAIAssistantChatHistory: (props: CometChatAIAssistantChatHistoryProps) => react_jsx_runtime.JSX.Element;
 
-export { AuxiliaryButtonAlignment, ButtonAction, CalendarObject, CallButtonConfiguration, CallWorkflow, CallingConfiguration, CallingDetailsUtils, CallingExtension, CallingExtensionDecorator, ChatConfigurator, ChatSdkEventInitializer, CollaborativeDocumentConfiguration, CollaborativeDocumentExtension, CollaborativeDocumentExtensionDecorator, CollaborativeWhiteBoardExtensionDecorator, CollaborativeWhiteboardConfiguration, CollaborativeWhiteboardExtension, CometChatAIAssistantChat, CometChatAIAssistantChatHistory, CometChatAIAssistantMessageBubble, CometChatAIAssistantTools, CometChatActionBubble, CometChatActionSheet, CometChatActions, CometChatActionsIcon, CometChatActionsView, CometChatAudioBubble, CometChatAvatar, CometChatButton, CometChatCallBubble, CometChatCallButtons, CometChatCallEvents, CometChatCallLogs, CometChatChangeScope, CometChatCheckbox, CometChatConfirmDialog, CometChatContextMenu, CometChatConversationEvents, CometChatConversations, CometChatDate, CometChatDeleteBubble, CometChatDocumentBubble, CometChatDropDown, CometChatEditPreview, CometChatEmojiKeyboard, CometChatErrorView, CometChatFileBubble, CometChatFrameProvider, CometChatFullScreenViewer, CometChatGroupEvents, CometChatGroupMembers, CometChatGroups, CometChatImageBubble, CometChatIncomingCall, CometChatList, CometChatListItem, CometChatLocalize, CometChatMediaRecorder, CometChatMentionsFormatter, CometChatMessageBubble, CometChatMessageComposer, CometChatMessageComposerAction, CometChatMessageEvents, CometChatMessageHeader, CometChatMessageInformation, CometChatMessageList, CometChatMessageOption, CometChatMessagePreview, CometChatMessageTemplate, CometChatOngoingCall, CometChatOption, CometChatOutgoingCall, CometChatPopover, CometChatRadioButton, CometChatReactionInfo, CometChatReactionList, CometChatReactions, CometChatSearch, CometChatSearchBar, CometChatSearchFilter, CometChatSearchScope, CometChatStreamMessageBubble, CometChatTextBubble, CometChatTextFormatter, CometChatTextHighlightFormatter, 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, createMessageCopy, createMessageCopyFromBaseMessage, currentAudioPlayer, currentMediaPlayer, decodeHTML, downloadRecordingFromURL, emitStreamingState, fireClickEvent, formatDateFromTimestamp, getAIAssistantTools, getCommonDateFormat, getLocalizedString, getStreamSpeed, getThemeMode, getThemeVariable, handleWebsocketMessage, hasLink, hasValidConversationSearchCriteria, hasValidMessageSearchCriteria, isDarkMode, isMessageSentByMe, isMissedCall, isMobileDevice, isMonthDifferent, isSafari, isSentByMe, isURL, messageStream, processFileForAudio, sanitizeCalendarObject, sanitizeHtmlStringToFragment, setAIAssistantTools, setStreamSpeed, shouldShowCustomMimeTypes, startStreamingMessage, stopStreamingMessage, streamingState$, useCometChatErrorHandler, useCometChatFrameContext, useDebouncedCallback, useRefSync, useStateRef, verifyCallUser };
+export { AuxiliaryButtonAlignment, ButtonAction, CalendarObject, CallButtonConfiguration, CallWorkflow, CallingConfiguration, CallingDetailsUtils, CallingExtension, CallingExtensionDecorator, ChatConfigurator, ChatSdkEventInitializer, CollaborativeDocumentConfiguration, CollaborativeDocumentExtension, CollaborativeDocumentExtensionDecorator, CollaborativeWhiteBoardExtensionDecorator, CollaborativeWhiteboardConfiguration, CollaborativeWhiteboardExtension, CometChatAIAssistantChat, CometChatAIAssistantChatHistory, CometChatAIAssistantMessageBubble, CometChatAIAssistantTools, CometChatActionBubble, CometChatActionSheet, CometChatActions, CometChatActionsIcon, CometChatActionsView, CometChatAudioBubble, CometChatAvatar, CometChatButton, CometChatCallBubble, CometChatCallButtons, CometChatCallEvents, CometChatCallLogs, CometChatChangeScope, CometChatCheckbox, CometChatConfirmDialog, CometChatContextMenu, CometChatConversationEvents, CometChatConversations, CometChatDate, CometChatDeleteBubble, CometChatDocumentBubble, CometChatDropDown, CometChatEditPreview, CometChatEmojiKeyboard, CometChatErrorView, CometChatFileBubble, CometChatFlagMessageDialog, CometChatFrameProvider, CometChatFullScreenViewer, CometChatGroupEvents, CometChatGroupMembers, CometChatGroups, CometChatImageBubble, CometChatIncomingCall, CometChatList, CometChatListItem, CometChatLocalize, CometChatMediaRecorder, CometChatMentionsFormatter, CometChatMessageBubble, CometChatMessageComposer, CometChatMessageComposerAction, CometChatMessageEvents, CometChatMessageHeader, CometChatMessageInformation, CometChatMessageList, CometChatMessageOption, CometChatMessagePreview, CometChatMessageTemplate, CometChatOngoingCall, CometChatOption, CometChatOutgoingCall, CometChatPopover, CometChatRadioButton, CometChatReactionInfo, CometChatReactionList, CometChatReactions, CometChatSearch, CometChatSearchBar, CometChatSearchFilter, CometChatSearchScope, CometChatStreamMessageBubble, CometChatTextBubble, CometChatTextFormatter, CometChatTextHighlightFormatter, 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, createMessageCopy, createMessageCopyFromBaseMessage, currentAudioPlayer, currentMediaPlayer, decodeHTML, downloadRecordingFromURL, emitStreamingState, fireClickEvent, formatDateFromTimestamp, getAIAssistantTools, getCommonDateFormat, getLocalizedString, getStreamSpeed, getThemeMode, getThemeVariable, handleWebsocketMessage, hasLink, hasValidConversationSearchCriteria, hasValidMessageSearchCriteria, isDarkMode, isMessageSentByMe, isMissedCall, isMobileDevice, isMonthDifferent, isSafari, isSentByMe, isURL, messageStream, processFileForAudio, sanitizeCalendarObject, sanitizeHtmlStringToFragment, setAIAssistantTools, setStreamSpeed, shouldShowCustomMimeTypes, startStreamingMessage, stopStreamingMessage, streamingState$, useCometChatErrorHandler, useCometChatFrameContext, useDebouncedCallback, useRefSync, useStateRef, verifyCallUser };
 export type { IActiveChatChanged, IDialog, IGroupLeft, IGroupMemberAdded, IGroupMemberJoined, IGroupMemberKickedBanned, IGroupMemberScopeChanged, IGroupMemberUnBanned, IMentionsCountWarning, IMessages, IModal, IMouseEvent, IOpenChat, IOwnershipChanged, IPanel, IShowOngoingCall, IStreamData, LocalizationSettings, PollOptions };