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

package/dist/types/src/CometChatUIKit/UIKitSettings.d.ts

@@ -1,304 +0,0 @@
-import { AIExtensionDataSource } from "../components/AI/AIExtensionDataSource";
-import { CallingExtension } from "../components/Calling/CallingExtension";
-import { ExtensionsDataSource } from "../components/Extensions/ExtensionsDataSource";
-/**
- * Represents the settings required to initialize the CometChat SDK.
- * This class holds various configuration options, such as app credentials, socket connection settings, and feature toggles.
- *
- * @class UIKitSettings
- */
-export declare class UIKitSettings {
-    /**
-     * Unique ID for the app, available on the CometChat dashboard.
-     * @type {string}
-     */
-    readonly appId?: string;
-    /**
-     * Region for the app, such as "us" or "eu".
-     * @type {string}
-     */
-    readonly region?: string;
-    /**
-     * Sets the subscription type for presence.
-     * @type {string}
-     */
-    readonly subscriptionType?: string;
-    /**
-     * Configures WebSocket connections. When set to true, establishes connection automatically on app initialization.
-     * @type {boolean}
-     * @default true
-     */
-    readonly autoEstablishSocketConnection?: boolean;
-    /**
-     * Authentication key for the app, available on the CometChat dashboard.
-     * @type {string}
-     */
-    readonly authKey?: string;
-    /**
-     * Token representing the device, used for push notifications.
-     * @type {string}
-     */
-    readonly deviceToken?: string;
-    /**
-     * API key for Google services.
-     * @type {string}
-     */
-    readonly googleApiKey?: string;
-    /**
-     * Flag to disable the calling feature.
-     * @type {boolean}
-     * @default false
-     */
-    readonly disableCalling: boolean;
-    /**
-     * Subscribes to user presence for users having the specified roles.
-     * @type {string[]}
-     */
-    readonly roles?: string[];
-    /**
-     * Custom admin URL, used instead of the default admin URL for dedicated deployments.
-     * @type {string}
-     */
-    readonly adminHost?: string;
-    /**
-     * Custom client URL, used instead of the default client URL for dedicated deployments.
-     * @type {string}
-     */
-    readonly clientHost?: string;
-    /**
-     * Data source for managing UI extensions.
-     * @type {ExtensionsDataSource[]}
-     */
-    readonly extensions?: ExtensionsDataSource[];
-    /**
-   * Data source for managing  calls.
-   * @type {ExtensionsDataSource}
-   */
-    readonly callingExtension?: CallingExtension;
-    /**
-     * Data source for managing AI features.
-     * @type {AIExtensionDataSource[]}
-     */
-    readonly aiFeatures?: AIExtensionDataSource[];
-    /**
-     * Private constructor to initialize the settings using the provided builder.
-     * @param {UIKitSettingsBuilder} builder - The builder instance containing the settings configuration.
-     */
-    private constructor();
-    /**
-     * Creates an instance of UIKitSettings from the provided builder.
-     * @param {UIKitSettingsBuilder} builder - The builder instance containing the settings configuration.
-     * @returns {UIKitSettings} A new instance of UIKitSettings.
-     */
-    static fromBuilder(builder: UIKitSettingsBuilder): UIKitSettings;
-    /**
-      * Retrieves the app ID.
-      * @returns {string} The unique ID of the app.
-      */
-    getAppId(): string;
-    /**
-    * Retrieves the region.
-    * @returns {string} The region of the app.
-    */
-    getRegion(): string;
-    /**
-     * Retrieves the roles for presence subscription.
-     * @returns {string[]} The list of roles subscribed to presence.
-     */
-    getRoles(): string[];
-    /**
-     * Retrieves the subscription type for presence.
-     * @returns {string} The subscription type.
-     */
-    getSubscriptionType(): string;
-    /**
-     * Retrieves the authentication key.
-     * @returns {string} The authentication key.
-     */
-    getAuthKey(): string;
-    /**
-     * Checks if auto-establish socket connection is enabled.
-     * @returns {boolean} True if auto-establish is enabled, otherwise false.
-     */
-    isAutoEstablishSocketConnection(): boolean;
-    /**
-     * Retrieves the custom admin host URL.
-     * @returns {string} The admin host URL.
-     */
-    getAdminHost(): string;
-    /**
-     * Retrieves the custom client host URL.
-     * @returns {string} The client host URL.
-     */
-    getClientHost(): string;
-    /**
-     * Retrieves the list of UI extensions.
-     * @returns {ExtensionsDataSource[]} The list of UI extensions.
-     */
-    getExtensions(): ExtensionsDataSource[];
-    /**
-   * Retrieves the calling extension.
-   * @returns {ExtensionsDataSource[]}
-   */
-    getCallsExtension(): ExtensionsDataSource;
-    /**
-     * Retrieves the list of AI features.
-     * @returns {AIExtensionDataSource[]} The list of AI features.
-     */
-    getAiFeatures(): AIExtensionDataSource[];
-}
-export declare class UIKitSettingsBuilder {
-    /**
-     * Unique ID for the app, available on the CometChat dashboard.
-     * @type {string}
-     */
-    appId?: string;
-    /**
-     * Region for the app, such as "us" or "eu".
-     * @type {string}
-     */
-    region?: string;
-    /**
-     * Sets the subscription type for presence.
-     * @type {string}
-     */
-    subscriptionType?: string;
-    /**
-     * Subscribes to user presence for users having the specified roles.
-     * @type {string[]}
-     */
-    roles?: string[];
-    /**
-     * Configures WebSocket connections.
-     * @type {boolean}
-     */
-    autoEstablishSocketConnection?: boolean;
-    /**
-     * Authentication key for the app, available on the CometChat dashboard.
-     * @type {string}
-     */
-    authKey?: string;
-    /**
-     * Token representing the device, used for push notifications.
-     * @type {string}
-     */
-    deviceToken?: string;
-    /**
-     * API key for Google services.
-     * @type {string}
-     */
-    googleApiKey?: string;
-    /**
-     * Data source for managing UI extensions.
-     * @type {ExtensionsDataSource[]}
-     */
-    extensions?: ExtensionsDataSource[];
-    /**
-   * Data source for managing calls extension.
-   * @type {CallingExtension}
-   */
-    callingExtension?: CallingExtension;
-    /**
-     * Flag to disable the calling feature.
-     * @type {boolean}
-     * @default false
-     */
-    disableCalling: boolean;
-    /**
-     * Custom admin URL, used instead of the default admin URL for dedicated deployments.
-     * @type {string}
-     */
-    adminHost?: string;
-    /**
-     * Custom client URL, used instead of the default client URL for dedicated deployments.
-     * @type {string}
-     */
-    clientHost?: string;
-    /**
-     * Data source for managing AI features.
-     * @type {AIExtensionDataSource[]}
-     */
-    aiFeatures?: AIExtensionDataSource[];
-    /**
-    * Builds and returns an instance of UIKitSettings.
-    * @returns {UIKitSettings} A new instance of UIKitSettings with the specified configuration.
-    */
-    build(): UIKitSettings;
-    /**
-    * Sets the app ID.
-    * @param {string} appId - The unique ID of the app.
-    * @returns {UIKitSettingsBuilder} The builder instance.
-    */
-    setAppId(appId: string): UIKitSettingsBuilder;
-    /**
-     * Sets the region.
-     * @param {string} region - The region of the app.
-     * @returns {UIKitSettingsBuilder} The builder instance.
-     */
-    setRegion(region: string): UIKitSettingsBuilder;
-    /**
-     * Subscribes to presence updates for all users.
-     * @returns {UIKitSettingsBuilder} The builder instance.
-     */
-    subscribePresenceForAllUsers(): UIKitSettingsBuilder;
-    /**
-     * Subscribes to presence updates for specific roles.
-     * @param {string[]} roles - The roles to subscribe to.
-     * @returns {UIKitSettingsBuilder} The builder instance.
-     */
-    subscribePresenceForRoles(roles: string[]): UIKitSettingsBuilder;
-    /**
-     * Subscribes to presence updates for specific roles.
-     * @param {string[]} roles - The roles to subscribe to.
-     * @returns {UIKitSettingsBuilder} The builder instance.
-     */
-    subscribePresenceForFriends(): UIKitSettingsBuilder;
-    /**
-     * Sets the roles for presence subscription.
-     * @param {string[]} roles - The roles to subscribe to.
-     * @returns {UIKitSettingsBuilder} The builder instance.
-     */
-    setRoles(roles: string[]): UIKitSettingsBuilder;
-    /**
-     * Enables or disables the auto-establish socket connection.
-     * @param {boolean} autoEstablishSocketConnection - True to enable, false to disable.
-     * @returns {UIKitSettingsBuilder} The builder instance.
-     */
-    setAutoEstablishSocketConnection(autoEstablishSocketConnection: boolean): UIKitSettingsBuilder;
-    /**
-     * Sets the authentication key.
-     * @param {string} authKey - The authentication key.
-     * @returns {UIKitSettingsBuilder} The builder instance.
-     */
-    setAuthKey(authKey: string): UIKitSettingsBuilder;
-    /**
-     * Sets the custom admin host URL.
-     * @param {string} adminHost - The admin host URL.
-     * @returns {UIKitSettingsBuilder} The builder instance.
-     */
-    setAdminHost(adminHost: string): UIKitSettingsBuilder;
-    /**
-     * Sets the custom client host URL.
-     * @param {string} clientHost - The client host URL.
-     * @returns {UIKitSettingsBuilder} The builder instance.
-     */
-    setClientHost(clientHost: string): UIKitSettingsBuilder;
-    /**
-     * Sets the list of UI extensions.
-     * @param {ExtensionsDataSource[]} extensions - The list of UI extensions.
-     * @returns {UIKitSettingsBuilder} The builder instance.
-     */
-    setExtensions(extensions: ExtensionsDataSource[]): UIKitSettingsBuilder;
-    /**
-   * Sets the calling extension.
-   * @param {ExtensionsDataSource} calling.
-   * @returns {UIKitSettingsBuilder} The builder instance.
-   */
-    setCallsExtension(callingExtension: CallingExtension): UIKitSettingsBuilder;
-    /**
-     * Sets the list of AI features.
-     * @param {AIExtensionDataSource[]} aiFeatures - The list of AI features.
-     * @returns {UIKitSettingsBuilder} The builder instance.
-     */
-    setAiFeatures(aiFeatures: AIExtensionDataSource[]): UIKitSettingsBuilder;
-}

