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

package/dist/types/src/events/CometChatMessageEvents.d.ts

@@ -1,43 +0,0 @@
-import { MessageStatus } from '../Enums/Enums';
-import { Subject } from 'rxjs';
-/**
- * Message event subjects for handling actions related to messages (e.g., message sent, edited, deleted, etc.)
- */
-export declare class CometChatMessageEvents {
-    static ccMessageSent: Subject<IMessages>;
-    static ccMessageEdited: Subject<IMessages>;
-    static ccMessageTranslated: Subject<IMessages>;
-    static ccLiveReaction: Subject<string>;
-    static ccMessageRead: Subject<CometChat.BaseMessage>;
-    static ccMessageDeleted: Subject<CometChat.BaseMessage>;
-    /**
-     * Publishes a message event.
-     * @param {Subject<any>} event - The event to publish.
-     * @param {any} item - The item (message, etc.) associated with the event.
-     */
-    static publishEvent(event: any, item?: any): void;
-    /**
-    * message events wrapper of SDK listeners (e.g., media message, typing       indicator, read receipts, etc.)
-    */
-    static onTextMessageReceived: Subject<CometChat.TextMessage>;
-    static onMediaMessageReceived: Subject<CometChat.MediaMessage>;
-    static onCustomMessageReceived: Subject<CometChat.CustomMessage>;
-    static onTypingStarted: Subject<CometChat.TypingIndicator>;
-    static onTypingEnded: Subject<CometChat.TypingIndicator>;
-    static onMessagesDelivered: Subject<CometChat.MessageReceipt>;
-    static onMessagesRead: Subject<CometChat.MessageReceipt>;
-    static onMessagesDeliveredToAll: Subject<CometChat.MessageReceipt>;
-    static onMessagesReadByAll: Subject<CometChat.MessageReceipt>;
-    static onMessageEdited: Subject<CometChat.BaseMessage>;
-    static onMessageDeleted: Subject<CometChat.BaseMessage>;
-    static onTransientMessageReceived: Subject<CometChat.TransientMessage>;
-    static onMessageReactionAdded: Subject<CometChat.ReactionEvent>;
-    static onMessageReactionRemoved: Subject<CometChat.ReactionEvent>;
-}
-/**
-* Interface for message-related events
-*/
-export interface IMessages {
-    message: CometChat.BaseMessage;
-    status: MessageStatus;
-}

package/dist/types/src/events/CometChatUIEvents.d.ts

@@ -1,59 +0,0 @@
-import { Subject } from "rxjs";
-import { MouseEventSource, PanelAlignment } from "../Enums/Enums";
-/**
- * UI event subjects for handling various UI-related actions (e.g., showing panels, modals, dialogs, etc.)
-
- */
-export declare class CometChatUIEvents {
-    static ccHidePanel: Subject<PanelAlignment | void>;
-    static ccShowPanel: Subject<IPanel>;
-    static ccShowModal: Subject<IModal>;
-    static ccHideModal: Subject<void>;
-    static ccShowDialog: Subject<IDialog>;
-    static ccHideDialog: Subject<void>;
-    static ccActiveChatChanged: Subject<IActiveChatChanged>;
-    static ccShowOngoingCall: Subject<IShowOngoingCall>;
-    static ccOpenChat: Subject<IOpenChat>;
-    static ccComposeMessage: Subject<string>;
-    static ccMouseEvent: Subject<IMouseEvent>;
-    static ccShowMentionsCountWarning: Subject<IMentionsCountWarning>;
-    static ccActivePopover: Subject<string>;
-}
-/**
-* Interface for ui-related events
-*/
-export interface IOpenChat {
-    user?: CometChat.User;
-    group?: CometChat.Group;
-}
-export interface IShowOngoingCall {
-    child: any;
-}
-export interface IPanel {
-    child?: any;
-    configuration?: any;
-    message?: CometChat.BaseMessage;
-    position?: PanelAlignment;
-}
-export interface IModal {
-    child?: any;
-}
-export interface IActiveChatChanged {
-    user?: CometChat.User;
-    group?: CometChat.Group;
-    message?: CometChat.BaseMessage;
-    unreadMessageCount?: number;
-}
-export interface IDialog {
-    child: any;
-    confirmCallback: any;
-}
-export interface IMouseEvent {
-    event: Event;
-    source: MouseEventSource;
-    body?: {};
-}
-export interface IMentionsCountWarning {
-    showWarning: boolean;
-    id?: string;
-}

