@blocknote/core 0.15.11 → 0.17.0

package/src/schema/blocks/createSpec.ts

@@ -1,22 +1,22 @@
 import { Editor } from "@tiptap/core";
 import { TagParseRule } from "@tiptap/pm/model";
 import { NodeView } from "@tiptap/pm/view";
-import type { BlockNoteEditor } from "../../editor/BlockNoteEditor";
-import { InlineContentSchema } from "../inlineContent/types";
-import { StyleSchema } from "../styles/types";
+import type { BlockNoteEditor } from "../../editor/BlockNoteEditor.js";
+import { InlineContentSchema } from "../inlineContent/types.js";
+import { StyleSchema } from "../styles/types.js";
 import {
   createInternalBlockSpec,
   createStronglyTypedTiptapNode,
   getBlockFromPos,
   propsToAttributes,
   wrapInBlockStructure,
-} from "./internal";
+} from "./internal.js";
 import {
   BlockConfig,
   BlockFromConfig,
   BlockSchemaWithBlock,
   PartialBlockFromConfig,
-} from "./types";
+} from "./types.js";
 
 // restrict content to "inline" and "none" only
 export type CustomBlockConfig = BlockConfig & {
@@ -154,15 +154,24 @@ export function createBlockSpec<
       return getParseRules(blockConfig, blockImplementation.parse);
     },
 
-    renderHTML() {
-      // renderHTML is not really used, as we always use a nodeView, and we use toExternalHTML / toInternalHTML for serialization
-      // There's an edge case when this gets called nevertheless; before the nodeviews have been mounted
-      // this is why we implement it with a temporary placeholder
+    renderHTML({ HTMLAttributes }) {
+      // renderHTML is used for copy/pasting content from the editor back into
+      // the editor, so we need to make sure the `blockContent` element is
+      // structured correctly as this is what's used for parsing blocks. We
+      // just render a placeholder div inside as the `blockContent` element
+      // already has all the information needed for proper parsing.
       const div = document.createElement("div");
-      div.setAttribute("data-tmp-placeholder", "true");
-      return {
-        dom: div,
-      };
+      return wrapInBlockStructure(
+        {
+          dom: div,
+          contentDOM: blockConfig.content === "inline" ? div : undefined,
+        },
+        blockConfig.type,
+        {},
+        blockConfig.propSchema,
+        blockConfig.isFileBlock,
+        HTMLAttributes
+      );
     },
 
     addNodeView() {
@@ -222,6 +231,8 @@ export function createBlockSpec<
         blockContentDOMAttributes
       );
     },