package/dist/types/src/Enums/Enums.d.ts

@@ -1,258 +0,0 @@
-/**
- * This is used for providing the required date configs.
- * It is used in components where the date field is present.
- */
-export declare enum DatePatterns {
-    time = 0,
-    DayDate = 1,
-    DayDateTime = 2,
-    DateTime = 3
-}
-/**
- * It is used for specifying the position of the auxiliary buttons.
- * It is used in CometChatMessageComposer component.
- */
-export declare enum AuxiliaryButtonAlignment {
-    left = 0,
-    right = 1
-}
-/**
- * It is used for describing the position of the element on the UI.
- * It is used in CometChatContextualMenu, CometChatMessageBubble, CometChatUsers and CometChatGroupMembers components.
- */
-export declare enum Placement {
-    top = "top",
-    right = "right",
-    bottom = "bottom",
-    left = "left"
-}
-/**
- * It is used for specifying the alignment of the message list.
- * It is used in CometChatMessageList component.
- */
-export declare enum MessageListAlignment {
-    left = 0,
-    standard = 1
-}
-/**
- * This is used for specifying the position of the message bubble.
- * It is used in various components where the message bubbles are used.
- */
-export declare enum MessageBubbleAlignment {
-    left = 0,
-    right = 1,
-    center = 2
-}
-/**
- * This is used for specifying the position of the document icon.
- * It is used in Decorators like CallingExtension, CollaborativeDocument, CollaborativeWhiteboard.
- */
-export declare enum DocumentIconAlignment {
-    left = 0,
-    right = 1
-}
-/**
- * This is used to specify the alignment of the tabs.
- * It is used in CometChatTabs and CometChatContacts components.
- */
-export declare enum TabAlignment {
-    top = 0,
-    bottom = 1,
-    left = 2,
-    right = 3
-}
-/**
- * This is used to specify the status of the message delivery.
- * It is used in components related to messages.
- */
-export declare enum MessageStatus {
-    inprogress = 0,
-    success = 1,
-    error = 2
-}
-/**
- * This is used to specify the types of the read receipts for the message.
- * It is used in Bubbles, CometChatMessageInformation components.
- */
-export declare enum Receipts {
-    wait = 0,
-    sent = 1,
-    delivered = 2,
-    read = 3,
-    error = 4
-}
-/**
- * This is used for specifying the position of the title.
- */
-export declare enum TitleAlignment {
-    left = 0,
-    center = 1
-}
-/**
- * It is used to specify the mode of selection for the list of items.
- * It is used in components where there is a list of items involed, like users/groups etc.
- */
-export declare enum SelectionMode {
-    single = 0,
-    multiple = 1,
-    none = 2
-}
-/**
- * This is used to specify the states of the operation on the UI.
- * It has options like:
- * loading: to be used while waiting for a particular operation,
- * empty: when there is nothing to be displayed,
- * error: when an error occurs in the operation, and
- * loaded: when the operation is completed.
- */
-export declare enum States {
-    loading = 0,
-    empty = 1,
-    error = 2,
-    loaded = 3
-}
-/**
- * This is used to specify the position for the time-stamp.
- * It is used in CometChatMessageList component.
- */
-export declare enum TimestampAlignment {
-    top = 0,
-    bottom = 1
-}
-/**
- * This is used to specify the alignment for the icon button.
- * It is used in CometChatTabs, CometChatOutgoingCall components.
- */
-export declare enum IconButtonAlignment {
-    top = "column",
-    bottom = "column-reverse",
-    left = "row",
-    right = "row-reverse"
-}
-/**
- * It is used to specify the type for the recording.
- * It is used in CometChatMessageComposer component.
- */
-export declare enum RecordingType {
-    audio = 0,
-    video = 1
-}
-/**
- * It is used to specify which tabs should be visible amongst user and group.
- * It is used in CometChatContacts component.
- */
-export declare enum TabsVisibility {
-    usersAndGroups = 0,
-    users = 1,
-    groups = 2
-}
-/**
- * This is used to specify the type of the call.
- * It is used in CometChatCallLogs, CometChatOngoingCall components.
- */
-export declare enum CallWorkflow {
-    defaultCalling = 0,
-    directCalling = 1
-}
-/**
- * This is used to provide the alignment for the panel.
- * It is used in CometChatMessageList component and AI module components.
- */
-export declare enum PanelAlignment {
-    composerHeader = 0,
-    messageListHeader = 1,
-    messageListFooter = 2,
-    messages = 3
-}
-/**
- * It is used to provide the alignment for the labels.
- */
-export declare enum LabelAlignment {
-    top = "column",
-    bottom = "column-reverse",
-    left = "row",
-    right = "row-reverse"
-}
-/**
- * It is used to specify the type of the UI element.
- * It is used in modal components.
- */
-export declare enum ElementType {
-    label = "label",
-    text = "textInput",
-    dropdown = "dropdown",
-    checkbox = "checkbox",
-    radio = "radio",
-    button = "button",
-    singleSelect = "singleSelect",
-    dateTime = "dateTime"
-}
-/**
- * It is used to specify what action a button should perform.
- * It is used in InteractiveMessageUtils function and in modal components.
- */
-export declare enum ButtonAction {
-    apiAction = "apiAction",
-    urlNavigation = "urlNavigation",
-    custom = "custom"
-}
-/**
- * It is used to specify the type of the http request call.
- * It is used in InteractiveMessageUtils function and APIAction inside modals.
- */
-export declare enum HTTPSRequestMethods {
-    POST = "POST",
-    PUT = "PUT",
-    PATCH = "PATCH",
-    DELETE = "DELETE"
-}
-/**
- * It is used to select the mode for date time picker component.
- * It is used in DateTimePickerElement component.
- */
-export declare enum DateTimePickerMode {
-    date = "date",
-    dateTime = "dateTime",
-    time = "time"
-}
-/**
- * It is used for specifying the type of user/members list.
- * It is used in CometChatMessageComposer and CometChatUserMemberWrapper components.
- */
-export declare enum UserMemberListType {
-    users = 0,
-    groupmembers = 1
-}
-/**
- * This is used to specify the source for mouse event with mentions information.
- * It is used in CometChatMentionsFormatter util.
- */
-export declare enum MouseEventSource {
-    mentions = 0
-}
-/**
- * It is used to describe the mode for previewing message.
- * It is used in CometChatMessageComposer component.
- */
-export declare enum PreviewMessageMode {
-    edit = 0,
-    none = 1
-}
-/**
- * It is generally used for formatting the text by providing the required data.
- * It is used in CometChatConversations, CometChatTextFormatter and CometChatMentionsFormatter.
- */
-export declare enum MentionsTargetElement {
-    textinput = 0,
-    textbubble = 1,
-    conversation = 2
-}
-/**
- * It is used for providing the value for the mentions visibility.
- * It is used in CometChatMentionsFormatter component.
- */
-export declare enum MentionsVisibility {
-    usersConversationOnly = 0,
-    groupConversationOnly = 1,
-    both = 2
-}