package/dist/types/src/events/CometChatUserEvents.d.ts

@@ -1,16 +0,0 @@
-import { Subject } from 'rxjs';
-/**
- * Class to handle user-related events such as blocking and unblocking users
- */
-export declare class CometChatUserEvents {
-    static ccUserBlocked: Subject<CometChat.User>;
-    static ccUserUnblocked: Subject<CometChat.User>;
-    /**
-     * Publishes a user event (like blocking/unblocking a user).
-     * This function will emit the event using the 'next()' method of the Subject.
-     *
-     * @param {Subject<CometChat.User>} event - The user event to be published (e.g., block or unblock).
-     * @param {any} item - The item (user) associated with the event.
-     */
-    static publishEvent(event: Subject<CometChat.User>, item: any): void;
-}

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

@@ -1,210 +0,0 @@
-import { CometChatTextFormatter } from "../CometChatTextFormatter";
-import { MentionsTargetElement, MentionsVisibility } from "../../../Enums/Enums";
-/**
- * Class that handles the text formatting for mentions in CometChat.
- * CometChatMentionsFormatter is a child class of CometChatTextFormatter.
- * It extends the functionality of text formatting to specifically handle user mentions
- * in the text, it keeps track of the mentions in the text, format them for display and
- * other functionalities.
- * It is used in CometChatMessageComposer component and extension decorators like link preview, message translation, text moderator.
- *
- * @extends {CometChatTextFormatter}
- */
-export declare class CometChatMentionsFormatter extends CometChatTextFormatter {
-    /**
-     * List of users for mentions.
-     */
-    private cometChatUserGroupMembers;
-    /**
-     * Mapping of CSS classes for mentions.
-     */
-    private mentionsCssClassMapping;
-    /**
-     * Specifies the visibility of mentions.
-     */
-    private visibleIn;
-    /**
-     * Regular expression for validating search input.
-     *
-     * The search input is considered valid if it meets all of the following conditions:
-     * - It starts with an "@" symbol.
-     * - After the "@" symbol, it can optionally contain alphanumeric characters or periods.
-     * - If there are spaces, they should not be immediately after the "@" symbol.
-     * - After a space, it can optionally contain alphanumeric characters or periods.
-     *
-     * If the search input does not meet these conditions, the regular expression match will fail, indicating invalid input.
-     *
-     * @type {RegExp}
-     * @private
-     */
-    private invalidCharactersRegexForSearch;
-    /**
-     * Count of mentions in the text.
-     */
-    private mentionsCount;
-    /**
-     * Map of mentions, linking user ids with their names.
-     */
-    private mentionsMap?;
-    /**
-     * Observer for observing changes to the text.
-     */
-    observer: MutationObserver;
-    /**
-     * Callback function for when a match is found by the regex used for search.
-     */
-    keyUpCallBack: Function;
-    private warningDisplayed;
-    private allowMultipleSpaces;
-    private mouseOverEventDispatched;
-    constructor();
-    /**
-     * Observes changes in targetNode.
-     *
-     * @param {HTMLElement} targetNode - The HTML element to observe for changes.
-     */
-    observeChange(targetNode: HTMLElement): void;
-    /**
-     * Retrieves the count of mentions.
-     *
-     * @returns {number} - The count of mentions.
-     */
-    getMentionsCount(): number;
-    /**
-     * Sets the count of mentions.
-     *
-     * @param {number} mentionsCount - The count of mentions to be set.
-     */
-    setMentionsCount(mentionsCount: number): void;
-    /**
-     * Set Regex for Checking Invalid Characters in Search Term
-     * @param pattern
-     */
-    setInvalidCharactersRegexForSearch(pattern: RegExp): void;
-    /**
-     * Sets the current caret position and selection range.
-     *
-     * @param {Selection} currentCaretPosition - The current caret position.
-     * @param {Range} currentRange - The current selection range.
-     */
-    setCaretPositionAndRange(currentCaretPosition: Selection, currentRange: Range): void;
-    /**
-     * Sets the reference to the input element.
-     *
-     * @param {HTMLElement} inputElementReference - The reference to the input element.
-     */
-    setInputElementReference(inputElementReference: HTMLElement): void;
-    /**
-     * Sets the regex pattern for matching text.
-     *
-     * @param {Array<RegExp>} regexPatterns - The array of regex patterns.
-     */
-    setRegexPattern(regexPatterns: Array<RegExp>): void;
-    /**
-     * Retrieves the CometChatUserGroupMembers.
-     *
-     * @returns {Array<CometChatUserGroupMembers>} - The current CometChatUserGroupMembers.
-     */
-    getCometChatUserGroupMembers(): (import("@cometchat/chat-sdk-javascript").User | import("@cometchat/chat-sdk-javascript").GroupMember)[];
-    /**
-     * Sets the CometChatUserGroupMembers.
-     *
-     * @param {Array<CometChatUserGroupMembers>} CometChatUserGroupMembers - The CometChatUserGroupMembers to be set.
-     */
-    setCometChatUserGroupMembers(CometChatUserGroupMembers: Array<CometChat.User | CometChat.GroupMember>): void;
-    resetCometChatUserGroupMembers(): void;
-    /**
-     * Sets the callback function for handling key down events.
-     *
-     * @param {Function} keyUpCallBack - The callback function for handling key up events.
-     */
-    setKeyUpCallBack(keyUpCallBack: Function): void;
-    /**
-     * Sets the keydown callback function.
-     * @param {Function} keyDownCallBack - The keydown callback function.
-     */
-    setKeyDownCallBack(keyDownCallBack: Function): void;
-    getAllowMultipleSpaces(): boolean;
-    setAllowMultipleSpaces(allowMultipleSpaces: boolean): void;
-    cleanup(): void;
-    /**
-     * This will be called by composer before sending the message. This can be used to set metadata, tags on message
-     * @param {CometChat.BaseMessage} message
-     * @return {CometChat.BaseMessage} - message with metadata added
-     */
-    formatMessageForSending(message: CometChat.BaseMessage): CometChat.BaseMessage;
-    reset(): void;
-    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.
-     * @returns {string|void} - The formatted input text, or void if inputText is not provided.
-     */
-    getFormattedText(inputText: string | null, params?: {
-        mentionsTargetElement: MentionsTargetElement;
-    }): 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.
-     * @returns {string} - The modified input text.
-     */
-    protected addMentionsSpan(inputText: string): string;
-    /**
-     * Registers event listeners for click, mouseover, mouseout on the element
-     * @param {HTMLElement} element - The element on which the events need to be registered
-     * @param {DOMTokenList} domTokenList - The classes to be added
-     * @return {HTMLElement} - The element with the registered event listeners
-     */
-    registerEventListeners(element: HTMLElement, domTokenList: DOMTokenList): HTMLElement;
-    /**
-     * Replaces mentions which are span tags with corresponding user UIDs
-     *
-     * @param {string | null | undefined} inputText - The text in which the mentions need to be replaced
-     * @return {string} - The text after replacing the mentions with uids
-     */
-    protected replaceMentionsSpanWithUid(inputText: string | null | undefined): string;
-    /**
-     * Handles the keydown events, updating the mention state as necessary
-     *
-     * @param {KeyboardEvent} event - The keydown event
-     */
-    onKeyDown(event: KeyboardEvent): void;
-    /**
-     * Validates the text input based on the invalidCharactersRegexForSearch regular expression.
-     *
-     * @param {string | null} text - The text to validate. If null, the function will return null.
-     * @returns {string | null} - Returns the original text if valid, otherwise returns null.
-     */
-    validateText(text: string | null): string | null;
-    /**
-     * Handles the keyup events, updating the mention state as necessary
-     *
-     * @param {KeyboardEvent} event - The keydown event
-     */
-    onKeyUp(event: KeyboardEvent): null | undefined;
-    /**
-     * Adds the given HTML at the caret position.
-     *
-     * @param {string} newHtml - The HTML to be added.
-     * @param {Selection} currentCaretPosition - The current caret position
-     * @param {Range} currentRange - The current range
-     * @returns {void}
-     */
-    protected addAtCaretPosition(newHtml: string, currentCaretPosition: Selection, currentRange: Range): void;
-    /**
-     * Matches the regex with the given inputText and replaces the matched text with respective spans
-     *
-     * @param {string | null} inputText - The text in which the regex patterns needs to be matched
-     * @return {string} - The text after replacing the matched text with spans
-     */
-    onRegexMatch(inputText?: string | null): string;
-    /**
-     * Retrieves the original text after replacing mentions span with UIDs
-     *
-     * @param {string | null | undefined} inputText - The input text to be formatted.
-     * @returns {string} The original text after replacing mentions span with UIDs
-     */
-    getOriginalText(inputText: string | null | undefined): string;
-    setVisibleIn(visibleIn: MentionsVisibility): void;
-    getVisibleIn(): MentionsVisibility;
-}

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

