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

package/dist/types/src/components/CometChatMessageInformation/CometChatMessageInformation.d.ts

@@ -0,0 +1,6 @@
+interface MessageInformationProps {
+    message: CometChat.BaseMessage;
+    onClose?: () => void;
+}
+declare const CometChatMessageInformation: (props: MessageInformationProps) => import("react/jsx-runtime").JSX.Element;
+export { CometChatMessageInformation };

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

@@ -0,0 +1,132 @@
+/// <reference types="react" />
+import { CometChatMessageTemplate } from "../../modals";
+import { DatePatterns, MessageListAlignment } from "../../Enums/Enums";
+import { CometChatTextFormatter } from "../../formatters/CometChatFormatters/CometChatTextFormatter";
+/**
+ * Props for the MessageList component.
+ */
+interface MessageListProps {
+    /**
+     * Unique identifier of the parent message for displaying threaded conversations.
+     */
+    parentMessageId?: number;
+    /**
+     * CometChat User object, representing the participant of the chat whose details are displayed.
+     */
+    user?: CometChat.User;
+    /**
+     * CometChat Group object, representing the group whose chat messages are displayed.
+     */
+    group?: CometChat.Group;
+    /**
+     * Custom empty state view to display when there are no messages.
+     */
+    emptyStateView?: JSX.Element;
+    /**
+     * Custom error state view to display when an error occurs while retrieving messages.
+     */
+    errorStateView?: JSX.Element;
+    /**
+     * Custom loading state view to display while messages are being fetched.
+     */
+    loadingStateView?: JSX.Element;
+    /**
+     * Boolean to toggle visibility of read receipts in the message list.
+     * @default false
+     */
+    hideReceipt?: boolean;
+    /**
+     * Specifies the alignment of the messages in the list (left, right, etc.).
+     * @default 'standard'
+     */
+    alignment?: MessageListAlignment;
+    /**
+     * User-defined date format for the message timestamp.
+     */
+    datePattern?: DatePatterns;
+    /**
+     * User-defined date format for the separators between dates in the message list.
+     */
+    DateSeparatorPattern?: DatePatterns;
+    /**
+     * Boolean to toggle visibility of the date separator in the message list.
+     * @default false
+     */
+    hideDateSeparator?: boolean;
+    /**
+     * Array of message templates to define how various types of messages (e.g., text, image, video) should be displayed.
+     */
+    templates?: CometChatMessageTemplate[];
+    /**
+     * Instance of the CometChat MessagesRequestBuilder for building the request to fetch messages.
+     */
+    messagesRequestBuilder?: CometChat.MessagesRequestBuilder;
+    /**
+     * Text to display as a new message indicator.
+     */
+    newMessageIndicatorText?: string;
+    /**
+     * Boolean to indicate whether the message list should scroll to the bottom when a new message arrives.
+     * @default false
+     */
+    scrollToBottomOnNewMessages?: boolean;
+    /**
+     * Threshold value for triggering certain actions (e.g., loading more messages) as the user scrolls.
+     */
+    thresholdValue?: number;
+    /**
+     * Callback function that is triggered when the user clicks on a thread reply.
+     * @param parentMessageId - The ID of the parent message to which replies belong.
+     */
+    onThreadRepliesClick?: Function;
+    /**
+     * Custom header view component for the message list.
+     */
+    headerView?: JSX.Element;
+    /**
+     * Custom footer view component for the message list.
+     */
+    footerView?: JSX.Element;
+    /**
+     * Callback triggered when an error occurs during the message fetching process.
+     * @param error - CometChatException object representing the error.
+     */
+    onError?: ((error: CometChat.CometChatException) => void) | null;
+    /**
+     * Boolean to hide or show errors in the message list.
+     * @default false
+     */
+    hideError?: boolean;
+    /**
+     * Instance of the CometChat ReactionsRequestBuilder for managing message reactions.
+     */
+    reactionsRequestBuilder?: CometChat.ReactionsRequestBuilder;
+    /**
+     * Callback function that triggers when a reaction is clicked.
+     * @param reaction - The reaction object.
+     * @param message - The message associated with the reaction.
+     */
+    onReactionClick?: (reaction: CometChat.ReactionCount, message: CometChat.BaseMessage) => void;
+    /**
+     * Callback function that triggers when an item in the reaction list is clicked.
+     * @param reaction - The reaction object.
+     * @param message - The message associated with the reaction.
+     */
+    onReactionListItemClick?: (reaction: CometChat.Reaction, message: CometChat.BaseMessage) => void;
+    /**
+     * Boolean to disable message reactions.
+     * @default false
+     */
+    disableReactions?: boolean;
+    /**
+     * Boolean to disable mentions in text messages.
+     * @default false
+     */
+    disableMentions?: boolean;
+    /**
+     * Array of text formatters for custom styling or formatting of text bubbles.
+     */
+    textFormatters?: CometChatTextFormatter[];
+}
+declare const CometChatMessageList: (props: MessageListProps) => import("react/jsx-runtime").JSX.Element;
+export { CometChatMessageList };

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

