@box/threaded-annotations 1.80.0

package/dist/types/index.d.ts

@@ -0,0 +1,9 @@
+export * from './lib/components/text-message/types';
+export * from './lib/document-node-types';
+export * from './lib/threaded-annotations';
+export { MentionContextProvider, useMentionContext, type MentionContextData, type MentionContextProviderProps, } from './lib/components/mention-component/mention-context';
+export { MessageEditor as MessageEditorV2, type MessageEditorProps as MessageEditorPropsV2, } from './lib/components/v2/message-editor/message-editor';
+export { ThreadedAnnotations as ThreadedAnnotationsV2, type ThreadedAnnotationsProps as ThreadedAnnotationsPropsV2, } from './lib/v2/threaded-annotations';
+export { type DocumentNode as DocumentNodeV2, type EditorMentionAttributes as EditorMentionAttributesV2, type MentionNode as MentionNodeV2, type MentionRenderAttributes as MentionRenderAttributesV2, type ParagraphNode as ParagraphNodeV2, type TextNode as TextNodeV2, } from './lib/v2/types/document-node-types';
+export { type Permissions, type TextMessageAuthorType as TextMessageAuthorTypeV2, type TextMessageType as TextMessageTypeV2, } from './lib/v2/types/message-types';
+export { serializeMentionMarkup } from './lib/v2/utils/serialize-mention-markup';

package/dist/types/lib/components/mention-component/mention-component.d.ts

@@ -0,0 +1,12 @@
+interface MentionComponentProps {
+    mentionedUserName: string;
+    mentionedUserId: string;
+    mentionedUserEmail?: string;
+    mentionId: string;
+    authorId?: string;
+}
+export declare const MentionComponent: {
+    ({ mentionedUserName, mentionedUserId, mentionedUserEmail, authorId, mentionId, }: MentionComponentProps): import("react/jsx-runtime").JSX.Element;
+    displayName: string;
+};
+export {};

package/dist/types/lib/components/mention-component/mention-context.d.ts

@@ -0,0 +1,31 @@
+import { CollaborationPopoverProps } from '@box/collaboration-popover';
+import { UserContactType } from '@box/user-selector';
+import { ReactNode } from 'react';
+export interface MentionContextData {
+    collaborationPopoverProps?: Omit<CollaborationPopoverProps, 'anchor' | 'userInfo'>;
+    getAvatarUrl?: (id: string) => string;
+    fetchCollaboratorState?: (user: UserContactType) => Promise<boolean>;
+    /**
+     * Lazily resolves a user's email by ID. Called during mention click
+     * when the mention doesn't already carry an email attribute.
+     */
+    fetchEmail?: (userId: string) => Promise<string>;
+    /**
+     * The ID of the user whose collaboration popover should be open, or null if none.
+     */
+    openPopoverMentionId?: string | null;
+    /**
+     * Opens the collaboration popover for a specific user if they are not a collaborator.
+     */
+    openPopoverForMentionId?: (mentionId: string, user: UserContactType) => Promise<void>;
+    /**
+     * Closes all open collaboration popovers.
+     */
+    closeAllPopovers?: () => void;
+}
+export interface MentionContextProviderProps {
+    value: MentionContextData;
+    children: ReactNode;
+}
+export declare const MentionContextProvider: ({ value, children }: MentionContextProviderProps) => import("react/jsx-runtime").JSX.Element;
+export declare const useMentionContext: () => MentionContextData;

package/dist/types/lib/components/message-editor/editor-extensions/custom-mention/custom-mention-suggestions.d.ts

