@blocknote/core 0.9.5 → 0.10.0

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

@@ -1,2 +1,7 @@
-import { Block, BlockSchema, PartialBlock } from "../../extensions/Blocks/api/blockTypes";
-export declare function partialBlockToBlockForTesting<BSchema extends BlockSchema>(partialBlock: PartialBlock<BSchema>): Block<BSchema>;
+import { Block, BlockSchema, PartialBlock } from "../../extensions/Blocks/api/blocks/types";
+import { InlineContentSchema } from "../../extensions/Blocks/api/inlineContent/types";
+import { StyleSchema } from "../../extensions/Blocks/api/styles/types";
+export declare function partialBlocksToBlocksForTesting<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(schema: BSchema, partialBlocks: Array<PartialBlock<BSchema, I, S>>): Array<Block<BSchema, I, S>>;
+export declare function partialBlockToBlockForTesting<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(schema: BSchema, partialBlock: PartialBlock<BSchema, I, S>): Block<BSchema, I, S>;
+export declare function addIdsToBlock(block: PartialBlock<any, any, any>): void;
+export declare function addIdsToBlocks(blocks: PartialBlock<any, any, any>[]): void;

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

@@ -0,0 +1,8 @@
+import { Node } from "prosemirror-model";
+/**
+ * Get a TipTap node by id
+ */
+export declare function getNodeById(id: string, doc: Node): {
+    node: Node;
+    posBeforeNode: number;
+};

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

@@ -0,0 +1,3 @@
+import { Schema } from "prosemirror-model";
+import { Block, BlockSchema, InlineContentSchema, StyleSchema } from "../../../schema";
+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/html/parseHTML.test.d.ts

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

package/types/src/api/parsers/html/util/nestedLists.d.ts

@@ -0,0 +1 @@
+export declare function nestedListsToBlockNoteStructure(elementOrHTML: HTMLElement | string): HTMLElement;

package/types/src/api/parsers/html/util/nestedLists.test.d.ts

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

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

@@ -0,0 +1,3 @@
+import { Schema } from "prosemirror-model";
+import { Block, BlockSchema, InlineContentSchema, StyleSchema } from "../../../schema";
+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/parsers/markdown/parseMarkdown.test.d.ts

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

package/types/src/api/parsers/pasteExtension.d.ts

@@ -0,0 +1,6 @@
+import { Extension } from "@tiptap/core";
+import type { BlockNoteEditor } from "../../editor/BlockNoteEditor";
+import { InlineContentSchema, StyleSchema } from "../../schema";
+export declare const createPasteFromClipboardExtension: <BSchema extends Record<string, import("../../schema").BlockConfig>, I extends InlineContentSchema, S extends StyleSchema>(editor: BlockNoteEditor<BSchema, I, S>) => Extension<{
+    editor: BlockNoteEditor<BSchema, I, S>;
+}, undefined>;

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