@@ -0,0 +1,48 @@
+/**
+The MessageListManager is  responsible for controlling chat operations like fetching messages and managing listener lifecycles. It  attaches listeners for group and call activities for a particular user or group, which are activated when the chat is open and deactivated when it's closed or when switching to a new chat.
+In addition, it supports real-time connection monitoring by attaching an SDK websocket listener to the chat session.
+*/
+export declare class MessageListManager {
+    messagesRequest: CometChat.MessagesRequest | null;
+    static groupListenerId: string;
+    static callListenerId: string;
+    static connectionListenerId: string;
+    /**
+     * Creates an instance of MessageListManager which constructs a request builder for fetching messages from a particular user/group in the chat.
+     * @param {CometChat.MessagesRequestBuilder} [messagesRequestBuilder]
+     * @param {CometChat.User} [user]
+     * @param {CometChat.Group} [group]
+     * @param {number} [messageId]
+     * @param {number} [parentMessageId]
+     * @memberof MessageListManager
+     */
+    constructor(messagesRequestBuilder?: CometChat.MessagesRequestBuilder, user?: CometChat.User, group?: CometChat.Group, messageId?: number, parentMessageId?: number);
+    /**
+     * Function to invoke the fetchNext method of the messagesRequestBuilder to retrieve the subsequent messages following the latest fetched message.
+     *
+     * @returns {Promise}
+     */
+    fetchNextMessages: () => Promise<CometChat.BaseMessage[] | []> | undefined;
+    /**
+    * Function to invoke the fetchPrevious method of the messagesRequestBuilder to retrieve the subsequent messages following the last fetched message.
+    *
+    * @returns {Promise}
+    */
+    fetchPreviousMessages: () => Promise<CometChat.BaseMessage[] | []> | undefined;
+    /**
+     * Function to attach the group and call listeners for a particular user/group. This listener is attached when the chat is opened and is removed once the chat is closed or when switching to a new chat, where it creates a new listener for the particular chat.
+     *
+     * @param {Function} callback
+     */
+    static attachListeners: (callback: (key: string, mesage: CometChat.BaseMessage, group?: CometChat.Group) => void) => void;
+    /**
+     * Function to remove the attached listeners for a particular user/group.
+     *  */
+    static removeListeners(): void;
+    /**
+* Attaches an SDK websocket listener to monitor when the connection disconnects or reconnects.
+*
+* @returns - Function to remove the added SDK websocket listener
+*/
+    static attachConnectionListener(callback: () => void): void;
+}

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

@@ -0,0 +1,6 @@
+import { MutableRefObject } from "react";
+/**
+ * This Hooks function is a custom React hook designed to manage  functionalities of CometChatMessageList component. It fetches the logged-in user, handles event subscriptions and tracks message IDs for new message retrieval. It plays a key role in maintaining real-time functionality and user interactions in the chat interface.
+ **/
+declare function useCometChatMessageList(loggedInUserRef: MutableRefObject<CometChat.User | null>, messageListManagerRef: MutableRefObject<any>, fetchPreviousMessages: () => void, updateMessage: (key: string, mesage: CometChat.BaseMessage, group?: CometChat.Group) => void, messagesRequestBuilder: CometChat.MessagesRequestBuilder | undefined, user: CometChat.User | undefined, group: CometChat.Group | undefined, messageIdRef: MutableRefObject<any>, totalMessagesCountRef: MutableRefObject<any>, messageList: CometChat.BaseMessage[], onErrorCallback: (error: CometChat.CometChatException) => void, setMessageList: (messages: CometChat.BaseMessage[]) => void, setScrollListToBottom: (scrollToBottom: boolean) => void, smartReplyViewRef: MutableRefObject<any>, isOnBottomRef: MutableRefObject<boolean>, isFirstReloadRef: MutableRefObject<boolean>, subscribeToUIEvents: Function, setDateHeader?: Function, parentMessageId?: number): void;
+export { useCometChatMessageList };

