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

package/dist/types/src/components/Extensions/Polls/CreatePolls.d.ts

@@ -0,0 +1,66 @@
+import React from 'react';
+interface CreatePollProps {
+    /**
+      * Title for the poll creation form.
+      * Optional, defaults to localized "CREATE_POLL".
+      */
+    title?: string;
+    /**
+     * User object if the poll is directed to a specific user.
+     * Optional.
+     */
+    user?: CometChat.User;
+    /**
+     * Group object if the poll is directed to a specific group.
+     * Optional.
+     */
+    group?: CometChat.Group;
+    /**
+     * Callback function to be called when the close button is clicked.
+     * Optional.
+     */
+    ccCloseClicked?: () => void;
+    /**
+     * Default number of answer options to display initially.
+     * Optional, defaults to 3.
+     */
+    defaultAnswers?: number;
+    /**
+     * Placeholder text for the poll question input field.
+     * Optional, defaults to localized "QUESTION".
+     */
+    questionPlaceholderText?: string;
+    /**
+     * Placeholder text for the answer input fields.
+     * Optional, defaults to localized "ANSWER".
+     */
+    answerPlaceholderText?: string;
+    /**
+     * Help text for the answer input fields.
+     * Optional, defaults to localized "SET_THE_ANSWERS".
+     */
+    answerHelpText?: string;
+    /**
+     * Text to display for adding additional answer options.
+     * Optional, defaults to localized "ADD_ANOTHER_ANSWER".
+     */
+    addAnswerText?: string;
+    /**
+     * URL of the add answer icon image.
+     * Optional, defaults to a predefined plus icon.
+     */
+    addAnswerIconURL?: string;
+    /**
+     * Text to display on the create poll button.
+     * Optional, defaults to localized "CREATE".
+     */
+    createPollButtonText?: string;
+}
+/**
+ * CreatePoll component that provides a form to create a new poll.
+ *
+ * @param {CreatePollProps} props - The props for the component.
+ * @returns {JSX.Element} The rendered CreatePoll component.
+ */
+declare const CreatePoll: React.FC<CreatePollProps>;
+export { CreatePoll };

package/dist/types/src/components/Extensions/Polls/PollsBubble.d.ts

@@ -0,0 +1,35 @@
+interface PollsBubbleProps {
+    /**
+     * Array of options for the poll.
+     */
+    options?: any[];
+    /**
+     * The question being asked in the poll.
+     */
+    pollQuestion: string;
+    /**
+     * The unique identifier for the poll.
+     */
+    pollId: string | number;
+    /**
+     * The currently logged-in user.
+     * Optional.
+     */
+    loggedInUser: CometChat.User | undefined;
+    /**
+     * The unique identifier of the sender of the poll.
+     */
+    senderUid: string;
+    /**
+     * Optional metadata associated with the poll.
+     */
+    metadata?: any;
+}
+/**
+ * PollsBubble component that displays a poll question and options.
+ *
+ * @param {PollsBubbleProps} props - The props for the component.
+ * @returns {JSX.Element} The rendered PollsBubble component.
+ */
+declare const PollsBubble: (props: PollsBubbleProps) => import("react/jsx-runtime").JSX.Element;
+export { PollsBubble };

package/dist/types/src/components/Extensions/Polls/PollsConfiguration.d.ts

@@ -0,0 +1,19 @@
+export declare class PollsConfiguration {
+    private createPollIconURL;
+    private deleteIconURL;
+    private closeIconURL;
+    private optionIconURL;
+    private addAnswerIconURL;
+    constructor(configuration: {
+        createPollIconURL?: string;
+        deleteIconURL?: string;
+        closeIconURL?: string;
+        optionIconURL?: string;
+        addAnswerIconURL?: string;
+    });
+    getCreatePollIconURL(): string;
+    getDeleteIconURL(): string;
+    getCloseIconURL(): string;
+    getOptionIconURL(): string;
+    getAddAnswerIconURL(): string;
+}

package/dist/types/src/components/Extensions/Polls/PollsConstants.d.ts

@@ -0,0 +1,8 @@
+export declare const PollsConstants: Readonly<{
+    polls: "polls";
+    post: "POST";
+    v2_create: "v2/create";
+    v2_vote: "v2/vote";
+    extension_poll: "extension_poll";
+    injected: "@injected";
+}>;

package/dist/types/src/components/Extensions/Polls/PollsExtension.d.ts

