feat: add support for tiptap / liveblocks comments

packages/core/src/api/nodeConversions/nodeToBlock.ts

@@ -104,11 +104,12 @@ export function contentNodeToInlineContent<
       return;
     }
 
-    if (
-      node.type.name !== "link" &&
-      node.type.name !== "text" &&
-      inlineContentSchema[node.type.name]
-    ) {
+    if (node.type.name !== "link" && node.type.name !== "text") {
+      if (!inlineContentSchema[node.type.name]) {
+        // eslint-disable-next-line no-console
+        console.warn("unrecognized inline content type", node.type.name);
+        return;
+      }
       if (currentContent) {
         content.push(currentContent);
         currentContent = undefined;
@@ -130,6 +131,11 @@ export function contentNodeToInlineContent<
       } else {
         const config = styleSchema[mark.type.name];
         if (!config) {
+          if (mark.type.spec.blocknoteIgnore) {
+            // at this point, we don't want to show certain marks (such as comments)
+            // in the BlockNote JSON output. These marks should be tagged with "blocknoteIgnore" in the spec
+            continue;
+          }
           throw new Error(`style ${mark.type.name} not found in styleSchema`);
         }
         if (config.propSchema === "boolean") {

packages/core/src/editor/BlockNoteEditor.ts

@@ -489,7 +489,11 @@ export class BlockNoteEditor<
     this.resolveFileUrl = newOptions.resolveFileUrl;
     this.headless = newOptions._headless;
 
-    if (newOptions.collaboration && newOptions.initialContent) {
+    const collaborationEnabled =
+      "collaboration" in this.extensions ||
+      "liveblocksExtension" in this.extensions;
+
+    if (collaborationEnabled && newOptions.initialContent) {
       // eslint-disable-next-line no-console
       console.warn(
         "When using Collaboration, initialContent might cause conflicts, because changes should come from the collaboration provider"
@@ -498,7 +502,7 @@ export class BlockNoteEditor<
 
     const initialContent =
       newOptions.initialContent ||
-      (options.collaboration
+      (collaborationEnabled
         ? [
             {
               type: "paragraph",
@@ -930,7 +934,12 @@ export class BlockNoteEditor<
     for (const mark of marks) {
       const config = this.schema.styleSchema[mark.type.name];
       if (!config) {
-        if (mark.type.name !== "link") {
+        if (
+          // Links are not considered styles in blocknote
+          mark.type.name !== "link" &&
+          // "blocknoteIgnore" tagged marks (such as comments) are also not considered BlockNote "styles"
+          !mark.type.spec.blocknoteIgnore
+        ) {
           // eslint-disable-next-line no-console
           console.warn("mark not found in styleschema", mark.type.name);
         }

packages/core/src/i18n/locales/ar.ts

@@ -261,6 +261,9 @@ export const ar: Dictionary = {
     align_justify: {
       tooltip: "ضبط النص",
     },
+    comment: {
+      tooltip: "إضافة ملاحظة",
+    },
   },
   file_panel: {
     upload: {

packages/core/src/i18n/locales/de.ts

@@ -273,6 +273,9 @@ export const de = {
     align_justify: {
       tooltip: "Text Blocksatz",
     },
+    comment: {
+      tooltip: "Kommentar hinzufügen",
+    },
   },
   file_panel: {
     upload: {

packages/core/src/i18n/locales/en.ts

@@ -275,6 +275,9 @@ export const en = {
     align_justify: {
       tooltip: "Justify text",
     },
+    comment: {
+      tooltip: "Add comment",
+    },
   },
   file_panel: {
     upload: {

packages/core/src/i18n/locales/es.ts

@@ -272,6 +272,9 @@ export const es = {
     align_justify: {
       tooltip: "Justificar texto",
     },
+    comment: {
+      tooltip: "Agregar comentario",
+    },
   },
   file_panel: {
     upload: {

packages/core/src/i18n/locales/fr.ts

@@ -300,6 +300,9 @@ export const fr: Dictionary = {
     align_justify: {
       tooltip: "Justifier le texte",
     },
+    comment: {
+      tooltip: "Ajouter un commentaire",
+    },
   },
   file_panel: {
     upload: {

packages/core/src/i18n/locales/hr.ts

@@ -281,6 +281,9 @@ export const hr = {
     align_justify: {
       tooltip: "Poravnaj tekst obostrano",
     },
+    comment: {
+      tooltip: "Dodaj komentar",
+    },
   },
   file_panel: {
     upload: {

packages/core/src/i18n/locales/is.ts

@@ -268,6 +268,9 @@ export const is: Dictionary = {
     align_justify: {
       tooltip: "Jafna texta",
     },
+    comment: {
+      tooltip: "Bæta við athugun",
+    },
   },
   file_panel: {
     upload: {