@blocknote/core 0.18.0 → 0.19.1

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

@@ -1,5 +1,3 @@
-import { Node } from "prosemirror-model";
-
 import { Block, PartialBlock } from "../../../../blocks/defaultBlocks.js";
 import type { BlockNoteEditor } from "../../../../editor/BlockNoteEditor";
 import {
@@ -8,11 +6,11 @@ import {
   InlineContentSchema,
   StyleSchema,
 } from "../../../../schema/index.js";
+import { Node } from "prosemirror-model";
 import { blockToNode } from "../../../nodeConversions/blockToNode.js";
 import { nodeToBlock } from "../../../nodeConversions/nodeToBlock.js";
-import { removeBlocksWithCallback } from "../removeBlocks/removeBlocks.js";
 
-export function replaceBlocks<
+export function removeAndInsertBlocks<
   BSchema extends BlockSchema,
   I extends InlineContentSchema,
   S extends StyleSchema
@@ -24,6 +22,11 @@ export function replaceBlocks<
   insertedBlocks: Block<BSchema, I, S>[];
   removedBlocks: Block<BSchema, I, S>[];
 } {
+  const ttEditor = editor._tiptapEditor;
+  let tr = ttEditor.state.tr;
+
+  // Converts the `PartialBlock`s to ProseMirror nodes to insert them into the
+  // document.
   const nodesToInsert: Node[] = [];
   for (const block of blocksToInsert) {
     nodesToInsert.push(
@@ -31,28 +34,86 @@ export function replaceBlocks<
     );
   }
 
+  const idsOfBlocksToRemove = new Set<string>(
+    blocksToRemove.map((block) =>
+      typeof block === "string" ? block : block.id
+    )
+  );
+  const removedBlocks: Block<BSchema, I, S>[] = [];
+
   const idOfFirstBlock =
     typeof blocksToRemove[0] === "string"
       ? blocksToRemove[0]
       : blocksToRemove[0].id;
-  const removedBlocks = removeBlocksWithCallback(
-    editor,
-    blocksToRemove,
-    (node, pos, tr, removedSize) => {
-      if (node.attrs.id === idOfFirstBlock) {
-        const oldDocSize = tr.doc.nodeSize;
-        tr.insert(pos, nodesToInsert);
-        const newDocSize = tr.doc.nodeSize;
-
-        return removedSize + oldDocSize - newDocSize;
-      }
-
-      return removedSize;
+  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.isInGroup("bnBlock") ||
+      !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);
+
+    if (blocksToInsert.length > 0 && node.attrs.id === idOfFirstBlock) {
+      const oldDocSize = tr.doc.nodeSize;
+      tr = tr.insert(pos, nodesToInsert);
+      const newDocSize = tr.doc.nodeSize;
+
+      removedSize += oldDocSize - newDocSize;
     }
-  );
 
-  // Now that the `PartialBlock`s have been converted to nodes, we can
-  // re-convert them into full `Block`s.
+    const oldDocSize = tr.doc.nodeSize;
+    // Checks if the block is the only child of its parent. In this case, we
+    // need to delete the parent `blockGroup` node instead of just the
+    // `blockContainer`.
+    const $pos = tr.doc.resolve(pos - removedSize);
+    if (
+      $pos.node().type.name === "blockGroup" &&
+      $pos.node($pos.depth - 1).type.name !== "doc" &&
+      $pos.node().childCount === 1
+    ) {
+      tr = tr.delete($pos.before(), $pos.after());
+    } else {
+      tr = tr.delete(pos - removedSize, pos - removedSize + node.nodeSize);
+    }
+    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);
+
+  // Converts the nodes created from `blocksToInsert` into full `Block`s.
   const insertedBlocks: Block<BSchema, I, S>[] = [];
   for (const node of nodesToInsert) {
     insertedBlocks.push(
@@ -68,3 +129,18 @@ export function replaceBlocks<
 
   return { insertedBlocks, removedBlocks };
 }
+
+export function replaceBlocks<
+  BSchema extends BlockSchema,
+  I extends InlineContentSchema,
+  S extends StyleSchema
+>(
+  editor: BlockNoteEditor<BSchema, I, S>,
+  blocksToRemove: BlockIdentifier[],
+  blocksToInsert: PartialBlock<BSchema, I, S>[]
+): {
+  insertedBlocks: Block<BSchema, I, S>[];
+  removedBlocks: Block<BSchema, I, S>[];
+} {
+  return removeAndInsertBlocks(editor, blocksToRemove, blocksToInsert);
+}

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

@@ -361,7 +361,6 @@ exports[`Test splitBlocks > Basic 1`] = `
     },
     "id": "table-0",
     "props": {
-      "backgroundColor": "default",
       "textColor": "default",
     },
     "type": "table",
@@ -854,7 +853,6 @@ exports[`Test splitBlocks > Block has children 1`] = `
     },
     "id": "table-0",
     "props": {
-      "backgroundColor": "default",
       "textColor": "default",
     },
     "type": "table",
