@blocknote/core 0.16.0 → 0.17.0

package/types/src/api/getBlockInfoFromPos.d.ts

@@ -1,27 +1,70 @@
-import { Node, NodeType } from "prosemirror-model";
-export type BlockInfoWithoutPositions = {
-    id: string;
+import { Node, ResolvedPos } from "prosemirror-model";
+import { EditorState } from "prosemirror-state";
+type SingleBlockInfo = {
     node: Node;
-    contentNode: Node;
-    contentType: NodeType;
-    numChildBlocks: number;
+    beforePos: number;
+    afterPos: number;
 };
-export type BlockInfo = BlockInfoWithoutPositions & {
-    startPos: number;
-    endPos: number;
-    depth: number;
+export type BlockInfo = {
+    blockContainer: SingleBlockInfo;
+    blockContent: SingleBlockInfo;
+    blockGroup?: SingleBlockInfo;
 };
 /**
- * Helper function for `getBlockInfoFromPos`, returns information regarding
- * provided blockContainer node.
- * @param blockContainer The blockContainer node to retrieve info for.
+ * Retrieves the position just before the nearest blockContainer node in a
+ * ProseMirror doc, relative to a position. If the position is within a
+ * blockContainer node or its descendants, the position just before it is
+ * returned. If the position is not within a blockContainer node or its
+ * descendants, the position just before the next closest blockContainer node
+ * is returned. If the position is beyond the last blockContainer, the position
+ * just before the last blockContainer is returned.
+ * @param doc The ProseMirror doc.
+ * @param pos An integer position in the document.
+ * @returns The position just before the nearest blockContainer node.
+ */
+export declare function getNearestBlockContainerPos(doc: Node, pos: number): {
+    posBeforeNode: number;
+    node: Node;
+};
+/**
+ * Gets information regarding the ProseMirror nodes that make up a block in a
+ * BlockNote document. This includes the main `blockContainer` node, the
+ * `blockContent` node with the block's main body, and the optional `blockGroup`
+ * node which contains the block's children. As well as the nodes, also returns
+ * the ProseMirror positions just before & after each node.
+ * @param node The main `blockContainer` node that the block information should
+ * be retrieved from,
+ * @param blockContainerBeforePosOffset the position just before the
+ * `blockContainer` node in the document.
  */
-export declare function getBlockInfo(blockContainer: Node): BlockInfoWithoutPositions;
+export declare function getBlockInfoWithManualOffset(node: Node, blockContainerBeforePosOffset: number): BlockInfo;
 /**
- * Retrieves information regarding the nearest blockContainer node in a
- * ProseMirror doc, relative to a position.
- * @param doc The ProseMirror doc.
- * @param pos An integer position.
- * @returns A BlockInfo object for the nearest blockContainer node.
+ * Gets information regarding the ProseMirror nodes that make up a block in a
+ * BlockNote document. This includes the main `blockContainer` node, the
+ * `blockContent` node with the block's main body, and the optional `blockGroup`
+ * node which contains the block's children. As well as the nodes, also returns
+ * the ProseMirror positions just before & after each node.
+ * @param posInfo An object with the main `blockContainer` node that the block
+ * information should be retrieved from, and the position just before it in the
+ * document.
+ */
+export declare function getBlockInfo(posInfo: {
+    posBeforeNode: number;
+    node: Node;
+}): BlockInfo;
+/**
+ * Gets information regarding the ProseMirror nodes that make up a block from a
+ * resolved position just before the `blockContainer` node in the document that
+ * corresponds to it.
+ * @param resolvedPos The resolved position just before the `blockContainer`
+ * node.
+ */
+export declare function getBlockInfoFromResolvedPos(resolvedPos: ResolvedPos): BlockInfo;
+/**
+ * Gets information regarding the ProseMirror nodes that make up a block. The
+ * block chosen is the one currently containing the current ProseMirror
+ * selection.
+ * @param state The ProseMirror editor state.
  */
-export declare function getBlockInfoFromPos(doc: Node, pos: number): BlockInfo;
+export declare function getBlockInfoFromSelection(state: EditorState): BlockInfo;
+export {};

package/types/src/api/nodeConversions/blockToNode.d.ts

@@ -0,0 +1,15 @@
+import { Node, Schema } from "@tiptap/pm/model";
+import type { InlineContentSchema, PartialInlineContent, PartialTableContent, StyleSchema } from "../../schema";
+import type { PartialBlock } from "../../blocks/defaultBlocks";
+/**
+ * converts an array of inline content elements to prosemirror nodes
+ */
+export declare function inlineContentToNodes<I extends InlineContentSchema, S extends StyleSchema>(blockContent: PartialInlineContent<I, S>, schema: Schema, styleSchema: S): Node[];
+/**
+ * converts an array of inline content elements to prosemirror nodes
+ */
+export declare function tableContentToNodes<I extends InlineContentSchema, S extends StyleSchema>(tableContent: PartialTableContent<I, S>, schema: Schema, styleSchema: StyleSchema): Node[];
+/**
+ * Converts a BlockNote block to a TipTap node.
+ */
+export declare function blockToNode(block: PartialBlock<any, any, any>, schema: Schema, styleSchema: StyleSchema): Node;

package/types/src/api/nodeConversions/fragmentToBlocks.d.ts

@@ -0,0 +1,7 @@
+import { Fragment } from "@tiptap/pm/model";
+import { BlockNoteSchema } from "../../editor/BlockNoteSchema.js";
+import { BlockNoDefaults, BlockSchema, InlineContentSchema, StyleSchema } from "../../schema/index.js";
+/**
+ * Converts all Blocks within a fragment to BlockNote blocks.
+ */
+export declare function fragmentToBlocks<B extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(fragment: Fragment, schema: BlockNoteSchema<B, I, S>): BlockNoDefaults<B, I, S>[];

package/types/src/api/nodeConversions/nodeToBlock.d.ts

@@ -0,0 +1,16 @@
+import { Node } from "@tiptap/pm/model";
+import type { BlockSchema, InlineContent, InlineContentSchema, StyleSchema, TableContent } from "../../schema/index.js";
+import type { Block } from "../../blocks/defaultBlocks.js";
+/**
+ * Converts an internal (prosemirror) table node contentto a BlockNote Tablecontent
+ */
+export declare function contentNodeToTableContent<I extends InlineContentSchema, S extends StyleSchema>(contentNode: Node, inlineContentSchema: I, styleSchema: S): TableContent<I, S>;
+/**
+ * Converts an internal (prosemirror) content node to a BlockNote InlineContent array.
+ */
+export declare function contentNodeToInlineContent<I extends InlineContentSchema, S extends StyleSchema>(contentNode: Node, inlineContentSchema: I, styleSchema: S): InlineContent<I, S>[];
+export declare function nodeToCustomInlineContent<I extends InlineContentSchema, S extends StyleSchema>(node: Node, inlineContentSchema: I, styleSchema: S): InlineContent<I, S>;
+/**
+ * Convert a TipTap node to a BlockNote block.
+ */
+export declare function nodeToBlock<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(node: Node, blockSchema: BSchema, inlineContentSchema: I, styleSchema: S, blockCache?: WeakMap<Node, Block<BSchema, I, S>>): Block<BSchema, I, S>;

package/types/src/api/parsers/html/parseHTML.d.ts

@@ -1,4 +1,4 @@
 import { Schema } from "prosemirror-model";
-import { BlockSchema, InlineContentSchema, StyleSchema } from "../../../schema";
-import { Block } from "../../../blocks/defaultBlocks";
+import { BlockSchema, InlineContentSchema, StyleSchema } from "../../../schema/index.js";
+import { Block } from "../../../blocks/defaultBlocks.js";
 export declare function HTMLToBlocks<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(html: string, blockSchema: BSchema, icSchema: I, styleSchema: S, pmSchema: Schema): Promise<Block<BSchema, I, S>[]>;

package/types/src/api/parsers/markdown/parseMarkdown.d.ts

@@ -1,4 +1,4 @@
 import { Schema } from "prosemirror-model";
-import { Block } from "../../../blocks/defaultBlocks";
-import { BlockSchema, InlineContentSchema, StyleSchema } from "../../../schema";
+import { Block } from "../../../blocks/defaultBlocks.js";
+import { BlockSchema, InlineContentSchema, StyleSchema } from "../../../schema/index.js";
 export declare function markdownToBlocks<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(markdown: string, blockSchema: BSchema, icSchema: I, styleSchema: S, pmSchema: Schema): Promise<Block<BSchema, I, S>[]>;

package/types/src/api/testUtil/cases/customBlocks.d.ts

@@ -1,7 +1,7 @@
-import { EditorTestCases } from "../index";
-import { DefaultInlineContentSchema, DefaultStyleSchema } from "../../../blocks/defaultBlocks";
-import { BlockNoteSchema } from "../../../editor/BlockNoteSchema";
-declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromSpecs<{
+import { EditorTestCases } from "../index.js";
+import { DefaultInlineContentSchema, DefaultStyleSchema } from "../../../blocks/defaultBlocks.js";
+import { BlockNoteSchema } from "../../../editor/BlockNoteSchema.js";
+declare const schema: BlockNoteSchema<import("../../../schema/index.js").BlockSchemaFromSpecs<{
     simpleImage: {
         config: {
             type: string;
@@ -31,7 +31,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
             };
             content: "none";
         };
-        implementation: import("../../../schema").TiptapBlockImplementation<{
+        implementation: import("../../../schema/index.js").TiptapBlockImplementation<{
             type: string;
             propSchema: {
                 textAlignment: {
@@ -58,7 +58,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
                 };
             };
             content: "none";
-        }, any, import("../../../schema").InlineContentSchema, import("../../../schema").StyleSchema>;
+        }, any, import("../../../schema/index.js").InlineContentSchema, import("../../../schema/index.js").StyleSchema>;
     };
     customParagraph: {
         config: {
@@ -77,7 +77,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
             };
             content: "inline";
         };
-        implementation: import("../../../schema").TiptapBlockImplementation<{
+        implementation: import("../../../schema/index.js").TiptapBlockImplementation<{
             type: string;
             propSchema: {
                 backgroundColor: {
@@ -92,7 +92,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
                 };
             };
             content: "inline";
-        }, any, import("../../../schema").InlineContentSchema, import("../../../schema").StyleSchema>;
+        }, any, import("../../../schema/index.js").InlineContentSchema, import("../../../schema/index.js").StyleSchema>;
     };
     simpleCustomParagraph: {
         config: {
@@ -111,7 +111,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
             };
             content: "inline";
         };
-        implementation: import("../../../schema").TiptapBlockImplementation<{
+        implementation: import("../../../schema/index.js").TiptapBlockImplementation<{
             type: string;
             propSchema: {
                 backgroundColor: {
@@ -126,7 +126,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
                 };
             };
             content: "inline";
-        }, any, import("../../../schema").InlineContentSchema, import("../../../schema").StyleSchema>;
+        }, any, import("../../../schema/index.js").InlineContentSchema, import("../../../schema/index.js").StyleSchema>;
     };
     paragraph: {
         config: {
@@ -145,7 +145,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
                 };
             };
         };