+    // TODO: this should not have wrapInBlockStructure and generally be a lot simpler
+    // post-processing in externalHTMLExporter should not be necessary
     toExternalHTML: (block, editor) => {
       const blockContentDOMAttributes =
         node.options.domAttributes?.blockContent || {};
@@ -233,7 +244,6 @@ export function createBlockSpec<
       if (output === undefined) {
         output = blockImplementation.render(block as any, editor as any);
       }
-
       return wrapInBlockStructure(
         output,
         block.type,

package/src/schema/blocks/internal.ts

@@ -6,14 +6,14 @@ import {
   Node,
   NodeConfig,
 } from "@tiptap/core";
-import { defaultBlockToHTML } from "../../blocks/defaultBlockHelpers";
-import { inheritedProps } from "../../blocks/defaultProps";
-import type { BlockNoteEditor } from "../../editor/BlockNoteEditor";
-import { mergeCSSClasses } from "../../util/browser";
-import { camelToDataKebab } from "../../util/string";
-import { InlineContentSchema } from "../inlineContent/types";
-import { PropSchema, Props } from "../propTypes";
-import { StyleSchema } from "../styles/types";
+import { defaultBlockToHTML } from "../../blocks/defaultBlockHelpers.js";
+import { inheritedProps } from "../../blocks/defaultProps.js";
+import type { BlockNoteEditor } from "../../editor/BlockNoteEditor.js";
+import { mergeCSSClasses } from "../../util/browser.js";
+import { camelToDataKebab } from "../../util/string.js";
+import { InlineContentSchema } from "../inlineContent/types.js";
+import { PropSchema, Props } from "../propTypes.js";
+import { StyleSchema } from "../styles/types.js";
 import {
   BlockConfig,
   BlockSchemaFromSpecs,
@@ -22,7 +22,7 @@ import {
   BlockSpecs,
   SpecificBlock,
   TiptapBlockImplementation,
-} from "./types";
+} from "./types.js";
 
 // Function that uses the 'propSchema' of a blockConfig to create a TipTap
 // node's `addAttributes` property.

package/src/schema/blocks/types.ts

@@ -1,14 +1,14 @@
 /** Define the main block types **/
 import type { Extension, Node } from "@tiptap/core";
 
-import type { BlockNoteEditor } from "../../editor/BlockNoteEditor";
+import type { BlockNoteEditor } from "../../editor/BlockNoteEditor.js";
 import type {
   InlineContent,
   InlineContentSchema,
   PartialInlineContent,
-} from "../inlineContent/types";
-import type { PropSchema, Props } from "../propTypes";
-import type { StyleSchema } from "../styles/types";
+} from "../inlineContent/types.js";
+import type { PropSchema, Props } from "../propTypes.js";
+import type { StyleSchema } from "../styles/types.js";
 
 export type BlockNoteDOMElement =
   | "editor"

package/src/schema/index.ts

@@ -1,10 +1,10 @@
-export * from "./blocks/createSpec";
-export * from "./blocks/internal";
-export * from "./blocks/types";
-export * from "./inlineContent/createSpec";
-export * from "./inlineContent/internal";
-export * from "./inlineContent/types";
-export * from "./propTypes";
-export * from "./styles/createSpec";
-export * from "./styles/internal";
-export * from "./styles/types";
+export * from "./blocks/createSpec.js";
+export * from "./blocks/internal.js";
+export * from "./blocks/types.js";
+export * from "./inlineContent/createSpec.js";
+export * from "./inlineContent/internal.js";
+export * from "./inlineContent/types.js";
+export * from "./propTypes.js";
+export * from "./styles/createSpec.js";
+export * from "./styles/internal.js";
+export * from "./styles/types.js";

package/src/schema/inlineContent/createSpec.ts

@@ -1,24 +1,23 @@
 import { Node } from "@tiptap/core";
+
 import { TagParseRule } from "@tiptap/pm/model";
-import {
-  inlineContentToNodes,
-  nodeToCustomInlineContent,
-} from "../../api/nodeConversions/nodeConversions";
-import type { BlockNoteEditor } from "../../editor/BlockNoteEditor";
-import { propsToAttributes } from "../blocks/internal";
-import { Props } from "../propTypes";
-import { StyleSchema } from "../styles/types";
+import { inlineContentToNodes } from "../../api/nodeConversions/blockToNode.js";
+import { nodeToCustomInlineContent } from "../../api/nodeConversions/nodeToBlock.js";
+import type { BlockNoteEditor } from "../../editor/BlockNoteEditor.js";
+import { propsToAttributes } from "../blocks/internal.js";
+import { Props } from "../propTypes.js";
+import { StyleSchema } from "../styles/types.js";
 import {
   addInlineContentAttributes,
   addInlineContentKeyboardShortcuts,
   createInlineContentSpecFromTipTapNode,
-} from "./internal";
+} from "./internal.js";
 import {
   CustomInlineContentConfig,
   InlineContentFromConfig,
   InlineContentSpec,
   PartialCustomInlineContentFromConfig,
-} from "./types";
+} from "./types.js";
 
 // TODO: support serialization
 

package/src/schema/inlineContent/internal.ts

@@ -1,7 +1,7 @@
 import { KeyboardShortcutCommand, Node } from "@tiptap/core";
 
