Merge remote-tracking branch 'origin/zod-tests' into refactor/zod-props-v2

YousefED · YousefED · commit 57602da94f0d · 2025-11-12T15:44:40.000+01:00
diff --git a/packages/core/src/blocks/Code/block.ts b/packages/core/src/blocks/Code/block.ts
@@ -171,6 +171,7 @@ export const createCodeBlockSpec = createBlockSpec(
         contentDOM: code,
       };
     },
+    runsBefore: [],
   }),
   (options) => {
     return [
diff --git a/packages/core/src/blocks/Divider/block.ts b/packages/core/src/blocks/Divider/block.ts
@@ -37,6 +37,7 @@ export const createDividerBlockSpec = createBlockSpec(
         dom,
       };
     },
+    runsBefore: [],
   },
   [
     createBlockNoteExtension({
diff --git a/packages/core/src/blocks/File/block.ts b/packages/core/src/blocks/File/block.ts
@@ -100,4 +100,5 @@ export const createFileBlockSpec = createBlockSpec(createFileBlockConfig, {
       dom: fileSrcLink,
     };
   },
+  runsBefore: [],
 });
diff --git a/packages/core/src/blocks/Heading/block.ts b/packages/core/src/blocks/Heading/block.ts
@@ -103,6 +103,7 @@ export const createHeadingBlockSpec = createBlockSpec(
         contentDOM: dom,
       };
     },
