@blocknote/core 0.30.1 → 0.31.0

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

@@ -1,5 +1,7 @@
 import { describe, expect, it } from "vitest";
 
+import { getBlockInfo } from "../../../getBlockInfoFromPos.js";
+import { getNodeById } from "../../../nodeUtil.js";
 import { setupTestEnv } from "../../setupTestEnv.js";
 import { updateBlock } from "./updateBlock.js";
 
@@ -173,6 +175,162 @@ describe("Test updateBlock", () => {
     expect(getEditor().document).toMatchSnapshot();
   });
 
+  it("Update partial (offset start)", () => {
+    const info = getBlockInfo(
+      getNodeById("heading-with-everything", getEditor().prosemirrorState.doc)!,
+    );
+
+    if (!info.isBlockContainer) {
+      throw new Error("heading-with-everything is not a block container");
+    }
+
+    getEditor().transact((tr) =>
+      updateBlock(
+        tr,
+        "heading-with-everything",
+        {
+          content: [
+            {
+              type: "text",
+              text: "without styles",
+              styles: {},
+            },
+          ],
+        },
+        info.blockContent.beforePos + 9,
+      ),
+    );
+
+    expect(getEditor().document).toMatchSnapshot();
+  });
+
+  it("Update partial (offset start + end)", () => {
+    const info = getBlockInfo(
+      getNodeById("heading-with-everything", getEditor().prosemirrorState.doc)!,
+    );
+
+    if (!info.isBlockContainer) {
+      throw new Error("heading-with-everything is not a block container");
+    }
+
+    getEditor().transact((tr) =>
+      updateBlock(
+        tr,
+        "heading-with-everything",
+        {
+          content: [
+            {
+              type: "text",
+              text: "without styles and ",
+              styles: {},
+            },
+          ],
+        },
+        info.blockContent.beforePos + 9,
+        info.blockContent.beforePos + 9,
+      ),
+    );
+
+    expect(getEditor().document).toMatchSnapshot();
+  });
+
+  it("Update partial (props + offset end)", () => {
+    const info = getBlockInfo(
+      getNodeById("heading-with-everything", getEditor().prosemirrorState.doc)!,
+    );
+
+    if (!info.isBlockContainer) {
+      throw new Error("heading-with-everything is not a block container");
+    }
+
+    getEditor().transact((tr) => {
+      updateBlock(
+        tr,
+        "heading-with-everything",
+        {
+          props: {
+            level: 1,
+          },
+          content: [
+            {
+              type: "text",
+              text: "Title",
+              styles: {},
+            },
+          ],
+        },
+        undefined,
+        info.blockContent.beforePos + 8,
+      );
+    });
+
+    expect(getEditor().document).toMatchSnapshot();
+  });
+
+  it("Update partial (table cell)", () => {
+    const info = getBlockInfo(
+      getNodeById("table-0", getEditor().prosemirrorState.doc)!,
+    );
+
+    if (!info.isBlockContainer) {
+      throw new Error("table-0 is not a block container");
+    }
+
+    const cell = info.blockContent.node.resolve(2);
+
+    getEditor().transact((tr) =>
+      updateBlock(
+        tr,
+        "table-0",
+        {
+          type: "table",
+          content: {
+            type: "tableContent",
+            rows: [{ cells: ["updated cell 1"] }],
+          },
+        },
+        info.blockContent.beforePos + 2,
+        info.blockContent.beforePos + 2 + cell.node().nodeSize,
+      ),
+    );
+
+    expect(getEditor().document).toMatchSnapshot();
+  });
+
+  it("Update partial (table row)", () => {
+    const info = getBlockInfo(
+      getNodeById("table-0", getEditor().prosemirrorState.doc)!,
+    );
+
+    if (!info.isBlockContainer) {
+      throw new Error("table-0 is not a block container");
+    }
+
+    const cell = info.blockContent.node.resolve(1);
+
+    getEditor().transact((tr) =>
+      updateBlock(
+        tr,
+        "table-0",
+        {
+          type: "table",
+          content: {
+            type: "tableContent",
+            rows: [
+              {
+                cells: ["updated cell 1", "updated cell 2", "updated cell 3"],
+              },
+            ],
+          },
+        },
+        info.blockContent.beforePos + 1,
+        info.blockContent.beforePos + 1 + cell.node().nodeSize,
+      ),
+    );
+
+    expect(getEditor().document).toMatchSnapshot();
+  });
+
   it("Update children", () => {
     expect(
       getEditor().transact((tr) =>

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

@@ -6,7 +6,7 @@ import {
 } from "prosemirror-model";
 import type { Transaction } from "prosemirror-state";
 
-import { ReplaceStep } from "prosemirror-transform";
+import { ReplaceStep, Transform } from "prosemirror-transform";
 import type { Block, PartialBlock } from "../../../../blocks/defaultBlocks.js";
 import type {
   BlockIdentifier,
@@ -28,6 +28,7 @@ import { nodeToBlock } from "../../../nodeConversions/nodeToBlock.js";
 import { getNodeById } from "../../../nodeUtil.js";
 import { getPmSchema } from "../../../pmUtil.js";
 
+// for compatibility with tiptap. TODO: remove as we want to remove dependency on tiptap command interface
 export const updateBlockCommand = <
   BSchema extends BlockSchema,
   I extends InlineContentSchema,
@@ -50,18 +51,29 @@ export const updateBlockCommand = <
   };
 };
 
-const updateBlockTr = <
+export function updateBlockTr<
   BSchema extends BlockSchema,
   I extends InlineContentSchema,
   S extends StyleSchema,
 >(
-  tr: Transaction,
+  tr: Transform,
   posBeforeBlock: number,
   block: PartialBlock<BSchema, I, S>,
-) => {
+  replaceFromPos?: number,
+  replaceToPos?: number,
+) {
   const blockInfo = getBlockInfoFromResolvedPos(tr.doc.resolve(posBeforeBlock));
 
   const pmSchema = getPmSchema(tr);
+
+  if (
+    replaceFromPos !== undefined &&
+    replaceToPos !== undefined &&
+    replaceFromPos > replaceToPos
+  ) {
+    throw new Error("Invalid replaceFromPos or replaceToPos");
+  }
+
   // Adds blockGroup node with child blocks if necessary.
 
   const oldNodeType = pmSchema.nodes[blockInfo.blockNoteType];
@@ -71,10 +83,32 @@ const updateBlockTr = <
     : pmSchema.nodes["blockContainer"];
 
   if (blockInfo.isBlockContainer && newNodeType.isInGroup("blockContent")) {
+    const replaceFromOffset =
+      replaceFromPos !== undefined &&
+      replaceFromPos > blockInfo.blockContent.beforePos &&
+      replaceFromPos < blockInfo.blockContent.afterPos
+        ? replaceFromPos - blockInfo.blockContent.beforePos - 1
+        : undefined;
+
+    const replaceToOffset =
+      replaceToPos !== undefined &&
+      replaceToPos > blockInfo.blockContent.beforePos &&
+      replaceToPos < blockInfo.blockContent.afterPos
+        ? replaceToPos - blockInfo.blockContent.beforePos - 1
+        : undefined;
+
     updateChildren(block, tr, blockInfo);
     // The code below determines the new content of the block.
     // or "keep" to keep as-is
-    updateBlockContentNode(block, tr, oldNodeType, newNodeType, blockInfo);
+    updateBlockContentNode(
+      block,
+      tr,
+      oldNodeType,
+      newNodeType,
+      blockInfo,
+      replaceFromOffset,
+      replaceToOffset,
+    );
   } else if (!blockInfo.isBlockContainer && newNodeType.isInGroup("bnBlock")) {
     updateChildren(block, tr, blockInfo);
     // old node was a bnBlock type (like column or columnList) and new block as well
@@ -109,7 +143,7 @@ const updateBlockTr = <
     ...blockInfo.bnBlock.node.attrs,
     ...block.props,
   });
-};
+}
 
 function updateBlockContentNode<
   BSchema extends BlockSchema,
@@ -117,7 +151,7 @@ function updateBlockContentNode<
   S extends StyleSchema,
 >(
   block: PartialBlock<BSchema, I, S>,
-  tr: Transaction,
+  tr: Transform,
   oldNodeType: NodeType,
   newNodeType: NodeType,
   blockInfo: {
@@ -126,6 +160,8 @@ function updateBlockContentNode<
       | undefined;
     blockContent: { node: PMNode; beforePos: number; afterPos: number };
   },
+  replaceFromOffset?: number,
+  replaceToOffset?: number,
 ) {
   const pmSchema = getPmSchema(tr);
   let content: PMNode[] | "keep" = "keep";
@@ -172,17 +208,43 @@ function updateBlockContentNode<
   // content is being replaced or not.
   if (content === "keep") {
     // use setNodeMarkup to only update the type and attributes
-    tr.setNodeMarkup(
-      blockInfo.blockContent.beforePos,
-      block.type === undefined ? undefined : pmSchema.nodes[block.type],
-      {
-        ...blockInfo.blockContent.node.attrs,
-        ...block.props,
-      },
+    tr.setNodeMarkup(blockInfo.blockContent.beforePos, newNodeType, {
+      ...blockInfo.blockContent.node.attrs,
+      ...block.props,
+    });
+  } else if (replaceFromOffset !== undefined || replaceToOffset !== undefined) {
+    // first update markup of the containing node
+    tr.setNodeMarkup(blockInfo.blockContent.beforePos, newNodeType, {
+      ...blockInfo.blockContent.node.attrs,
+      ...block.props,
+    });
+
+    const start =
+      blockInfo.blockContent.beforePos + 1 + (replaceFromOffset ?? 0);
+    const end =
+      blockInfo.blockContent.beforePos +
+      1 +
+      (replaceToOffset ?? blockInfo.blockContent.node.content.size);
+
+    // for content like table cells (where the blockcontent has nested PM nodes),
+    // we need to figure out the correct openStart and openEnd for the slice when replacing
+
+    const contentDepth = tr.doc.resolve(blockInfo.blockContent.beforePos).depth;
+    const startDepth = tr.doc.resolve(start).depth;
+    const endDepth = tr.doc.resolve(end).depth;
+
+    tr.replace(
+      start,
+      end,
+      new Slice(
+        Fragment.from(content),
+        startDepth - contentDepth - 1,
+        endDepth - contentDepth - 1,
+      ),
     );
   } else {
     // use replaceWith to replace the content and the block itself
-    // also  reset the selection since replacing the block content
+    // also reset the selection since replacing the block content
     // sets it to the next block.
     tr.replaceWith(
       blockInfo.blockContent.beforePos,
@@ -202,7 +264,7 @@ function updateChildren<
   BSchema extends BlockSchema,
   I extends InlineContentSchema,
   S extends StyleSchema,
->(block: PartialBlock<BSchema, I, S>, tr: Transaction, blockInfo: BlockInfo) {
+>(block: PartialBlock<BSchema, I, S>, tr: Transform, blockInfo: BlockInfo) {
   const pmSchema = getPmSchema(tr);
   if (block.children !== undefined && block.children.length > 0) {
     const childNodes = block.children.map((child) => {
@@ -242,6 +304,8 @@ export function updateBlock<
   tr: Transaction,
   blockToUpdate: BlockIdentifier,
   update: PartialBlock<BSchema, I, S>,
+  replaceFromPos?: number,
+  replaceToPos?: number,
 ): Block<BSchema, I, S> {
   const id =
     typeof blockToUpdate === "string" ? blockToUpdate : blockToUpdate.id;
@@ -250,7 +314,13 @@ export function updateBlock<
     throw new Error(`Block with ID ${id} not found`);
   }
 
-  updateBlockTr(tr, posInfo.posBeforeNode, update);
+  updateBlockTr(
+    tr,
+    posInfo.posBeforeNode,
+    update,
+    replaceFromPos,
+    replaceToPos,
+  );
 
   const blockContainerNode = tr.doc
     .resolve(posInfo.posBeforeNode + 1) // TODO: clean?

package/src/api/blockManipulation/selections/selection.ts

@@ -10,7 +10,10 @@ import {
   StyleSchema,
 } from "../../../schema/index.js";
 import { getBlockInfo, getNearestBlockPos } from "../../getBlockInfoFromPos.js";
-import { nodeToBlock } from "../../nodeConversions/nodeToBlock.js";
+import {
+  nodeToBlock,
+  prosemirrorSliceToSlicedBlocks,
+} from "../../nodeConversions/nodeToBlock.js";
 import { getNodeById } from "../../nodeUtil.js";
 import { getBlockNoteSchema, getPmSchema } from "../../pmUtil.js";
 
@@ -216,3 +219,47 @@ export function setSelection(
   //  restriction that the start/end blocks must have content.
   tr.setSelection(TextSelection.create(tr.doc, startPos, endPos));
 }
+
+export function getSelectionCutBlocks(tr: Transaction) {
+  // TODO: fix image node selection
+
+  const pmSchema = getPmSchema(tr);
+  let start = tr.selection.$from;
+  let end = tr.selection.$to;
+
+  // the selection moves below are used to make sure `prosemirrorSliceToSlicedBlocks` returns
+  // the correct information about whether content is cut at the start or end of a block
+
+  // if the end is at the end of a node (|</span></p>) move it forward so we include all closing tags (</span></p>|)
+  while (end.parentOffset >= end.parent.nodeSize - 2 && end.depth > 0) {
+    end = tr.doc.resolve(end.pos + 1);
+  }
+
+  // if the end is at the start of an empty node (</span></p><p>|) move it backwards so we drop empty start tags (</span></p>|)
+  while (end.parentOffset === 0 && end.depth > 0) {
+    end = tr.doc.resolve(end.pos - 1);
+  }
+
+  // if the start is at the start of a node (<p><span>|) move it backwards so we include all open tags (|<p><span>)
+  while (start.parentOffset === 0 && start.depth > 0) {
+    start = tr.doc.resolve(start.pos - 1);
+  }
+
+  // if the start is at the end of a node (|</p><p><span>|) move it forwards so we drop all closing tags (|<p><span>)
+  while (start.parentOffset >= start.parent.nodeSize - 2 && start.depth > 0) {
+    start = tr.doc.resolve(start.pos + 1);
+  }
+
+  const selectionInfo = prosemirrorSliceToSlicedBlocks(
+    tr.doc.slice(start.pos, end.pos, true),
+    pmSchema,
+  );
+
+  return {
+    _meta: {
+      startPos: start.pos,
+      endPos: end.pos,
+    },
+    ...selectionInfo,
+  };
+}

package/src/api/blockManipulation/selections/{textCursorPosition/textCursorPosition.ts → textCursorPosition.ts}

@@ -4,21 +4,21 @@ import {
   TextSelection,
   type Transaction,
 } from "prosemirror-state";
-import type { TextCursorPosition } from "../../../../editor/cursorPositionTypes.js";
+import type { TextCursorPosition } from "../../../editor/cursorPositionTypes.js";
 import type {
   BlockIdentifier,
   BlockSchema,
   InlineContentSchema,
   StyleSchema,
-} from "../../../../schema/index.js";
-import { UnreachableCaseError } from "../../../../util/typescript.js";
+} from "../../../schema/index.js";
+import { UnreachableCaseError } from "../../../util/typescript.js";
 import {
   getBlockInfo,
   getBlockInfoFromTransaction,
-} from "../../../getBlockInfoFromPos.js";
-import { nodeToBlock } from "../../../nodeConversions/nodeToBlock.js";
-import { getNodeById } from "../../../nodeUtil.js";
-import { getBlockNoteSchema, getPmSchema } from "../../../pmUtil.js";
+} from "../../getBlockInfoFromPos.js";
+import { nodeToBlock } from "../../nodeConversions/nodeToBlock.js";
+import { getNodeById } from "../../nodeUtil.js";
+import { getBlockNoteSchema, getPmSchema } from "../../pmUtil.js";
 
 export function getTextCursorPosition<
   BSchema extends BlockSchema,

package/src/api/getBlockInfoFromPos.ts

@@ -126,7 +126,7 @@ export function getBlockInfoWithManualOffset(
 ): BlockInfo {
   if (!node.type.isInGroup("bnBlock")) {
     throw new Error(
-      `Attempted to get bnBlock node at position but found node of different type ${node.type}`,
+      `Attempted to get bnBlock node at position but found node of different type ${node.type.name}`,
     );
   }
 

package/src/api/nodeConversions/blockToNode.ts

@@ -33,7 +33,7 @@ function styledTextToNodes<T extends StyleSchema>(
 ): Node[] {
   const marks: Mark[] = [];
 
-  for (const [style, value] of Object.entries(styledText.styles)) {
+  for (const [style, value] of Object.entries(styledText.styles || {})) {
     const config = styleSchema[style];
     if (!config) {
       throw new Error(`style ${style} not found in styleSchema`);
@@ -51,7 +51,9 @@ function styledTextToNodes<T extends StyleSchema>(
   const parseHardBreaks = !blockType || !schema.nodes[blockType].spec.code;
 
   if (!parseHardBreaks) {
-    return [schema.text(styledText.text, marks)];
+    return styledText.text.length > 0
+      ? [schema.text(styledText.text, marks)]
+      : [];
   }
 
   return (
@@ -259,6 +261,7 @@ export function tableContentToNodes<
       );
       columnNodes.push(cellNode);
     }
+
     const rowNode = schema.nodes["tableRow"].createChecked({}, columnNodes);
     rowNodes.push(rowNode);
   }