-        implementation: import("../../../schema").TiptapBlockImplementation<{
+        implementation: import("../../../schema/index.js").TiptapBlockImplementation<{
             type: "paragraph";
             content: "inline";
             propSchema: {
@@ -160,7 +160,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
                     values: readonly ["left", "center", "right", "justify"];
                 };
             };
-        }, any, import("../../../schema").InlineContentSchema, import("../../../schema").StyleSchema>;
+        }, any, import("../../../schema/index.js").InlineContentSchema, import("../../../schema/index.js").StyleSchema>;
     };
     heading: {
         config: {
@@ -183,7 +183,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
                 };
             };
         };
-        implementation: import("../../../schema").TiptapBlockImplementation<{
+        implementation: import("../../../schema/index.js").TiptapBlockImplementation<{
             type: "heading";
             content: "inline";
             propSchema: {
@@ -202,7 +202,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
                     values: readonly ["left", "center", "right", "justify"];
                 };
             };
-        }, any, import("../../../schema").InlineContentSchema, import("../../../schema").StyleSchema>;
+        }, any, import("../../../schema/index.js").InlineContentSchema, import("../../../schema/index.js").StyleSchema>;
     };
     bulletListItem: {
         config: {
@@ -221,7 +221,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
                 };
             };
         };
-        implementation: import("../../../schema").TiptapBlockImplementation<{
+        implementation: import("../../../schema/index.js").TiptapBlockImplementation<{
             type: "bulletListItem";
             content: "inline";
             propSchema: {
@@ -236,7 +236,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
                     values: readonly ["left", "center", "right", "justify"];
                 };
             };
-        }, any, import("../../../schema").InlineContentSchema, import("../../../schema").StyleSchema>;
+        }, any, import("../../../schema/index.js").InlineContentSchema, import("../../../schema/index.js").StyleSchema>;
     };
     numberedListItem: {
         config: {
@@ -255,7 +255,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
                 };
             };
         };