+    runsBefore: [],
   }),
   ({ levels = HEADING_LEVELS }: HeadingOptions = {}) => [
     createBlockNoteExtension({
diff --git a/packages/core/src/blocks/ListItem/BulletListItem/block.ts b/packages/core/src/blocks/ListItem/BulletListItem/block.ts
@@ -74,6 +74,7 @@ export const createBulletListItemBlockSpec = createBlockSpec(
         contentDOM: p,
       };
     },
+    runsBefore: [],
   },
   [
     createBlockNoteExtension({
diff --git a/packages/core/src/blocks/ListItem/NumberedListItem/block.ts b/packages/core/src/blocks/ListItem/NumberedListItem/block.ts
@@ -95,6 +95,7 @@ export const createNumberedListItemBlockSpec = createBlockSpec(
         contentDOM: p,
       };
     },
+    runsBefore: [],
   },
   [
     createBlockNoteExtension({
diff --git a/packages/core/src/blocks/ListItem/ToggleListItem/block.ts b/packages/core/src/blocks/ListItem/ToggleListItem/block.ts
@@ -46,6 +46,7 @@ export const createToggleListItemBlockSpec = createBlockSpec(
         contentDOM: p,
       };
     },
+    runsBefore: [],
   },
   [
     createBlockNoteExtension({
diff --git a/packages/core/src/blocks/PageBreak/block.ts b/packages/core/src/blocks/PageBreak/block.ts
@@ -53,6 +53,7 @@ export const createPageBreakBlockSpec = createBlockSpec(
         dom: pageBreak,
       };
     },
+    runsBefore: [],
   },
 );
 
diff --git a/packages/core/src/blocks/Quote/block.ts b/packages/core/src/blocks/Quote/block.ts
@@ -58,6 +58,7 @@ export const createQuoteBlockSpec = createBlockSpec(
         contentDOM: quote,
       };
     },
+    runsBefore: [],
   },
   [
     createBlockNoteExtension({
diff --git a/packages/core/src/schema/blocks/createSpec.ts b/packages/core/src/schema/blocks/createSpec.ts
@@ -385,6 +385,9 @@ export function createBlockSpec<
       config: blockConfig,
       implementation: {
         ...blockImplementation,
+        // If the block implementation does not specify a runsBefore, we default to ["default"]
+        // This allows for custom blocks to always be prioritized over default blocks.
+        runsBefore: blockImplementation.runsBefore ?? ["default"],
         // TODO: this should not have wrapInBlockStructure and generally be a lot simpler
         // post-processing in externalHTMLExporter should not be necessary
         toExternalHTML(block, editor) {
diff --git a/tests/src/unit/core/formatConversion/export/__snapshots__/blocknoteHTML/custom-blocks/advancedComplexAttributeNode.html b/tests/src/unit/core/formatConversion/export/__snapshots__/blocknoteHTML/custom-blocks/advancedComplexAttributeNode.html
@@ -0,0 +1,15 @@
+<div class="bn-block-group" data-node-type="blockGroup">
+  <div class="bn-block-outer" data-node-type="blockOuter" data-id="1">
+    <div class="bn-block" data-node-type="blockContainer" data-id="1">
+      <div
+        class="bn-block-content"
+        data-content-type="advancedComplexAttributeNode"
+        data-user="{&quot;name&quot;:{&quot;first&quot;:&quot;USER_FIRST_NAME&quot;,&quot;last&quot;:&quot;USER_LAST_NAME&quot;},&quot;age&quot;:30}"
+      >
+        <div
+          data-user="{&quot;name&quot;:{&quot;first&quot;:&quot;USER_FIRST_NAME&quot;,&quot;last&quot;:&quot;USER_LAST_NAME&quot;},&quot;age&quot;:30}"
+        ></div>
+      </div>
+    </div>
+  </div>
+</div>
diff --git a/tests/src/unit/core/formatConversion/export/__snapshots__/html/custom-blocks/advancedComplexAttributeNode.html b/tests/src/unit/core/formatConversion/export/__snapshots__/html/custom-blocks/advancedComplexAttributeNode.html
@@ -0,0 +1,3 @@
+<div
+  data-user="{&quot;name&quot;:{&quot;first&quot;:&quot;USER_FIRST_NAME&quot;,&quot;last&quot;:&quot;USER_LAST_NAME&quot;},&quot;age&quot;:30}"
+></div>
diff --git a/tests/src/unit/core/formatConversion/export/__snapshots__/markdown/custom-blocks/advancedComplexAttributeNode.md b/tests/src/unit/core/formatConversion/export/__snapshots__/markdown/custom-blocks/advancedComplexAttributeNode.md
diff --git a/tests/src/unit/core/formatConversion/export/__snapshots__/nodes/custom-blocks/advancedComplexAttributeNode.json b/tests/src/unit/core/formatConversion/export/__snapshots__/nodes/custom-blocks/advancedComplexAttributeNode.json
@@ -0,0 +1,22 @@
+[
+  {
+    "attrs": {
+      "id": "1",
+    },
+    "content": [
+      {
+        "attrs": {
+          "user": {
+            "age": 30,
+            "name": {
+              "first": "USER_FIRST_NAME",
+              "last": "USER_LAST_NAME",
+            },
+          },
+        },
+        "type": "advancedComplexAttributeNode",
+      },
+    ],
+    "type": "blockContainer",
+  },
+]
diff --git a/tests/src/unit/core/formatConversion/export/exportTestInstances.ts b/tests/src/unit/core/formatConversion/export/exportTestInstances.ts
@@ -1729,6 +1729,23 @@ export const exportTestInstancesBlockNoteHTML: TestInstance<
     },
     executeTest: testExportBlockNoteHTML,
   },
+  {
+    testCase: {
+      name: "custom-blocks/advancedComplexAttributeNode",
+      content: [
+        {
+          type: "advancedComplexAttributeNode",
+          props: {
+            user: {
+              name: { first: "USER_FIRST_NAME", last: "USER_LAST_NAME" },
+              age: 30,
+            },
+          },
+        },
+      ],
+    },
+    executeTest: testExportBlockNoteHTML,
+  },
 ];
 
 export const exportTestInstancesHTML: TestInstance<
diff --git a/tests/src/unit/core/schema/__snapshots__/blocks.json b/tests/src/unit/core/schema/__snapshots__/blocks.json
@@ -1,4 +1,28 @@
 {
+  "advancedComplexAttributeNode": {
+    "config": {
+      "content": "none",
+      "propSchema": {
+        "user": {
+          "age": 30,
+          "name": {
+            "first": "John",
+            "last": "Doe",
+          },
+        },
+      },
+      "type": "advancedComplexAttributeNode",
+    },
+    "extensions": undefined,
+    "implementation": {
+      "node": null,
+      "render": [Function],
+      "runsBefore": [
+        "default",
+      ],
+      "toExternalHTML": [Function],
+    },
+  },
   "audio": {
     "config": {
       "content": "none",
@@ -62,6 +86,7 @@
       "parse": [Function],
       "parseContent": [Function],
       "render": [Function],
+      "runsBefore": [],
       "toExternalHTML": [Function],
     },
   },
@@ -175,6 +200,7 @@
       "parse": [Function],
       "parseContent": [Function],
       "render": [Function],
+      "runsBefore": [],
       "toExternalHTML": [Function],
     },
   },
@@ -193,6 +219,9 @@
       "node": null,
       "parse": [Function],
       "render": [Function],
+      "runsBefore": [
+        "default",
+      ],
       "toExternalHTML": [Function],
     },
   },
