@blocknote/core 0.18.0 → 0.19.1

package/src/api/blockManipulation/commands/removeBlocks/__snapshots__/removeBlocks.test.ts.snap

@@ -1,7 +1,58 @@
 // Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-exports[`Test removeBlocks > Remove multiple consecutive blocks 1`] = `
+exports[`Test removeBlocks > Remove all child blocks 1`] = `
 [
+  {
+    "children": [],
+    "content": [
+      {
+        "styles": {},
+        "text": "Paragraph 0",
+        "type": "text",
+      },
+    ],
+    "id": "paragraph-0",
+    "props": {
+      "backgroundColor": "default",
+      "textAlignment": "left",
+      "textColor": "default",
+    },
+    "type": "paragraph",
+  },
+  {
+    "children": [],
+    "content": [
+      {
+        "styles": {},
+        "text": "Paragraph 1",
+        "type": "text",
+      },
+    ],
+    "id": "paragraph-1",
+    "props": {
+      "backgroundColor": "default",
+      "textAlignment": "left",
+      "textColor": "default",
+    },
+    "type": "paragraph",
+  },
+  {
+    "children": [],
+    "content": [
+      {
+        "styles": {},
+        "text": "Paragraph with children",
+        "type": "text",
+      },
+    ],
+    "id": "paragraph-with-children",
+    "props": {
+      "backgroundColor": "default",
+      "textAlignment": "left",
+      "textColor": "default",
+    },
+    "type": "paragraph",
+  },
   {
     "children": [],
     "content": [
@@ -256,8 +307,395 @@ exports[`Test removeBlocks > Remove multiple consecutive blocks 1`] = `
       "type": "tableContent",
     },
     "id": "table-0",