-import { camelToDataKebab } from "../../util/string";
-import { PropSchema, Props } from "../propTypes";
+import { camelToDataKebab } from "../../util/string.js";
+import { PropSchema, Props } from "../propTypes.js";
 import {
   CustomInlineContentConfig,
   InlineContentConfig,
@@ -9,7 +9,7 @@ import {
   InlineContentSchemaFromSpecs,
   InlineContentSpec,
   InlineContentSpecs,
-} from "./types";
+} from "./types.js";
 
 // Function that adds necessary classes and attributes to the `dom` element
 // returned from a custom inline content's 'render' function, to ensure no data

package/src/schema/inlineContent/types.ts

@@ -1,6 +1,6 @@
 import { Node } from "@tiptap/core";
-import { PropSchema, Props } from "../propTypes";
-import { StyleSchema, Styles } from "../styles/types";
+import { PropSchema, Props } from "../propTypes.js";
+import { StyleSchema, Styles } from "../styles/types.js";
 
 export type CustomInlineContentConfig = {
   type: string;

package/src/schema/styles/createSpec.ts

@@ -1,12 +1,13 @@
 import { Mark } from "@tiptap/core";
+
 import { ParseRule } from "@tiptap/pm/model";
+import { UnreachableCaseError } from "../../util/typescript.js";
 import {
   addStyleAttributes,
   createInternalStyleSpec,
   stylePropsToAttributes,
-} from "./internal";
-import { StyleConfig, StyleSpec } from "./types";
-import {UnreachableCaseError} from "../../util/typescript";
+} from "./internal.js";
+import { StyleConfig, StyleSpec } from "./types.js";
 
 export type CustomStyleImplementation<T extends StyleConfig> = {
   render: T["propSchema"] extends "boolean"

package/src/schema/styles/internal.ts

@@ -6,7 +6,7 @@ import {
   StyleSchemaFromSpecs,
   StyleSpec,
   StyleSpecs,
-} from "./types";
+} from "./types.js";
 
 export function stylePropsToAttributes(
   propSchema: StylePropSchema

package/types/src/api/blockManipulation/commands/insertBlocks/insertBlocks.d.ts

@@ -0,0 +1,4 @@
+import { Block, PartialBlock } from "../../../../blocks/defaultBlocks.js";
+import type { BlockNoteEditor } from "../../../../editor/BlockNoteEditor";
+import { BlockIdentifier, BlockSchema, InlineContentSchema, StyleSchema } from "../../../../schema/index.js";
+export declare function insertBlocks<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(editor: BlockNoteEditor<BSchema, I, S>, blocksToInsert: PartialBlock<BSchema, I, S>[], referenceBlock: BlockIdentifier, placement?: "before" | "after"): Block<BSchema, I, S>[];

package/types/src/api/blockManipulation/commands/mergeBlocks/mergeBlocks.d.ts

@@ -0,0 +1,7 @@
+import { Node, ResolvedPos } from "prosemirror-model";
+import { EditorState } from "prosemirror-state";
+export declare const getPrevBlockPos: (doc: Node, $nextBlockPos: ResolvedPos) => ResolvedPos;
+export declare const mergeBlocksCommand: (posBetweenBlocks: number) => ({ state, dispatch, }: {
+    state: EditorState;
+    dispatch: ((args?: any) => any) | undefined;
+}) => boolean;

package/types/src/api/blockManipulation/commands/mergeBlocks/mergeBlocks.test.d.ts

@@ -0,0 +1 @@
+export {};

package/types/src/api/blockManipulation/commands/moveBlock/moveBlock.d.ts

@@ -0,0 +1,5 @@
+import type { BlockNoteEditor } from "../../../../editor/BlockNoteEditor";
+import { BlockIdentifier } from "../../../../schema/index.js";
+export declare function moveSelectedBlockAndSelection(editor: BlockNoteEditor<any, any, any>, referenceBlock: BlockIdentifier, placement: "before" | "after"): void;
+export declare function moveBlockUp(editor: BlockNoteEditor<any, any, any>): void;
+export declare function moveBlockDown(editor: BlockNoteEditor<any, any, any>): void;

package/types/src/api/blockManipulation/commands/moveBlock/moveBlock.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,7 @@
+import { Node } from "prosemirror-model";
+import { Transaction } from "prosemirror-state";
+import { Block } from "../../../../blocks/defaultBlocks.js";
+import type { BlockNoteEditor } from "../../../../editor/BlockNoteEditor";
+import { BlockIdentifier, BlockSchema, InlineContentSchema, StyleSchema } from "../../../../schema/index.js";
+export declare function removeBlocksWithCallback<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(editor: BlockNoteEditor<BSchema, I, S>, blocksToRemove: BlockIdentifier[], callback?: (node: Node, pos: number, tr: Transaction, removedSize: number) => number): Block<BSchema, I, S>[];
+export declare function removeBlocks<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(editor: BlockNoteEditor<BSchema, I, S>, blocksToRemove: BlockIdentifier[]): Block<BSchema, I, S>[];

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,7 @@
+import { Block, PartialBlock } from "../../../../blocks/defaultBlocks.js";
+import type { BlockNoteEditor } from "../../../../editor/BlockNoteEditor";
+import { BlockIdentifier, BlockSchema, InlineContentSchema, StyleSchema } from "../../../../schema/index.js";
+export declare 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>[];
+};

