@cometchat/chat-uikit-react 5.0.2 → 5.0.3

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import * as React from 'react';
 import React__default, { JSX as JSX$1, ReactNode, FC } from 'react';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as _cometchat_chat_sdk_javascript from '@cometchat/chat-sdk-javascript';
+import { CometChat as CometChat$1 } from '@cometchat/chat-sdk-javascript';
 import { Subject } from 'rxjs';
 
 /**
@@ -909,6 +910,10 @@ declare class CometChatLocalize {
             ADD_MEMBERS: string;
             SEND_MESSAGE: string;
             UNBLOCK_USER: string;
+            /**
+             * Returns rtl or ltr based on the active language
+             * @returns {String} the direction of the active langauge
+             */
             BLOCK_USER: string;
             DELETE_AND_EXIT: string;
             LEAVE_GROUP: string;
@@ -1285,7 +1290,11 @@ declare class CometChatLocalize {
             TYPING: string;
             IS_TYPING: string;
             CLOSE: string;
-            ENTER_GROUP_NAME: string;
+            ENTER_GROUP_NAME: string; /**
+             * Accepts the string to localize and return the localized string
+             * @param {String} str
+             * @returns {String} localized str
+             */
             ADD_MEMBERS: string;
             SEND_MESSAGE: string;
             UNBLOCK_USER: string;
@@ -1990,7 +1999,7 @@ declare class CometChatLocalize {
             SEARCH_EMOJI: string;
             WOULD__YOU_LIKE_TO_DELETE_THIS_CONVERSATION: string;
             GROUPS: string;
-            WRONG_FILE_TYPE: string;
+            WRONG_FILE_TYPE: string; /**Properties and constants */
             SHARED: string;
             SOUND_MANAGER: string;
             THEME: string;
@@ -2057,7 +2066,9 @@ declare class CometChatLocalize {
             MISSED_VIDEO_CALL: string;
             CUSTOM_MESSAGE_POLL: string;
             CUSTOM_MESSAGE_STICKER: string;
-            CUSTOM_MESSAGE_DOCUMENT: string;
+            CUSTOM_MESSAGE_DOCUMENT: string; /**
+             * Sets the default lannguage if no language is passed in init method
+             */
             CUSTOM_MESSAGE_WHITEBOARD: string;
             ONLINE: string;
             ADMINISTRATOR: string;
@@ -2466,7 +2477,9 @@ declare class CometChatLocalize {
             MEMBER: string;
             EDITED: string;
             TODAY: string;
-            YESTERDAY: string;
+            YESTERDAY: string; /**
+             * Sets the default lannguage if no language is passed in init method
+             */
             SUNDAY: string;
             MONDAY: string;
             TUESDAY: string;
@@ -2778,6 +2791,7 @@ declare class CometChatLocalize {
             GROUPS: string;
             WRONG_FILE_TYPE: string;
             SHARED: string;
+            /**Properties and constants */
             SOUND_MANAGER: string;
             THEME: string;
             DELETE_MSG_TEXT: string;
@@ -2806,7 +2820,7 @@ declare class CometChatLocalize {
             PASSWORD: string;
             CONTINUE: string;
             NO_CHATS_SELECTED: string;
-            NO_USERS_SELECTED: string;
+            NO_USERS_SELECTED: string; /**Override resources */
             NO_GROUPS_SELECTED: string;
             SELECT_DAY: string;
             SELECT_TIME: string;
@@ -2816,7 +2830,10 @@ declare class CometChatLocalize {
             GROUP_PASSWORD_BLANK: string;
             GROUP_NAME_BLANK: string;
             GROUP_TYPE_BLANK: string;
-            DELETE_CONVERSATION: string;
+            DELETE_CONVERSATION: string; /**
+             * Returns the browser language
+             * @returns {String} browser langauge i.e. en-US
+             */
             ADD_TO_CHAT: string;
             MORE: string;
             COPY: string;
@@ -2824,7 +2841,10 @@ declare class CometChatLocalize {
             MESSAGE_IMAGE: string;
             MESSAGE_FILE: string;
             MESSAGE_VIDEO: string;
-            MESSAGE_AUDIO: string;
+            MESSAGE_AUDIO: string; /**
+             * Returns the language code
+             * @returns {String} language code i.e. en
+             */
             CUSTOM_MESSAGE: string;
             SELECT_A_DATE: string;
             TIME_ZONE: string;
@@ -2885,6 +2905,10 @@ declare class CometChatLocalize {
             LOADING: string;
             REPLY: string;
             REPLIES: string;
+            /**
+             * Returns rtl or ltr based on the active language
+             * @returns {String} the direction of the active langauge
+             */
             AI: string;
             SMART_REPLIES: string;
             CONVERSATION_STARTER: string;
@@ -3991,10 +4015,20 @@ declare class CometChatLocalize {
             SELECT_TIME: string;
             NO_CALLS_SELECTED: string;
             SELECT__GROUP: string;
+            /**
+             * Initializes localization with the specified language and custom resources.
+             * @param {string} [language=""] - The language code to set.
+             * @param {object} [resources={}] - Custom translations to override defaults.
+             */
             SELECT__USER: string;
             GROUP_PASSWORD_BLANK: string;
             GROUP_NAME_BLANK: string;
             GROUP_TYPE_BLANK: string;
+            /**
+             * Initializes localization with the specified language and custom resources.
+             * @param {string} [language=""] - The language code to set.
+             * @param {object} [resources={}] - Custom translations to override defaults.
+             */
             DELETE_CONVERSATION: string;
             ADD_TO_CHAT: string;
             MORE: string;
@@ -4036,7 +4070,10 @@ declare class CometChatLocalize {
             PREFERENCES: string;
             MEMBERS: string;
             MEMBER: string;
-            EDITED: string;
+            EDITED: string; /**
+             * Returns the language code
+             * @returns {String} language code i.e. en
+             */
             TODAY: string;
             YESTERDAY: string;
             SUNDAY: string;
@@ -4403,7 +4440,7 @@ declare class CometChatLocalize {
             MEETING_SCHEDULED: string;
             SOMETHING_WRONG: string;
             MEETING_SLOT_BOOK: string;
-            MEETING_BOOK_NEW_SLOT: string;
+            MEETING_BOOK_NEW_SLOT: string; /**Override resources */
             MEETING_NO_SLOTS_AVAILABLE: string;
             MEETING_TRY_DIFFERENT_DATE: string;
             NO_TIME_SLOTS_AVAILABLE: string;
@@ -4760,7 +4797,11 @@ declare class CometChatLocalize {
             CONVERSATIONS: string;
             CONVERSATION_LIST: string;
             MESSAGES: string;
-            MESSAGE_HEADER: string;
+            MESSAGE_HEADER: string; /**
+             * Initializes localization with the specified language and custom resources.
+             * @param {string} [language=""] - The language code to set.
+             * @param {object} [resources={}] - Custom translations to override defaults.
+             */
             MESSAGE_LIST: string;
             MESSAGE_COMPOSER: string;
             USERS_WITH_MESSAGES: string;
@@ -4840,7 +4881,10 @@ declare class CometChatLocalize {
             SEND_MESSAGE: string;
             UNBLOCK_USER: string;
             BLOCK_USER: string;
-            DELETE_AND_EXIT: string;
+            DELETE_AND_EXIT: string; /**
+             * Returns true if the active language is rtl otherwise return false
+             * @returns {Boolean} whether the language is rtl or not
+             */
             LEAVE_GROUP: string;
             CREATE_GROUP: string;
             SHARED_MEDIA: string;
@@ -5187,7 +5231,10 @@ declare class CometChatLocalize {
             SELECT_A_DATE: string;
             TIME_ZONE: string;
             MEETING_SCHEDULED: string;
-            SOMETHING_WRONG: string;
+            SOMETHING_WRONG: string; /**
+             * Returns the active language. Return fallback language if translation is not available for the active language
+             * @returns {String} active language
+             */
             MEETING_SLOT_BOOK: string;
             MEETING_BOOK_NEW_SLOT: string;
             MEETING_NO_SLOTS_AVAILABLE: string;
@@ -6736,28 +6783,28 @@ declare class MessagesDataSource implements DataSource {
     getSendMessagePrivatelyOption(): CometChatActionsIcon;
     getCopyOption(): CometChatActionsIcon;
     getMessageInfoOption(): 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;
-    getImageMessageOptions(loggedInUser: CometChat.User, messageObject: CometChat.BaseMessage, group?: CometChat.Group, additionalParams?: Object | undefined): Array<CometChatActionsIcon | CometChatActionsView>;
-    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>;
+    isSentByMe(loggedInUser: CometChat$1.User, message: CometChat$1.BaseMessage): boolean;
+    getTextMessageOptions(loggedInUser: CometChat$1.User, messageObject: CometChat$1.BaseMessage, group?: CometChat$1.Group, additionalParams?: additionalParamsOptions): Array<CometChatActionsIcon | CometChatActionsView>;
+    getIsSentByMe(message: CometChat$1.BaseMessage): boolean;
+    getImageMessageOptions(loggedInUser: CometChat$1.User, messageObject: CometChat$1.BaseMessage, group?: CometChat$1.Group, additionalParams?: Object | undefined): Array<CometChatActionsIcon | CometChatActionsView>;
+    getVideoMessageOptions(loggedInUser: CometChat$1.User, messageObject: CometChat$1.BaseMessage, group?: CometChat$1.Group, additionalParams?: Object | undefined): Array<CometChatActionsIcon | CometChatActionsView>;
+    getAudioMessageOptions(loggedInUser: CometChat$1.User, messageObject: CometChat$1.BaseMessage, group?: CometChat$1.Group, additionalParams?: Object | undefined): Array<CometChatActionsIcon | CometChatActionsView>;
+    getFileMessageOptions(loggedInUser: CometChat$1.User, messageObject: CometChat$1.BaseMessage, group?: CometChat$1.Group, additionalParams?: Object | undefined): Array<CometChatActionsIcon | CometChatActionsView>;
     getReceiptClass(status?: number): "wait" | "error" | "read" | "delivered" | "sent" | undefined;
     /**
   * Function to get receipt for message bubble
   * @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.BaseMessage, hideReceipt?: boolean) => JSX.Element | null;
+    getBubbleStatusInfoReceipt: (item: CometChat$1.BaseMessage, hideReceipt?: boolean) => JSX.Element | null;
     /**
   * Function to get status and date for message bubble
   * @param {CometChat.BaseMessage} item - The message bubble for which the information needs to be fetched
   * @returns {JSX.Element | null} Returns JSX.Element for status and date of a message bubble or null
   */
-    getBubbleStatusInfoDate: (item: CometChat.BaseMessage, datePattern?: DatePatterns) => JSX.Element | null;
-    getStatusInfoView: (_messageObject: CometChat.BaseMessage, _alignment: MessageBubbleAlignment, hideReceipt?: boolean, datePattern?: DatePatterns) => react_jsx_runtime.JSX.Element | null;
-    getBottomView(_messageObject: CometChat.BaseMessage, _alignment: MessageBubbleAlignment): null;
+    getBubbleStatusInfoDate: (item: CometChat$1.BaseMessage, datePattern?: DatePatterns) => JSX.Element | null;
+    getStatusInfoView: (_messageObject: CometChat$1.BaseMessage, _alignment: MessageBubbleAlignment, hideReceipt?: boolean, datePattern?: DatePatterns) => react_jsx_runtime.JSX.Element | null;
+    getBottomView(_messageObject: CometChat$1.BaseMessage, _alignment: MessageBubbleAlignment): null;
     getTextMessageTemplate(additionalConfigurations?: additionalParams): CometChatMessageTemplate;
     getAudioMessageTemplate(): CometChatMessageTemplate;
     getVideoMessageTemplate(): CometChatMessageTemplate;
@@ -6768,25 +6815,25 @@ declare class MessagesDataSource implements DataSource {
     getFileMessageTemplate(): CometChatMessageTemplate;
     getAllMessageTemplates(additionalConfigurations?: additionalParams): Array<CometChatMessageTemplate>;
     getMessageTemplate(messageType: string, messageCategory: string, additionalConfigurations?: additionalParams): CometChatMessageTemplate | null;
-    getMessageOptions(loggedInUser: CometChat.User, messageObject: CometChat.BaseMessage, group?: CometChat.Group, additionalParams?: additionalParamsOptions): Array<CometChatActionsIcon | CometChatActionsView>;
-    getCommonOptions(loggedInUser: CometChat.User, messageObject: CometChat.BaseMessage, group?: CometChat.Group, additionalParams?: additionalParamsOptions): Array<CometChatActionsIcon | CometChatActionsView>;
+    getMessageOptions(loggedInUser: CometChat$1.User, messageObject: CometChat$1.BaseMessage, group?: CometChat$1.Group, additionalParams?: additionalParamsOptions): Array<CometChatActionsIcon | CometChatActionsView>;
+    getCommonOptions(loggedInUser: CometChat$1.User, messageObject: CometChat$1.BaseMessage, group?: CometChat$1.Group, additionalParams?: additionalParamsOptions): Array<CometChatActionsIcon | CometChatActionsView>;
     getAllMessageTypes(): Array<string>;
     addList(): string;
     getAllMessageCategories(additionalConfigurations?: {
         hideGroupActionMessages?: boolean;
     }): Array<string>;
-    getStickerButton(id: ComposerId, user?: CometChat.User, group?: CometChat.Group): JSX.Element | undefined;
+    getStickerButton(id: ComposerId, user?: CometChat$1.User, group?: CometChat$1.Group): JSX.Element | undefined;
     getId(): string;
-    getTextMessageContentView(message: CometChat.TextMessage, _alignment: MessageBubbleAlignment, additionalConfigurations?: additionalParams): JSX.Element | Element;
-    getAudioMessageContentView(message: CometChat.MediaMessage, _alignment: MessageBubbleAlignment): Element | JSX.Element;
-    getFileMessageContentView(message: CometChat.MediaMessage, _alignment: MessageBubbleAlignment): Element | JSX.Element;
-    getImageMessageContentView(message: CometChat.MediaMessage, _alignment: MessageBubbleAlignment): Element | JSX.Element;
-    getVideoMessageContentView(message: CometChat.MediaMessage, _alignment: MessageBubbleAlignment): Element | JSX.Element;
+    getTextMessageContentView(message: CometChat$1.TextMessage, _alignment: MessageBubbleAlignment, additionalConfigurations?: additionalParams): JSX.Element | Element;
+    getAudioMessageContentView(message: CometChat$1.MediaMessage, _alignment: MessageBubbleAlignment): Element | JSX.Element;
+    getFileMessageContentView(message: CometChat$1.MediaMessage, _alignment: MessageBubbleAlignment): Element | JSX.Element;
+    getImageMessageContentView(message: CometChat$1.MediaMessage, _alignment: MessageBubbleAlignment): Element | JSX.Element;
+    getVideoMessageContentView(message: CometChat$1.MediaMessage, _alignment: MessageBubbleAlignment): Element | JSX.Element;
     getActionMessage(message: any): string;
-    getDeleteMessageBubble(message: CometChat.BaseMessage, text?: string, alignment?: MessageBubbleAlignment): react_jsx_runtime.JSX.Element;
-    getGroupActionBubble(message: CometChat.BaseMessage): react_jsx_runtime.JSX.Element;
-    getTextMessageBubble(messageText: string, message: CometChat.TextMessage, alignment: MessageBubbleAlignment, additionalConfigurations?: additionalParams): Element | JSX.Element;
-    getAudioMessageBubble(audioUrl: string, message: CometChat.MediaMessage, title?: string, alignment?: MessageBubbleAlignment): Element | JSX.Element;
+    getDeleteMessageBubble(message: CometChat$1.BaseMessage, text?: string, alignment?: MessageBubbleAlignment): react_jsx_runtime.JSX.Element;
+    getGroupActionBubble(message: CometChat$1.BaseMessage): react_jsx_runtime.JSX.Element;
+    getTextMessageBubble(messageText: string, message: CometChat$1.TextMessage, alignment: MessageBubbleAlignment, additionalConfigurations?: additionalParams): Element | JSX.Element;
+    getAudioMessageBubble(audioUrl: string, message: CometChat$1.MediaMessage, title?: string, alignment?: MessageBubbleAlignment): Element | JSX.Element;
     /**
      * Function to check mimeType and return the iconUrl of that type
      * @param mimeType
@@ -6799,16 +6846,16 @@ declare class MessagesDataSource implements DataSource {
      * @returns
      */
     getFileSize: (sizeInBytes: number) => string;
-    getFileMessageBubble(fileUrl: string, message: CometChat.MediaMessage, title?: string, alignment?: MessageBubbleAlignment): Element | JSX.Element;
-    getImageMessageBubble(imageUrl: string, placeholderImage: string, message: CometChat.MediaMessage, onClick?: Function): react_jsx_runtime.JSX.Element;
-    getVideoMessageBubble(videoUrl: string, message: CometChat.MediaMessage, thumbnailUrl?: string, onClick?: Function): Element | JSX.Element;
+    getFileMessageBubble(fileUrl: string, message: CometChat$1.MediaMessage, title?: string, alignment?: MessageBubbleAlignment): Element | JSX.Element;
+    getImageMessageBubble(imageUrl: string, placeholderImage: string, message: CometChat$1.MediaMessage, onClick?: Function): react_jsx_runtime.JSX.Element;
+    getVideoMessageBubble(videoUrl: string, message: CometChat$1.MediaMessage, thumbnailUrl?: string, onClick?: Function): Element | JSX.Element;
     imageAttachmentOption(): CometChatMessageComposerAction;
     videoAttachmentOption(): CometChatMessageComposerAction;
     audioAttachmentOption(): CometChatMessageComposerAction;
     fileAttachmentOption(): CometChatMessageComposerAction;
     getAttachmentOptions(id: ComposerId, additionalConfigurations?: any): Array<CometChatMessageComposerAction>;
-    getLastConversationMessage(conversation: CometChat.Conversation, loggedInUser: CometChat.User, additionalConfigurations: additionalParams): string;
-    getAuxiliaryHeaderMenu(user?: CometChat.User, group?: CometChat.Group, additionalConfigurations?: any): Element[] | JSX.Element[];
+    getLastConversationMessage(conversation: CometChat$1.Conversation, loggedInUser: CometChat$1.User, additionalConfigurations: additionalParams): string;
+    getAuxiliaryHeaderMenu(user?: CometChat$1.User, group?: CometChat$1.Group, additionalConfigurations?: any): Element[] | JSX.Element[];
     /**
      * Adds styled @ for every mention in the text by matching uid
      *
@@ -6816,7 +6863,7 @@ declare class MessagesDataSource implements DataSource {
      * @param {string} subtitle
      * @returns {void}
      */
-    getMentionsFormattedText(message: CometChat.TextMessage, subtitle: string, mentionsFormatterParams: {
+    getMentionsFormattedText(message: CometChat$1.TextMessage, subtitle: string, mentionsFormatterParams: {
         mentionsTargetElement: MentionsTargetElement;
     }): string;
     getAllTextFormatters(formatterParams: additionalParams): CometChatTextFormatter[];
@@ -8391,7 +8438,7 @@ declare class StickersExtensionDecorator extends DataSourceDecorator {
      * @param group - Optional group object.
      * @returns An array of auxiliary options.
      */
-    getStickerButton(id: ComposerId, user?: CometChat.User, group?: CometChat.Group): react_jsx_runtime.JSX.Element;
+    getStickerButton(id: ComposerId, user?: CometChat$1.User, group?: CometChat$1.Group): react_jsx_runtime.JSX.Element;
     /**
      * Creates the sticker auxiliary button component.
      * @param id - A map containing relevant IDs.
@@ -8400,7 +8447,7 @@ declare class StickersExtensionDecorator extends DataSourceDecorator {
      * @param group - Optional group object.
      * @returns The JSX element for the sticker auxiliary button.
      */
-    getStickerAuxiliaryButton: (id: ComposerId, user?: CometChat.User, group?: CometChat.Group) => react_jsx_runtime.JSX.Element;
+    getStickerAuxiliaryButton: (id: ComposerId, user?: CometChat$1.User, group?: CometChat$1.Group) => react_jsx_runtime.JSX.Element;
     /**
      * Sends a sticker message.
      * @param event - The event object containing sticker details.
@@ -8410,14 +8457,14 @@ declare class StickersExtensionDecorator extends DataSourceDecorator {
      * Sends a sticker message.
      * @param event - The event object containing sticker details.
      */
-    getSticker(message: CometChat.CustomMessage): any;
+    getSticker(message: CometChat$1.CustomMessage): any;
     /**
      * Creates a JSX element for displaying the sticker message content.
      * @param stickerMessage - The custom message containing sticker data.
      * @param _theme - The theme object for styling.
      * @returns The JSX element for the sticker message content.
      */
-    getStickerMessageContentView(stickerMessage: CometChat.CustomMessage): react_jsx_runtime.JSX.Element;
+    getStickerMessageContentView(stickerMessage: CometChat$1.CustomMessage): react_jsx_runtime.JSX.Element;
     /**
      * Creates a sticker message template.
      * @param _theme - The theme object for styling.
@@ -8453,7 +8500,7 @@ declare class StickersExtensionDecorator extends DataSourceDecorator {
      * @param additionalConfigurations - Additional configurations, if any.
      * @returns A string representing the last message.
      */
-    getLastConversationMessage(conversation: CometChat.Conversation, loggedInUser: CometChat.User, additionalConfigurations?: any): string;
+    getLastConversationMessage(conversation: CometChat$1.Conversation, loggedInUser: CometChat$1.User, additionalConfigurations?: any): string;
 }
 
 /**
@@ -11342,7 +11389,7 @@ declare class CometChatUIKitUtility {
      * @param messageObject - The message object containing extensions.
      * @returns The sanitized message text if available, otherwise the original text.
      */
-    static getExtensionData(messageObject: CometChat.BaseMessage): string;
+    static getExtensionData(messageObject: CometChat$1.BaseMessage): string;
     /**
      * Checks for extension data in a message.
      *
@@ -11350,7 +11397,7 @@ declare class CometChatUIKitUtility {
      * @param extensionKey - The extension key to look for.
      * @returns The extension data if found.
      */
-    static checkMessageForExtensionsData: (message: CometChat.BaseMessage | null, extensionKey: string) => (object & MessageExtensionType) | undefined;
+    static checkMessageForExtensionsData: (message: CometChat$1.BaseMessage | null, extensionKey: string) => (object & MessageExtensionType) | undefined;
     /**
      * Sanitizes an HTML string by escaping tags not matching the whitelist.
      *