-        implementation: import("../../../schema").TiptapBlockImplementation<{
+        implementation: import("../../../schema/index.js").TiptapBlockImplementation<{
             type: "numberedListItem";
             content: "inline";
             propSchema: {
@@ -270,7 +270,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
                     values: readonly ["left", "center", "right", "justify"];
                 };
             };
-        }, any, import("../../../schema").InlineContentSchema, import("../../../schema").StyleSchema>;
+        }, any, import("../../../schema/index.js").InlineContentSchema, import("../../../schema/index.js").StyleSchema>;
     };
     checkListItem: {
         config: {
@@ -292,7 +292,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
                 };
             };
         };
-        implementation: import("../../../schema").TiptapBlockImplementation<{
+        implementation: import("../../../schema/index.js").TiptapBlockImplementation<{
             type: "checkListItem";
             content: "inline";
             propSchema: {
@@ -310,7 +310,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
                     values: readonly ["left", "center", "right", "justify"];
                 };
             };
-        }, any, import("../../../schema").InlineContentSchema, import("../../../schema").StyleSchema>;
+        }, any, import("../../../schema/index.js").InlineContentSchema, import("../../../schema/index.js").StyleSchema>;
     };
     table: {
         config: {
@@ -329,7 +329,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
                 };
             };
         };