package/dist/types/src/components/CometChatThreadedMessagePreview/CometChatThreadedMessagePreview.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="react" />
+import { CometChatMessageTemplate } from "../../modals";
+interface ThreadedMessagePreviewProps {
+    title?: string;
+    parentMessage: CometChat.BaseMessage;
+    template?: CometChatMessageTemplate;
+    bubbleView?: (messageObject: CometChat.BaseMessage) => void | JSX.Element;
+    onClose?: () => void;
+}
+declare const CometChatThreadedMessagePreview: (props: ThreadedMessagePreviewProps) => import("react/jsx-runtime").JSX.Element;
+export { CometChatThreadedMessagePreview };

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

@@ -0,0 +1,21 @@
+import { CSSProperties } from 'react';
+import { UserMemberListType } from '../../Enums/Enums';
+export interface MentionsProps {
+    userMemberListType?: UserMemberListType;
+    onItemClick?: (user: CometChat.User | CometChat.GroupMember) => void;
+    listItemView?: (item?: CometChat.User | CometChat.GroupMember) => JSX.Element;
+    statusIndicatorStyle?: CSSProperties;
+    searchKeyword?: string;
+    group?: CometChat.Group;
+    subtitleView?: (item?: CometChat.User | CometChat.GroupMember) => JSX.Element;
+    usersRequestBuilder?: CometChat.UsersRequestBuilder;
+    disableUsersPresence?: boolean;
+    hideSeparator?: boolean;
+    loadingStateView?: JSX.Element;
+    onEmpty?: () => void;
+    groupMemberRequestBuilder?: CometChat.GroupMembersRequestBuilder;
+    loadingIconUrl?: string;
+    disableLoadingState?: boolean;
+    onError?: () => void;
+}
+export declare function CometChatUserMemberWrapper(props: MentionsProps): import("react/jsx-runtime").JSX.Element;

package/dist/types/{CometChatAddMembers/index.d.ts → src/components/CometChatUsers/CometChatUsers.d.ts}