@@ -0,0 +1,8 @@
+import { ExtensionsDataSource } from "../ExtensionsDataSource";
+import { PollsConfiguration } from "./PollsConfiguration";
+export declare class PollsExtension extends ExtensionsDataSource {
+    private configuration?;
+    constructor(configuration?: PollsConfiguration);
+    addExtension(): void;
+    getExtensionId(): string;
+}

package/dist/types/src/components/Extensions/Polls/PollsExtensionDecorator.d.ts

@@ -0,0 +1,112 @@
+import { DataSourceDecorator } from "../../../utils/DataSourceDecorator";
+import { DataSource } from "../../../utils/DataSource";
+import { PollsConfiguration } from "./PollsConfiguration";
+import { CometChatMessageComposerAction, CometChatMessageTemplate } from "../../../modals";
+/**
+ * The PollsExtensionDecorator class extends the DataSourceDecorator to
+ * handle custom poll messages in the CometChat UI.
+ */
+export declare class PollsExtensionDecorator extends DataSourceDecorator {
+    /** The currently logged-in user. */
+    private loggedInUser;
+    /** Configuration for the polls extension. */
+    configuration?: PollsConfiguration;
+    /** The data source used by this decorator. */
+    newDataSource: DataSource;
+    /**
+     * Constructs a PollsExtensionDecorator instance.
+     * @param dataSource - The data source to decorate.
+     * @param configuration - Optional configuration for the polls extension.
+     */
+    constructor(dataSource: DataSource, configuration?: PollsConfiguration);
+    /**
+     * Fetches the currently logged-in user.
+     */
+    getLoggedInUser(): Promise<void>;
+    /**
+     * Gets the unique ID of this decorator.
+     * @returns The ID of the decorator.
+     */
+    getId(): string;
+    /**
+     * Retrieves all message types, including the poll message type if not already present.
+     * @returns An array of message types.
+     */
+    getAllMessageTypes(): string[];
+    /**
+    * Retrieves all message categories, including the custom message category if not already present.
+    * @returns An array of message categories.
+    */
+    getAllMessageCategories(): string[];
+    /**
+    * Checks if a template of a specific type exists.
+    * @param template - The array of message templates.
+    * @param type - The type of the template to check.
+    * @returns True if the template exists, false otherwise.
+    */
+    checkIfTemplateExist(template: CometChatMessageTemplate[], type: string): boolean;
+    /**
+     * Retrieves all message templates, including the polls template if not already present.
+     * @param _theme - Optional theme to apply.
+     * @param additionalConfigurations - Optional additional configurations.
+     * @returns An array of message templates.
+     */
+    getAllMessageTemplates(additionalConfigurations?: any): CometChatMessageTemplate[];
+    /**
+    * Creates a template for poll messages.
+    * @param _theme - The theme to apply to the template.
+    * @returns A CometChatMessageTemplate for polls.
+    */
+    getPollsTemplate(): CometChatMessageTemplate;
+    /**
+      * Generates the content view for a poll message.
+      * @param message - The poll message.
+      * @param _theme - The theme to apply.
+      * @returns The content view for the poll message.
+      */
+    getPollsContentView(message: CometChat.CustomMessage): import("react/jsx-runtime").JSX.Element;
+    /**
+     * Retrieves specific data from a poll message.
+     * @param message - The poll message.
+     * @param key - The key to retrieve data for.
+     * @returns The requested data or the sender's UID if no key is specified.
+     */
+    getPollBubbleData(message: CometChat.CustomMessage, key?: string): any;
+    /**
+     * Retrieves the attachment options for the poll extension.
+     * @param theme - The theme to apply.
+     * @param id - The ID for the attachment options.
+     * @returns An array of message composer actions.
+     */
+    getAttachmentOptions(id: any): CometChatMessageComposerAction[];
+    /**
+     * Handles the click event for the polls button in the message composer.
+     * Opens the poll creation modal with pre-defined styles.
+     *
+     * @param theme - The current theme settings for the application.
+     * @param args - Additional arguments passed during the button click.
+     */
+    onPollsButtonClicked(...args: any[]): void;
+    /**
+     * Constructs the poll creation view with the given user and group details.
+     *
+     * @param user - The user who is creating the poll.
+     * @param group - The group in which the poll is being created.
+     * @param createPollStyle - Style configurations for the poll creation modal.
+     * @returns JSX element representing the poll creation modal.
+     */
+    getPollView(user: CometChat.User, group: CometChat.Group): import("react/jsx-runtime").JSX.Element;
+    /**
+    * Triggers the event to close the poll creation modal.
+    */
+    triggerCloseEvent(): void;
+    /**
+    * Retrieves the last message in a conversation and checks if it is a poll message.
+    *
+    * @param conversation - The conversation from which to retrieve the last message.
+    * @param loggedInUser - The currently logged-in user.
+    * @param additionalConfigurations - Any additional configurations to be used.
+    * @returns The localized string for a poll message if it exists, otherwise a default string.
+    */
+    getLastConversationMessage(conversation: CometChat.Conversation, loggedInUser: CometChat.User, additionalConfigurations?: any): string;
+}

