@box/threaded-annotations 1.80.0

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

@@ -0,0 +1,5 @@
+import { EditorView } from '@tiptap/pm/view';
+export declare const MENTION_PLUGIN_KEY = "mentionAt";
+export declare const MENTION_CHAR = "@";
+export declare const normalizeMentionTextInput: (view: EditorView, from: number, to: number, text: string) => boolean;
+export declare const normalizeMentionPastedText: (text: string) => string;

package/dist/types/lib/components/v2/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 '../../../../../v2/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/v2/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/v2/message-editor/hooks/useCharacterLimit.d.ts

@@ -0,0 +1,15 @@
+import { Editor } from '@tiptap/core';
+import { JSONContent } from '@tiptap/react';
+export interface CharacterLimitState {
+    /** Current character count */
+    count: number;
+    /** Number of characters over the limit (0 if not exceeded) */
+    excess: number;
+    /** The configured maximum character count */
+    maxCount: number;
+}
+/**
+ * Tracks the editor's character count relative to the configured limit.
+ * Returns null when disabled (no editor).
+ */
+export declare const useCharacterLimit: (editor: Editor | null, initialContent?: JSONContent | string | null, maxCount?: number) => CharacterLimitState | null;

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

@@ -0,0 +1,27 @@
+import { Editor } from '@tiptap/core';
+export interface EditorContainerState {
+    /** True when content height exceeds one line (e.g. user pressed Enter). */
+    exceedsSingleLine: boolean;
+    /** True when the container has vertical or horizontal scroll (content overflows). */
+    hasScroll: boolean;
+    /** True when the user has scrolled to the bottom (within threshold). */
+    isAtBottom: boolean;
+}
+/**
+ * Observes the editor container's content and returns layout state.
+ *
+ * Uses a ResizeObserver on the content element (first child or container) because the
+ * container's box size stays fixed due to max-height/overflow, so observing the
+ * container itself would not fire on content changes.
+ *
+ * State updates are triggered by: ResizeObserver, scroll events, and editor.on('update').
+ *
+ * - exceedsSingleLine: True when doc has 2+ paragraphs (if editor provided), or when
+ *   content height exceeds SINGLE_LINE_HEIGHT ± HYSTERESIS for single-paragraph wrapping.
+ * - hasScroll: True when container.scrollHeight - clientHeight > SCROLL_THRESHOLD.
+ * - isAtBottom: True when scrollTop + clientHeight >= scrollHeight - SCROLL_BOTTOM_THRESHOLD.
+ *
+ * @param containerRef - Ref to the scrollable container (overflow-y: auto)
+ * @param editor - Optional Tiptap editor; when provided, doc.childCount and on('update') are used
+ */
+export declare const useEditorContainerState: (containerRef: React.RefObject<HTMLElement | null>, editor?: Editor | null) => EditorContainerState;

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

@@ -0,0 +1,5 @@
+import { UserContactType } from '@box/user-selector';
+import { EditorMentionAttributes } from '../../../../v2/types';
+export declare const useMentionUserSelection: (command: ((props: EditorMentionAttributes) => void) | null) => {
+    onUserSelected: (user: UserContactType) => Promise<void>;
+};

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

@@ -0,0 +1,13 @@
+import { JSONContent } from '@tiptap/react';
+import { TextMessageType } from '../../../../v2/types';
+interface UseMessageSubmitProps {
+    onSubmit: (content: JSONContent | null) => Promise<TextMessageType | void> | TextMessageType | void;
+    onSubmitError?: (error: unknown) => string | undefined;
+    onSuccess?: () => void;
+    cleanEditor?: () => void;
+    getEditorJsonContent: () => JSONContent | null;
+}
+export declare const useMessageSubmit: ({ onSubmit, onSubmitError, onSuccess, cleanEditor, getEditorJsonContent, }: UseMessageSubmitProps) => {
+    handleSubmit: () => Promise<void>;
+};
+export {};

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

