@cometchat/chat-uikit-react 6.3.4 → 6.3.6

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

@@ -0,0 +1,29 @@
+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) => import("react/jsx-runtime").JSX.Element;
+export { CometChatFlagMessageDialog };

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

@@ -159,6 +159,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.

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

@@ -11,7 +11,6 @@ type Args = {
     pasteHtmlAtCaret: (text: string) => void;
     renderSanitizedHtml: (text: string) => void;
     textFormatters: Array<CometChatTextFormatter>;
-    disableMentions: boolean;
     textFormatterArray: Array<CometChatTextFormatter>;
     mentionsTextFormatterInstanceRef: React.MutableRefObject<CometChatMentionsFormatter>;
     setTextFormatters: React.Dispatch<React.SetStateAction<CometChatTextFormatter[]>>;

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

@@ -240,6 +240,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) => import("react/jsx-runtime").JSX.Element;
 export { CometChatMessageList };

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

@@ -11,7 +11,7 @@ export 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.
      *
@@ -59,5 +59,19 @@ export 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;
 }
 export declare function CometChatUserMemberWrapper(props: MentionsProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/constants/CometChatUIKitConstants.d.ts

@@ -59,6 +59,7 @@ export declare class CometChatUIKitConstants {
         translateMessage: "translate";
         reactToMessage: "react";
         messageInformation: "messageInformation";
+        flagMessage: "flagMessage";
         copyMessage: "copy";
         shareMessage: "share";
         forwardMessage: "forward";

package/dist/types/formatters/CometChatFormatters/CometChatMentionsFormatter/CometChatMentionsFormatter.d.ts

@@ -15,6 +15,7 @@ export declare class CometChatMentionsFormatter extends CometChatTextFormatter {
      * List of users for mentions.
      */
     private cometChatUserGroupMembers;
+    private mentionedChannels;
     /**
      * Mapping of CSS classes for mentions.
      */
@@ -113,6 +114,20 @@ export 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.
      *
@@ -137,12 +152,13 @@ export 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.
@@ -192,12 +208,13 @@ export 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
      *

package/dist/types/formatters/CometChatFormatters/CometChatTextFormatter.d.ts

@@ -165,9 +165,10 @@ export 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.
      *
@@ -213,7 +214,7 @@ export 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.

package/dist/types/index.d.ts

@@ -41,6 +41,7 @@ export { CometChatMessageHeader } from './components/CometChatMessageHeader/Come
 export { CometChatMessageList } from './components/CometChatMessageList/CometChatMessageList';
 export { CometChatUsers } from './components/CometChatUsers/CometChatUsers';
 export { CometChatMessageInformation } from './components/CometChatMessageInformation/CometChatMessageInformation';
+export { CometChatFlagMessageDialog } from './components/CometChatFlagMessageDialog/CometChatFlagMessageDialog';
 export { CometChatUIKitCalls } from './CometChatUIKit/CometChatCalls';
 export { CometChatUIKitConstants } from "./constants/CometChatUIKitConstants";
 export { CometChatUtilityConstants } from "./constants/CometChatUtilityConstants";

package/dist/types/utils/MessagesDataSource.d.ts

@@ -26,6 +26,7 @@ export interface additionalParamsOptions {
     hideMessagePrivatelyOption?: boolean;
     hideCopyMessageOption?: boolean;
     hideMessageInfoOption?: boolean;
+    hideFlagMessageOption?: boolean;
 }
 export declare class MessagesDataSource implements DataSource {
     getEditOption(): CometChatActionsIcon;
@@ -36,6 +37,7 @@ export 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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cometchat/chat-uikit-react",
-  "version": "6.3.4",
+  "version": "6.3.6",
   "description": "Ready-to-use Chat UI Components for React(Javascript/Web)",
   "author": "CometChat",
   "exports": {
@@ -8,7 +8,7 @@
     "./css-variables.css": "./dist/styles/css-variables.css"
   },
   "dependencies": {
-    "@cometchat/chat-sdk-javascript": "^4.1.3",
+    "@cometchat/chat-sdk-javascript": "^4.1.5",
     "@rollup/plugin-json": "^6.1.0",
     "rxjs": "^7.8.1",
     "react-markdown": "^10.1.0",