@blocknote/core 0.11.2 → 0.12.1

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

@@ -1,8 +1,233 @@
 import { EditorTestCases } from "../index";
 import { DefaultBlockSchema, DefaultStyleSchema } from "../../../blocks/defaultBlocks";
-import { InlineContentSchemaFromSpecs } from "../../../schema/inlineContent/types";
-declare const customInlineContent: {
-    mention: import("../../../schema/inlineContent/types").InlineContentSpec<{
+import { BlockNoteSchema } from "../../../editor/BlockNoteSchema";
+declare const schema: BlockNoteSchema<import("../../..").BlockSchemaFromSpecs<{
+    paragraph: {
+        config: {
+            type: "paragraph";
+            content: "inline";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        };
+        implementation: import("../../..").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("../../..").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("../../..").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("../../..").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("../../..").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("../../..").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>;
+    };
+}>, import("../../..").InlineContentSchemaFromSpecs<{
+    mention: import("../../..").InlineContentSpec<{
         type: "mention";
         propSchema: {
             user: {
@@ -11,7 +236,7 @@ declare const customInlineContent: {
         };
         content: "none";
     }>;
-    tag: import("../../../schema/inlineContent/types").InlineContentSpec<{
+    tag: import("../../..").InlineContentSpec<{
         type: "tag";
         propSchema: {};
         content: "styled";
@@ -24,6 +249,56 @@ declare const customInlineContent: {
         config: "link";
         implementation: any;
     };
-};
-export declare const customInlineContentTestCases: EditorTestCases<DefaultBlockSchema, InlineContentSchemaFromSpecs<typeof customInlineContent>, DefaultStyleSchema>;
+}>, import("../../..").StyleSchemaFromSpecs<{
+    bold: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../..").StyleImplementation;
+    };
+    italic: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../..").StyleImplementation;
+    };
+    underline: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../..").StyleImplementation;
+    };
+    strike: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../..").StyleImplementation;
+    };
+    code: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../..").StyleImplementation;
+    };
+    textColor: {
+        config: {
+            type: string;
+            propSchema: "string";
+        };
+        implementation: import("../../..").StyleImplementation;
+    };
+    backgroundColor: {
+        config: {
+            type: string;
+            propSchema: "string";
+        };
+        implementation: import("../../..").StyleImplementation;
+    };
+}>>;
+export declare const customInlineContentTestCases: EditorTestCases<DefaultBlockSchema, typeof schema.inlineContentSchema, DefaultStyleSchema>;
 export {};

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

@@ -1,12 +1,246 @@
 import { EditorTestCases } from "../index";
 import { DefaultBlockSchema, DefaultInlineContentSchema } from "../../../blocks/defaultBlocks";
-import { StyleSchemaFromSpecs } from "../../../schema/styles/types";
-declare const customStyles: {
-    small: import("../../../schema/styles/types").StyleSpec<{
+import { BlockNoteSchema } from "../../../editor/BlockNoteSchema";
+declare const schema: BlockNoteSchema<import("../../..").BlockSchemaFromSpecs<{
+    paragraph: {
+        config: {
+            type: "paragraph";
+            content: "inline";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        };
+        implementation: import("../../..").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("../../..").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("../../..").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("../../..").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("../../..").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("../../..").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>;
+    };
+}>, import("../../..").InlineContentSchemaFromSpecs<{
+    text: {
+        config: "text";
+        implementation: any;
+    };
+    link: {
+        config: "link";
+        implementation: any;
+    };
+}>, import("../../..").StyleSchemaFromSpecs<{
+    small: import("../../..").StyleSpec<{
         type: string;
         propSchema: "boolean";
     }>;
-    fontSize: import("../../../schema/styles/types").StyleSpec<{
+    fontSize: import("../../..").StyleSpec<{
         type: string;
         propSchema: "string";
     }>;
@@ -15,50 +249,50 @@ declare const customStyles: {
             type: string;
             propSchema: "boolean";
         };
-        implementation: import("../../../schema/styles/types").StyleImplementation;
+        implementation: import("../../..").StyleImplementation;
     };
     italic: {
         config: {
             type: string;
             propSchema: "boolean";
         };
-        implementation: import("../../../schema/styles/types").StyleImplementation;
+        implementation: import("../../..").StyleImplementation;
     };
     underline: {
         config: {
             type: string;
             propSchema: "boolean";
         };
-        implementation: import("../../../schema/styles/types").StyleImplementation;
+        implementation: import("../../..").StyleImplementation;
     };
     strike: {
         config: {
             type: string;
             propSchema: "boolean";
         };
-        implementation: import("../../../schema/styles/types").StyleImplementation;
+        implementation: import("../../..").StyleImplementation;
     };
     code: {
         config: {
             type: string;
             propSchema: "boolean";
         };
-        implementation: import("../../../schema/styles/types").StyleImplementation;
+        implementation: import("../../..").StyleImplementation;
     };
     textColor: {
         config: {
             type: string;
             propSchema: "string";
         };
-        implementation: import("../../../schema/styles/types").StyleImplementation;
+        implementation: import("../../..").StyleImplementation;
     };
     backgroundColor: {
         config: {
             type: string;
             propSchema: "string";
         };
-        implementation: import("../../../schema/styles/types").StyleImplementation;
+        implementation: import("../../..").StyleImplementation;
     };
-};
-export declare const customStylesTestCases: EditorTestCases<DefaultBlockSchema, DefaultInlineContentSchema, StyleSchemaFromSpecs<typeof customStyles>>;
+}>>;
+export declare const customStylesTestCases: EditorTestCases<DefaultBlockSchema, DefaultInlineContentSchema, typeof schema.styleSchema>;
 export {};

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

@@ -1,12 +1,14 @@
+import { PartialBlock } from "../../blocks/defaultBlocks";
 import { BlockNoteEditor } from "../../editor/BlockNoteEditor";
-import { BlockSchema, PartialBlock } from "../../schema/blocks/types";
+import { BlockSchema } from "../../schema/blocks/types";
 import { InlineContentSchema } from "../../schema/inlineContent/types";
 import { StyleSchema } from "../../schema/styles/types";
+import { NoInfer } from "../../util/typescript";
 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>[];
+        blocks: PartialBlock<NoInfer<B>, NoInfer<I>, NoInfer<S>>[];
     }>;
 };

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