@@ -0,0 +1,12 @@
+import { ReactNode } from 'react';
+export interface MessageEditorContextValue {
+    errorMessage: string | null;
+    setErrorMessage: (message: string | null) => void;
+    isLoading: boolean;
+    setIsLoading: (value: boolean) => void;
+}
+export interface MessageEditorProviderProps {
+    children: ReactNode;
+}
+export declare const MessageEditorProvider: ({ children }: MessageEditorProviderProps) => import("react/jsx-runtime").JSX.Element;
+export declare const useMessageEditorContext: () => MessageEditorContextValue;

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

@@ -0,0 +1,3 @@
+import { MessageEditorVariant, MessageEditorProps } from './message-editor.types';
+export { MessageEditorVariant, type MessageEditorProps };
+export declare const MessageEditor: (props: MessageEditorProps) => import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,69 @@
+import { HeadlessUserSelectorProps } from '@box/user-selector';
+import { JSONContent } from '@tiptap/react';
+import { TextMessageType } from '../../../v2/types';
+export declare enum MessageEditorVariant {
+    CREATE_MESSAGE = "CREATE_MESSAGE",
+    EDIT_MESSAGE = "EDIT_MESSAGE"
+}
+type MessageActionCallback = (content: JSONContent | null) => Promise<TextMessageType | void> | TextMessageType | void;
+interface BaseMessageEditorProps {
+    disableComponent?: boolean;
+    /** When true (create mode only), editor does not expand to full width. Defaults to false. */
+    isFirstAnnotation?: boolean;
+    /** Optional initial editor content used to prefill the editor (both edit and post modes). */
+    initialContent?: JSONContent | string | null;
+    /** Maximum character count. Defaults to 5000. */
+    maxCharacterCount?: number;
+    /** Properties for the user selector component from blueprint-web. */
+    userSelectorProps: Omit<HeadlessUserSelectorProps, 'inputElementRef' | 'onSelectedUserChange' | 'open' | 'rootElement' | 'value'>;
+}
+interface CreateMessageEditorProps extends BaseMessageEditorProps {
+    /**
+     * 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: MessageActionCallback;
+    /**
+     * 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;
+    /** Optional callback fired after a message is successfully posted. */
+    onPostSuccess?: () => void;
+    variant?: MessageEditorVariant.CREATE_MESSAGE;
+    onSave?: never;
+    onSaveError?: never;
+    onEditSuccess?: never;
+    onEditCancel?: never;
+}
+interface EditMessageEditorProps extends BaseMessageEditorProps {
+    /**
+     * A callback function to be executed when the user saves an edited message.
+     * @param content The content of the message in JSON format or null.
+     * @returns A promise or synchronous function that updates the message.
+     */
+    onSave: MessageActionCallback;
+    /**
+     * An optional callback function to handle errors during the save operation.
+     * @param error The error object.
+     * @returns An optional error message string to be displayed.
+     */
+    onSaveError?: (error: unknown) => string | undefined;
+    /** Optional callback fired after a message is successfully saved. */
+    onEditSuccess?: () => void;
+    /** Optional callback fired when edit cancel is clicked. */
+    onEditCancel?: () => void;
+    variant: MessageEditorVariant.EDIT_MESSAGE;
+    onPost?: never;
+    onPostError?: never;
+    onPostSuccess?: never;
+}
+/**
+ * Message editor props modeled as a discriminated union by `variant`:
+ * - `EDIT_MESSAGE` requires `onSave`
+ * - omitted/default variant is create mode and requires `onPost`
+ */
+export type MessageEditorProps = CreateMessageEditorProps | EditMessageEditorProps;
+export {};

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

@@ -0,0 +1,53 @@
+declare const messages: {
+    cancel: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    characterCount: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    characterLimitExceeded: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    editorContentAriaLabel: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    placeholder: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    post: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    postLoading: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    save: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    saveLoading: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    scrollContainerAriaLabel: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+};
+export default messages;

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

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

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