@@ -0,0 +1,345 @@
+import { EditorTestCases } from "..";
+import { BlockSchemaFromSpecs } from "../../../extensions/Blocks/api/blocks/types";
+import { DefaultInlineContentSchema, DefaultStyleSchema } from "../../../extensions/Blocks/api/defaultBlocks";
+declare const customSpecs: {
+    simpleImage: {
+        config: {
+            type: "simpleImage";
+            propSchema: {
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+                width: {
+                    default: 512;
+                };
+            };
+            content: "none";
+        };
+        implementation: import("../../../extensions/Blocks/api/blocks/types").TiptapBlockImplementation<{
+            type: "simpleImage";
+            propSchema: {
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+                width: {
+                    default: 512;
+                };
+            };
+            content: "none";
+        }, any, import("../../..").InlineContentSchema, import("../../..").StyleSchema>;
+    };
+    customParagraph: {
+        config: {
+            type: "customParagraph";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+            content: "inline";
+        };
+        implementation: import("../../../extensions/Blocks/api/blocks/types").TiptapBlockImplementation<{
+            type: "customParagraph";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+            content: "inline";
+        }, any, import("../../..").InlineContentSchema, import("../../..").StyleSchema>;
+    };
+    simpleCustomParagraph: {
+        config: {
+            type: "simpleCustomParagraph";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+            content: "inline";
+        };
+        implementation: import("../../../extensions/Blocks/api/blocks/types").TiptapBlockImplementation<{
+            type: "simpleCustomParagraph";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+            content: "inline";
+        }, any, import("../../..").InlineContentSchema, import("../../..").StyleSchema>;
+    };
+    paragraph: {
+        config: {
+            type: "paragraph";
+            content: "inline";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        };
+        implementation: import("../../../extensions/Blocks/api/blocks/types").TiptapBlockImplementation<{
+            type: "paragraph";
+            content: "inline";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        }, any, import("../../..").InlineContentSchema, import("../../..").StyleSchema>;
+    };
+    heading: {
+        config: {
+            type: "heading";
+            content: "inline";
+            propSchema: {
+                level: {
+                    default: number;
+                    values: readonly [1, 2, 3];
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        };
+        implementation: import("../../../extensions/Blocks/api/blocks/types").TiptapBlockImplementation<{
+            type: "heading";
+            content: "inline";
+            propSchema: {
+                level: {
+                    default: number;
+                    values: readonly [1, 2, 3];
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        }, any, import("../../..").InlineContentSchema, import("../../..").StyleSchema>;
+    };
+    bulletListItem: {
+        config: {
+            type: "bulletListItem";
+            content: "inline";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        };
+        implementation: import("../../../extensions/Blocks/api/blocks/types").TiptapBlockImplementation<{
+            type: "bulletListItem";
+            content: "inline";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        }, any, import("../../..").InlineContentSchema, import("../../..").StyleSchema>;
+    };
+    numberedListItem: {
+        config: {
+            type: "numberedListItem";
+            content: "inline";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        };
+        implementation: import("../../../extensions/Blocks/api/blocks/types").TiptapBlockImplementation<{
+            type: "numberedListItem";
+            content: "inline";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        }, any, import("../../..").InlineContentSchema, import("../../..").StyleSchema>;
+    };
+    image: {
+        config: {
+            type: "image";
+            propSchema: {
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+                width: {
+                    default: 512;
+                };
+            };
+            content: "none";
+        };
+        implementation: import("../../../extensions/Blocks/api/blocks/types").TiptapBlockImplementation<{
+            type: "image";
+            propSchema: {
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+                width: {
+                    default: 512;
+                };
+            };
+            content: "none";
+        }, any, import("../../..").InlineContentSchema, import("../../..").StyleSchema>;
+    };
+    table: {
+        config: {
+            type: "table";
+            content: "table";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        };
+        implementation: import("../../../extensions/Blocks/api/blocks/types").TiptapBlockImplementation<{
+            type: "table";
+            content: "table";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        }, any, import("../../..").InlineContentSchema, import("../../..").StyleSchema>;
+    };
+};
+export declare const customBlocksTestCases: EditorTestCases<BlockSchemaFromSpecs<typeof customSpecs>, DefaultInlineContentSchema, DefaultStyleSchema>;
+export {};

package/types/src/api/testCases/cases/customInlineContent.d.ts

@@ -0,0 +1,29 @@
+import { EditorTestCases } from "..";
+import { DefaultBlockSchema, DefaultStyleSchema } from "../../../extensions/Blocks/api/defaultBlocks";
+import { InlineContentSchemaFromSpecs } from "../../../extensions/Blocks/api/inlineContent/types";
+declare const customInlineContent: {
+    mention: import("../../../extensions/Blocks/api/inlineContent/types").InlineContentSpec<{
+        type: "mention";
+        propSchema: {
+            user: {
+                default: string;
+            };
+        };
+        content: "none";
+    }>;
+    tag: import("../../../extensions/Blocks/api/inlineContent/types").InlineContentSpec<{
+        type: "tag";
+        propSchema: {};
+        content: "styled";
+    }>;
+    text: {
+        config: "text";
+        implementation: any;
+    };
+    link: {
+        config: "link";
+        implementation: any;
+    };
+};
+export declare const customInlineContentTestCases: EditorTestCases<DefaultBlockSchema, InlineContentSchemaFromSpecs<typeof customInlineContent>, DefaultStyleSchema>;
+export {};

package/types/src/api/testCases/cases/customStyles.d.ts

@@ -0,0 +1,64 @@
+import { EditorTestCases } from "..";
+import { DefaultBlockSchema, DefaultInlineContentSchema } from "../../../extensions/Blocks/api/defaultBlocks";
+import { StyleSchemaFromSpecs } from "../../../extensions/Blocks/api/styles/types";
+declare const customStyles: {
+    small: import("../../../extensions/Blocks/api/styles/types").StyleSpec<{
+        type: string;
+        propSchema: "boolean";
+    }>;
+    fontSize: import("../../../extensions/Blocks/api/styles/types").StyleSpec<{
+        type: string;
+        propSchema: "string";
+    }>;
+    bold: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../../extensions/Blocks/api/styles/types").StyleImplementation;
+    };
+    italic: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../../extensions/Blocks/api/styles/types").StyleImplementation;
+    };
+    underline: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../../extensions/Blocks/api/styles/types").StyleImplementation;
+    };
+    strike: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../../extensions/Blocks/api/styles/types").StyleImplementation;
+    };
+    code: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../../extensions/Blocks/api/styles/types").StyleImplementation;
+    };
+    textColor: {
+        config: {
+            type: string;
+            propSchema: "string";
+        };
+        implementation: import("../../../extensions/Blocks/api/styles/types").StyleImplementation;
+    };
+    backgroundColor: {
+        config: {
+            type: string;
+            propSchema: "string";
+        };
+        implementation: import("../../../extensions/Blocks/api/styles/types").StyleImplementation;
+    };
+};
+export declare const customStylesTestCases: EditorTestCases<DefaultBlockSchema, DefaultInlineContentSchema, StyleSchemaFromSpecs<typeof customStyles>>;
+export {};

package/types/src/api/testCases/cases/defaultSchema.d.ts

@@ -0,0 +1,3 @@
+import { EditorTestCases } from "..";
+import { DefaultBlockSchema, DefaultInlineContentSchema, DefaultStyleSchema } from "../../../extensions/Blocks/api/defaultBlocks";
+export declare const defaultSchemaTestCases: EditorTestCases<DefaultBlockSchema, DefaultInlineContentSchema, DefaultStyleSchema>;

package/types/src/api/testCases/index.d.ts

@@ -0,0 +1,12 @@
+import { BlockNoteEditor } from "../../BlockNoteEditor";
+import { BlockSchema, PartialBlock } from "../../extensions/Blocks/api/blocks/types";
+import { InlineContentSchema } from "../../extensions/Blocks/api/inlineContent/types";
+import { StyleSchema } from "../../extensions/Blocks/api/styles/types";
+export type EditorTestCases<B extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema> = {
+    name: string;
+    createEditor: () => BlockNoteEditor<B, I, S>;
+    documents: Array<{
+        name: string;
+        blocks: PartialBlock<B, I, S>[];
+    }>;
+};