package/dist/types/src/components/Extensions/Stickers/StickersConstants.d.ts

@@ -0,0 +1,16 @@
+/**
+ * A constant object that holds various keys and values related to stickers in the CometChat UI Kit.
+ * This object is frozen to prevent any modifications to its properties.
+ */
+export declare const StickersConstants: Readonly<{
+    sticker: "extension_sticker";
+    default_stickers: "defaultStickers";
+    custom_stickers: "customStickers";
+    stickers: "stickers";
+    data: "data";
+    custom_data: "customData";
+    sticker_url: "sticker_url";
+    sticker_name: "sticker_name";
+    get: "GET";
+    v1_fetch: "v1/fetch";
+}>;

package/dist/types/src/components/Extensions/Stickers/StickersExtension.d.ts

@@ -0,0 +1,31 @@
+import { ExtensionsDataSource } from "../ExtensionsDataSource";
+/**
+ * The StickersExtension class extends the ExtensionsDataSource and is responsible for
+ * configuring and adding the Stickers extension to the chat application.
+ *
+ * @class
+ * @extends {ExtensionsDataSource}
+ */
+export declare class StickersExtension extends ExtensionsDataSource {
+    /**
+     * Creates an instance of StickersExtension.
+     *
+     * @param {StickersConfiguration} [configuration] - Optional configuration for the Stickers extension.
+     */
+    constructor();
+    /**
+     * Adds the Stickers extension by enabling it in the ChatConfigurator.
+     * This method is called to register the Stickers extension with the chat application.
+     *
+     * @override
+     * @returns {void}
+     */
+    addExtension(): void;
+    /**
+    * Returns the unique ID of the Stickers extension.
+    *
+    * @override
+    * @returns {string} The ID of the Stickers extension.
+    */
+    getExtensionId(): string;
+}

package/dist/types/src/components/Extensions/Stickers/StickersExtensionDecorator.d.ts