@@ -223,6 +252,7 @@
       "node": null,
       "parse": [Function],
       "render": [Function],
+      "runsBefore": [],
       "toExternalHTML": [Function],
     },
   },
@@ -247,6 +277,7 @@
       "node": null,
       "parse": [Function],
       "render": [Function],
+      "runsBefore": [],
       "toExternalHTML": [Function],
     },
   },
@@ -310,6 +341,7 @@
       "node": null,
       "parse": [Function],
       "render": [Function],
+      "runsBefore": [],
       "toExternalHTML": [Function],
     },
   },
@@ -396,6 +428,7 @@
       "parse": [Function],
       "parseContent": [Function],
       "render": [Function],
+      "runsBefore": [],
       "toExternalHTML": [Function],
     },
   },
@@ -410,6 +443,7 @@
       "node": null,
       "parse": [Function],
       "render": [Function],
+      "runsBefore": [],
       "toExternalHTML": [Function],
     },
   },
@@ -479,6 +513,7 @@
       "node": null,
       "parse": [Function],
       "render": [Function],
+      "runsBefore": [],
       "toExternalHTML": [Function],
     },
   },
@@ -496,6 +531,9 @@
     "implementation": {
       "node": null,
       "render": [Function],
+      "runsBefore": [
+        "default",
+      ],
       "toExternalHTML": [Function],
     },
   },
@@ -516,6 +554,9 @@
     "implementation": {
       "node": null,
       "render": [Function],
+      "runsBefore": [
+        "default",
+      ],
       "toExternalHTML": [Function],
     },
   },
@@ -652,6 +693,7 @@
       },
       "node": null,
       "render": [Function],
+      "runsBefore": [],
       "toExternalHTML": [Function],
     },
   },
diff --git a/tests/src/unit/core/testSchema.ts b/tests/src/unit/core/testSchema.ts
@@ -11,7 +11,7 @@ import {
   defaultPropSchema,
   parseDefaultProps,
 } from "@blocknote/core";
-import { z } from "zod/v4";
+import z from "zod/v4";
 
 // BLOCKS ----------------------------------------------------------------------
 
@@ -101,6 +101,40 @@ const SimpleCustomParagraph = createBlockSpec(
   },
 );
 
