@puredesktop/platform-editor 1.0.0-beta.1 → 2.1.0

package/src/extensions/commentMark.ts

@@ -1,223 +1,223 @@
-import { Mark, mergeAttributes } from '@tiptap/core'
-import {
-  normalizeCommentReviewStatus,
-  normalizeCommentSeverity,
-  normalizeCommentType,
-  type CommentReviewStatus,
-  type CommentSeverity,
-  type CommentType,
-} from '../commentUtils.js'
-
-declare module '@tiptap/core' {
-  interface Commands<ReturnType> {
-    commentMark: {
-      setCommentMark: (attrs: {
-        commentId: string
-        commentText: string
-        author?: string
-        createdAt?: string
-        commentType?: CommentType
-        subjectText?: string
-        reviewStatus?: CommentReviewStatus
-        severity?: CommentSeverity
-        replies?: string
-        resolvedAt?: string
-        resolvedBy?: string
-      }) => ReturnType
-      unsetCommentMark: () => ReturnType
-    }
-  }
-}
-
-export const CommentMark = Mark.create({
-  name: 'commentMark',
-  inclusive: false,
-  excludes: '',
-
-  addAttributes() {
-    return {
-      commentId: {
-        default: null,
-        parseHTML: el => el.getAttribute('data-comment-id'),
-        renderHTML: (attrs: { commentId?: string }) =>
-          attrs.commentId ? { 'data-comment-id': attrs.commentId } : {},
-      },
-      commentText: {
-        default: null,
-        parseHTML: el => el.getAttribute('data-comment-text'),
-        renderHTML: (attrs: { commentText?: string }) =>
-          attrs.commentText ? { 'data-comment-text': attrs.commentText } : {},
-      },
-      author: {
-        default: null,
-        parseHTML: el => el.getAttribute('data-comment-author'),
-        renderHTML: (attrs: { author?: string }) =>
-          attrs.author ? { 'data-comment-author': attrs.author } : {},
-      },
-      createdAt: {
-        default: null,
-        parseHTML: el => el.getAttribute('data-comment-created-at'),
-        renderHTML: (attrs: { createdAt?: string }) =>
-          attrs.createdAt ? { 'data-comment-created-at': attrs.createdAt } : {},
-      },
-      commentType: {
-        default: 'general',
-        parseHTML: el =>
-          normalizeCommentType(el.getAttribute('data-comment-type')),
-        renderHTML: (attrs: { commentType?: string }) => ({
-          'data-comment-type': normalizeCommentType(attrs.commentType),
-        }),
-      },
-      subjectText: {
-        default: null,
-        parseHTML: el => el.getAttribute('data-comment-subject'),
-        renderHTML: (attrs: { subjectText?: string }) =>
-          attrs.subjectText ? { 'data-comment-subject': attrs.subjectText } : {},
-      },
-      reviewStatus: {
-        default: null,
-        parseHTML: el => {
-          const type = normalizeCommentType(el.getAttribute('data-comment-type'))
-          return normalizeCommentReviewStatus(
-            el.getAttribute('data-comment-review-status'),
-            type,
-          )
-        },
-        renderHTML: (attrs: {
-          commentType?: string
-          reviewStatus?: string
-        }) => {
-          const type = normalizeCommentType(attrs.commentType)
-          const status =
-            attrs.reviewStatus ??
-            normalizeCommentReviewStatus(undefined, type)
-          return { 'data-comment-review-status': status }
-        },
-      },
-      severity: {
-        default: null,
-        parseHTML: el => {
-          const type = normalizeCommentType(el.getAttribute('data-comment-type'))
-          return normalizeCommentSeverity(
-            el.getAttribute('data-comment-severity'),
-            type,
-          )
-        },
-        renderHTML: (attrs: { commentType?: string; severity?: string }) => {
-          const type = normalizeCommentType(attrs.commentType)
-          const severity =
-            attrs.severity ?? normalizeCommentSeverity(undefined, type)
-          return { 'data-comment-severity': severity }
-        },
-      },
-      replies: {
-        default: null,
-        parseHTML: el => el.getAttribute('data-comment-replies'),
-        renderHTML: (attrs: { replies?: string }) =>
-          attrs.replies ? { 'data-comment-replies': attrs.replies } : {},
-      },
-      resolvedAt: {
-        default: null,
-        parseHTML: el => el.getAttribute('data-comment-resolved-at'),
-        renderHTML: (attrs: { resolvedAt?: string }) =>
-          attrs.resolvedAt
-            ? { 'data-comment-resolved-at': attrs.resolvedAt }
-            : {},
-      },
-      resolvedBy: {
-        default: null,
-        parseHTML: el => el.getAttribute('data-comment-resolved-by'),
-        renderHTML: (attrs: { resolvedBy?: string }) =>
-          attrs.resolvedBy
-            ? { 'data-comment-resolved-by': attrs.resolvedBy }
-            : {},
-      },
-    }
-  },
-
-  parseHTML() {
-    return [
-      {
-        tag: 'span[data-comment-id]',
-        getAttrs: el => ({
-          commentId: (el as HTMLElement).getAttribute('data-comment-id'),
-          commentText: (el as HTMLElement).getAttribute('data-comment-text'),
-          author: (el as HTMLElement).getAttribute('data-comment-author'),
-          createdAt: (el as HTMLElement).getAttribute(
-            'data-comment-created-at',
-          ),
-          commentType: normalizeCommentType(
-            (el as HTMLElement).getAttribute('data-comment-type'),
-          ),
-          subjectText: (el as HTMLElement).getAttribute(
-            'data-comment-subject',
-          ),
-          reviewStatus: normalizeCommentReviewStatus(
-            (el as HTMLElement).getAttribute('data-comment-review-status'),
-            normalizeCommentType(
-              (el as HTMLElement).getAttribute('data-comment-type'),
-            ),
-          ),
-          severity: normalizeCommentSeverity(
-            (el as HTMLElement).getAttribute('data-comment-severity'),
-            normalizeCommentType(
-              (el as HTMLElement).getAttribute('data-comment-type'),
-            ),
-          ),
-          replies: (el as HTMLElement).getAttribute('data-comment-replies'),
-          resolvedAt: (el as HTMLElement).getAttribute(
-            'data-comment-resolved-at',
-          ),
-          resolvedBy: (el as HTMLElement).getAttribute(
-            'data-comment-resolved-by',
-          ),
-        }),
-      },
-    ]
-  },
-
-  renderHTML({ HTMLAttributes, mark }) {
-    const attrs = mark.attrs as {
-      commentText?: string
-      author?: string
-      commentType?: string
-      resolvedAt?: string
-      reviewStatus?: string
-      severity?: string
-    }
-    const commentType = normalizeCommentType(attrs.commentType)
-    const title = attrs.author
-      ? `${attrs.author}: ${attrs.commentText ?? ''}`
-      : attrs.commentText ?? ''
-    return [
-      'span',
-      mergeAttributes(HTMLAttributes, {
-        class: [
-          'comment-mark',
-          `comment-mark--${commentType}`,
-          attrs.resolvedAt ? 'comment-mark--resolved' : '',
-        ]
-          .filter(Boolean)
-          .join(' '),
-        title,
-      }),
-      0,
-    ]
-  },
-
-  addCommands() {
-    return {
-      setCommentMark:
-        attrs =>
-        ({ commands, state }) => {
-          const { from, to } = state.selection
-          if (from === to) return false
-          return commands.setMark(this.name, attrs)
-        },
-      unsetCommentMark:
-        () =>
-        ({ commands }) =>
-          commands.unsetMark(this.name),
-    }
-  },
-})
+import { Mark, mergeAttributes } from '@tiptap/core'
+import {
+  normalizeCommentReviewStatus,
+  normalizeCommentSeverity,
+  normalizeCommentType,
+  type CommentReviewStatus,
+  type CommentSeverity,
+  type CommentType,
+} from '../commentUtils.js'
+
+declare module '@tiptap/core' {
+  interface Commands<ReturnType> {
+    commentMark: {
+      setCommentMark: (attrs: {
+        commentId: string
+        commentText: string
+        author?: string
+        createdAt?: string
+        commentType?: CommentType
+        subjectText?: string
+        reviewStatus?: CommentReviewStatus
+        severity?: CommentSeverity
+        replies?: string
+        resolvedAt?: string
+        resolvedBy?: string
+      }) => ReturnType
+      unsetCommentMark: () => ReturnType
+    }
+  }
+}
+
+export const CommentMark = Mark.create({
+  name: 'commentMark',
+  inclusive: false,
+  excludes: '',
+
+  addAttributes() {
+    return {
+      commentId: {
+        default: null,
+        parseHTML: el => el.getAttribute('data-comment-id'),
+        renderHTML: (attrs: { commentId?: string }) =>
+          attrs.commentId ? { 'data-comment-id': attrs.commentId } : {},
+      },
+      commentText: {
+        default: null,
+        parseHTML: el => el.getAttribute('data-comment-text'),
+        renderHTML: (attrs: { commentText?: string }) =>
+          attrs.commentText ? { 'data-comment-text': attrs.commentText } : {},
+      },
+      author: {
+        default: null,
+        parseHTML: el => el.getAttribute('data-comment-author'),
+        renderHTML: (attrs: { author?: string }) =>
+          attrs.author ? { 'data-comment-author': attrs.author } : {},
+      },
+      createdAt: {
+        default: null,
+        parseHTML: el => el.getAttribute('data-comment-created-at'),
+        renderHTML: (attrs: { createdAt?: string }) =>
+          attrs.createdAt ? { 'data-comment-created-at': attrs.createdAt } : {},
+      },
+      commentType: {
+        default: 'general',
+        parseHTML: el =>
+          normalizeCommentType(el.getAttribute('data-comment-type')),
+        renderHTML: (attrs: { commentType?: string }) => ({
+          'data-comment-type': normalizeCommentType(attrs.commentType),
+        }),
+      },
+      subjectText: {
+        default: null,
+        parseHTML: el => el.getAttribute('data-comment-subject'),
+        renderHTML: (attrs: { subjectText?: string }) =>
+          attrs.subjectText ? { 'data-comment-subject': attrs.subjectText } : {},
+      },
+      reviewStatus: {
+        default: null,
+        parseHTML: el => {
+          const type = normalizeCommentType(el.getAttribute('data-comment-type'))
+          return normalizeCommentReviewStatus(
+            el.getAttribute('data-comment-review-status'),
+            type,
+          )
+        },
+        renderHTML: (attrs: {
+          commentType?: string
+          reviewStatus?: string
+        }) => {
+          const type = normalizeCommentType(attrs.commentType)
+          const status =
+            attrs.reviewStatus ??
+            normalizeCommentReviewStatus(undefined, type)
+          return { 'data-comment-review-status': status }
+        },
+      },
+      severity: {
+        default: null,
+        parseHTML: el => {
+          const type = normalizeCommentType(el.getAttribute('data-comment-type'))
+          return normalizeCommentSeverity(
+            el.getAttribute('data-comment-severity'),
+            type,
+          )
+        },
+        renderHTML: (attrs: { commentType?: string; severity?: string }) => {
+          const type = normalizeCommentType(attrs.commentType)
+          const severity =
+            attrs.severity ?? normalizeCommentSeverity(undefined, type)
+          return { 'data-comment-severity': severity }
+        },
+      },
+      replies: {
+        default: null,
+        parseHTML: el => el.getAttribute('data-comment-replies'),
+        renderHTML: (attrs: { replies?: string }) =>
+          attrs.replies ? { 'data-comment-replies': attrs.replies } : {},
+      },
+      resolvedAt: {
+        default: null,
+        parseHTML: el => el.getAttribute('data-comment-resolved-at'),
+        renderHTML: (attrs: { resolvedAt?: string }) =>
+          attrs.resolvedAt
+            ? { 'data-comment-resolved-at': attrs.resolvedAt }
+            : {},
+      },
+      resolvedBy: {
+        default: null,
+        parseHTML: el => el.getAttribute('data-comment-resolved-by'),
+        renderHTML: (attrs: { resolvedBy?: string }) =>
+          attrs.resolvedBy
+            ? { 'data-comment-resolved-by': attrs.resolvedBy }
+            : {},
+      },
+    }
+  },
+
+  parseHTML() {
+    return [
+      {
+        tag: 'span[data-comment-id]',
+        getAttrs: el => ({
+          commentId: (el as HTMLElement).getAttribute('data-comment-id'),
+          commentText: (el as HTMLElement).getAttribute('data-comment-text'),
+          author: (el as HTMLElement).getAttribute('data-comment-author'),
+          createdAt: (el as HTMLElement).getAttribute(
+            'data-comment-created-at',
+          ),
+          commentType: normalizeCommentType(
+            (el as HTMLElement).getAttribute('data-comment-type'),
+          ),
+          subjectText: (el as HTMLElement).getAttribute(
+            'data-comment-subject',
+          ),
+          reviewStatus: normalizeCommentReviewStatus(
+            (el as HTMLElement).getAttribute('data-comment-review-status'),
+            normalizeCommentType(
+              (el as HTMLElement).getAttribute('data-comment-type'),
+            ),
+          ),
+          severity: normalizeCommentSeverity(
+            (el as HTMLElement).getAttribute('data-comment-severity'),
+            normalizeCommentType(
+              (el as HTMLElement).getAttribute('data-comment-type'),
+            ),
+          ),
+          replies: (el as HTMLElement).getAttribute('data-comment-replies'),
+          resolvedAt: (el as HTMLElement).getAttribute(
+            'data-comment-resolved-at',
+          ),
+          resolvedBy: (el as HTMLElement).getAttribute(
+            'data-comment-resolved-by',
+          ),
+        }),
+      },
+    ]
+  },
+
+  renderHTML({ HTMLAttributes, mark }) {
+    const attrs = mark.attrs as {
+      commentText?: string
+      author?: string
+      commentType?: string
+      resolvedAt?: string
+      reviewStatus?: string
+      severity?: string
+    }
+    const commentType = normalizeCommentType(attrs.commentType)
+    const title = attrs.author
+      ? `${attrs.author}: ${attrs.commentText ?? ''}`
+      : attrs.commentText ?? ''
+    return [
+      'span',
+      mergeAttributes(HTMLAttributes, {
+        class: [
+          'comment-mark',
+          `comment-mark--${commentType}`,
+          attrs.resolvedAt ? 'comment-mark--resolved' : '',
+        ]
+          .filter(Boolean)
+          .join(' '),
+        title,
+      }),
+      0,
+    ]
+  },
+
+  addCommands() {
+    return {
+      setCommentMark:
+        attrs =>
+        ({ commands, state }) => {
+          const { from, to } = state.selection
+          if (from === to) return false
+          return commands.setMark(this.name, attrs)
+        },
+      unsetCommentMark:
+        () =>
+        ({ commands }) =>
+          commands.unsetMark(this.name),
+    }
+  },
+})