+    "props": {
+      "textColor": "default",
+    },
+    "type": "table",
+  },
+  {
+    "children": [],
+    "content": [
+      {
+        "styles": {},
+        "text": "Paragraph 7",
+        "type": "text",
+      },
+    ],
+    "id": "paragraph-7",
+    "props": {
+      "backgroundColor": "default",
+      "textAlignment": "left",
+      "textColor": "default",
+    },
+    "type": "paragraph",
+  },
+  {
+    "children": [],
+    "content": [],
+    "id": "empty-paragraph",
+    "props": {
+      "backgroundColor": "default",
+      "textAlignment": "left",
+      "textColor": "default",
+    },
+    "type": "paragraph",
+  },
+  {
+    "children": [],
+    "content": [
+      {
+        "styles": {},
+        "text": "Paragraph 8",
+        "type": "text",
+      },
+    ],
+    "id": "paragraph-8",
+    "props": {
+      "backgroundColor": "default",
+      "textAlignment": "left",
+      "textColor": "default",
+    },
+    "type": "paragraph",
+  },
+  {
+    "children": [
+      {
+        "children": [
+          {
+            "children": [],
+            "content": [
+              {
+                "styles": {},
+                "text": "Double Nested Paragraph 1",
+                "type": "text",
+              },
+            ],
+            "id": "double-nested-paragraph-1",
+            "props": {
+              "backgroundColor": "default",
+              "textAlignment": "left",
+              "textColor": "default",
+            },
+            "type": "paragraph",
+          },
+        ],
+        "content": [
+          {
+            "styles": {},
+            "text": "Nested Paragraph 1",
+            "type": "text",
+          },
+        ],
+        "id": "nested-paragraph-1",
+        "props": {
+          "backgroundColor": "default",
+          "textAlignment": "left",
+          "textColor": "default",
+        },
+        "type": "paragraph",
+      },
+    ],
+    "content": [
+      {
+        "styles": {
+          "bold": true,
+        },
+        "text": "Heading",
+        "type": "text",
+      },
+      {
+        "styles": {},
+        "text": " with styled ",
+        "type": "text",
+      },
+      {
+        "styles": {
+          "italic": true,
+        },
+        "text": "content",
+        "type": "text",
+      },
+    ],
+    "id": "heading-with-everything",
+    "props": {
+      "backgroundColor": "red",
+      "level": 2,
+      "textAlignment": "center",
+      "textColor": "red",
+    },
+    "type": "heading",
+  },
+  {
+    "children": [],
+    "content": [],
+    "id": "trailing-paragraph",
+    "props": {
+      "backgroundColor": "default",
+      "textAlignment": "left",
+      "textColor": "default",
+    },
+    "type": "paragraph",
+  },
+]
+`;
+
+exports[`Test removeBlocks > Remove multiple consecutive blocks 1`] = `
+[
+  {
+    "children": [],
+    "content": [
+      {
+        "styles": {},
+        "text": "Paragraph 2",
+        "type": "text",
+      },
+    ],
+    "id": "paragraph-2",
+    "props": {
+      "backgroundColor": "default",
+      "textAlignment": "left",
+      "textColor": "default",
+    },
+    "type": "paragraph",
+  },
+  {
+    "children": [],
+    "content": [
+      {
+        "styles": {},
+        "text": "Paragraph with props",
+        "type": "text",
+      },
+    ],
+    "id": "paragraph-with-props",
+    "props": {
+      "backgroundColor": "default",
+      "textAlignment": "center",
+      "textColor": "red",
+    },
+    "type": "paragraph",
+  },
+  {
+    "children": [],
+    "content": [
+      {
+        "styles": {},
+        "text": "Paragraph 3",
+        "type": "text",
+      },
+    ],
+    "id": "paragraph-3",
+    "props": {
+      "backgroundColor": "default",
+      "textAlignment": "left",
+      "textColor": "default",
+    },
+    "type": "paragraph",
+  },
+  {
+    "children": [],
+    "content": [
+      {
+        "styles": {
+          "bold": true,
+        },
+        "text": "Paragraph",
+        "type": "text",
+      },
+      {
+        "styles": {},
+        "text": " with styled ",
+        "type": "text",
+      },
+      {
+        "styles": {
+          "italic": true,
+        },
+        "text": "content",
+        "type": "text",
+      },
+    ],
+    "id": "paragraph-with-styled-content",
+    "props": {
+      "backgroundColor": "default",
+      "textAlignment": "left",
+      "textColor": "default",
+    },
+    "type": "paragraph",
+  },
+  {
+    "children": [],
+    "content": [
+      {
+        "styles": {},
+        "text": "Paragraph 4",
+        "type": "text",
+      },
+    ],
+    "id": "paragraph-4",
+    "props": {
+      "backgroundColor": "default",
+      "textAlignment": "left",
+      "textColor": "default",
+    },
+    "type": "paragraph",
+  },
+  {
+    "children": [],
+    "content": [
+      {
+        "styles": {},
+        "text": "Heading 1",
+        "type": "text",
+      },
+    ],
+    "id": "heading-0",
     "props": {
       "backgroundColor": "default",
+      "level": 1,
+      "textAlignment": "left",
+      "textColor": "default",
+    },
+    "type": "heading",
+  },
+  {
+    "children": [],
+    "content": [
+      {
+        "styles": {},
+        "text": "Paragraph 5",
+        "type": "text",
+      },
+    ],
+    "id": "paragraph-5",
+    "props": {
+      "backgroundColor": "default",
+      "textAlignment": "left",
+      "textColor": "default",
+    },
+    "type": "paragraph",
+  },
+  {
+    "children": [],
+    "content": undefined,
+    "id": "image-0",
+    "props": {
+      "backgroundColor": "default",
+      "caption": "",
+      "name": "",
+      "previewWidth": 512,
+      "showPreview": true,
+      "textAlignment": "left",
+      "url": "https://via.placeholder.com/150",
+    },
+    "type": "image",
+  },
+  {
+    "children": [],
+    "content": [
+      {
+        "styles": {},
+        "text": "Paragraph 6",
+        "type": "text",
+      },
+    ],
+    "id": "paragraph-6",
+    "props": {
+      "backgroundColor": "default",
+      "textAlignment": "left",
+      "textColor": "default",
+    },
+    "type": "paragraph",
+  },
+  {
+    "children": [],
+    "content": {
+      "columnWidths": [
+        undefined,
+        undefined,
+        undefined,
+      ],
+      "rows": [
+        {
+          "cells": [
+            [
+              {
+                "styles": {},
+                "text": "Cell 1",
+                "type": "text",
+              },
+            ],
+            [
+              {
+                "styles": {},
+                "text": "Cell 2",
+                "type": "text",
+              },
+            ],
+            [
+              {
+                "styles": {},
+                "text": "Cell 3",
+                "type": "text",
+              },
+            ],
+          ],
+        },
+        {
+          "cells": [
+            [
+              {
+                "styles": {},
+                "text": "Cell 4",
+                "type": "text",
+              },
+            ],
+            [
+              {
+                "styles": {},
+                "text": "Cell 5",
+                "type": "text",
+              },
+            ],
+            [
+              {
+                "styles": {},
+                "text": "Cell 6",
+                "type": "text",
+              },
+            ],
+          ],
+        },
+        {
+          "cells": [
+            [
+              {
+                "styles": {},
+                "text": "Cell 7",
+                "type": "text",
+              },
+            ],
+            [
+              {
+                "styles": {},
+                "text": "Cell 8",
+                "type": "text",
+              },
+            ],
+            [
+              {
+                "styles": {},
+                "text": "Cell 9",
+                "type": "text",
+              },
+            ],
+          ],
+        },
+      ],
+      "type": "tableContent",
+    },
+    "id": "table-0",
+    "props": {
       "textColor": "default",
     },
     "type": "table",
@@ -1013,7 +1451,6 @@ exports[`Test removeBlocks > Remove single block 1`] = `
     },
     "id": "table-0",
     "props": {
-      "backgroundColor": "default",
       "textColor": "default",
     },
     "type": "table",

package/src/api/blockManipulation/commands/removeBlocks/removeBlocks.test.ts

@@ -31,4 +31,10 @@ describe("Test removeBlocks", () => {
 
     expect(getEditor().document).toMatchSnapshot();
   });
+
+  it("Remove all child blocks", () => {
+    removeBlocks(getEditor(), ["nested-paragraph-0"]);
+
+    expect(getEditor().document).toMatchSnapshot();
+  });
 });

package/src/api/blockManipulation/commands/removeBlocks/removeBlocks.ts

@@ -1,6 +1,3 @@
-import { Node } from "prosemirror-model";
-import { Transaction } from "prosemirror-state";
-
 import { Block } from "../../../../blocks/defaultBlocks.js";
 import type { BlockNoteEditor } from "../../../../editor/BlockNoteEditor";
 import {
@@ -9,84 +6,7 @@ import {
   InlineContentSchema,
   StyleSchema,
 } from "../../../../schema/index.js";
-import { nodeToBlock } from "../../../nodeConversions/nodeToBlock.js";
-
-export function removeBlocksWithCallback<
-  BSchema extends BlockSchema,
-  I extends InlineContentSchema,
-  S extends StyleSchema
->(
-  editor: BlockNoteEditor<BSchema, I, S>,
-  blocksToRemove: BlockIdentifier[],
-  // Should return new removedSize.
-  callback?: (
-    node: Node,
-    pos: number,
-    tr: Transaction,
-    removedSize: number
-  ) => number
-): Block<BSchema, I, S>[] {
-  const ttEditor = editor._tiptapEditor;
-  const tr = ttEditor.state.tr;
-
-  const idsOfBlocksToRemove = new Set<string>(
-    blocksToRemove.map((block) =>
-      typeof block === "string" ? block : block.id
-    )
-  );
-  const removedBlocks: Block<BSchema, I, S>[] = [];
-  let removedSize = 0;
-
-  ttEditor.state.doc.descendants((node, pos) => {
-    // Skips traversing nodes after all target blocks have been removed.
-    if (idsOfBlocksToRemove.size === 0) {
-      return false;
-    }
-
-    // Keeps traversing nodes if block with target ID has not been found.
-    if (
-      node.type.name !== "blockContainer" ||
-      !idsOfBlocksToRemove.has(node.attrs.id)
-    ) {
-      return true;
-    }
-
-    // Saves the block that is being deleted.
-    removedBlocks.push(
-      nodeToBlock(
-        node,
-        editor.schema.blockSchema,
-        editor.schema.inlineContentSchema,
-        editor.schema.styleSchema,
-        editor.blockCache
-      )
-    );
-    idsOfBlocksToRemove.delete(node.attrs.id);
-
-    // Removes the block and calculates the change in document size.
-    removedSize = callback?.(node, pos, tr, removedSize) || removedSize;
-    const oldDocSize = tr.doc.nodeSize;
-    tr.delete(pos - removedSize - 1, pos - removedSize + node.nodeSize + 1);
-    const newDocSize = tr.doc.nodeSize;
-    removedSize += oldDocSize - newDocSize;
-
-    return false;
-  });
-
-  // Throws an error if now all blocks could be found.
-  if (idsOfBlocksToRemove.size > 0) {
-    const notFoundIds = [...idsOfBlocksToRemove].join("\n");
-
-    throw Error(
-      "Blocks with the following IDs could not be found in the editor: " +
-        notFoundIds
-    );
-  }
-
-  editor.dispatch(tr);
-
-  return removedBlocks;
-}
+import { removeAndInsertBlocks } from "../replaceBlocks/replaceBlocks.js";
 
 export function removeBlocks<
   BSchema extends BlockSchema,
@@ -96,5 +16,5 @@ export function removeBlocks<
   editor: BlockNoteEditor<BSchema, I, S>,
   blocksToRemove: BlockIdentifier[]
 ): Block<BSchema, I, S>[] {
-  return removeBlocksWithCallback(editor, blocksToRemove);
+  return removeAndInsertBlocks(editor, blocksToRemove, []).removedBlocks;
 }

package/src/api/blockManipulation/commands/replaceBlocks/__snapshots__/replaceBlocks.test.ts.snap

@@ -257,7 +257,6 @@ exports[`Test replaceBlocks > Remove multiple consecutive blocks 1`] = `
     },
     "id": "table-0",
     "props": {
-      "backgroundColor": "default",
       "textColor": "default",
     },
     "type": "table",
@@ -1013,7 +1012,6 @@ exports[`Test replaceBlocks > Remove single block 1`] = `
     },
     "id": "table-0",
     "props": {
-      "backgroundColor": "default",
       "textColor": "default",
     },
     "type": "table",
@@ -1453,7 +1451,6 @@ exports[`Test replaceBlocks > Replace multiple consecutive blocks with multiple
     },
     "id": "table-0",
     "props": {
-      "backgroundColor": "default",
       "textColor": "default",
     },
     "type": "table",