package/dist/types/src/components/AI/AIBaseConfiguration.d.ts

@@ -1,51 +0,0 @@
-/// <reference types="react" />
-/**
- * AIBaseConfiguration is a base configuration class that provides options for customizing the appearance and behavior of AI-related components.
- */
-export declare class AIBaseConfiguration {
-    /**
-     * Overrides the default API configuration for fetching data.
-     * @param {CometChat.User} [user] - The user object.
-     * @param {CometChat.Group} [group] - The group object.
-     * @returns {Promise<Object>} A promise resolving to a custom configuration object.
-     */
-    apiConfiguration?: (user?: CometChat.User, group?: CometChat.Group) => Promise<Object>;
-    /**
-     * Custom view component for displaying the error state.
-     * @type {any}
-     */
-    errorStateView?: JSX.Element;
-    /**
-     * Custom view component for displaying the empty state.
-     * @type {any}
-     */
-    emptyStateView?: JSX.Element;
-    /**
-     * Custom view component for displaying the loading state.
-     * @type {any}
-     */
-    loadingStateView?: JSX.Element;
-    /**
-     * URL for the loading icon.
-     * @type {string}
-     * @default loadingIcon
-     */
-    loadingIconURL?: string;
-    /**
-     * URL for the error icon.
-     * @type {string}
-     * @default errorIcon
-     */
-    errorIconURL?: string;
-    /**
-     * URL for the empty state icon.
-     * @type {string}
-     * @default emptyIcon
-     */
-    emptyIconURL?: string;
-    /**
-     * Constructs a new AIBaseConfiguration instance.
-     * @param {Partial<AIBaseConfiguration>} props - Partial properties to customize the base configuration.
-     */
-    constructor(props: Partial<AIBaseConfiguration>);
-}