package/src/extensions/documentAssetIdentity.ts

@@ -1,54 +1,54 @@
-import { Extension } from '@tiptap/core'
-import { Plugin } from '@tiptap/pm/state'
-
-const ASSET_NODE_TYPES = new Set(['table', 'inlineMath', 'blockMath'])
-
-function createDocumentAssetId(kind: string): string {
-  const id =
-    globalThis.crypto?.randomUUID?.() ?? Math.random().toString(36).slice(2)
-  return `asset_${kind}_${id}`
-}
-
-export const DocumentAssetIdentity = Extension.create({
-  name: 'documentAssetIdentity',
-
-  addGlobalAttributes() {
-    return [
-      {
-        types: [...ASSET_NODE_TYPES],
-        attributes: {
-          assetId: {
-            default: null,
-            parseHTML: element =>
-              element.getAttribute('data-asset-id')?.trim() || null,
-            renderHTML: attributes => {
-              const assetId = String(attributes.assetId ?? '').trim()
-              return assetId ? { 'data-asset-id': assetId } : {}
-            },
-          },
-        },
-      },
-    ]
-  },
-
-  addProseMirrorPlugins() {
-    return [
-      new Plugin({
-        appendTransaction: (_transactions, _oldState, newState) => {
-          let tr = newState.tr
-          let changed = false
-          newState.doc.descendants((node, pos) => {
-            if (!ASSET_NODE_TYPES.has(node.type.name)) return
-            if (node.attrs.assetId) return
-            tr = tr.setNodeMarkup(pos, undefined, {
-              ...node.attrs,
-              assetId: createDocumentAssetId(node.type.name),
-            })
-            changed = true
-          })
-          return changed ? tr : null
-        },
-      }),
-    ]
-  },
-})
+import { Extension } from '@tiptap/core'
+import { Plugin } from '@tiptap/pm/state'
+
+const ASSET_NODE_TYPES = new Set(['table', 'inlineMath', 'blockMath'])
+
+function createDocumentAssetId(kind: string): string {
+  const id =
+    globalThis.crypto?.randomUUID?.() ?? Math.random().toString(36).slice(2)
+  return `asset_${kind}_${id}`
+}
+
+export const DocumentAssetIdentity = Extension.create({
+  name: 'documentAssetIdentity',
+
+  addGlobalAttributes() {
+    return [
+      {
+        types: [...ASSET_NODE_TYPES],
+        attributes: {
+          assetId: {
+            default: null,
+            parseHTML: element =>
+              element.getAttribute('data-asset-id')?.trim() || null,
+            renderHTML: attributes => {
+              const assetId = String(attributes.assetId ?? '').trim()
+              return assetId ? { 'data-asset-id': assetId } : {}
+            },
+          },
+        },
+      },
+    ]
+  },
+
+  addProseMirrorPlugins() {
+    return [
+      new Plugin({
+        appendTransaction: (_transactions, _oldState, newState) => {
+          let tr = newState.tr
+          let changed = false
+          newState.doc.descendants((node, pos) => {
+            if (!ASSET_NODE_TYPES.has(node.type.name)) return
+            if (node.attrs.assetId) return
+            tr = tr.setNodeMarkup(pos, undefined, {
+              ...node.attrs,
+              assetId: createDocumentAssetId(node.type.name),
+            })
+            changed = true
+          })
+          return changed ? tr : null
+        },
+      }),
+    ]
+  },
+})