@blocknote/core 0.13.2 → 0.13.4

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

@@ -144,6 +144,120 @@ export declare const defaultBlockSpecs: {
             };
         }, any, InlineContentSchema, 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("../schema").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, InlineContentSchema, 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("../schema").TiptapBlockImplementation<{
+            type: "table";
+            content: "table";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        }, any, InlineContentSchema, StyleSchema>;
+    };
+    file: {
+        config: {
+            type: "file";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+        };
+        implementation: import("../schema").TiptapBlockImplementation<{
+            type: "file";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+        }, any, InlineContentSchema, StyleSchema>;
+    };
     image: {
         config: {
             type: "image";
@@ -155,17 +269,25 @@ export declare const defaultBlockSpecs: {
                 backgroundColor: {
                     default: "default";
                 };
+                name: {
+                    default: "";
+                };
                 url: {
                     default: "";
                 };
                 caption: {
                     default: "";
                 };
-                width: {
-                    default: 512;
+                showPreview: {
+                    default: true;
+                };
+                previewWidth: {
+                    default: number;
                 };
             };
             content: "none";
+            isFileBlock: true;
+            fileBlockAcceptMimeTypes: string[];
         };
         implementation: import("../schema").TiptapBlockImplementation<{
             type: "image";
@@ -177,51 +299,135 @@ export declare const defaultBlockSpecs: {
                 backgroundColor: {
                     default: "default";
                 };
+                name: {
+                    default: "";
+                };
                 url: {
                     default: "";
                 };
                 caption: {
                     default: "";
                 };
-                width: {
-                    default: 512;
+                showPreview: {
+                    default: true;
+                };
+                previewWidth: {
+                    default: number;
                 };
             };
             content: "none";
+            isFileBlock: true;
+            fileBlockAcceptMimeTypes: string[];
         }, any, InlineContentSchema, StyleSchema>;
     };
-    table: {
+    video: {
         config: {
-            type: "table";
-            content: "table";
+            type: "video";
             propSchema: {
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
                 backgroundColor: {
                     default: "default";
                 };
-                textColor: {
-                    default: "default";
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
                 };
+                showPreview: {
+                    default: true;
+                };
+                previewWidth: {
+                    default: number;
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+            fileBlockAcceptMimeTypes: string[];
+        };
+        implementation: import("../schema").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;
+            fileBlockAcceptMimeTypes: string[];
+        }, any, InlineContentSchema, StyleSchema>;
+    };
+    audio: {
+        config: {
+            type: "audio";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+                showPreview: {
+                    default: true;
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+            fileBlockAcceptMimeTypes: string[];
         };
         implementation: import("../schema").TiptapBlockImplementation<{
-            type: "table";
-            content: "table";
+            type: "audio";
             propSchema: {
                 backgroundColor: {
                     default: "default";
                 };
-                textColor: {
-                    default: "default";
+                name: {
+                    default: "";
                 };
-                textAlignment: {
-                    default: "left";
-                    values: readonly ["left", "center", "right", "justify"];
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+                showPreview: {
+                    default: true;
                 };
             };
+            content: "none";
+            isFileBlock: true;
+            fileBlockAcceptMimeTypes: string[];
         }, any, InlineContentSchema, StyleSchema>;
     };
 };
@@ -370,6 +576,120 @@ export declare const defaultBlockSchema: import("../schema").BlockSchemaFromSpec
             };
         }, any, InlineContentSchema, 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("../schema").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, InlineContentSchema, 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("../schema").TiptapBlockImplementation<{
+            type: "table";
+            content: "table";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        }, any, InlineContentSchema, StyleSchema>;
+    };
+    file: {
+        config: {
+            type: "file";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+        };
+        implementation: import("../schema").TiptapBlockImplementation<{
+            type: "file";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+        }, any, InlineContentSchema, StyleSchema>;
+    };
     image: {
         config: {
             type: "image";
@@ -381,17 +701,25 @@ export declare const defaultBlockSchema: import("../schema").BlockSchemaFromSpec
                 backgroundColor: {
                     default: "default";
                 };
+                name: {
+                    default: "";
+                };
                 url: {
                     default: "";
                 };
                 caption: {
                     default: "";
                 };
-                width: {
-                    default: 512;
+                showPreview: {
+                    default: true;
+                };
+                previewWidth: {
+                    default: number;
                 };
             };
             content: "none";
+            isFileBlock: true;
+            fileBlockAcceptMimeTypes: string[];
         };
         implementation: import("../schema").TiptapBlockImplementation<{
             type: "image";
@@ -403,51 +731,135 @@ export declare const defaultBlockSchema: import("../schema").BlockSchemaFromSpec
                 backgroundColor: {
                     default: "default";
                 };
+                name: {
+                    default: "";
+                };
                 url: {
                     default: "";
                 };
                 caption: {
                     default: "";
                 };
-                width: {
-                    default: 512;
+                showPreview: {
+                    default: true;
+                };
+                previewWidth: {
+                    default: number;
                 };
             };
             content: "none";
+            isFileBlock: true;
+            fileBlockAcceptMimeTypes: string[];
         }, any, InlineContentSchema, StyleSchema>;
     };
-    table: {
+    video: {
         config: {
-            type: "table";
-            content: "table";
+            type: "video";
             propSchema: {
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
                 backgroundColor: {
                     default: "default";
                 };
-                textColor: {
-                    default: "default";
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
                 };
+                showPreview: {
+                    default: true;
+                };
+                previewWidth: {
+                    default: number;
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+            fileBlockAcceptMimeTypes: string[];
+        };
+        implementation: import("../schema").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;
+            fileBlockAcceptMimeTypes: string[];
+        }, any, InlineContentSchema, StyleSchema>;
+    };
+    audio: {
+        config: {
+            type: "audio";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+                showPreview: {
+                    default: true;
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+            fileBlockAcceptMimeTypes: string[];
         };
         implementation: import("../schema").TiptapBlockImplementation<{
-            type: "table";
-            content: "table";
+            type: "audio";
             propSchema: {
                 backgroundColor: {
                     default: "default";
                 };
-                textColor: {
-                    default: "default";
+                name: {
+                    default: "";
                 };
-                textAlignment: {
-                    default: "left";
-                    values: readonly ["left", "center", "right", "justify"];
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+                showPreview: {
+                    default: true;
                 };
             };
+            content: "none";
+            isFileBlock: true;
+            fileBlockAcceptMimeTypes: string[];
         }, any, InlineContentSchema, StyleSchema>;
     };
 }>;

package/types/src/editor/BlockNoteEditor.d.ts

@@ -2,8 +2,8 @@ import { EditorOptions } from "@tiptap/core";
 import { Node } from "prosemirror-model";
 import * as Y from "yjs";
 import { Block, DefaultBlockSchema, DefaultInlineContentSchema, DefaultStyleSchema, PartialBlock } from "../blocks/defaultBlocks";
+import { FilePanelProsemirrorPlugin } from "../extensions/FilePanel/FilePanelPlugin";
 import { FormattingToolbarProsemirrorPlugin } from "../extensions/FormattingToolbar/FormattingToolbarPlugin";
-import { ImagePanelProsemirrorPlugin } from "../extensions/ImagePanel/ImageToolbarPlugin";
 import { LinkToolbarProsemirrorPlugin } from "../extensions/LinkToolbar/LinkToolbarPlugin";
 import { SideMenuProsemirrorPlugin } from "../extensions/SideMenu/SideMenuPlugin";
 import { SuggestionMenuProseMirrorPlugin } from "../extensions/SuggestionMenu/SuggestionPlugin";
@@ -47,9 +47,15 @@ export type BlockNoteEditorOptions<BSchema extends BlockSchema, ISchema extends
     /**
      * A custom function to handle file uploads.
      * @param file The file that should be uploaded.
-     * @returns The URL of the uploaded file.
+     * @returns The URL of the uploaded file OR an object containing props that should be set on the file block (such as an id)
      */
-    uploadFile: (file: File) => Promise<string>;
+    uploadFile: (file: File) => Promise<string | Record<string, any>>;
+    /**
+     * Resolve a URL of a file block to one that can be displayed or downloaded. This can be used for creating authenticated URL or
+     * implementing custom protocols / schemes
+     * @returns The URL that's
+     */
+    resolveFileUrl: (url: string) => Promise<string>;
     /**
      * When enabled, allows for collaboration between multiple users.
      */
@@ -92,9 +98,10 @@ export declare class BlockNoteEditor<BSchema extends BlockSchema = DefaultBlockS
     readonly linkToolbar: LinkToolbarProsemirrorPlugin<BSchema, ISchema, SSchema>;
     readonly sideMenu: SideMenuProsemirrorPlugin<BSchema, ISchema, SSchema>;
     readonly suggestionMenus: SuggestionMenuProseMirrorPlugin<BSchema, ISchema, SSchema>;
-    readonly imagePanel?: ImagePanelProsemirrorPlugin<ISchema, SSchema>;
+    readonly filePanel?: FilePanelProsemirrorPlugin<BSchema, ISchema, SSchema>;
     readonly tableHandles?: TableHandlesProsemirrorPlugin<ISchema, SSchema>;
-    readonly uploadFile: ((file: File) => Promise<string>) | undefined;
+    readonly uploadFile: ((file: File) => Promise<string | Record<string, any>>) | undefined;
+    readonly resolveFileUrl: (url: string) => Promise<string>;
     static create<BSchema extends BlockSchema = DefaultBlockSchema, ISchema extends InlineContentSchema = DefaultInlineContentSchema, SSchema extends StyleSchema = DefaultStyleSchema>(options?: Partial<BlockNoteEditorOptions<BSchema, ISchema, SSchema>>): BlockNoteEditor<BSchema, ISchema, SSchema>;
     private constructor();
     /**

package/types/src/extensions/{ImagePanel/ImageToolbarPlugin.d.ts → FilePanel/FilePanelPlugin.d.ts}

@@ -1,20 +1,19 @@
 import { EditorState, Plugin, PluginKey, PluginView } from "prosemirror-state";
 import { EditorView } from "prosemirror-view";
-import { DefaultBlockSchema } from "../../blocks/defaultBlocks";
 import type { BlockNoteEditor } from "../../editor/BlockNoteEditor";
 import { UiElementPosition } from "../../extensions-shared/UiElementPosition";
-import type { BlockFromConfig, InlineContentSchema, StyleSchema } from "../../schema";
+import type { BlockFromConfig, BlockSchema, FileBlockConfig, InlineContentSchema, StyleSchema } from "../../schema";
 import { EventEmitter } from "../../util/EventEmitter";
-export type ImagePanelState<I extends InlineContentSchema, S extends StyleSchema> = UiElementPosition & {
-    block: BlockFromConfig<DefaultBlockSchema["image"], I, S>;
+export type FilePanelState<I extends InlineContentSchema, S extends StyleSchema> = UiElementPosition & {
+    block: BlockFromConfig<FileBlockConfig, I, S>;
 };
-export declare class ImagePanelView<I extends InlineContentSchema, S extends StyleSchema> implements PluginView {
+export declare class FilePanelView<I extends InlineContentSchema, S extends StyleSchema> implements PluginView {
     private readonly pluginKey;
     private readonly pmView;
-    state?: ImagePanelState<I, S>;
+    state?: FilePanelState<I, S>;
     emitUpdate: () => void;
     prevWasEditable: boolean | null;
-    constructor(pluginKey: PluginKey, pmView: EditorView, emitUpdate: (state: ImagePanelState<I, S>) => void);
+    constructor(pluginKey: PluginKey, pmView: EditorView, emitUpdate: (state: FilePanelState<I, S>) => void);
     mouseDownHandler: () => void;
     dragstartHandler: () => void;
     scrollHandler: () => void;
@@ -22,13 +21,11 @@ export declare class ImagePanelView<I extends InlineContentSchema, S extends Sty
     closeMenu: () => void;
     destroy(): void;
 }
-export declare class ImagePanelProsemirrorPlugin<I extends InlineContentSchema, S extends StyleSchema> extends EventEmitter<any> {
+export declare class FilePanelProsemirrorPlugin<B extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema> extends EventEmitter<any> {
     private view;
     readonly plugin: Plugin;
-    constructor(_editor: BlockNoteEditor<{
-        image: DefaultBlockSchema["image"];
-    }, I, S>);
+    constructor(_editor: BlockNoteEditor<B, I, S>);
     get shown(): boolean;
-    onUpdate(callback: (state: ImagePanelState<I, S>) => void): () => void;
+    onUpdate(callback: (state: FilePanelState<I, S>) => void): () => void;
     closeMenu: () => void;
 }

package/types/src/extensions/TableHandles/TableHandlesPlugin.d.ts

@@ -17,7 +17,7 @@ export type TableHandlesState<I extends InlineContentSchema, S extends StyleSche
         mousePos: number;
     } | undefined;
 };
-export declare class TableHandlesView<BSchema extends BlockSchemaWithBlock<"table", DefaultBlockSchema["table"]>, I extends InlineContentSchema, S extends StyleSchema> implements PluginView {
+export declare class TableHandlesView<I extends InlineContentSchema, S extends StyleSchema> implements PluginView {
     private readonly editor;
     private readonly pmView;
     state?: TableHandlesState<I, S>;