@@ -1853,7 +1850,6 @@ exports[`Test replaceBlocks > Replace multiple consecutive blocks with single ba
     },
     "id": "table-0",
     "props": {
-      "backgroundColor": "default",
       "textColor": "default",
     },
     "type": "table",
@@ -2310,7 +2306,6 @@ exports[`Test replaceBlocks > Replace multiple consecutive blocks with single co
     },
     "id": "table-0",
     "props": {
-      "backgroundColor": "default",
       "textColor": "default",
     },
     "type": "table",
@@ -3841,7 +3836,6 @@ exports[`Test replaceBlocks > Replace single block with multiple 1`] = `
     },
     "id": "table-0",
     "props": {
-      "backgroundColor": "default",
       "textColor": "default",
     },
     "type": "table",
@@ -4311,7 +4305,6 @@ exports[`Test replaceBlocks > Replace single block with single basic 1`] = `
     },
     "id": "table-0",
     "props": {
-      "backgroundColor": "default",
       "textColor": "default",
     },
     "type": "table",
@@ -4838,7 +4831,6 @@ exports[`Test replaceBlocks > Replace single block with single complex 1`] = `
     },
     "id": "table-0",
     "props": {
-      "backgroundColor": "default",
       "textColor": "default",
     },
     "type": "table",