@@ -1,4 +1,5 @@
-import { Block, BlockSchema, PartialBlock } from "../../schema/blocks/types";
+import { Block, PartialBlock } from "../../blocks/defaultBlocks";
+import { BlockSchema } from "../../schema/blocks/types";
 import { InlineContentSchema } from "../../schema/inlineContent/types";
 import { StyleSchema } from "../../schema/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>>;

package/types/src/blocks/ImageBlockContent/uploadToTmpFilesDotOrg_DEV_ONLY.d.ts

@@ -1 +1,6 @@
-export declare const uploadToTmpFilesDotOrg_DEV_ONLY: (file: File) => Promise<any>;
+/**
+ * Uploads a file to tmpfiles.org and returns the URL to the uploaded file.
+ *
+ * @warning This function should only be used for development purposes, replace with your own backend!
+ */
+export declare const uploadToTmpFilesDotOrg_DEV_ONLY: (file: File) => Promise<string>;

package/types/src/blocks/defaultBlockHelpers.d.ts

@@ -1,10 +1,10 @@
 import type { BlockNoteEditor } from "../editor/BlockNoteEditor";
-import type { Block, InlineContentSchema, StyleSchema } from "../schema";
+import type { BlockNoDefaults, InlineContentSchema, StyleSchema } from "../schema";
 export declare function createDefaultBlockDOMOutputSpec(blockName: string, htmlTag: string, blockContentHTMLAttributes: Record<string, string>, inlineContentHTMLAttributes: Record<string, string>): {
     dom: HTMLDivElement;
     contentDOM: HTMLElement;
 };
-export declare const defaultBlockToHTML: <BSchema extends Record<string, import("../schema").BlockConfig>, I extends InlineContentSchema, S extends StyleSchema>(block: Block<BSchema, I, S>, editor: BlockNoteEditor<BSchema, I, S>) => {
+export declare const defaultBlockToHTML: <BSchema extends Record<string, import("../schema").BlockConfig>, I extends InlineContentSchema, S extends StyleSchema>(block: BlockNoDefaults<BSchema, I, S>, editor: BlockNoteEditor<BSchema, I, S>) => {
     dom: HTMLElement;
     contentDOM?: HTMLElement;
 };

package/types/src/blocks/defaultBlockTypeGuards.d.ts

@@ -0,0 +1,24 @@
+import type { BlockNoteEditor } from "../editor/BlockNoteEditor";
+import { BlockFromConfig, InlineContentSchema, StyleSchema } from "../schema";
+import { Block, DefaultBlockSchema } from "./defaultBlocks";
+import { defaultProps } from "./defaultProps";
+export declare function checkDefaultBlockTypeInSchema<BlockType extends keyof DefaultBlockSchema, I extends InlineContentSchema, S extends StyleSchema>(blockType: BlockType, editor: BlockNoteEditor<any, I, S>): editor is BlockNoteEditor<{
+    Type: DefaultBlockSchema[BlockType];
+}, I, S>;
+export declare function checkBlockIsDefaultType<BlockType extends keyof DefaultBlockSchema, I extends InlineContentSchema, S extends StyleSchema>(blockType: BlockType, block: Block<any, I, S>, editor: BlockNoteEditor<any, I, S>): block is BlockFromConfig<DefaultBlockSchema[BlockType], I, S>;
+export declare function checkBlockTypeHasDefaultProp<Prop extends keyof typeof defaultProps, I extends InlineContentSchema, S extends StyleSchema>(prop: Prop, blockType: string, editor: BlockNoteEditor<any, I, S>): editor is BlockNoteEditor<{
+    [BT in string]: {
+        type: BT;
+        propSchema: {
+            [P in Prop]: (typeof defaultProps)[P];
+        };
+        content: "table" | "inline" | "none";
+    };
+}, I, S>;
+export declare function checkBlockHasDefaultProp<Prop extends keyof typeof defaultProps, I extends InlineContentSchema, S extends StyleSchema>(prop: Prop, block: Block<any, I, S>, editor: BlockNoteEditor<any, I, S>): block is BlockFromConfig<{
+    type: string;
+    propSchema: {
+        [P in Prop]: (typeof defaultProps)[P];
+    };
+    content: "table" | "inline" | "none";
+}, I, S>;