@@ -0,0 +1,6 @@
+import { createMockFetchAvatarUrls, createMockFetchUsers } from '../../../../../v2/test-utils/mocks';
+export declare const mockOnPost: (content: import('@tiptap/core').JSONContent | null) => Promise<import('../../../../../..').TextMessageTypeV2>;
+export declare const mockOnPostWithError: () => Promise<never>;
+export declare const mockOnSave: (content: import('@tiptap/core').JSONContent | null) => Promise<import('../../../../../..').TextMessageTypeV2>;
+export declare const mockOnSaveWithError: () => Promise<never>;
+export { createMockFetchAvatarUrls, createMockFetchUsers };

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

@@ -0,0 +1,10 @@
+export declare const waitForPlaceholderToAppear: (canvasElement: HTMLElement) => Promise<void>;
+/**
+ * Waits for the v2 message editor placeholder to disappear (e.g. after typing).
+ */
+export declare const waitForPlaceholderToDisappear: (canvasElement: HTMLElement) => Promise<void>;
+/**
+ * Scrolls the message editor container to top or bottom.
+ * Targets the scroll container via aria-label; uses editor.closest when multiple scroll containers exist.
+ */
+export declare const scrollEditorTo: (canvasElement: HTMLElement, position: "top" | "bottom", delay?: number) => Promise<void>;

package/dist/types/lib/components/v2/message-editor/subcomponents/character-limit-counter.d.ts

@@ -0,0 +1,7 @@
+interface CharacterLimitCounterProps {
+    count: number;
+    excess: number;
+    maxCount: number;
+}
+export declare const CharacterLimitCounter: ({ count, excess, maxCount }: CharacterLimitCounterProps) => import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/types/lib/components/v2/message-editor/subcomponents/edit-buttons.d.ts

@@ -0,0 +1,11 @@
+import { JSONContent } from '@tiptap/react';
+import { TextMessageType } from '../../../../v2/types';
+export interface EditButtonsProps {
+    onSave: (content: JSONContent | null) => Promise<TextMessageType | void> | TextMessageType | void;
+    onSaveError?: (error: unknown) => string | undefined;
+    onEditSuccess?: () => void;
+    onCancel?: () => void;
+    getEditorJsonContent: () => JSONContent | null;
+    disabled?: boolean;
+}
+export declare const EditButtons: ({ onSave, onSaveError, onEditSuccess, onCancel, getEditorJsonContent, disabled, }: EditButtonsProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/lib/components/v2/message-editor/subcomponents/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/v2/message-editor/subcomponents/post-button.d.ts

@@ -0,0 +1,11 @@
+import { JSONContent } from '@tiptap/react';
+import { TextMessageType } from '../../../../v2/types';
+export interface PostButtonProps {
+    disabled?: boolean;
+    onPost: (content: JSONContent | null) => Promise<TextMessageType | void> | TextMessageType | void;
+    onPostError?: (error: unknown) => string | undefined;
+    onPostSuccess?: () => void;
+    cleanEditor: () => void;
+    getEditorJsonContent: () => JSONContent | null;
+}
+export declare const PostButton: ({ disabled, onPost, onPostError, onPostSuccess, cleanEditor, getEditorJsonContent, }: PostButtonProps) => import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,11 @@
+export interface DeleteConfirmationPopoverProps {
+    open: boolean;
+    onOpenChange: (open: boolean) => void;
+    onConfirm: () => void;
+    onCancel: () => void;
+}
+/**
+ * Renders a delete confirmation popover anchored to the bottom-right.
+ * Used when the user selects Delete from the message options menu.
+ */
+export declare const DeleteConfirmationPopover: ({ open, onOpenChange, onConfirm, onCancel, }: DeleteConfirmationPopoverProps) => import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,32 @@
+import { TextMessageAuthorType } from '../../../v2/types/message-types';
+export interface MessageHeaderProps {
+    /** The author whose avatar and name are displayed in the header. */
+    author: TextMessageAuthorType;
+    /** Whether the Resolve/Unresolve option is available in the options menu. */
+    canResolve?: boolean;
+    /** Whether the message is currently resolved. When true and canResolve is true, shows Unresolve; when false and canResolve is true, shows Resolve. */
+    isResolved?: boolean;
+    /** Whether the Edit option is available in the options menu. */
+    canEdit?: boolean;
+    /** Whether the Delete option is available in the options menu. */
+    canDelete?: boolean;
+    /** Whether the message is the first message in the thread. */
+    isFirstMessage?: boolean;
+    /** Callback invoked when the user clicks the author avatar. */
+    onAvatarClick: (id: number) => void;
+    /** Callback invoked when the user selects Edit from the options menu. */
+    onEdit?: () => void;
+    /** Callback invoked when the user selects Resolve from the options menu. */
+    onResolve?: () => void;
+    /** Callback invoked when the user selects Unresolve from the options menu. */
+    onUnresolve?: () => void;
+    /** Callback invoked when the user selects Delete from the options menu. */
+    onDelete?: () => void;
+    /** Callback invoked when the user confirms deletion of the entire thread (only used when isFirstMessage is true). */
+    onThreadDelete?: () => void;
+}
+/**
+ * Renders the header section of a threaded message, including
+ * the author avatar, name, and an optional delete action.
+ */
+export declare const MessageHeader: ({ author, canResolve, isResolved, canEdit, canDelete, isFirstMessage, onAvatarClick, onEdit, onResolve, onUnresolve, onDelete, onThreadDelete, }: MessageHeaderProps) => import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,12 @@
+export interface MessageOptionsMenuProps {
+    canDelete?: boolean;
+    canEdit?: boolean;
+    disabled?: boolean;
+    onEdit?: () => void;
+    onDelete?: () => void;
+    onOpenChange?: (isOpen: boolean) => void;
+}
+/**
+ * Renders a context menu for an annotation message with Edit and Delete options.
+ */
+export declare const MessageOptionsMenu: ({ canDelete, canEdit, disabled, onEdit, onDelete, onOpenChange, }: MessageOptionsMenuProps) => import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,53 @@
+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;
+    };
+    edit: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    resolveButtonAriaLabel: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    unresolveButtonAriaLabel: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+};
+export default messages;

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

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

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

