@blocknote/core 0.30.1 → 0.31.0

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

@@ -0,0 +1,552 @@
+import { EditorTestCases } from "../index.js";
+import { DefaultBlockSchema, DefaultInlineContentSchema } from "../../../blocks/defaultBlocks.js";
+import { BlockNoteSchema } from "../../../editor/BlockNoteSchema.js";
+declare const schema: BlockNoteSchema<import("../../../index.js").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("../../../index.js").TiptapBlockImplementation<{
+            type: "paragraph";
+            content: "inline";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        }, any, import("../../../index.js").InlineContentSchema, import("../../../index.js").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("../../../index.js").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("../../../index.js").InlineContentSchema, import("../../../index.js").StyleSchema>;
+    };
+    quote: {
+        config: {
+            type: "quote";
+            content: "inline";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        };
+        implementation: import("../../../index.js").TiptapBlockImplementation<{
+            type: "quote";
+            content: "inline";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        }, any, import("../../../index.js").InlineContentSchema, import("../../../index.js").StyleSchema>;
+    };
+    codeBlock: {
+        config: {
+            type: "codeBlock";
+            content: "inline";
+            propSchema: {
+                language: {
+                    default: string;
+                };
+            };
+        };
+        implementation: import("../../../index.js").TiptapBlockImplementation<{
+            type: "codeBlock";
+            content: "inline";
+            propSchema: {
+                language: {
+                    default: string;
+                };
+            };
+        }, any, import("../../../index.js").InlineContentSchema, import("../../../index.js").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("../../../index.js").TiptapBlockImplementation<{
+            type: "bulletListItem";
+            content: "inline";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        }, any, import("../../../index.js").InlineContentSchema, import("../../../index.js").StyleSchema>;
+    };
+    numberedListItem: {
+        config: {
+            type: "numberedListItem";
+            content: "inline";
+            propSchema: {
+                start: {
+                    default: undefined;
+                    type: "number";
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        };
+        implementation: import("../../../index.js").TiptapBlockImplementation<{
+            type: "numberedListItem";
+            content: "inline";
+            propSchema: {
+                start: {
+                    default: undefined;
+                    type: "number";
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        }, any, import("../../../index.js").InlineContentSchema, import("../../../index.js").StyleSchema>;
+    };
+    checkListItem: {
+        config: {
+            type: "checkListItem";
+            content: "inline";
+            propSchema: {
+                checked: {
+                    default: false;
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        };
+        implementation: import("../../../index.js").TiptapBlockImplementation<{
+            type: "checkListItem";
+            content: "inline";
+            propSchema: {
+                checked: {
+                    default: false;
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        }, any, import("../../../index.js").InlineContentSchema, import("../../../index.js").StyleSchema>;
+    };
+    table: {
+        config: {
+            type: "table";
+            content: "table";
+            propSchema: {
+                textColor: {
+                    default: "default";
+                };
+            };
+        };
+        implementation: import("../../../index.js").TiptapBlockImplementation<{
+            type: "table";
+            content: "table";
+            propSchema: {
+                textColor: {
+                    default: "default";
+                };
+            };
+        }, any, import("../../../index.js").InlineContentSchema, import("../../../index.js").StyleSchema>;
+    };
+    file: {
+        config: {
+            type: "file";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+        };
+        implementation: import("../../../index.js").TiptapBlockImplementation<{
+            type: "file";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+        }, any, import("../../../index.js").InlineContentSchema, import("../../../index.js").StyleSchema>;
+    };
+    image: {
+        config: {
+            type: "image";
+            propSchema: {
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+                showPreview: {
+                    default: true;
+                };
+                previewWidth: {
+                    default: number;
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+            fileBlockAccept: string[];
+        };
+        implementation: import("../../../index.js").TiptapBlockImplementation<{
+            type: "image";
+            propSchema: {
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+                showPreview: {
+                    default: true;
+                };
+                previewWidth: {
+                    default: number;
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+            fileBlockAccept: string[];
+        }, any, import("../../../index.js").InlineContentSchema, import("../../../index.js").StyleSchema>;
+    };
+    video: {
+        config: {
+            type: "video";
+            propSchema: {
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+                showPreview: {
+                    default: true;
+                };
+                previewWidth: {
+                    default: number;
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+            fileBlockAccept: string[];
+        };
+        implementation: import("../../../index.js").TiptapBlockImplementation<{
+            type: "video";
+            propSchema: {
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+                showPreview: {
+                    default: true;
+                };
+                previewWidth: {
+                    default: number;
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+            fileBlockAccept: string[];
+        }, any, import("../../../index.js").InlineContentSchema, import("../../../index.js").StyleSchema>;
+    };
+    audio: {
+        config: {
+            type: "audio";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+                showPreview: {
+                    default: true;
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+            fileBlockAccept: string[];
+        };
+        implementation: import("../../../index.js").TiptapBlockImplementation<{
+            type: "audio";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+                showPreview: {
+                    default: true;
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+            fileBlockAccept: string[];
+        }, any, import("../../../index.js").InlineContentSchema, import("../../../index.js").StyleSchema>;
+    };
+}>, import("../../../index.js").InlineContentSchemaFromSpecs<{
+    text: {
+        config: "text";
+        implementation: any;
+    };
+    link: {
+        config: "link";
+        implementation: any;
+    };
+}>, import("../../../index.js").StyleSchemaFromSpecs<{
+    small: import("../../../index.js").StyleSpec<{
+        type: string;
+        propSchema: "boolean";
+    }>;
+    fontSize: import("../../../index.js").StyleSpec<{
+        type: string;
+        propSchema: "string";
+    }>;
+    bold: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../../index.js").StyleImplementation;
+    };
+    italic: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../../index.js").StyleImplementation;
+    };
+    underline: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../../index.js").StyleImplementation;
+    };
+    strike: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../../index.js").StyleImplementation;
+    };
+    code: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../../index.js").StyleImplementation;
+    };
+    textColor: {
+        config: {
+            type: string;
+            propSchema: "string";
+        };
+        implementation: import("../../../index.js").StyleImplementation;
+    };
+    backgroundColor: {
+        config: {
+            type: string;
+            propSchema: "string";
+        };
+        implementation: import("../../../index.js").StyleImplementation;
+    };
+}>>;
+export declare const customStylesTestCases: EditorTestCases<DefaultBlockSchema, DefaultInlineContentSchema, typeof schema.styleSchema>;
+export {};

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

@@ -0,0 +1,4 @@
+import { EditorTestCases } from "../index.js";
+import { DefaultBlockSchema, DefaultInlineContentSchema, DefaultStyleSchema } from "../../../blocks/defaultBlocks.js";
+import { pageBreakSchema } from "../../../blocks/PageBreakBlockContent/schema.js";
+export declare const defaultSchemaTestCases: EditorTestCases<DefaultBlockSchema & typeof pageBreakSchema.blockSchema, DefaultInlineContentSchema, DefaultStyleSchema>;

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

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

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

@@ -0,0 +1,9 @@
+import { Block, PartialBlock } from "../../blocks/defaultBlocks.js";
+import { BlockNoteSchema } from "../../editor/BlockNoteSchema.js";
+import { BlockSchema } from "../../schema/blocks/types.js";
+import { InlineContentSchema } from "../../schema/inlineContent/types.js";
+import { StyleSchema } from "../../schema/styles/types.js";
+export declare function partialBlocksToBlocksForTesting<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(schema: BlockNoteSchema<BSchema, I, S>, partialBlocks: Array<PartialBlock<NoInfer<BSchema>, NoInfer<I>, NoInfer<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/testUtil/paste.d.ts

@@ -0,0 +1,2 @@
+import { EditorView } from "@tiptap/pm/view";
+export declare function doPaste(view: EditorView, text: string, html: string | null, preferPlain: boolean, event: ClipboardEvent): boolean;

package/types/src/blocks/CodeBlockContent/defaultSupportedLanguages.d.ts

@@ -0,0 +1,6 @@
+export type SupportedLanguageConfig = {
+    id: string;
+    name: string;
+    match: string[];
+};
+export declare const defaultSupportedLanguages: SupportedLanguageConfig[];

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

@@ -1,14 +1,22 @@
+import { Node } from "@tiptap/core";
 export declare const tablePropSchema: {
     textColor: {
         default: "default";
     };
 };
-export declare const TableBlockContent: import("@tiptap/core").Node<any, any> & {
+export declare const TableBlockContent: Node<any, any> & {
     name: "table";
     config: {
         content: "tableRow+";
     };
 };
+/**
+ * This extension allows you to create table rows.
+ * @see https://www.tiptap.dev/api/nodes/table-row
+ */
+export declare const TableRow: Node<{
+    HTMLAttributes: Record<string, any>;
+}, any>;
 export declare const Table: {
     config: {
         type: "table";