-        implementation: import("../../../schema").TiptapBlockImplementation<{
+        implementation: import("../../../schema/index.js").TiptapBlockImplementation<{
             type: "table";
             content: "table";
             propSchema: {
@@ -344,7 +344,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
                     values: readonly ["left", "center", "right", "justify"];
                 };
             };
-        }, any, import("../../../schema").InlineContentSchema, import("../../../schema").StyleSchema>;
+        }, any, import("../../../schema/index.js").InlineContentSchema, import("../../../schema/index.js").StyleSchema>;
     };
     file: {
         config: {
@@ -366,7 +366,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
             content: "none";
             isFileBlock: true;
         };
-        implementation: import("../../../schema").TiptapBlockImplementation<{
+        implementation: import("../../../schema/index.js").TiptapBlockImplementation<{
             type: "file";
             propSchema: {
                 backgroundColor: {
@@ -384,7 +384,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
             };
             content: "none";
             isFileBlock: true;
-        }, any, import("../../../schema").InlineContentSchema, import("../../../schema").StyleSchema>;
+        }, any, import("../../../schema/index.js").InlineContentSchema, import("../../../schema/index.js").StyleSchema>;
     };
     image: {
         config: {
@@ -417,7 +417,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
             isFileBlock: true;
             fileBlockAccept: string[];
         };
-        implementation: import("../../../schema").TiptapBlockImplementation<{
+        implementation: import("../../../schema/index.js").TiptapBlockImplementation<{
             type: "image";
             propSchema: {
                 textAlignment: {
@@ -446,7 +446,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
             content: "none";
             isFileBlock: true;
             fileBlockAccept: string[];
-        }, any, import("../../../schema").InlineContentSchema, import("../../../schema").StyleSchema>;
+        }, any, import("../../../schema/index.js").InlineContentSchema, import("../../../schema/index.js").StyleSchema>;
     };
     video: {
         config: {
@@ -479,7 +479,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
             isFileBlock: true;
             fileBlockAccept: string[];
         };
-        implementation: import("../../../schema").TiptapBlockImplementation<{
+        implementation: import("../../../schema/index.js").TiptapBlockImplementation<{
             type: "video";
             propSchema: {
                 textAlignment: {
@@ -508,7 +508,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
             content: "none";
             isFileBlock: true;
             fileBlockAccept: string[];
-        }, any, import("../../../schema").InlineContentSchema, import("../../../schema").StyleSchema>;
+        }, any, import("../../../schema/index.js").InlineContentSchema, import("../../../schema/index.js").StyleSchema>;
     };
     audio: {
         config: {
@@ -534,7 +534,7 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
             isFileBlock: true;
             fileBlockAccept: string[];
         };
-        implementation: import("../../../schema").TiptapBlockImplementation<{
+        implementation: import("../../../schema/index.js").TiptapBlockImplementation<{
             type: "audio";
             propSchema: {
                 backgroundColor: {
@@ -556,9 +556,9 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
             content: "none";
             isFileBlock: true;
             fileBlockAccept: string[];
-        }, any, import("../../../schema").InlineContentSchema, import("../../../schema").StyleSchema>;
+        }, any, import("../../../schema/index.js").InlineContentSchema, import("../../../schema/index.js").StyleSchema>;
     };
-}>, import("../../../schema").InlineContentSchemaFromSpecs<{
+}>, import("../../../schema/index.js").InlineContentSchemaFromSpecs<{
     text: {
         config: "text";
         implementation: any;
@@ -567,55 +567,55 @@ declare const schema: BlockNoteSchema<import("../../../schema").BlockSchemaFromS
         config: "link";
         implementation: any;
     };
-}>, import("../../../schema").StyleSchemaFromSpecs<{
+}>, import("../../../schema/index.js").StyleSchemaFromSpecs<{
     bold: {
         config: {
             type: string;
             propSchema: "boolean";
         };
-        implementation: import("../../../schema").StyleImplementation;
+        implementation: import("../../../schema/index.js").StyleImplementation;
     };
     italic: {
         config: {
             type: string;
             propSchema: "boolean";
         };
-        implementation: import("../../../schema").StyleImplementation;
+        implementation: import("../../../schema/index.js").StyleImplementation;
     };
     underline: {
         config: {
             type: string;
             propSchema: "boolean";
         };
-        implementation: import("../../../schema").StyleImplementation;
+        implementation: import("../../../schema/index.js").StyleImplementation;
     };
     strike: {
         config: {
             type: string;
             propSchema: "boolean";
         };
-        implementation: import("../../../schema").StyleImplementation;
+        implementation: import("../../../schema/index.js").StyleImplementation;
     };
     code: {
         config: {
             type: string;
             propSchema: "boolean";
         };
-        implementation: import("../../../schema").StyleImplementation;
+        implementation: import("../../../schema/index.js").StyleImplementation;
     };
     textColor: {
         config: {
             type: string;
             propSchema: "string";
         };
-        implementation: import("../../../schema").StyleImplementation;
+        implementation: import("../../../schema/index.js").StyleImplementation;
     };
     backgroundColor: {
         config: {
             type: string;
             propSchema: "string";
         };
-        implementation: import("../../../schema").StyleImplementation;
+        implementation: import("../../../schema/index.js").StyleImplementation;
     };
 }>>;
 export declare const customBlocksTestCases: EditorTestCases<typeof schema.blockSchema, DefaultInlineContentSchema, DefaultStyleSchema>;