@@ -1,61 +1,34 @@
-import { AddMembersStyle } from "@cometchat/uikit-shared";
-import { AvatarStyle, ListItemStyle } from "@cometchat/uikit-elements";
-import { CSSProperties, JSX } from "react";
-import { CometChatOption, SelectionMode, TitleAlignment } from "@cometchat/uikit-resources";
-interface IAddMembersProps {
-    /**
-     * Image URL for the back button
-     *
-     * @remarks
-     * This prop will also be used if `backButton` prop is not provided
-     *
-     * @defaultValue `./assets/backbutton.svg`
-     */
-    backButtonIconURL?: string;
-    /**
-     * Show back button
-     *
-     * @defaultValue `true`
-     */
-    showBackButton?: boolean;
-    /**
-     * Function to call when the back button is clicked
-     */
-    onBack?: () => void;
+import { JSX } from "react";
+import { UsersManager } from "./controller";
+import { SelectionMode, States } from "../../Enums/Enums";
+import { CometChatOption } from "../../modals/CometChatOption";
+export interface UsersProps {
     /**
      * Title of the component
      *
-     * @defaultValue `localize("ADD_MEMBERS")`
-    */
-    title?: string;
-    /**
-     * Alignment of the `title` text
-     *
-     * @defaultValue `TitleAlignment.center`
+     * @defaultValue `localize("USERS")`
      */
-    titleAlignment?: TitleAlignment;
+    title?: string;
     /**
      * Hide the search bar
      *
-     * @defaulValue `false`
+     * @defaultValue `false`
      */
     hideSearch?: boolean;
-    /**
-     * Image URL for the search icon to use in the search bar
-     *
-     * @defaultValue `./assets/search.svg`
-     */
-    searchIconURL?: string;
     /**
      * Text to be displayed when the search input has no value
      *
      * @defaultValue `localize("SEARCH")`
      */
-    searchPlaceholder?: string;
+    searchPlaceholderText?: string;
+    /**
+     * Custom list item view to be rendered for each user in the fetched list
+     */
+    listItemView?: (user: CometChat.User) => JSX.Element;
     /**
      * Show alphabetical header
      *
-     * @defaultValue `false`
+     * @defaultValue `true`
      */
     showSectionHeader?: boolean;
     /**
@@ -66,46 +39,35 @@ interface IAddMembersProps {
      *
      * @defaultValue `getName`
      */
-    sectionHeaderField?: keyof CometChat.User;
-    /**
-     * Image URL for the default loading view
-     *
-     * @defaultValue `./assets/spinner.svg`
-     */
-    loadingIconURL?: string;
+    sectionHeaderKey?: keyof CometChat.User;
     /**
      * Custom view for the loading state of the component
      */
     loadingStateView?: JSX.Element;
     /**
-     * Text to display in the default empty view
+     * Hide error view
      *
-     * @defaultValue `localize("NO_USERS_FOUND")`
-     */
-    emptyStateText?: string;
-    /**
-     * Custom view for the empty state of the component
-     */
-    emptyStateView?: JSX.Element;
-    /**
-     * Text to display in the default error view
+     * @remarks
+     * If set to true, hides the default and the custom error view
      *
-     * @defaultValue `localize("SOMETHING_WRONG")`
+     * @defaultValue `false`
      */
-    errorStateText?: string;
+    hideError?: boolean;
     /**
      * Custom view for the error state of the component
      */
     errorStateView?: JSX.Element;
     /**
-     * Hide error view
+     * Custom view for the empty state of the component
+     */
+    emptyStateView?: JSX.Element;
+    /**
+     * Custom subtitle view to be rendered for each user in the fetched list
      *
      * @remarks
-     * If set to true, hides the default and the custom error view
-     *
-     * @defaultValue `false`
+     * This prop is used if `listItemView` prop is not provided
      */
-    hideError?: boolean;
+    subtitleView?: (user: CometChat.User) => JSX.Element;
     /**
      * Hide user presence
      *
@@ -115,20 +77,10 @@ interface IAddMembersProps {
      * @defaultValue `false`
      */
     disableUsersPresence?: boolean;
-    /**
-     * Hide the separator at the bottom of the default list item view
-     *
-     * @defaultValue `false`
-     */
-    hideSeparator?: boolean;
-    /**
-     * Function to call whenever the component encounters an error
-     */
-    onError?: ((error: CometChat.CometChatException) => void) | null;
     /**
      * Custom view to render on the top-right of the component
      */
-    menus?: JSX.Element;
+    menu?: JSX.Element;
     /**
      * List of actions available on mouse over on the default list item component
      */
@@ -139,7 +91,7 @@ interface IAddMembersProps {
      * @remarks
      * This prop is used if `listItemView` prop is not provided.
      *
-     * @defaultValue `SelectionMode.multiple`
+     * @defaultValue `SelectionMode.none`
      */
     selectionMode?: SelectionMode;
     /**
@@ -148,7 +100,7 @@ interface IAddMembersProps {
      * @remarks
      * This prop is used if `selectionMode` prop is not `SelectionMode.none`
      */
-    onSelect?: (user: CometChat.User, selected: boolean) => void;
+    onSelect?: (users: CometChat.User, selected: boolean) => void;
     /**
      * Request builder to fetch users
      *
@@ -168,62 +120,74 @@ interface IAddMembersProps {
      */
     searchRequestBuilder?: CometChat.UsersRequestBuilder;
     /**
-     * Custom list item view to be rendered for each user in the fetched list
-     */
-    listItemView?: (user: CometChat.User) => JSX.Element;
-    /**
-     * Custom subtitle view to be rendered for each user in the fetched list
-     *
-     * @remarks
-     * This prop is used if `listItemView` prop is not provided
+     * Function to call on click of the default list item view of a user
      */
-    subtitleView?: (user: CometChat.User) => JSX.Element;
+    onItemClick?: (user: CometChat.User) => void;
     /**
-     * Group to add members to
+     * Function to call whenever the component encounters an error
      */
-    group: CometChat.Group;
+    onError?: ((error: CometChat.CometChatException) => void) | null;
     /**
-     * Function to call when add button of the component is clicked
+     * User to highlight
      *
      * @remarks
-     * This function won't be call if no users are selected
-     */
-    onAddMembersButtonClick?: (guid: string, membersToAdd: CometChat.GroupMember[]) => void;
-    /**
-     * Text to display for the default add button
-     *
-     * @defaultValue `localize("ADD_MEMBERS")`
+     * This prop is used if `listItemView` prop is not provided
      */
-    buttonText?: string;
+    activeUser?: CometChat.User;
     /**
-     * Image URL for the close button
+     * Search keyword to filter the list of users.
      *
-     * @defaultValue `./assets/close2x.svg`
-     */
-    closeButtonIconURL?: string;
-    /**
-     * Function to call when the close button is clicked
+     * @defaultValue `""`
      */
-    onClose?: () => void;
+    searchKeyword?: string;
     /**
-     * Styles to apply to the status indicator component of the default list item view
+     * Callback function to be executed when the user list is empty.
      */
-    statusIndicatorStyle?: CSSProperties;
+    onEmpty?: () => void;
     /**
-     * Styles to apply to the avatar component of the default list item view
-     */
-    avatarStyle?: AvatarStyle;
-    /**
-     * Styles to apply to the default list item view
+     * Flag to indicate whether users are currently being fetched.
+     *
+     * @defaultValue `false`
      */
-    listItemStyle?: ListItemStyle;
+    fetchingUsers?: boolean;
     /**
-     * Styles to apply to this component
+     * Flag to indicate whether to disable loading state while fetching users.
+     * @defaultValue `false`
      */
-    addMembersStyle?: AddMembersStyle;
+    disableLoadingState?: boolean;
 }
+type State = {
+    searchText: string;
+    userList: CometChat.User[];
+    fetchState: States;
+    isFirstReload: boolean;
+    fetchingUsers: boolean;
+    disableLoadingState: boolean;
+};
+export type Action = {
+    type: "setSearchText";
+    searchText: State["searchText"];
+} | {
+    type: "appendUsers";
+    users: CometChat.User[];
+    removeOldUsers?: boolean;
+    usersManager?: UsersManager | null;
+    onEmpty?: () => void;
+} | {
+    type: "setFetchState";
+    fetchState: States;
+} | {
+    type: "setUserList";
+    userList: CometChat.User[];
+} | {
+    type: "updateUser";
+    user: CometChat.User;
+} | {
+    type: "setIsFirstReload";
+    isFirstReload: boolean;
+};
 /**
- * Renders a scrollable list of users to add to a group of a CometChat App
+ * Renders a scrollable list of users that has been created in a CometChat app
  */
-export declare function CometChatAddMembers(props: IAddMembersProps): import("react/jsx-runtime").JSX.Element;
+export declare function CometChatUsers(props: UsersProps): import("react/jsx-runtime").JSX.Element;
 export {};

package/dist/types/src/components/CometChatUsers/controller.d.ts

@@ -0,0 +1,28 @@
+/// <reference types="react" />
+type Args = {
+    searchText: string;
+    usersRequestBuilder: CometChat.UsersRequestBuilder | null;
+    searchRequestBuilder: CometChat.UsersRequestBuilder | null;
+    usersSearchText: React.MutableRefObject<string>;
+};
+export declare class UsersManager {
+    private usersRequest;
+    private static defaultLimit;
+    /**
+     * Set `usersRequest` of the instance
+     */
+    constructor(args: Args);
+    private getDefaultRequestBuilder;
+    /**
+     * Calls `fetchNext` method of the set `usersRequest`
+     */
+    fetchNext(): Promise<[] | import("@cometchat/chat-sdk-javascript").User[]>;
+    getCurrentPage(): number;
+    /**
+* Attaches an SDK websocket  listener
+*
+* @returns - Function to remove the added SDK websocket listener
+*/
+    static attachConnestionListener(callback: () => void): () => void;
+}
+export {};

package/dist/types/src/components/CometChatUsers/useCometChatUsers.d.ts

@@ -0,0 +1,19 @@
+import React from "react";
+import { Action } from "./CometChatUsers";
+import { UsersManager } from "./controller";
+type Args = {
+    usersManagerRef: React.MutableRefObject<UsersManager | null>;
+    fetchNextAndAppendUsers: (fetchId: string) => Promise<void>;
+    searchText: string;
+    usersRequestBuilder: CometChat.UsersRequestBuilder | null;
+    searchRequestBuilder: CometChat.UsersRequestBuilder | null;
+    dispatch: React.Dispatch<Action>;
+    updateUser: (user: CometChat.User) => void;
+    fetchNextIdRef: React.MutableRefObject<string>;
+    searchKeyword: string;
+    disableLoadingState: boolean;
+    usersSearchText: React.MutableRefObject<string>;
+    disableUsersPresence: boolean;
+};
+export declare function useCometChatUsers(args: Args): void;
+export {};

package/dist/types/src/components/Extensions/CollaborativeDocument/CollaborativeDocumentConfiguration.d.ts

@@ -0,0 +1,35 @@
+/**
+ * Configuration class for collaborative document settings.
+ *
+ * This class encapsulates the configuration required for rendering document bubbles
+ * and options in the collaborative document feature.
+ */
+export declare class CollaborativeDocumentConfiguration {
+    private iconURL;
+    private optionIconURL;
+    /**
+    * Constructs a CollaborativeDocumentConfiguration instance.
+    *
+    * @param configuration - An object containing optional configuration properties.
+    * @param configuration.style - Custom styling for the document bubble.
+    * @param configuration.iconURL - URL for the document icon.
+    * @param configuration.optionIconURL - URL for the options icon.
+    * @param configuration.optionStyle - Custom styling for the options.
+    */
+    constructor(configuration: {
+        iconURL?: string;
+        optionIconURL?: string;
+    });
+    /**
+     * Retrieves the URL for the document icon.
+     *
+     * @returns The icon URL as a string.
+     */
+    getIconURL(): string;
+    /**
+     * Retrieves the URL for the options icon.
+     *
+     * @returns The options icon URL as a string.
+     */
+    getOptionIconURL(): string;
+}

package/dist/types/src/components/Extensions/CollaborativeDocument/CollaborativeDocumentConstants.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Constants used for collaborative document operations.
+ *
+ * This frozen object contains various string constants used throughout
+ * the collaborative document feature, ensuring consistent usage across the codebase.
+ */
+export declare const CollaborativeDocumentConstants: Readonly<{
+    v1_create: "v1/create";
+    extension_document: "extension_document";
+    document: "document";
+    extensions: "extensions";
+    metadata: "metadata";
+    injected: "@injected";
+    post: "POST";
+}>;

package/dist/types/src/components/Extensions/CollaborativeDocument/CollaborativeDocumentExtension.d.ts

@@ -0,0 +1,37 @@
+import { ExtensionsDataSource } from "../ExtensionsDataSource";
+import { CollaborativeDocumentConfiguration } from "./CollaborativeDocumentConfiguration";
+/**
+ * Class representing the Collaborative Document Extension.
+ *
+ * This extension is responsible for enabling collaborative document features within the chat application.
+ * It extends the `ExtensionsDataSource` class and utilizes a configuration to customize its behavior.
+ */
+export declare class CollaborativeDocumentExtension extends ExtensionsDataSource {
+    /** @private Configuration for the collaborative document extension. */
+    private configuration?;
+    /**
+     * Constructs a new CollaborativeDocumentExtension.
+     *
+     * @param {CollaborativeDocumentConfiguration} [configuration] - The configuration for customizing the collaborative document extension.
+     */
+    constructor(configuration?: CollaborativeDocumentConfiguration);
+    /**
+     * Adds the collaborative document extension to the chat configurator.
+     *
+     * This method overrides the `addExtension` method from `ExtensionsDataSource` and enables the collaborative document feature
+     * by creating a new `CollaborativeDocumentExtensionDecorator`.
+     *
+     * @override
+     */
+    addExtension(): void;
+    /**
+     * Retrieves the extension ID for the collaborative document extension.
+     *
+     * This method overrides the `getExtensionId` method from `ExtensionsDataSource`
+     * and returns the unique ID associated with the collaborative document extension.
+     *
+     * @returns {string} The unique ID of the collaborative document extension.
+     * @override
+     */
+    getExtensionId(): string;
+}