@@ -1347,7 +1345,6 @@ exports[`Test splitBlocks > Don't keep props 1`] = `
     },
     "id": "table-0",
     "props": {
-      "backgroundColor": "default",
       "textColor": "default",
     },
     "type": "table",
@@ -1840,7 +1837,6 @@ exports[`Test splitBlocks > Don't keep type 1`] = `
     },
     "id": "table-0",
     "props": {
-      "backgroundColor": "default",
       "textColor": "default",
     },
     "type": "table",
@@ -2327,7 +2323,6 @@ exports[`Test splitBlocks > End of content 1`] = `
     },
     "id": "table-0",
     "props": {
-      "backgroundColor": "default",
       "textColor": "default",
     },
     "type": "table",
@@ -2821,7 +2816,6 @@ exports[`Test splitBlocks > Keep type 1`] = `
     },
     "id": "table-0",
     "props": {
-      "backgroundColor": "default",
       "textColor": "default",
     },
     "type": "table",

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

@@ -28,11 +28,15 @@ function setSelectionWithOffset(
   offset: number
 ) {
   const posInfo = getNodeById(targetBlockId, doc);
-  const { blockContent } = getBlockInfo(posInfo);
+  const info = getBlockInfo(posInfo);
+
+  if (!info.isBlockContainer) {
+    throw new Error("Target block is not a block container");
+  }
 
   getEditor()._tiptapEditor.view.dispatch(
     getEditor()._tiptapEditor.state.tr.setSelection(
-      TextSelection.create(doc, blockContent.beforePos + offset + 1)
+      TextSelection.create(doc, info.blockContent.beforePos + offset + 1)
     )
   );
 }
@@ -123,12 +127,12 @@ describe("Test splitBlocks", () => {
 
     splitBlock(getEditor()._tiptapEditor.state.selection.anchor);
 
-    const { blockContainer } = getBlockInfoFromSelection(
+    const { bnBlock } = getBlockInfoFromSelection(
       getEditor()._tiptapEditor.state
     );
 
     const anchorIsAtStartOfNewBlock =
-      blockContainer.node.attrs.id === "0" &&
+      bnBlock.node.attrs.id === "0" &&
       getEditor()._tiptapEditor.state.selection.$anchor.parentOffset === 0;
 
     expect(anchorIsAtStartOfNewBlock).toBeTruthy();

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

@@ -2,7 +2,7 @@ import { EditorState } from "prosemirror-state";
 
 import {
   getBlockInfo,
-  getNearestBlockContainerPos,
+  getNearestBlockPos,
 } from "../../../getBlockInfoFromPos.js";
 
 export const splitBlockCommand = (
@@ -17,25 +17,26 @@ export const splitBlockCommand = (
     state: EditorState;
     dispatch: ((args?: any) => any) | undefined;
   }) => {
-    const nearestBlockContainerPos = getNearestBlockContainerPos(
-      state.doc,
-      posInBlock
-    );
+    const nearestBlockContainerPos = getNearestBlockPos(state.doc, posInBlock);
 
-    const { blockContainer, blockContent } = getBlockInfo(
-      nearestBlockContainerPos
-    );
+    const info = getBlockInfo(nearestBlockContainerPos);
+
+    if (!info.isBlockContainer) {
+      throw new Error(
+        `BlockContainer expected when calling splitBlock, position ${posInBlock}`
+      );
+    }
 
     const types = [
       {
-        type: blockContainer.node.type, // always keep blockcontainer type
-        attrs: keepProps ? { ...blockContainer.node.attrs, id: undefined } : {},
+        type: info.bnBlock.node.type, // always keep blockcontainer type
+        attrs: keepProps ? { ...info.bnBlock.node.attrs, id: undefined } : {},
       },
       {
         type: keepType
-          ? blockContent.node.type
+          ? info.blockContent.node.type
           : state.schema.nodes["paragraph"],
-        attrs: keepProps ? { ...blockContent.node.attrs } : {},
+        attrs: keepProps ? { ...info.blockContent.node.attrs } : {},
       },
     ];