@@ -1,268 +0,0 @@
-import { MentionsTargetElement, MessageBubbleAlignment } from "../../Enums/Enums";
-import { ComposerId } from "../../utils/MessagesDataSource";
-/**
- * Abstract class that provides methods for formatting text in CometChat.
- * It is used in CometChatMessageComposer, CometChatConversations, CometChatMessageList components and extension decorators.
- */
-export declare abstract class CometChatTextFormatter {
-    /**
-     * An ID for tracking the timeout.
-     */
-    protected timeoutID?: number;
-    /**
-     * A flag to start tracking once a specific keyboard event occurs.
-     */
-    protected startTracking: boolean;
-    /**
-     * Current position/type of the text selection or cursor in the text input field.
-     */
-    protected currentCaretPosition?: Selection;
-    /**
-     * Represents the text range that the user has selected or the cursor position in the text input field.
-     */
-    protected currentRange?: Range;
-    /**
-     * Reference to the text input field DOM element.
-     */
-    protected inputElementReference?: HTMLElement;
-    /**
-     * The regex patterns to find specific text pattern in the user input text.
-     */
-    protected regexPatterns: RegExp[];
-    /**
-     * The regex patterns to replace text formatting in the user input text.
-     */
-    protected regexToReplaceFormatting: RegExp[];
-    /**
-     * Mapping of CSS classes for styling the text.
-     */
-    protected cssClassMapping: Array<string>;
-    /**
-     * The character to track once typed in the text input field.
-     */
-    protected trackCharacter: string;
-    /**
-     * Callback function to be triggered on the 'keyup' event.
-     */
-    protected keyUpCallBack: Function;
-    /**
-     * Callback function to be triggered on the 'keydown' event.
-     */
-    protected keyDownCallBack: Function;
-    protected classes: string[];
-    /**
-     * Function reference to trigger a re-render of the component.
-     */
-    reRender: Function;
-    messageBubbleAlignment: MessageBubbleAlignment;
-    /**
-     * The message object in context.
-     */
-    protected messageObject: CometChat.BaseMessage;
-    user?: CometChat.User;
-    group?: CometChat.Group;
-    composerId?: ComposerId;
-    /**
-     * The user who is currently logged in.
-     */
-    protected loggedInUser?: CometChat.User | null;
-    protected id?: string;
-    protected textStyle: {
-        [key: string]: string;
-    };
-    /**
-     * Sets the current caret position and selection range.
-     *
-     * @param {Selection} currentCaretPosition - The current caret position.
-     * @param {Range} currentRange - The current selection range.
-     */
-    setCaretPositionAndRange(currentCaretPosition: Selection, currentRange: Range): void;
-    /**
-     * Set css class to be applied on format spans
-     */
-    setClasses(classes: string[]): void;
-    /**
-     * Sets the regex patterns to match.
-     * @param regexPatterns - Array of regex patterns.
-     */
-    setRegexPatterns(regexPatterns: Array<RegExp>): void;
-    /**
-     * Gets the regex patterns.
-     */
-    getRegexPatterns(): RegExp[];
-    /**
-     * Sets the regex patterns to replace formatting.
-     * @param regexToReplaceFormatting - Array of regex patterns.
-     */
-    setRegexToReplaceFormatting(regexToReplaceFormatting: Array<RegExp>): void;
-    /**
-     * Sets the tracking character.
-     * @param trackCharacter - The character to track.
-     */
-    setTrackingCharacter(trackCharacter: string): void;
-    /**
-     * Sets the input element reference.
-     * @param inputElementReference - The reference to the input element.
-     */
-    setInputElementReference(inputElementReference: HTMLElement): void;
-    /**
-     * Sets the re-render function.
-     * @param reRender - The function to call for re-rendering.
-     */
-    setReRender(reRender: Function): void;
-    /**
-     * Retrieves the keydown callback function.
-     * @returns {Function} The keydown callback function.
-     */
-    getKeyUpCallBack(): Function;
-    /**
-     * Sets the keydown callback function.
-     * @param {Function} keyUpCallBack - The callback function for handling key down events.
-     */
-    setKeyUpCallBack(keyUpCallBack: Function): void;
-    /**
-     * Retrieves the keydown callback function.
-     * @returns {Function} The keydown callback function.
-     */
-    getKeyDownCallBack(): Function;
-    /**
-     * Sets the keydown callback function.
-     * @param {Function} keyDownCallBack - The keydown callback function.
-     */
-    setKeyDownCallBack(keyDownCallBack: Function): void;
-    /**
-     * Retrieves the currently logged in user.
-     * @returns The currently logged user.
-     */
-    getLoggedInUser(): import("@cometchat/chat-sdk-javascript").User | null | undefined;
-    /**
-     * Sets the currently logged in user.
-     * @param {CometChat.User} loggedInUser - The user to set as currently logged in.
-     */
-    setLoggedInUser(loggedInUser: CometChat.User): void;
-    /**
-     * Sets the mapping of CSS classes.
-     * @param cssClassesNames - Array of CSS class names.
-     */
-    setCssClassMapping(cssClassesNames: string[]): void;
-    /**
-     * Sets the CSS style.
-     * @param {Object} styleObject - The CSS style object.
-     * @param {string} styleObject.formattedTextColor - The color to use for formatted text.
-     */
-    setStyle(styleObject: {
-        formattedTextColor: string;
-        formattedTextFont: string;
-    }): void;
-    getStyle(): {
-        [key: string]: string;
-    };
-    setId(id: string): void;
-    getId(): string | undefined;
-    cleanup(): void;
-    /**
-     * If the input text is provided, it returns the formatted text. Otherwise, it edits the text using the current cursor position.
-     * @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: {
-        mentionsTargetElement: MentionsTargetElement;
-    }): string | void;
-    /**
-     * Sets the message object.
-     *
-     * @param {CometChat.BaseMessage} messageObject - The message object to be set.
-     */
-    setMessage(messageObject: CometChat.BaseMessage): void;
-    /**
-     * Retrieves the message object.
-     *
-     * @returns {CometChat.BaseMessage} - The current message object.
-     */
-    getMessage(): import("@cometchat/chat-sdk-javascript").BaseMessage;
-    setMessageBubbleAlignment(messageBubbleAlignment: MessageBubbleAlignment): void;
-    getMessageBubbleAlignment(): MessageBubbleAlignment;
-    setComposerConfig(user?: CometChat.User, group?: CometChat.Group, composerId?: ComposerId): void;
-    getComposerConfig(): {
-        user: import("@cometchat/chat-sdk-javascript").User | undefined;
-        group: import("@cometchat/chat-sdk-javascript").Group | undefined;
-        composerId: ComposerId | undefined;
-    };
-    /**
-     * Formats the text on keyboard key down.
-     * @param {string|void} inputText - The text to format.
-     */
-    protected formatTextOnKeyUp: (inputText: string | void) => void;
-    debouncedFormatTextOnKeyUp: (...args: Object[]) => void;
-    /**
-     * Retrieves the preceding text from the given caret position.
-     * @param {Selection} currentCaretPosition - The current caret position.
-     * @param {Range} currentRange - The current selection range.
-     * @return {string|null} - The preceding text or null.
-     */
-    protected getPrecedingText(currentCaretPosition: Selection | undefined, currentRange: Range | undefined): string | null;
-    /**
-     * Returns true if previous character is previousCharacterToCheck or if there is just one character
-     * @param {string} previousCharacterToCheck
-     * @param {Range} currentRange
-     * @returns  {boolean}
-     */
-    protected checkPreviousCharacterUsingRange(previousCharacterToCheck?: string, currentRange?: Range): boolean;
-    /**
-     * Applies regex match on the input text and replaces matched instances.
-     * @param {string|null} inputText - The text to apply regex match.
-     * @return {string} - The replaced text.
-     */
-    protected onRegexMatch(inputText?: string | null): string;
-    /**
-     * Debounce function.
-     * @param {Function} func - The function to debounce.
-     * @param {number} wait - The amount of delay before function invocation.
-     * @return {Function} - The debounced function.
-     */
-    debounce(func: Function, wait: number): (...args: Object[]) => void;
-    /**
-     * Handles 'keydown' events.
-     * @param {KeyboardEvent} event - The keyboard event.
-     */
-    onKeyUp(event: KeyboardEvent): void;
-    /**
-     * Handles 'keydown' events.
-     * @param {KeyboardEvent} event - The keyboard event.
-     */
-    onKeyDown(event: KeyboardEvent): void;
-    /**
-     * Adds HTML at the current caret position.
-     * @param {string} newHtml - The HTML to insert.
-     * @param {Selection} currentCaretPosition - The current caret position.
-     * @param {Range} currentRange - The current selection range.
-     */
-    protected addAtCaretPosition(newHtml: string, currentCaretPosition: Selection, currentRange: Range): void;
-    /**
-     * Returns the original unformatted text from the input text.
-     * @param {string|null|undefined} inputText - The input text to get original text from.
-     * @return {string} - The original text.
-     */
-    getOriginalText(inputText: string | null | undefined): string;
-    /**
-     * To inform formatter to stop keeping a track of characters
-     */
-    stopTracking(): void;
-    /**
-     * To reset the formatter properties
-     */
-    reset(): void;
-    /**
-     * This will be called by composer before sending the message. This can be used to set metadata, tags on message
-     * @param {CometChat.BaseMessage} message
-     * @return {CometChat.BaseMessage} - message with metadata added
-     */
-    formatMessageForSending(message: CometChat.BaseMessage): CometChat.BaseMessage;
-    /**
-     * Registers event listeners on the given element.
-     * @param {Element} span - The HTML element to register event listeners.
-     * @param {DOMTokenList} classList - The classList of the element.
-     * @return {Element} - The element with event listeners registered.
-     */
-    registerEventListeners(span: Element, classList: DOMTokenList): Element;
-}

package/dist/types/src/formatters/CometChatFormatters/CometChatUrlsFormatter/CometChatUrlsFormatter.d.ts

@@ -1,12 +0,0 @@
-import { CometChatTextFormatter } from "../CometChatTextFormatter";
-/**
- * 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.
- */
-export declare class CometChatUrlsFormatter extends CometChatTextFormatter {
-    constructor(regexPatterns: Array<RegExp>);
-    protected onRegexMatch(inputText?: string | null): string;
-    registerEventListeners(element: HTMLElement, classList: DOMTokenList): HTMLElement;
-}

package/dist/types/src/formatters/index.d.ts

@@ -1,3 +0,0 @@
-export { CometChatTextFormatter } from './CometChatFormatters/CometChatTextFormatter';
-export { CometChatUrlsFormatter } from './CometChatFormatters/CometChatUrlsFormatter/CometChatUrlsFormatter';
-export { CometChatMentionsFormatter } from './CometChatFormatters/CometChatMentionsFormatter/CometChatMentionsFormatter';