@@ -0,0 +1,15 @@
+import { Editor } from '@tiptap/core';
+import { SuggestionKeyDownProps, SuggestionOptions, SuggestionProps } from '@tiptap/suggestion';
+import { EditorMentionAttributes } from '../../../../document-node-types';
+interface SuggestionRenderProps extends SuggestionProps {
+    command: (props: EditorMentionAttributes) => void;
+    editor: Editor;
+}
+export interface SuggestionCallbacks {
+    onSuggestionStart: (props: SuggestionRenderProps) => void;
+    onSuggestionUpdate: (props: SuggestionRenderProps) => void;
+    onSuggestionKeyDown: (props: SuggestionKeyDownProps) => boolean;
+    onSuggestionExit: () => void;
+}
+export declare const createSuggestionOptions: (pluginKeyName: string, char: string, callbacks: SuggestionCallbacks) => Omit<SuggestionOptions, "editor">;
+export {};

package/dist/types/lib/components/message-editor/editor-extensions/custom-mention/custom-mention.d.ts

@@ -0,0 +1 @@
+export declare const CustomMention: import('@tiptap/core').Node<import('@tiptap/extension-mention').MentionOptions, any>;

package/dist/types/lib/components/message-editor/editor-extensions/custom-mention/useMentionState.d.ts

@@ -0,0 +1,15 @@
+import { HeadlessUserSelectorHandle } from '@box/user-selector';
+import { MutableRefObject } from 'react';
+import { EditorMentionAttributes } from '../../../../document-node-types';
+import { SuggestionCallbacks } from './custom-mention-suggestions';
+export declare enum KeyEvents {
+    ARROW_DOWN = "ArrowDown",
+    ARROW_UP = "ArrowUp",
+    ENTER = "Enter"
+}
+export declare const useMentionState: (userSelectorRef: MutableRefObject<HeadlessUserSelectorHandle | null>) => {
+    isActive: boolean;
+    query: string;
+    command: (props: EditorMentionAttributes) => void;
+    suggestionCallbacks: SuggestionCallbacks;
+};

package/dist/types/lib/components/message-editor/editor-extensions/custom-paragraph.d.ts

@@ -0,0 +1 @@
+export declare const CustomParagraph: import('@tiptap/core').Node<import('@tiptap/extension-paragraph').ParagraphOptions, any>;

package/dist/types/lib/components/message-editor/editor-extensions/custom-placeholder/custom-placeholder-utils.d.ts

@@ -0,0 +1,38 @@
+import { Editor, JSONContent } from '@tiptap/core';
+export declare enum EditorContentType {
+    Placeholder = "placeholder"
+}
+/**
+ * Adds a placeholder to the editor content if the editor is empty and contains only one paragraph.
+ * @param editor - The TipTap editor instance
+ */
+export declare const addPlaceholderToContent: (editor: Editor) => void;
+/**
+ * Removes all nodes of a specific type from the editor content.
+ * @param editor - The TipTap editor instance
+ * @param nodeType - The type of content to remove from the editor
+ */
+export declare const deleteNode: (editor: Editor, nodeType: EditorContentType) => void;
+/**
+ * Recursively removes all content nodes of specified type(s) from JSON content.
+ * @param content - The JSON content to filter
+ * @param type - The content type(s) to remove (single type or array of types)
+ * @returns The filtered JSON content without the specified type(s)
+ */
+export declare const removeContentOfType: (content: JSONContent, type: EditorContentType | EditorContentType[]) => JSONContent;
+/**
+ * Recursively filters JSON content based on a predicate function.
+ * @param content - The JSON content to filter
+ * @param predicate - Function that returns true for content to keep, false to remove
+ * @returns The filtered JSON content
+ */
+export declare const filterContent: (content: JSONContent, predicate: (content: JSONContent) => boolean) => JSONContent;
+/**
+ * Extracts and flattens content from the editor, returning content items and paragraph count.
+ * @param editor - The TipTap editor instance
+ * @returns Object containing flattened content array and total paragraph count
+ */
+export declare const getEditorContent: (editor: Editor) => {
+    content: JSONContent[];
+    paragraphNumber: number;
+};

package/dist/types/lib/components/message-editor/editor-extensions/custom-placeholder/custom-placeholder.d.ts