package/dist/types/src/components/AI/AIConversationStarter/AIConversationStarterConfiguration.d.ts

@@ -1,20 +0,0 @@
-/// <reference types="react" />
-import { AIBaseConfiguration } from "../AIBaseConfiguration";
-/**
- * AIConversationStarterConfiguration provides customization options for the AI conversation starter view.
- * Extends the base configuration with additional properties specific to conversation starters.
- */
-export declare class AIConversationStarterConfiguration extends AIBaseConfiguration {
-    /**
-     * Custom callback to display a custom UI for conversation starters.
-     * @param {string[]} response - The list of conversation starters.
-     * @param {() => void} [closeCallBack] - Optional callback to close the custom view.
-     * @returns {Promise<JSX.Element>} A promise resolving to a custom view component.
-     */
-    customView?: (response: string[], closeCallBack?: () => void) => Promise<JSX.Element>;
-    /**
-     * Constructs a new AIConversationStarterConfiguration instance.
-     * @param {Partial<AIConversationStarterConfiguration>} props - Partial properties to customize the conversation starter configuration.
-     */
-    constructor(props: Partial<AIConversationStarterConfiguration>);
-}

package/dist/types/src/components/AI/AIConversationStarter/AIConversationStarterDecorator.d.ts

@@ -1,18 +0,0 @@
-import { DataSource } from "../../../utils/DataSource";
-import { DataSourceDecorator } from "../../../utils/DataSourceDecorator";
-import { AIConversationStarterConfiguration } from "./AIConversationStarterConfiguration";
-export declare class AIConversationStarterDecorator extends DataSourceDecorator {
-    configuration?: AIConversationStarterConfiguration;
-    newDataSource: DataSource;
-    currentMessage: CometChat.BaseMessage | null;
-    loggedInUser: CometChat.User | null;
-    user: CometChat.User;
-    group: CometChat.Group;
-    constructor(dataSource: DataSource, configuration?: AIConversationStarterConfiguration);
-    getId(): string;
-    editReply(reply: string): void;
-    closeIfMessageReceived(message: CometChat.BaseMessage): void;
-    getConversationStarter: () => Promise<string[]>;
-    private loadConversationStarter;
-    private addMessageListener;
-}