@@ -0,0 +1 @@
+export declare const focusHeader: (canvasElement: HTMLElement) => Promise<void>;

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

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

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

@@ -0,0 +1,17 @@
+import { AnnotationBadgeTargetType } from '../../../v2/types/annotation-badge-types';
+import { TextMessageType } from '../../../v2/types/message-types';
+export interface MessagesViewProps {
+    messages: TextMessageType[];
+    isResolved?: boolean;
+    resolvedBy?: string;
+    resolvedAt?: number;
+    onDelete: (id: string) => void;
+    onThreadDelete?: () => void;
+    onAvatarClick: (id: number) => void;
+    onEdit?: (id: string) => void;
+    onResolve?: (id: string) => void;
+    onUnresolve?: (id: string) => void;
+    annotationTarget?: AnnotationBadgeTargetType;
+    onAnnotationBadgeClick?: (id: string) => void;
+}
+export declare const MessagesView: ({ messages, isResolved, resolvedBy, resolvedAt, onDelete, onThreadDelete, onAvatarClick, onEdit, onResolve, onUnresolve, annotationTarget, onAnnotationBadgeClick, }: MessagesViewProps) => import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,7 @@
+import { MessagesViewProps } from '../messages-view';
+export interface DefaultMessagesViewProps extends MessagesViewProps {
+    isReplyDisabled?: boolean;
+    isAnnotations?: boolean;
+    isResolvedContext?: boolean;
+}
+export declare const DefaultMessagesView: ({ isReplyDisabled, isAnnotations, isResolvedContext, ...props }: DefaultMessagesViewProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/lib/components/v2/resolved-state/messages.d.ts

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

package/dist/types/lib/components/v2/resolved-state/resolved-state.d.ts

@@ -0,0 +1,11 @@
+export interface ResolvedStateProps {
+    /** The display name of the user who resolved the thread. */
+    authorName: string;
+    /** Unix timestamp (in ms) for when the thread was resolved. */
+    createdAt: number;
+}
+/**
+ * Renders a status message indicating that a user has marked
+ * a comment thread as resolved.
+ */
+export declare const ResolvedState: ({ authorName, createdAt }: ResolvedStateProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/lib/components/v2/resolved-state/stories/shared.d.ts

@@ -0,0 +1,2 @@
+import { ResolvedStateProps } from '../resolved-state';
+export declare const DefaultResolvedState: (props: ResolvedStateProps) => import("react/jsx-runtime").JSX.Element;

package/dist/types/lib/components/v2/show-replies-button/messages.d.ts

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

package/dist/types/lib/components/v2/show-replies-button/show-replies-button.d.ts

@@ -0,0 +1,8 @@
+import { TextMessageAuthorType } from '../../../v2/types/message-types';
+export interface ShowRepliesButtonProps {
+    onShowReplies: () => void;
+    repliesCount: number;
+    lastUser: TextMessageAuthorType;
+    secondLastUser?: TextMessageAuthorType;
+}
+export declare const ShowRepliesButton: ({ onShowReplies, repliesCount, lastUser, secondLastUser, }: ShowRepliesButtonProps) => import("react/jsx-runtime").JSX.Element;

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

@@ -0,0 +1,23 @@
+declare const messages: {
+    annotationMessageAriaLabel: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    reply: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    replyButtonAriaLabel: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+    textMessageAriaLabel: {
+        defaultMessage: string;
+        description: string;
+        id: string;
+    };
+};
+export default messages;

package/dist/types/lib/components/v2/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/v2/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/v2/text-message/subcomponents/message-footer.d.ts

@@ -0,0 +1,10 @@
+export interface MessageFooterProps {
+    /** Unix timestamp (in ms) for when the message was created. */
+    createdAt: number;
+    /** Callback invoked when the user clicks the reply button. */
+    onReply?: () => void;
+}
+/**
+ * Renders the footer of a message with readable time and reply button.
+ */
+export declare const MessageFooter: ({ createdAt, onReply }: MessageFooterProps) => import("react/jsx-runtime").JSX.Element;

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

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

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

@@ -0,0 +1,26 @@
+import { AnnotationBadgeTargetType } from '../../../v2/types/annotation-badge-types';
+import { TextMessageType } from '../../../v2/types/message-types';
+/**
+ * Defines the props for the TextMessage component, combining message data with actionable callbacks.
+ */
+export interface TextMessageProps extends TextMessageType {
+    showThreadedIndicator?: boolean;
+    isResolved?: boolean;
+    isFirstMessage?: boolean;
+    onDelete: (id: string) => void;
+    onThreadDelete?: () => void;
+    onAvatarClick: (id: number) => void;
+    onEdit?: (id: string) => void;
+    onResolve?: (id: string) => void;
+    onUnresolve?: (id: string) => void;
+    annotationTarget?: AnnotationBadgeTargetType;
+    onAnnotationBadgeClick?: (id: string) => void;
+}
+/**
+ * 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: ({ id, author, message, createdAt, permissions, showThreadedIndicator, isResolved, isFirstMessage, onAvatarClick, onDelete, onThreadDelete, onEdit, onResolve, onUnresolve, annotationTarget, onAnnotationBadgeClick, }: TextMessageProps) => import("react/jsx-runtime").JSX.Element;

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

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

package/dist/types/lib/components/v2/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/v2/user-avatar/user-avatar.d.ts

@@ -0,0 +1,12 @@
+import { TextMessageAuthorType } from '../../../v2/types';
+export type UserAvatarSize = 'small' | 'medium';
+interface UserAvatarProps {
+    user: TextMessageAuthorType;
+    size?: UserAvatarSize;
+}
+export declare const UserAvatar: ({ user, size }: UserAvatarProps) => import("react/jsx-runtime").JSX.Element;
+interface UserAvatarButtonProps extends UserAvatarProps {
+    onClick: (id: number) => void;
+}
+export declare const UserAvatarButton: ({ user, size, onClick }: UserAvatarButtonProps) => import("react/jsx-runtime").JSX.Element;
+export {};