@box/threaded-annotations 1.80.0

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

@@ -0,0 +1,23 @@
+export declare enum AnnotationBadgeType {
+    Drawing = "drawing",
+    Frame = "frame",
+    Highlight = "highlight",
+    Point = "point",
+    Region = "region"
+}
+/**
+ * Describes the annotation target for a root annotation message.
+ * Highlight annotations display the highlighted text excerpt.
+ * Frame annotations display a formatted timestamp.
+ * Drawing, point, and region annotations display the page number.
+ */
+export type AnnotationBadgeTargetType = {
+    highlightedText: string;
+    type: AnnotationBadgeType.Highlight;
+} | {
+    page: number;
+    type: AnnotationBadgeType.Drawing | AnnotationBadgeType.Point | AnnotationBadgeType.Region;
+} | {
+    timestamp: string;
+    type: AnnotationBadgeType.Frame;
+};

package/dist/types/lib/v2/types/document-node-types.d.ts

@@ -0,0 +1,32 @@
+export type MentionNode = {
+    type: 'mention';
+    attrs: EditorMentionAttributes & MentionRenderAttributes;
+};
+export type EditorMentionAttributes = {
+    mentionedUserId: string;
+    mentionedUserName: string;
+    mentionedUserEmail?: string;
+    mentionId: string;
+};
+export type MentionRenderAttributes = {
+    authorId: string;
+    mentionId: string;
+};
+export type TextNode = {
+    type: 'text';
+    text: string;
+    marks?: Array<{
+        type: string;
+        attrs?: Record<string, unknown>;
+    }>;
+};
+export type ParagraphNode = {
+    type: 'paragraph';
+    content?: (MentionNode | TextNode)[];
+    attrs?: Record<string, unknown>;
+};
+export type DocumentNode = {
+    type: 'doc';
+    content: ParagraphNode[];
+    attrs?: Record<string, unknown>;
+};

package/dist/types/lib/v2/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from './annotation-badge-types';
+export * from './document-node-types';
+export * from './message-types';

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

@@ -0,0 +1,33 @@
+import { DocumentNode } from './document-node-types';
+/**
+ * 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;
+    permissions: Permissions;
+};
+/**
+ * Represents an author of a text message.
+ */
+export type TextMessageAuthorType = {
+    /** The full display name of the user. */
+    name: string;
+    id: number;
+    email: string;
+    avatarUrl?: string;
+    /** Flag indicating if the user is an external collaborator. */
+    isExternalUser?: boolean;
+    /** The type of the user  */
+    type?: string;
+};
+export type Permissions = {
+    canResolve: boolean;
+    canEdit: boolean;
+    canDelete: boolean;
+    canReply: boolean;
+};

package/dist/types/lib/v2/utils/build-mention-content.d.ts

@@ -0,0 +1,3 @@
+import { JSONContent } from '@tiptap/react';
+import { TextMessageAuthorType } from '../types/message-types';
+export declare const buildMentionContent: (author: TextMessageAuthorType) => JSONContent;

package/dist/types/lib/v2/utils/serialize-mention-markup.d.ts

@@ -0,0 +1,16 @@
+import { DocumentNode } from '../types';
+/**
+ * Serializes a DocumentNode to plain text with @mention markup.
+ * Mention nodes are formatted as `@[userId:userName]` for the Traditional API.
+ * Paragraphs are joined with newlines.
+ *
+ * Used by BUIE and box-annotations when posting or editing comments via the
+ * Traditional API (onPost/onSave callbacks). The backend parses `@[id:name]`
+ * patterns to generate @mention notifications.
+ *
+ * Returns the formatted text and whether any mentions were found.
+ */
+export declare const serializeMentionMarkup: (doc: DocumentNode | null) => {
+    hasMention: boolean;
+    text: string;
+};

package/package.json

@@ -0,0 +1,66 @@
+{
+    "name": "@box/threaded-annotations",
+    "version": "1.80.0",
+    "license": "SEE LICENSE IN LICENSE",
+    "dependencies": {
+        "@tanstack/react-virtual": "^3.10.8",
+        "@tiptap/core": "2.0.2",
+        "@tiptap/extension-document": "2.0.2",
+        "@tiptap/extension-mention": "2.0.2",
+        "@tiptap/extension-paragraph": "2.0.2",
+        "@tiptap/extension-placeholder": "2.0.2",
+        "@tiptap/extension-text": "2.0.2",
+        "@tiptap/pm": "2.0.2",
+        "@tiptap/react": "2.0.2",
+        "@tiptap/suggestion": "2.0.2",
+        "uuid": "^9.0.1"
+    },
+    "peerDependencies": {
+        "@box/blueprint-web": "^14.12.2",
+        "@box/blueprint-web-assets": "^4.114.3",
+        "@box/collaboration-popover": "^1.60.2",
+        "@box/readable-time": "^1.39.52",
+        "@box/user-selector": "^1.74.52",
+        "react": "^18.0.0",
+        "react-dom": "^18.0.0",
+        "react-intl": "^6.4.2"
+    },
+    "devDependencies": {
+        "@box/blueprint-web": "^14.12.2",
+        "@box/blueprint-web-assets": "^4.114.3",
+        "@box/eslint-plugin-blueprint": "1.1.17",
+        "@box/readable-time": "^1.39.52",
+        "@box/storybook-utils": "^0.17.45",
+        "@box/user-selector": "^1.74.52",
+        "react": "^18.0.0",
+        "react-dom": "^18.0.0"
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "files": [
+        "dist"
+    ],
+    "main": "./dist/esm/index.js",
+    "module": "./dist/esm/index.js",
+    "types": "./dist/types/index.d.ts",
+    "exports": {
+        ".": {
+            "require": "./dist/esm/index.js",
+            "import": "./dist/esm/index.js",
+            "types": "./dist/types/index.d.ts"
+        },
+        "./*": {
+            "require": "./dist/esm/*",
+            "import": "./dist/esm/*",
+            "types": "./dist/types/*"
+        },
+        "./i18n/*": {
+            "require": "./dist/i18n/*",
+            "import": "./dist/i18n/*"
+        }
+    },
+    "sideEffects": [
+        "**/*.css"
+    ]
+}