@blocknote/core 0.11.2 → 0.12.0

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>;

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

@@ -1,3 +1,4 @@
+import { BlockNoDefaults, BlockSchema, InlineContentSchema, PartialBlockNoDefaults, StyleSchema } from "../schema";
 export declare const defaultBlockSpecs: {
     paragraph: {
         config: {
@@ -31,7 +32,7 @@ export declare const defaultBlockSpecs: {
                     values: readonly ["left", "center", "right", "justify"];
                 };
             };
-        }, any, import("../schema").InlineContentSchema, import("../schema").StyleSchema>;
+        }, any, InlineContentSchema, StyleSchema>;
     };
     heading: {
         config: {
@@ -73,7 +74,7 @@ export declare const defaultBlockSpecs: {
                     values: readonly ["left", "center", "right", "justify"];
                 };
             };
-        }, any, import("../schema").InlineContentSchema, import("../schema").StyleSchema>;
+        }, any, InlineContentSchema, StyleSchema>;
     };
     bulletListItem: {
         config: {
@@ -107,7 +108,7 @@ export declare const defaultBlockSpecs: {
                     values: readonly ["left", "center", "right", "justify"];
                 };
             };
-        }, any, import("../schema").InlineContentSchema, import("../schema").StyleSchema>;
+        }, any, InlineContentSchema, StyleSchema>;
     };
     numberedListItem: {
         config: {
@@ -141,7 +142,7 @@ export declare const defaultBlockSpecs: {
                     values: readonly ["left", "center", "right", "justify"];
                 };
             };
-        }, any, import("../schema").InlineContentSchema, import("../schema").StyleSchema>;
+        }, any, InlineContentSchema, StyleSchema>;
     };
     image: {
         config: {
@@ -187,7 +188,7 @@ export declare const defaultBlockSpecs: {
                 };
             };
             content: "none";
-        }, any, import("../schema").InlineContentSchema, import("../schema").StyleSchema>;
+        }, any, InlineContentSchema, StyleSchema>;
     };
     table: {
         config: {
@@ -221,7 +222,7 @@ export declare const defaultBlockSpecs: {
                     values: readonly ["left", "center", "right", "justify"];
                 };
             };
-        }, any, import("../schema").InlineContentSchema, import("../schema").StyleSchema>;
+        }, any, InlineContentSchema, StyleSchema>;
     };
 };
 export declare const defaultBlockSchema: import("../schema").BlockSchemaFromSpecs<{
@@ -257,7 +258,7 @@ export declare const defaultBlockSchema: import("../schema").BlockSchemaFromSpec
                     values: readonly ["left", "center", "right", "justify"];
                 };
             };
-        }, any, import("../schema").InlineContentSchema, import("../schema").StyleSchema>;
+        }, any, InlineContentSchema, StyleSchema>;
     };
     heading: {
         config: {
@@ -299,7 +300,7 @@ export declare const defaultBlockSchema: import("../schema").BlockSchemaFromSpec
                     values: readonly ["left", "center", "right", "justify"];
                 };
             };
-        }, any, import("../schema").InlineContentSchema, import("../schema").StyleSchema>;
+        }, any, InlineContentSchema, StyleSchema>;
     };
     bulletListItem: {
         config: {
@@ -333,7 +334,7 @@ export declare const defaultBlockSchema: import("../schema").BlockSchemaFromSpec
                     values: readonly ["left", "center", "right", "justify"];
                 };
             };
-        }, any, import("../schema").InlineContentSchema, import("../schema").StyleSchema>;
+        }, any, InlineContentSchema, StyleSchema>;
     };
     numberedListItem: {
         config: {
@@ -367,7 +368,7 @@ export declare const defaultBlockSchema: import("../schema").BlockSchemaFromSpec
                     values: readonly ["left", "center", "right", "justify"];
                 };
             };
-        }, any, import("../schema").InlineContentSchema, import("../schema").StyleSchema>;
+        }, any, InlineContentSchema, StyleSchema>;
     };
     image: {
         config: {
@@ -413,7 +414,7 @@ export declare const defaultBlockSchema: import("../schema").BlockSchemaFromSpec
                 };
             };
             content: "none";
-        }, any, import("../schema").InlineContentSchema, import("../schema").StyleSchema>;
+        }, any, InlineContentSchema, StyleSchema>;
     };
     table: {
         config: {
@@ -447,10 +448,11 @@ export declare const defaultBlockSchema: import("../schema").BlockSchemaFromSpec
                     values: readonly ["left", "center", "right", "justify"];
                 };
             };
-        }, any, import("../schema").InlineContentSchema, import("../schema").StyleSchema>;
+        }, any, InlineContentSchema, StyleSchema>;
     };
 }>;
-export type DefaultBlockSchema = typeof defaultBlockSchema;
+export type _DefaultBlockSchema = typeof defaultBlockSchema;
+export type DefaultBlockSchema = _DefaultBlockSchema;
 export declare const defaultStyleSpecs: {
     bold: {
         config: {
@@ -553,7 +555,8 @@ export declare const defaultStyleSchema: import("../schema").StyleSchemaFromSpec
         implementation: import("../schema").StyleImplementation;
     };
 }>;
-export type DefaultStyleSchema = typeof defaultStyleSchema;
+export type _DefaultStyleSchema = typeof defaultStyleSchema;
+export type DefaultStyleSchema = _DefaultStyleSchema;
 export declare const defaultInlineContentSpecs: {
     text: {
         config: "text";
@@ -574,4 +577,7 @@ export declare const defaultInlineContentSchema: import("../schema").InlineConte
         implementation: any;
     };
 }>;
-export type DefaultInlineContentSchema = typeof defaultInlineContentSchema;
+export type _DefaultInlineContentSchema = typeof defaultInlineContentSchema;
+export type DefaultInlineContentSchema = _DefaultInlineContentSchema;
+export type PartialBlock<BSchema extends BlockSchema = DefaultBlockSchema, I extends InlineContentSchema = DefaultInlineContentSchema, S extends StyleSchema = DefaultStyleSchema> = PartialBlockNoDefaults<BSchema, I, S>;
+export type Block<BSchema extends BlockSchema = DefaultBlockSchema, I extends InlineContentSchema = DefaultInlineContentSchema, S extends StyleSchema = DefaultStyleSchema> = BlockNoDefaults<BSchema, I, S>;