package/dist/types/src/components/AI/AIConversationStarter/AIConversationStarterExtension.d.ts

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

package/dist/types/src/components/AI/AIConversationStarter/AIConversationStarterView.d.ts

@@ -1,8 +0,0 @@
-import { AIConversationStarterConfiguration } from './AIConversationStarterConfiguration';
-interface IAIConversationStarterProps {
-    getConversationStarterCallback?: () => Promise<string[]>;
-    editReplyCallback?: (reply: string) => void;
-    configuration?: AIConversationStarterConfiguration;
-}
-declare const AIConversationStarterView: (props: IAIConversationStarterProps) => import("react/jsx-runtime").JSX.Element;
-export { AIConversationStarterView };

package/dist/types/src/components/AI/AIConversationSummary/AIConversationSummaryConfiguration.d.ts

@@ -1,31 +0,0 @@
-import { AIBaseConfiguration } from "../AIBaseConfiguration";
-/**
- * AIConversationSummaryConfiguration provides customization options for the AI conversation summary view.
- * Extends the base configuration with additional properties specific to conversation summaries.
- */
-export declare class AIConversationSummaryConfiguration extends AIBaseConfiguration {
-    /**
-     * Custom callback to display a custom UI for conversation summaries.
-     * @param {string} response - The conversation summary response.
-     * @param {() => void} [closeCallBack] - Optional callback to close the custom view.
-     * @returns {Promise<any>} A promise resolving to a custom view component.
-     */
-    customView?: (response: string, closeCallBack?: () => void) => Promise<any>;
-    /**
-     * The threshold for the number of unread messages required to generate a conversation summary.
-     * @type {number}
-     * @default 30
-     */
-    unreadMessageThreshold?: number;
-    /**
-     * URL for the custom close button icon.
-     * @type {string}
-     * @default closeIcon
-     */
-    closeIconURL?: string;
-    /**
-     * Constructs a new AIConversationSummaryConfiguration instance.
-     * @param {Partial<AIConversationSummaryConfiguration>} props - Partial properties to customize the conversation summary configuration.
-     */
-    constructor(props: Partial<AIConversationSummaryConfiguration>);
-}