+const ComplexAttributeNode = createBlockSpec(
+  createBlockConfig(
+    () =>
+      ({
+        type: "advancedComplexAttributeNode",
+        propSchema: createPropSchemaFromZod(
+          z.object({
+            user: z
+              .object({
+                name: z.object({
+                  first: z.string(),
+                  last: z.string(),
+                }),
+                age: z.number(),
+              })
+              .default({ name: { first: "John", last: "Doe" }, age: 30 }),
+          }),
+        ),
+        content: "none",
+      }) as const,
+  ),
+  {
+    render(block) {
+      const paragraph = document.createElement("div");
+
+      paragraph.setAttribute("data-user", JSON.stringify(block.props.user));
+
+      return {
+        dom: paragraph,
+      };
+    },
+  },
+);
+
 // INLINE CONTENT --------------------------------------------------------------
 
 const Mention = createInlineContentSpec(
@@ -224,6 +258,7 @@ export const testSchema = BlockNoteSchema.create().extend({
     customParagraph: CustomParagraph(),
     simpleCustomParagraph: SimpleCustomParagraph(),
     simpleImage: SimpleImage(),
+    advancedComplexAttributeNode: ComplexAttributeNode(),
   },
   inlineContentSpecs: {
     mention: Mention,
diff --git a/tests/src/unit/react/testSchema.tsx b/tests/src/unit/react/testSchema.tsx
@@ -65,6 +65,35 @@ const createContextParagraph = createReactBlockSpec(
   },
 );
 
+// const ComplexAttributeNode = addNodeAndExtensionsToSpec(
+//   {
+//     type: "advancedComplexAttributeNode",
+//     propSchema: createPropSchemaFromZod(
+//       z.object({
+//         user: z.object({
+//           name: z.object({
+//             first: z.string(),
+//             last: z.string(),
+//           }),
+//           age: z.number(),
+//         }),
+//       }),
+//     ),
+//     content: "none",
+//   },
+//   {
+//     render: (block) => {
+//       const paragraph = document.createElement("div");
+//       paragraph.setAttribute("data-user", JSON.stringify(block.props.user));
+
+//       return {
+//         dom: paragraph,
+//         contentDOM: paragraph,
+//       };
+//     },
+//   },
+// );
+
 // INLINE CONTENT --------------------------------------------------------------
 
 const Mention = createReactInlineContentSpec(

Original file line number	Diff line number	Diff line change
`@@ -37,6 +37,7 @@ export const createDividerBlockSpec = createBlockSpec(`
`37`	`37`	`dom,`
`38`	`38`	`};`
`39`	`39`	`},`
	`40`	`+ runsBefore: [],`
`40`	`41`	`},`
`41`	`42`	`[`
`42`	`43`	`createBlockNoteExtension({`
Original file line number	Diff line number	Diff line change
`@@ -74,6 +74,7 @@ export const createBulletListItemBlockSpec = createBlockSpec(`
`74`	`74`	`contentDOM: p,`
`75`	`75`	`};`
`76`	`76`	`},`
	`77`	`+ runsBefore: [],`
`77`	`78`	`},`
`78`	`79`	`[`
`79`	`80`	`createBlockNoteExtension({`
Original file line number	Diff line number	Diff line change
`@@ -95,6 +95,7 @@ export const createNumberedListItemBlockSpec = createBlockSpec(`
`95`	`95`	`contentDOM: p,`
`96`	`96`	`};`
`97`	`97`	`},`
	`98`	`+ runsBefore: [],`
`98`	`99`	`},`
`99`	`100`	`[`
`100`	`101`	`createBlockNoteExtension({`
Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,7 @@ export const createToggleListItemBlockSpec = createBlockSpec(`
`46`	`46`	`contentDOM: p,`
`47`	`47`	`};`
`48`	`48`	`},`
	`49`	`+ runsBefore: [],`
`49`	`50`	`},`
`50`	`51`	`[`
`51`	`52`	`createBlockNoteExtension({`
Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,7 @@ export const createQuoteBlockSpec = createBlockSpec(`
`58`	`58`	`contentDOM: quote,`
`59`	`59`	`};`
`60`	`60`	`},`
	`61`	`+ runsBefore: [],`
`61`	`62`	`},`
`62`	`63`	`[`
`63`	`64`	`createBlockNoteExtension({`