@blocknote/core 0.15.11 → 0.17.0

package/types/src/api/blockManipulation/setupTestEnv.d.ts

@@ -0,0 +1,492 @@
+import { BlockNoteEditor } from "../../editor/BlockNoteEditor.js";
+export declare function setupTestEnv(): () => BlockNoteEditor<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>;
+    };
+    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: {
+                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: {
+                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: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        };
+        implementation: import("../../index.js").TiptapBlockImplementation<{
+            type: "table";
+            content: "table";
+            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>;
+    };
+    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<{
+    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;
+    };
+}>>;

package/types/src/api/clipboard/clipboard.test.d.ts

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

package/types/src/api/clipboard/fromClipboard/fileDropExtension.d.ts

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

package/types/src/api/{parsers → clipboard/fromClipboard}/handleFileInsertion.d.ts

@@ -1,3 +1,3 @@
-import type { BlockNoteEditor } from "../../editor/BlockNoteEditor";
-import { BlockSchema, InlineContentSchema, StyleSchema } from "../../schema";
+import type { BlockNoteEditor } from "../../../editor/BlockNoteEditor";
+import { BlockSchema, InlineContentSchema, StyleSchema } from "../../../schema/index.js";
 export declare function handleFileInsertion<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(event: DragEvent | ClipboardEvent, editor: BlockNoteEditor<BSchema, I, S>): Promise<void>;

package/types/src/api/clipboard/fromClipboard/pasteExtension.d.ts

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

package/types/src/api/clipboard/toClipboard/copyExtension.d.ts

@@ -0,0 +1,12 @@
+import { Extension } from "@tiptap/core";
+import { EditorView } from "prosemirror-view";
+import type { BlockNoteEditor } from "../../../editor/BlockNoteEditor.js";
+import { BlockSchema, InlineContentSchema, StyleSchema } from "../../../schema/index.js";
+export declare function selectedFragmentToHTML<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(view: EditorView, editor: BlockNoteEditor<BSchema, I, S>): {
+    clipboardHTML: string;
+    externalHTML: string;
+    markdown: string;
+};
+export declare const createCopyToClipboardExtension: <BSchema extends Record<string, import("../../../schema/index.js").BlockConfig>, I extends InlineContentSchema, S extends StyleSchema>(editor: BlockNoteEditor<BSchema, I, S>) => Extension<{
+    editor: BlockNoteEditor<BSchema, I, S>;
+}, undefined>;

package/types/src/api/exporters/html/externalHTMLExporter.d.ts

