@blocknote/core 0.30.1 → 0.31.1

package/src/api/nodeConversions/nodeToBlock.ts

@@ -1,5 +1,5 @@
-import { Mark, Node, Schema } from "@tiptap/pm/model";
-
+import { Mark, Node, Schema, Slice } from "@tiptap/pm/model";
+import type { Block } from "../../blocks/defaultBlocks.js";
 import UniqueID from "../../extensions/UniqueID/UniqueID.js";
 import type {
   BlockSchema,
@@ -13,17 +13,18 @@ import type {
   TableCell,
   TableContent,
 } from "../../schema/index.js";
-import { getBlockInfoWithManualOffset } from "../getBlockInfoFromPos.js";
-
-import type { Block } from "../../blocks/defaultBlocks.js";
 import {
   isLinkInlineContent,
   isStyledTextInlineContent,
 } from "../../schema/inlineContent/types.js";
 import { UnreachableCaseError } from "../../util/typescript.js";
-import { getBlockCache, getStyleSchema } from "../pmUtil.js";
-import { getInlineContentSchema } from "../pmUtil.js";
-import { getBlockSchema } from "../pmUtil.js";
+import { getBlockInfoWithManualOffset } from "../getBlockInfoFromPos.js";
+import {
+  getBlockCache,
+  getBlockSchema,
+  getInlineContentSchema,
+  getStyleSchema,
+} from "../pmUtil.js";
 
 /**
  * Converts an internal (prosemirror) table node contentto a BlockNote Tablecontent
@@ -492,3 +493,197 @@ export function nodeToBlock<
 
   return block;
 }
+
+/**
+ * Convert a Prosemirror document to a BlockNote document (array of blocks)
+ */
+export function docToBlocks<
+  BSchema extends BlockSchema,
+  I extends InlineContentSchema,
+  S extends StyleSchema,
+>(
+  doc: Node,
+  schema: Schema,
+  blockSchema: BSchema = getBlockSchema(schema) as BSchema,
+  inlineContentSchema: I = getInlineContentSchema(schema) as I,
+  styleSchema: S = getStyleSchema(schema) as S,
+  blockCache = getBlockCache(schema),
+) {
+  const blocks: Block<BSchema, I, S>[] = [];
+  doc.firstChild!.descendants((node) => {
+    blocks.push(
+      nodeToBlock(
+        node,
+        schema,
+        blockSchema,
+        inlineContentSchema,
+        styleSchema,
+        blockCache,
+      ),
+    );
+    return false;
+  });
+  return blocks;
+}
+
+/**
+ *
+ * Parse a Prosemirror Slice into a BlockNote selection. The prosemirror schema looks like this:
+ *
+ * <blockGroup>
+ *   <blockContainer> (main content of block)
+ *       <p, heading, etc.>
+ *   <blockGroup> (only if blocks has children)
+ *     <blockContainer> (child block)
+ *       <p, heading, etc.>
+ *     </blockContainer>
+ *    <blockContainer> (child block 2)
+ *       <p, heading, etc.>
+ *     </blockContainer>
+ *   </blockContainer>
+ *  </blockGroup>
+ * </blockGroup>
+ *
+ */
+export function prosemirrorSliceToSlicedBlocks<
+  BSchema extends BlockSchema,
+  I extends InlineContentSchema,
+  S extends StyleSchema,
+>(
+  slice: Slice,
+  schema: Schema,
+  blockSchema: BSchema = getBlockSchema(schema) as BSchema,
+  inlineContentSchema: I = getInlineContentSchema(schema) as I,
+  styleSchema: S = getStyleSchema(schema) as S,
+  blockCache: WeakMap<Node, Block<BSchema, I, S>> = getBlockCache(schema),
+): {
+  /**
+   * The blocks that are included in the selection.
+   */
+  blocks: Block<BSchema, I, S>[];
+  /**
+   * If a block was "cut" at the start of the selection, this will be the id of the block that was cut.
+   */
+  blockCutAtStart: string | undefined;
+  /**
+   * If a block was "cut" at the end of the selection, this will be the id of the block that was cut.
+   */
+  blockCutAtEnd: string | undefined;
+} {
+  // console.log(JSON.stringify(slice.toJSON()));
+  function processNode(
+    node: Node,
+    openStart: number,
+    openEnd: number,
+  ): {
+    blocks: Block<BSchema, I, S>[];
+    blockCutAtStart: string | undefined;
+    blockCutAtEnd: string | undefined;
+  } {
+    if (node.type.name !== "blockGroup") {
+      throw new Error("unexpected");
+    }
+    const blocks: Block<BSchema, I, S>[] = [];
+    let blockCutAtStart: string | undefined;
+    let blockCutAtEnd: string | undefined;
+
+    node.forEach((blockContainer, _offset, index) => {
+      if (blockContainer.type.name !== "blockContainer") {
+        throw new Error("unexpected");
+      }
+      if (blockContainer.childCount === 0) {
+        return;
+      }
+      if (blockContainer.childCount === 0 || blockContainer.childCount > 2) {
+        throw new Error(
+          "unexpected, blockContainer.childCount: " + blockContainer.childCount,
+        );
+      }
+
+      const isFirstBlock = index === 0;
+      const isLastBlock = index === node.childCount - 1;
+
+      if (blockContainer.firstChild!.type.name === "blockGroup") {
+        // this is the parent where a selection starts within one of its children,
+        // e.g.:
+        // A
+        // ├── B
+        // selection starts within B, then this blockContainer is A, but we don't care about A
+        // so let's descend into B and continue processing
+        if (!isFirstBlock) {
+          throw new Error("unexpected");
+        }
+        const ret = processNode(
+          blockContainer.firstChild!,
+          Math.max(0, openStart - 1),
+          isLastBlock ? Math.max(0, openEnd - 1) : 0,
+        );
+        blockCutAtStart = ret.blockCutAtStart;
+        if (isLastBlock) {
+          blockCutAtEnd = ret.blockCutAtEnd;
+        }
+        blocks.push(...ret.blocks);
+        return;
+      }
+
+      const block = nodeToBlock(
+        blockContainer,
+        schema,
+        blockSchema,
+        inlineContentSchema,
+        styleSchema,
+        blockCache,
+      );
+      const childGroup =
+        blockContainer.childCount > 1 ? blockContainer.child(1) : undefined;
+
+      let childBlocks: Block<BSchema, I, S>[] = [];
+      if (childGroup) {
+        const ret = processNode(
+          childGroup,
+          0, // TODO: can this be anything other than 0?
+          isLastBlock ? Math.max(0, openEnd - 1) : 0,
+        );
+        childBlocks = ret.blocks;
+        if (isLastBlock) {
+          blockCutAtEnd = ret.blockCutAtEnd;
+        }
+      }
+
+      if (isLastBlock && !childGroup && openEnd > 1) {
+        blockCutAtEnd = block.id;
+      }
+
+      if (isFirstBlock && openStart > 1) {
+        blockCutAtStart = block.id;
+      }
+
+      blocks.push({
+        ...(block as any),
+        children: childBlocks,
+      });
+    });
+
+    return { blocks, blockCutAtStart, blockCutAtEnd };
+  }
+
+  if (slice.content.childCount === 0) {
+    return {
+      blocks: [],
+      blockCutAtStart: undefined,
+      blockCutAtEnd: undefined,
+    };
+  }
+
+  if (slice.content.childCount !== 1) {
+    throw new Error(
+      "slice must be a single block, did you forget includeParents=true?",
+    );
+  }
+
+  return processNode(
+    slice.content.firstChild!,
+    Math.max(slice.openStart - 1, 0),
+    Math.max(slice.openEnd - 1, 0),
+  );
+}

package/src/api/pmUtil.ts

@@ -1,12 +1,12 @@
 import type { Node, Schema } from "prosemirror-model";
-import type { Transaction } from "prosemirror-state";
+import { Transform } from "prosemirror-transform";
 import type { BlockNoteEditor } from "../editor/BlockNoteEditor.js";
+import { BlockNoteSchema } from "../editor/BlockNoteSchema.js";
 import type { BlockSchema } from "../schema/blocks/types.js";
 import type { InlineContentSchema } from "../schema/inlineContent/types.js";
 import type { StyleSchema } from "../schema/styles/types.js";
-import { BlockNoteSchema } from "../editor/BlockNoteSchema.js";
 
-export function getPmSchema(trOrNode: Transaction | Node) {
+export function getPmSchema(trOrNode: Transform | Node) {
   if ("doc" in trOrNode) {
     return trOrNode.doc.type.schema;
   }

package/src/blocks/CodeBlockContent/CodeBlockContent.ts

@@ -1,15 +1,15 @@
+import type { HighlighterGeneric } from "@shikijs/types";
 import { InputRule, isTextSelection } from "@tiptap/core";
 import { TextSelection } from "@tiptap/pm/state";
-import { createHighlightPlugin, Parser } from "prosemirror-highlight";
+import { Parser, createHighlightPlugin } from "prosemirror-highlight";
 import { createParser } from "prosemirror-highlight/shiki";
+import { BlockNoteEditor } from "../../index.js";
 import {
+  PropSchema,
   createBlockSpecFromStronglyTypedTiptapNode,
   createStronglyTypedTiptapNode,
-  PropSchema,
 } from "../../schema/index.js";
 import { createDefaultBlockDOMOutputSpec } from "../defaultBlockHelpers.js";
-import type { HighlighterGeneric } from "@shikijs/types";
-import { BlockNoteEditor } from "../../index.js";
 
 export type CodeBlockOptions = {
   /**
@@ -76,7 +76,7 @@ const CodeBlockContent = createStronglyTypedTiptapNode({
   name: "codeBlock",
   content: "inline*",
   group: "blockContent",
-  marks: "",
+  marks: "insertion deletion modification",
   code: true,
   defining: true,
   addOptions() {
@@ -152,7 +152,7 @@ const CodeBlockContent = createStronglyTypedTiptapNode({
       // Parse from external HTML.
       {
         tag: "pre",
-        contentElement: "code",
+        // contentElement: "code",
         preserveWhitespace: "full",
       },
     ];

package/src/blocks/FileBlockContent/helpers/render/createAddFileButton.ts

@@ -33,7 +33,7 @@ export const createAddFileButton = (
   // Opens the file toolbar.
   const addFileButtonClickHandler = () => {
     editor.transact((tr) =>
-      tr.setMeta(editor.filePanel!.plugin, {
+      tr.setMeta(editor.filePanel!.plugins[0], {
         block: block,
       }),
     );

package/src/blocks/TableBlockContent/TableBlockContent.ts

@@ -1,9 +1,8 @@
+import { Node, mergeAttributes } from "@tiptap/core";
 import { TableCell } from "@tiptap/extension-table-cell";
 import { TableHeader } from "@tiptap/extension-table-header";
-import { TableRow } from "@tiptap/extension-table-row";
 import { DOMParser, Fragment, Node as PMNode, Schema } from "prosemirror-model";
 import { TableView } from "prosemirror-tables";
-
 import { NodeView } from "prosemirror-view";
 import {
   createBlockSpecFromStronglyTypedTiptapNode,
@@ -24,6 +23,7 @@ export const TableBlockContent = createStronglyTypedTiptapNode({
   group: "blockContent",
   tableRole: "table",
 
+  marks: "deletion insertion modification",
   isolating: true,
 
   parseHTML() {
@@ -152,6 +152,36 @@ const TableParagraph = createStronglyTypedTiptapNode({
 });
 
 /**
+ * This extension allows you to create table rows.
+ * @see https://www.tiptap.dev/api/nodes/table-row
+ */
+export const TableRow = Node.create<{ HTMLAttributes: Record<string, any> }>({
+  name: "tableRow",
+
+  addOptions() {
+    return {
+      HTMLAttributes: {},
+    };
+  },
+
+  content: "(tableCell | tableHeader)+",
+
+  tableRole: "row",
+  marks: "deletion insertion modification",
+  parseHTML() {
+    return [{ tag: "tr" }];
+  },
+
+  renderHTML({ HTMLAttributes }) {
+    return [
+      "tr",
+      mergeAttributes(this.options.HTMLAttributes, HTMLAttributes),
+      0,
+    ];
+  },
+});
+
+/*
  * This will flatten a node's content to fit into a table cell's paragraph.
  */
 function parseTableContent(node: HTMLElement, schema: Schema) {

package/src/editor/Block.css

@@ -152,6 +152,11 @@ NESTED BLOCKS
 
 .bn-block-outer:not([data-prev-type])
   > .bn-block
+  > .bn-block-content[data-content-type="heading"],
+.bn-block-outer:not([data-prev-type])
+  > .bn-block
+  > div[data-type="modification"]
+  > div[data-type="modification"]
   > .bn-block-content[data-content-type="heading"] {
   font-size: var(--level);
   font-weight: bold;
@@ -195,6 +200,10 @@ NESTED BLOCKS
 
 .bn-block-outer:not([data-prev-type])
   > .bn-block
+  > .bn-block-content[data-content-type="numberedListItem"]::before,
+.bn-block-outer:not([data-prev-type])
+  > .bn-block
+  > div[data-type="modification"]
   > .bn-block-content[data-content-type="numberedListItem"]::before {
   content: var(--index) ".";
 }
@@ -239,6 +248,10 @@ NESTED BLOCKS
 
 .bn-block-outer:not([data-prev-type])
   > .bn-block
+  > .bn-block-content[data-content-type="bulletListItem"]::before,
+.bn-block-outer:not([data-prev-type])
+  > .bn-block
+  > div[data-type="modification"]
   > .bn-block-content[data-content-type="bulletListItem"]::before {
   content: "•";
 }
@@ -256,6 +269,12 @@ NESTED BLOCKS
   ~ .bn-block-group
   > .bn-block-outer:not([data-prev-type])
   > .bn-block
+  > .bn-block-content[data-content-type="bulletListItem"]::before,
+[data-content-type="bulletListItem"]
+  ~ .bn-block-group
+  > .bn-block-outer:not([data-prev-type])
+  > .bn-block
+  > div[data-type="modification"]
   > .bn-block-content[data-content-type="bulletListItem"]::before {
   content: "◦";
 }
@@ -277,6 +296,14 @@ NESTED BLOCKS
   ~ .bn-block-group
   > .bn-block-outer:not([data-prev-type])
   > .bn-block
+  > .bn-block-content[data-content-type="bulletListItem"]::before,
+[data-content-type="bulletListItem"]
+  ~ .bn-block-group
+  [data-content-type="bulletListItem"]
+  ~ .bn-block-group
+  > .bn-block-outer:not([data-prev-type])
+  > .bn-block
+  > div[data-type="modification"]
   > .bn-block-content[data-content-type="bulletListItem"]::before {
   content: "▪";
 }
@@ -442,7 +469,6 @@ NESTED BLOCKS
   position: absolute;
   font-style: italic;
 }
-
 /* TODO: should this be here? */
 
 /* TEXT COLORS */

package/src/editor/BlockNoteEditor.test.ts

@@ -75,6 +75,13 @@ it("adds id attribute when requested", async () => {
   );
 });
 
+it("updates block", () => {
+  const editor = BlockNoteEditor.create();
+  editor.updateBlock(editor.document[0], {
+    content: "hello",
+  });
+});
+
 it("block prop types", () => {
   // this test checks whether the block props are correctly typed in typescript
   const editor = BlockNoteEditor.create();