@@ -0,0 +1,2 @@
+import { Node } from '@tiptap/core';
+export declare const CustomPlaceholder: Node<any, any>;

package/dist/types/lib/components/message-editor/error-message.d.ts

@@ -0,0 +1,3 @@
+export declare const ErrorMessage: ({ errorMessage }: {
+    errorMessage: string;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/types/lib/components/message-editor/hooks/useMessageEditor.d.ts

@@ -0,0 +1,12 @@
+import { HeadlessUserSelectorHandle, UserContactType } from '@box/user-selector';
+export declare const useMessageEditor: () => {
+    editor: import('@tiptap/react').Editor;
+    editorRef: import('react').MutableRefObject<HTMLElement>;
+    isEditorEmpty: boolean;
+    isActive: boolean;
+    query: string;
+    userSelectorRef: import('react').MutableRefObject<HeadlessUserSelectorHandle>;
+    cleanEditor: () => void;
+    getEditorJsonContent: () => import('@tiptap/core').JSONContent;
+    handleUserSelected: (user: UserContactType) => Promise<void>;
+};

package/dist/types/lib/components/message-editor/hooks/useMessagePost.d.ts

@@ -0,0 +1,18 @@
+import { JSONContent } from '@tiptap/react';
+import { TextMessageType } from '../../text-message/types';
+interface UseMessagePostProps {
+    onPost: (content: JSONContent | null) => Promise<TextMessageType | void> | TextMessageType | void;
+    onPostError?: (error: unknown) => string | undefined;
+    onPostSuccess?: (response: TextMessageType | void) => void;
+    defaultErrorMessage?: string | null;
+    cleanEditor: () => void;
+    getEditorJsonContent: () => JSONContent | null;
+    onCancel: (replyMode?: boolean) => void;
+}
+export declare const useMessagePost: ({ onPost, onPostError, onPostSuccess, defaultErrorMessage, cleanEditor, getEditorJsonContent, onCancel, }: UseMessagePostProps) => {
+    isLoading: boolean;
+    errorMessage: string;
+    handlePost: () => Promise<void>;
+    clearError: () => void;
+};
+export {};

package/dist/types/lib/components/message-editor/message-editor-actions.d.ts

@@ -0,0 +1,9 @@
+interface MessageEditorActionsProps {
+    onCancel: (replyMode?: boolean) => void;
+    onPost: () => void;
+    isLoading?: boolean;
+    disableCancel?: boolean;
+    disablePost?: boolean;
+}
+export declare const MessageEditorActions: ({ onCancel, onPost, isLoading, disableCancel, disablePost, }: MessageEditorActionsProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/lib/components/message-editor/message-editor-context.d.ts

@@ -0,0 +1,13 @@
+import { ReactNode } from 'react';
+export interface MessageEditorContextData {
+    /**
+     * The number of messages in the thread.
+     */
+    messageCount?: number;
+}
+export interface MessageEditorContextProviderProps {
+    value: MessageEditorContextData;
+    children: ReactNode;
+}
+export declare const MessageEditorContextProvider: ({ value, children }: MessageEditorContextProviderProps) => import("react/jsx-runtime").JSX.Element;
+export declare const useMessageEditorContext: () => MessageEditorContextData;

package/dist/types/lib/components/message-editor/message-editor.d.ts

@@ -0,0 +1,36 @@
+import { HeadlessUserSelectorProps } from '@box/user-selector';
+import { JSONContent } from '@tiptap/react';
+import { TextMessageType } from '../text-message/types';
+/**
+ * Defines the properties for the MessageEditor component.
+ */
+export interface MessageEditorProps {
+    /** The number of messages in the thread. Used for placeholder text. */
+    messageCount: number;
+    disableCancel?: boolean;
+    disablePost?: boolean;
+    disableComponent?: boolean;
+    /** A default error message to display that overrides callbackErrorMessage */
+    defaultErrorMessage?: string;
+    /** Properties for the user selector component from blueprint-web. */
+    userSelectorProps: Omit<HeadlessUserSelectorProps, 'inputElementRef' | 'onSelectedUserChange' | 'open' | 'rootElement' | 'value'>;
+    /**
+     * A callback function to be executed when the user posts a message.
+     * @param content The content of the message in JSON format or null.
+     * @returns A promise or synchronous function that adds new message to the thread.
+     */
+    onPost: (content: JSONContent | null) => Promise<TextMessageType | void> | TextMessageType | void;
+    /**
+     * An optional callback function to handle errors during the post operation.
+     * @param error The error object.
+     * @returns An optional error message string to be displayed.
+     */
+    onPostError?: (error: unknown) => string | undefined;
+    /**
+     * An optional callback function to be executed on a successful post.
+     * @param response The response from the post operation.
+     */
+    onPostSuccess?: (response: TextMessageType | void) => void;
+    onCancel: (replyMode?: boolean) => void;
+}
+export declare const MessageEditor: ({ messageCount, onPost, onCancel, onPostError, onPostSuccess, disableCancel, disablePost, disableComponent, defaultErrorMessage, userSelectorProps, }: MessageEditorProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/lib/components/message-editor/messages.d.ts

@@ -0,0 +1,53 @@
+declare const messages: {
+    postCancel: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    post: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    postLoading: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    placeholderPrefix: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    placeholderPrefixReply: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    placeholderSuffix: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    cancelButtonAriaLabel: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    postButtonAriaLabel: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    editorContentAriaLabel: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    placeholderAriaLabel: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+};
+export default messages;

package/dist/types/lib/components/message-editor/stories/shared.d.ts

@@ -0,0 +1,4 @@
+import { HeadlessUserSelectorProps } from '@box/user-selector';
+import { MessageEditorProps } from '../message-editor';
+export declare const defaultUserSelectorProps: Omit<HeadlessUserSelectorProps, 'inputElementRef' | 'onSelectedUserChange' | 'open' | 'rootElement' | 'value'>;
+export declare const DefaultMessageEditor: (props: MessageEditorProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/lib/components/message-editor/stories/utils/mock-props.d.ts

@@ -0,0 +1,4 @@
+import { createMockFetchAvatarUrls, createMockFetchUsers } from '../../../../stories/mock';
+export declare const mockOnPost: (content: import('@tiptap/core').JSONContent | null) => Promise<import('../../../text-message/types').TextMessageType>;
+export declare const mockOnPostWithError: () => Promise<never>;
+export { createMockFetchAvatarUrls, createMockFetchUsers };

package/dist/types/lib/components/message-editor/stories/utils/test-utils.d.ts

@@ -0,0 +1,2 @@
+import { within } from 'storybook/test';
+export declare const waitForPlaceholderToDisappear: (canvas: ReturnType<typeof within>) => Promise<void>;

package/dist/types/lib/components/message-editor/utils/getMessageEditorState.d.ts

@@ -0,0 +1,13 @@
+interface GetMessageEditorStateProps {
+    disablePost?: boolean;
+    disableCancel?: boolean;
+    disableComponent?: boolean;
+    isEditorEmpty: boolean;
+    isLoading: boolean;
+}
+export declare const getMessageEditorState: ({ disablePost, disableCancel, disableComponent, isEditorEmpty, isLoading, }: GetMessageEditorStateProps) => {
+    disableEditor: boolean;
+    isPostDisabled: boolean;
+    isCancelDisabled: boolean;
+};
+export {};

package/dist/types/lib/components/message-header/delete-annotations-message-popover.d.ts

@@ -0,0 +1,11 @@
+export interface DeletePopoverProps {
+    onDelete: () => void;
+    onOpenChange?: (isOpen: boolean) => void;
+}
+/**
+ * Renders a delete popover for an annotation message.
+ *
+ * This component is responsible for displaying a confirmation dialog when the user
+ * clicks the delete button on an annotation message.
+ */
+export declare const DeleteAnnotationMessagePopover: ({ onDelete, onOpenChange }: DeletePopoverProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/lib/components/message-header/message-header.d.ts

@@ -0,0 +1,18 @@
+import { TextMessageAuthorType } from '../text-message/types';
+export interface MessageHeaderProps {
+    /** The author whose avatar and name are displayed in the header. */
+    author: TextMessageAuthorType;
+    /** Unix timestamp (in ms) for when the message was created. */
+    createdAt: number;
+    /** Whether the current user is allowed to delete this message. */
+    isDeleteAllowed?: boolean;
+    /** Callback invoked when the user clicks the author avatar. */
+    onAvatarClick: (id: number) => void;
+    /** Callback invoked when the user confirms message deletion. */
+    onDelete: () => void;
+}
+/**
+ * Renders the header section of a threaded message, including
+ * the author avatar, name, timestamp, and an optional delete action.
+ */
+export declare const MessageHeader: ({ author, createdAt, isDeleteAllowed, onAvatarClick, onDelete, }: MessageHeaderProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/lib/components/message-header/messages.d.ts

@@ -0,0 +1,38 @@
+declare const messages: {
+    deleteConfirmation: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    deleteCommentQuestion: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    deleteCancel: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    delete: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    moreOptionsAriaLabel: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    cancelDeleteButtonAriaLabel: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    deleteButtonAriaLabel: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+};
+export default messages;

package/dist/types/lib/components/messages-view/consts.d.ts

@@ -0,0 +1,4 @@
+export declare const DEFAULT_MESSAGE_HEIGHT = 80;
+export declare const DEFAULT_AUTO_SCROLL_THRESHOLD = 150;
+export declare const DEFAULT_OVERSCAN = 2;
+export declare const MAXIMUM_VISIBLE_REPLIES_COUNT = 3;

package/dist/types/lib/components/messages-view/hooks/useAutoScroll.d.ts

@@ -0,0 +1,9 @@
+interface UseAutoScrollProps {
+    messageCount: number;
+    containerRef: React.RefObject<HTMLDivElement>;
+}
+export declare const useAutoScroll: ({ messageCount, containerRef }: UseAutoScrollProps) => {
+    handleScroll: () => void;
+    handleScrollToBottom: () => void;
+};
+export {};

package/dist/types/lib/components/messages-view/hooks/useShowMoreReplies.d.ts

@@ -0,0 +1,10 @@
+interface UseShowMoreRepliesProps {
+    repliesLength: number;
+}
+export declare const useShowMoreReplies: ({ repliesLength }: UseShowMoreRepliesProps) => {
+    showMoreRepliesButton: boolean;
+    showMoreReplies: boolean;
+    toggleReplies: () => void;
+    buttonText: string;
+};
+export {};

package/dist/types/lib/components/messages-view/hooks/useVirtualizedMessages.d.ts

@@ -0,0 +1,13 @@
+import { TextMessageType } from '../../text-message/types';
+interface UseVirtualizedMessagesProps {
+    replies: TextMessageType[];
+    parentRef: React.MutableRefObject<HTMLDivElement | null>;
+    estimateMessageHeight: number;
+    overscan: number;
+}
+export declare const useVirtualizedMessages: ({ overscan, replies, parentRef, estimateMessageHeight, }: UseVirtualizedMessagesProps) => {
+    virtualItems: import('@tanstack/virtual-core').VirtualItem[];
+    totalSize: number;
+    measureElement: (node: Element) => void;
+};
+export {};

package/dist/types/lib/components/messages-view/messages-view.d.ts

@@ -0,0 +1,20 @@
+import { ActionsType, TextMessageType } from '../text-message/types';
+/**
+ * Props for the MessagesView component.
+ */
+export interface MessagesViewProps extends ActionsType {
+    /**
+     * Callback function invoked when the overflow state of the messages container changes.
+     * @param {boolean} isOverflowing - Indicates whether the container is overflowing.
+     */
+    onOverflowChange: (isOverflowing: boolean) => void;
+    /**
+     * An array of message objects to be displayed.
+     */
+    messages: TextMessageType[];
+    /**
+     * Whether the reply button is blocked.
+     */
+    isDeleteAllowed?: boolean;
+}
+export declare const MessagesView: ({ messages, onDelete, onAvatarClick, onOverflowChange, isDeleteAllowed, }: MessagesViewProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/lib/components/messages-view/messages.d.ts

@@ -0,0 +1,13 @@
+declare const messages: {
+    hideReplies: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    showMoreReplies: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+};
+export default messages;

package/dist/types/lib/components/messages-view/virtualized-messages.d.ts

@@ -0,0 +1,22 @@
+import { VirtualItem } from '@tanstack/react-virtual';
+import { MessagesViewProps } from './messages-view';
+/**
+ * Props for the VirtualizedMessages component.
+ */
+interface VirtualizedMessagesProps extends Omit<MessagesViewProps, 'onOverflowChange'> {
+    /**
+     * The total height of all virtualized content in pixels.
+     */
+    totalSize: number;
+    /**
+     * Array of virtual items from react-virtual containing visible and overscan items.
+     */
+    virtualItems: VirtualItem[];
+    /**
+     * Callback function to measure the height of message elements for virtualization.
+     * @param node - The DOM element to measure, or null to clear measurement.
+     */
+    measureElement: (node: Element | null) => void;
+}
+export declare const VirtualizedMessages: ({ messages, totalSize, virtualItems, measureElement, onDelete, onAvatarClick, isDeleteAllowed, }: VirtualizedMessagesProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/lib/components/text-message/message-renderer.d.ts

@@ -0,0 +1,6 @@
+import { DocumentNode } from '../../document-node-types';
+interface MessageRendererProps {
+    messageObject: DocumentNode;
+}
+export declare const MessageRenderer: ({ messageObject }: MessageRendererProps) => import("react/jsx-runtime").JSX.Element[];
+export {};

package/dist/types/lib/components/text-message/stories/shared.d.ts

@@ -0,0 +1,2 @@
+import { TextMessageProps } from '../text-message';
+export declare const DefaultTextMessage: (props: TextMessageProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/lib/components/text-message/stories/utils/test-utils.d.ts

@@ -0,0 +1,2 @@
+import { userEvent, within } from 'storybook/test';
+export declare const openMoreOptionsMenu: (user: ReturnType<typeof userEvent.setup>, canvas: ReturnType<typeof within>, authorName: string) => Promise<void>;

package/dist/types/lib/components/text-message/text-message.d.ts

@@ -0,0 +1,17 @@
+import { ActionsType, TextMessageType } from './types';
+/**
+ * Defines the props for the TextMessage component, combining message data with actionable callbacks.
+ */
+export interface TextMessageProps extends ActionsType {
+    /** The complete data object representing the message to be displayed. */
+    textMessageData: TextMessageType;
+    isDeleteAllowed?: boolean;
+}
+/**
+ * Renders a single message within a text thread.
+ *
+ * This component is responsible for displaying the author's avatar and name,
+ * the message content itself, a relative timestamp, and providing a mechanism
+ * for deleting the message.
+ */
+export declare const TextMessage: ({ textMessageData, isDeleteAllowed, onAvatarClick, onDelete }: TextMessageProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/lib/components/text-message/types.d.ts

@@ -0,0 +1,35 @@
+import { DocumentNode } from '../../document-node-types';
+/**
+ * Defines the callback functions that can be triggered from a text message.
+ */
+export type ActionsType = {
+    onDelete: (id: string) => void;
+    onAvatarClick: (id: number) => void;
+};
+/**
+ * Represents the core structure of a single text message.
+ */
+export type TextMessageType = {
+    id: string;
+    /** The message content, structured as a TipTap document node. */
+    message: DocumentNode;
+    createdAt: number;
+    /** The author of the message. */
+    author: TextMessageAuthorType;
+};
+/**
+ * Represents an author of a text message.
+ */
+export type TextMessageAuthorType = {
+    /** The full display name of the user. */
+    name: string;
+    id: number;
+    /** The URL for the user's avatar image. */
+    avatarUrl?: string;
+    /** Flag indicating if this user is the one currently viewing the annotation. */
+    isCurrentUser?: boolean;
+    /** Flag indicating if the user is an external collaborator. */
+    isExternalUser?: boolean;
+    /** The type of the user  */
+    type?: string;
+};

package/dist/types/lib/components/user-avatar/getInitials.d.ts

@@ -0,0 +1 @@
+export declare const getInitials: (name: string) => string;

package/dist/types/lib/components/user-avatar/messages.d.ts

@@ -0,0 +1,13 @@
+declare const messages: {
+    userAvatar: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    userAvatarButtonAriaLabel: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+};
+export default messages;

package/dist/types/lib/components/user-avatar/user-avatar.d.ts

@@ -0,0 +1,10 @@
+import { TextMessageAuthorType } from '../text-message/types';
+interface UserAvatarProps {
+    user: TextMessageAuthorType;
+}
+export declare const UserAvatar: ({ user }: UserAvatarProps) => import("react/jsx-runtime").JSX.Element;
+interface UserAvatarButtonProps extends UserAvatarProps {
+    onClick: (id: number) => void;
+}
+export declare const UserAvatarButton: ({ user, onClick }: UserAvatarButtonProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/lib/components/v2/annotation-badge/annotation-badge.d.ts

@@ -0,0 +1,7 @@
+import { AnnotationBadgeTargetType } from '../../../v2/types';
+interface AnnotationBadgeProps {
+    annotationTarget: AnnotationBadgeTargetType;
+    onClick?: () => void;
+}
+export declare const AnnotationBadge: ({ annotationTarget, onClick }: AnnotationBadgeProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/lib/components/v2/annotation-badge/index.d.ts

@@ -0,0 +1 @@
+export { AnnotationBadge } from './annotation-badge';

package/dist/types/lib/components/v2/annotation-badge/messages.d.ts

@@ -0,0 +1,8 @@
+declare const messages: {
+    annotationPage: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+};
+export default messages;

package/dist/types/lib/components/v2/message-editor/editor-extensions/custom-mention/custom-mention-suggestions.d.ts

@@ -0,0 +1,15 @@
+import { Editor } from '@tiptap/core';
+import { SuggestionKeyDownProps, SuggestionOptions, SuggestionProps } from '@tiptap/suggestion';
+import { EditorMentionAttributes } from '../../../../../v2/types';
+interface SuggestionRenderProps extends SuggestionProps {
+    command: (props: EditorMentionAttributes) => void;
+    editor: Editor;
+}
+export interface SuggestionCallbacks {
+    onSuggestionStart: (props: SuggestionRenderProps) => void;
+    onSuggestionUpdate: (props: SuggestionRenderProps) => void;
+    onSuggestionKeyDown: (props: SuggestionKeyDownProps) => boolean;
+    onSuggestionExit: () => void;
+}
+export declare const createSuggestionOptions: (pluginKeyName: string, char: string, callbacks: SuggestionCallbacks) => Omit<SuggestionOptions, "editor">;
+export {};

package/dist/types/lib/components/v2/message-editor/editor-extensions/custom-mention/custom-mention.d.ts

@@ -0,0 +1 @@
+export declare const CustomMention: import('@tiptap/core').Node<import('@tiptap/extension-mention').MentionOptions, any>;