package/types/src/api/blockManipulation/commands/replaceBlocks/replaceBlocks.test.d.ts

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,5 @@
+import { EditorState } from "prosemirror-state";
+export declare const splitBlockCommand: (posInBlock: number, keepType?: boolean, keepProps?: boolean) => ({ state, dispatch, }: {
+    state: EditorState;
+    dispatch: ((args?: any) => any) | undefined;
+}) => boolean;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,11 @@
+import { EditorState } from "prosemirror-state";
+import { Block, PartialBlock } from "../../../../blocks/defaultBlocks.js";
+import { BlockNoteEditor } from "../../../../editor/BlockNoteEditor.js";
+import { BlockIdentifier, BlockSchema } from "../../../../schema/blocks/types.js";
+import { InlineContentSchema } from "../../../../schema/inlineContent/types.js";
+import { StyleSchema } from "../../../../schema/styles/types.js";
+export declare const updateBlockCommand: <BSchema extends Record<string, import("../../../../schema/blocks/types.js").BlockConfig>, I extends InlineContentSchema, S extends StyleSchema>(editor: BlockNoteEditor<BSchema, I, S>, posBeforeBlock: number, block: PartialBlock<BSchema, I, S>) => ({ state, dispatch, }: {
+    state: EditorState;
+    dispatch: ((args?: any) => any) | undefined;
+}) => boolean;
+export declare function updateBlock<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(editor: BlockNoteEditor<BSchema, I, S>, blockToUpdate: BlockIdentifier, update: PartialBlock<BSchema, I, S>): Block<BSchema, I, S>;

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

@@ -0,0 +1 @@
+export {};

package/types/src/api/blockManipulation/insertContentAt.d.ts

@@ -0,0 +1,6 @@
+import { Node } from "prosemirror-model";
+import type { BlockNoteEditor } from "../../editor/BlockNoteEditor.js";
+import { BlockSchema, InlineContentSchema, StyleSchema } from "../../schema/index.js";
+export declare function insertContentAt<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(position: any, nodes: Node[], editor: BlockNoteEditor<BSchema, I, S>, options?: {
+    updateSelection: boolean;
+}): boolean;

package/types/src/api/blockManipulation/selections/textCursorPosition/textCursorPosition.d.ts

@@ -0,0 +1,5 @@
+import type { BlockNoteEditor } from "../../../../editor/BlockNoteEditor.js";
+import { TextCursorPosition } from "../../../../editor/cursorPositionTypes.js";
+import { BlockIdentifier, BlockSchema, InlineContentSchema, StyleSchema } from "../../../../schema/index.js";
+export declare function getTextCursorPosition<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(editor: BlockNoteEditor<BSchema, I, S>): TextCursorPosition<BSchema, I, S>;
+export declare function setTextCursorPosition<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(editor: BlockNoteEditor<BSchema, I, S>, targetBlock: BlockIdentifier, placement?: "start" | "end"): void;

package/types/src/api/blockManipulation/selections/textCursorPosition/textCursorPosition.test.d.ts

@@ -0,0 +1 @@
+export {};