@@ -0,0 +1,112 @@
+/// <reference types="react" />
+import { CometChat } from "@cometchat/chat-sdk-javascript";
+import { DataSource } from "../../../utils/DataSource";
+import { DataSourceDecorator } from "../../../utils/DataSourceDecorator";
+import { ComposerId } from "../../../utils/MessagesDataSource";
+import { CometChatMessageTemplate } from "../../../modals";
+/**
+ * Class responsible for decorating the data source with sticker-related functionalities.
+ * Extends the DataSourceDecorator to add custom message templates, auxiliary options, and sticker-specific logic.
+ */
+export declare class StickersExtensionDecorator extends DataSourceDecorator {
+    /**
+    * New data source for the extension.
+    */
+    newDataSource: DataSource;
+    /**
+     * Flag to show or hide the sticker keyboard.
+     * @default false
+     */
+    showStickerKeyboard: boolean;
+    private id;
+    private user?;
+    private group?;
+    /**
+     * Constructs a new instance of StickersExtensionDecorator.
+     * @param dataSource - The data source to be decorated.
+     * @param configuration - Optional configuration for the stickers extension.
+     */
+    constructor(dataSource: DataSource);
+    /**
+     * Gets the decorated data source.
+     * @returns The decorated data source.
+     */
+    getDataSource(): DataSource;
+    /**
+     * Retrieves all message templates, including the sticker template if it doesn't already exist.
+     * @param additionalConfigurations - Additional configurations, if any.
+     * @returns An array of CometChatMessageTemplate objects.
+     */
+    getAllMessageTemplates(additionalConfigurations?: any): CometChatMessageTemplate[];
+    /**
+     * Retrieves auxiliary options for the stickers extension.
+     * @param id - A map containing relevant IDs.
+     * @param theme - The theme object for styling.
+     * @param user - Optional user object.
+     * @param group - Optional group object.
+     * @returns An array of auxiliary options.
+     */
+    getAuxiliaryOptions(id: ComposerId, user?: CometChat.User, group?: CometChat.Group): JSX.Element[];
+    /**
+     * Creates the sticker auxiliary button component.
+     * @param id - A map containing relevant IDs.
+     * @param theme - The theme object for styling.
+     * @param user - Optional user object.
+     * @param group - Optional group object.
+     * @returns The JSX element for the sticker auxiliary button.
+     */
+    getStickerAuxiliaryButton: (id: ComposerId, user?: CometChat.User, group?: CometChat.Group) => import("react/jsx-runtime").JSX.Element;
+    /**
+     * Sends a sticker message.
+     * @param event - The event object containing sticker details.
+     */
+    sendSticker(event: any, closeSticker: Function): void;
+    /**
+     * Sends a sticker message.
+     * @param event - The event object containing sticker details.
+     */
+    getSticker(message: CometChat.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): import("react/jsx-runtime").JSX.Element;
+    /**
+     * Creates a sticker message template.
+     * @param _theme - The theme object for styling.
+     * @returns The sticker message template.
+     */
+    getStickerTemplate(): CometChatMessageTemplate;
+    /**
+     * Checks if a specific message template already exists.
+     * @param template - An array of message templates.
+     * @param type - The type of message template to check for.
+     * @returns True if the template exists, false otherwise.
+     */
+    checkIfTemplateExist(template: CometChatMessageTemplate[], type: string): boolean;
+    /**
+     * Retrieves all message categories, including custom categories.
+     * @returns An array of message categories.
+     */
+    getAllMessageCategories(): string[];
+    /**
+     * Retrieves all message types, including sticker types.
+     * @returns An array of message types.
+     */
+    getAllMessageTypes(): string[];
+    /**
+     * Retrieves the ID of the sticker extension.
+     * @returns The ID string.
+     */
+    getId(): string;
+    /**
+     * Retrieves the last message in a conversation, checking for sticker messages.
+     * @param conversation - The conversation object.
+     * @param loggedInUser - The logged-in user.
+     * @param additionalConfigurations - Additional configurations, if any.
+     * @returns A string representing the last message.
+     */
+    getLastConversationMessage(conversation: CometChat.Conversation, loggedInUser: CometChat.User, additionalConfigurations?: any): string;
+}

package/dist/types/src/components/Extensions/Stickers/StickersKeyboard.d.ts

@@ -0,0 +1,29 @@
+interface StickersKeyboardProps {
+    /**
+     * Text to display when there is an error state.
+     * @default "SOMETHING_WRONG"
+     */
+    errorStateText?: string;
+    /**
+     * Text to display when no stickers are found.
+     * @default "NO_STICKERS_FOUND"
+     */
+    emptyStateText?: string;
+    /**
+     * Callback function triggered when a sticker is clicked.
+     */
+    ccStickerClicked: (event: {
+        detail: {
+            stickerURL: string;
+            stickerName: string;
+        };
+    }) => void;
+}
+/**
+ * A keyboard component that allows users to select and send stickers.
+ * @component
+ * @param {StickersKeyboardProps} props - The props for the component.
+ * @returns {JSX.Element}
+ */
+declare const StickersKeyboard: (props: StickersKeyboardProps) => import("react/jsx-runtime").JSX.Element;
+export { StickersKeyboard };

package/dist/types/src/components/Extensions/ThumbnailGeneration/ThumbnailGenerationConstants.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Constants related to thumbnail generation and metadata.
+ *
+ * This object contains constant values used in the thumbnail generation process,
+ * including keys for metadata, extensions, and other related properties.
+ *
+ */
+export declare const ThumbnailGenerationConstants: Readonly<{
+    metadata: "metadata";
+    injected: "@injected";
+    extensions: "extensions";
+    thumbnail_generation: "thumbnail-generation";
+}>;

package/dist/types/src/components/Extensions/ThumbnailGeneration/ThumbnailGenerationExtension.d.ts

@@ -0,0 +1,21 @@
+import { ExtensionsDataSource } from "../ExtensionsDataSource";
+/**
+ * Class representing a Thumbnail Generation extension for managing thumbnail generation functionality.
+ *
+ * @extends {ExtensionsDataSource}
+ */
+export declare class ThumbnailGenerationExtension extends ExtensionsDataSource {
+    /**
+     * Adds the Thumbnail Generation extension by configuring the ChatConfigurator.
+     *
+     * This method enables the Thumbnail Generation extension by creating and adding a
+     * `ThumbnailGenerationExtensionDecorator` to the `ChatConfigurator`.
+     */
+    addExtension(): void;
+    /**
+     * Gets the unique identifier for the Thumbnail Generation extension.
+     *
+     * @returns {string} The unique identifier for the Thumbnail Generation extension.
+     */
+    getExtensionId(): string;
+}