@@ -1,13 +1,12 @@
-import { Fragment, Schema } from "prosemirror-model";
-import { PartialBlock } from "../../../blocks/defaultBlocks";
-import type { BlockNoteEditor } from "../../../editor/BlockNoteEditor";
-import { BlockSchema, InlineContentSchema, StyleSchema } from "../../../schema";
-export interface ExternalHTMLExporter<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema> {
+import { Schema } from "prosemirror-model";
+import { PartialBlock } from "../../../blocks/defaultBlocks.js";
+import type { BlockNoteEditor } from "../../../editor/BlockNoteEditor.js";
+import { InlineContent, InlineContentSchema, StyleSchema } from "../../../schema/index.js";
+export declare const createExternalHTMLExporter: <BSchema extends Record<string, import("../../../schema/index.js").BlockConfig>, I extends InlineContentSchema, S extends StyleSchema>(schema: Schema, editor: BlockNoteEditor<BSchema, I, S>) => {
     exportBlocks: (blocks: PartialBlock<BSchema, I, S>[], options: {
         document?: Document;
     }) => string;
-    exportProseMirrorFragment: (fragment: Fragment, options: {
+    exportInlineContent: (inlineContent: InlineContent<I, S>[], options: {
         document?: Document;
     }) => string;
-}
-export declare const createExternalHTMLExporter: <BSchema extends Record<string, import("../../../schema").BlockConfig>, I extends InlineContentSchema, S extends StyleSchema>(schema: Schema, editor: BlockNoteEditor<BSchema, I, S>) => ExternalHTMLExporter<BSchema, I, S>;
+};

package/types/src/api/exporters/html/internalHTMLSerializer.d.ts

@@ -1,13 +1,9 @@
-import { Fragment, Schema } from "prosemirror-model";
-import { PartialBlock } from "../../../blocks/defaultBlocks";
-import type { BlockNoteEditor } from "../../../editor/BlockNoteEditor";
-import { BlockSchema, InlineContentSchema, StyleSchema } from "../../../schema";
-export interface InternalHTMLSerializer<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema> {
-    serializeProseMirrorFragment: (fragment: Fragment, options: {
-        document?: Document;
-    }) => string;
+import { Schema } from "prosemirror-model";
+import { PartialBlock } from "../../../blocks/defaultBlocks.js";
+import type { BlockNoteEditor } from "../../../editor/BlockNoteEditor.js";
+import { InlineContentSchema, StyleSchema } from "../../../schema/index.js";
+export declare const createInternalHTMLSerializer: <BSchema extends Record<string, import("../../../schema/index.js").BlockConfig>, I extends InlineContentSchema, S extends StyleSchema>(schema: Schema, editor: BlockNoteEditor<BSchema, I, S>) => {
     serializeBlocks: (blocks: PartialBlock<BSchema, I, S>[], options: {
         document?: Document;
     }) => string;
-}
-export declare const createInternalHTMLSerializer: <BSchema extends Record<string, import("../../../schema").BlockConfig>, I extends InlineContentSchema, S extends StyleSchema>(schema: Schema, editor: BlockNoteEditor<BSchema, I, S>) => InternalHTMLSerializer<BSchema, I, S>;
+};

package/types/src/api/exporters/html/util/serializeBlocksExternalHTML.d.ts

@@ -0,0 +1,10 @@
+import { DOMSerializer } from "prosemirror-model";
+import { PartialBlock } from "../../../../blocks/defaultBlocks.js";
+import type { BlockNoteEditor } from "../../../../editor/BlockNoteEditor.js";
+import { BlockSchema, InlineContentSchema, StyleSchema } from "../../../../schema/index.js";
+export declare function serializeInlineContentExternalHTML<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(editor: BlockNoteEditor<any, I, S>, blockContent: PartialBlock<BSchema, I, S>["content"], serializer: DOMSerializer, options?: {
+    document?: Document;
+}): HTMLElement | DocumentFragment;
+export declare const serializeBlocksExternalHTML: <BSchema extends Record<string, import("../../../../schema/index.js").BlockConfig>, I extends InlineContentSchema, S extends StyleSchema>(editor: BlockNoteEditor<BSchema, I, S>, blocks: PartialBlock<BSchema, I, S>[], serializer: DOMSerializer, orderedListItemBlockTypes: Set<string>, unorderedListItemBlockTypes: Set<string>, options?: {
+    document?: Document;
+}) => DocumentFragment;

package/types/src/api/exporters/html/util/serializeBlocksInternalHTML.d.ts

@@ -0,0 +1,11 @@
+import { DOMSerializer } from "prosemirror-model";
+import { PartialBlock } from "../../../../blocks/defaultBlocks.js";
+import type { BlockNoteEditor } from "../../../../editor/BlockNoteEditor.js";
+import { BlockSchema, InlineContentSchema, StyleSchema } from "../../../../schema/index.js";
+export declare function serializeInlineContentInternalHTML<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(editor: BlockNoteEditor<any, I, S>, blockContent: PartialBlock<BSchema, I, S>["content"], serializer: DOMSerializer, _toExternalHTML: boolean, // TODO, externalHTML for IC
+options?: {
+    document?: Document;
+}): HTMLElement | DocumentFragment;
+export declare const serializeBlocksInternalHTML: <BSchema extends Record<string, import("../../../../schema/index.js").BlockConfig>, I extends InlineContentSchema, S extends StyleSchema>(editor: BlockNoteEditor<BSchema, I, S>, blocks: PartialBlock<BSchema, I, S>[], serializer: DOMSerializer, toExternalHTML: boolean, options?: {
+    document?: Document;
+}) => HTMLElement;

package/types/src/api/exporters/markdown/markdownExporter.d.ts

@@ -1,7 +1,7 @@
 import { Schema } from "prosemirror-model";
-import { PartialBlock } from "../../../blocks/defaultBlocks";
-import type { BlockNoteEditor } from "../../../editor/BlockNoteEditor";
-import { BlockSchema, InlineContentSchema, StyleSchema } from "../../../schema";
+import { PartialBlock } from "../../../blocks/defaultBlocks.js";
+import type { BlockNoteEditor } from "../../../editor/BlockNoteEditor.js";
+import { BlockSchema, InlineContentSchema, StyleSchema } from "../../../schema/index.js";
 export declare function cleanHTMLToMarkdown(cleanHTMLString: string): string;
 export declare function blocksToMarkdown<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(blocks: PartialBlock<BSchema, I, S>[], schema: Schema, editor: BlockNoteEditor<BSchema, I, S>, options: {
     document?: Document;