package/dist/types/src/components/Extensions/ThumbnailGeneration/ThumbnailGenerationExtensionDecorator.d.ts

@@ -0,0 +1,40 @@
+/// <reference types="react" />
+import { DataSourceDecorator } from "../../../utils/DataSourceDecorator";
+/**
+ * Class representing a Thumbnail Generation extension decorator.
+ * Extends the `DataSourceDecorator` to handle thumbnail generation for images and videos.
+ *
+ * @extends {DataSourceDecorator}
+ */
+export declare class ThumbnailGenerationExtensionDecorator extends DataSourceDecorator {
+    /**
+     * Gets the unique identifier for the Thumbnail Generation extension decorator.
+     *
+     * @returns {string} The unique identifier for the Thumbnail Generation extension decorator.
+     */
+    getId(): string;
+    /**
+    * Provides the image message bubble with support for thumbnail generation.
+    * If the "imagemoderation" extension is included, it uses the default image bubble.
+    * Otherwise, it checks for a thumbnail URL in the message metadata and uses it if available.
+    *
+    * @param {string} imageUrl - The URL of the image.
+    * @param {string} placeholderImage - The URL of the placeholder image.
+    * @param {CometChat.MediaMessage} message - The media message containing the image.
+    * @param {Function} [onClick] - Optional click event handler.
+    * @param {ImageBubbleStyle} [style] - Optional style for the image bubble.
+    * @returns {React.ReactNode} The rendered image message bubble.
+    */
+    getImageMessageBubble(imageUrl: string, placeholderImage: string, message: CometChat.MediaMessage, onClick?: Function): JSX.Element | Element;
+    /**
+     * Provides the video message bubble with support for thumbnail generation.
+     * It checks for a thumbnail URL in the message metadata and uses it if available.
+     *
+     * @param {string} videoUrl - The URL of the video.
+     * @param {CometChat.MediaMessage} message - The media message containing the video.
+     * @param {string} [thumbnailUrl] - Optional URL of the thumbnail image.
+     * @param {Function} [onClick] - Optional click event handler.
+     * @returns {React.ReactNode} The rendered video message bubble.
+     */
+    getVideoMessageBubble(videoUrl: string, message: CometChat.MediaMessage, thumbnailUrl?: string, onClick?: Function): JSX.Element | Element;
+}

package/dist/types/src/components/Reactions/CometChatReactionInfo/CometChatReactionInfo.d.ts

@@ -0,0 +1,9 @@
+import React from "react";
+import { Placement } from "../../../Enums/Enums";
+interface ReactionInfoProps {
+    messageObject: CometChat.BaseMessage;
+    reaction: string;
+    placement?: Placement;
+}
+declare const CometChatReactionInfo: React.FC<ReactionInfoProps>;
+export default CometChatReactionInfo;

package/dist/types/src/components/Reactions/CometChatReactionList/CometChatReactionList.d.ts

@@ -0,0 +1,8 @@
+import React from "react";
+interface ReactionListProps {
+    messageObject: CometChat.BaseMessage;
+    reactionsRequestBuilder?: CometChat.ReactionsRequestBuilder;
+    reactionItemClicked?: (reaction: CometChat.Reaction, message: CometChat.BaseMessage) => void;
+}
+declare const CometChatReactionList: React.FC<ReactionListProps>;
+export default CometChatReactionList;

package/dist/types/src/components/Reactions/CometChatReactions/CometChatReactions.d.ts

@@ -0,0 +1,12 @@
+import React from "react";
+import { MessageBubbleAlignment } from "../../../Enums/Enums";
+interface ReactionsProps {
+    messageObject: CometChat.BaseMessage;
+    alignment?: MessageBubbleAlignment;
+    reactionsRequestBuilder?: CometChat.ReactionsRequestBuilder;
+    onReactionListItemClick?: (reaction: CometChat.Reaction, message: CometChat.BaseMessage) => void;
+    hoverDebounceTime?: number;
+    onReactionClick?: (reaction: CometChat.ReactionCount, message: CometChat.BaseMessage) => void;
+}
+declare const CometChatReactions: React.FC<ReactionsProps>;
+export default CometChatReactions;