@blocknote/core 0.29.1 → 0.30.1

package/src/util/table.ts

@@ -13,47 +13,50 @@ import { PartialTableCell, TableCell } from "../schema/blocks/types.js";
  */
 export function mapTableCell<
   T extends InlineContentSchema,
-  S extends StyleSchema
+  S extends StyleSchema,
 >(
-  content: PartialInlineContent<T, S> | PartialTableCell<T, S> | TableCell<T, S>
+  content:
+    | PartialInlineContent<T, S>
+    | PartialTableCell<T, S>
+    | TableCell<T, S>,
 ): TableCell<T, S> {
   return isTableCell(content)
     ? { ...content }
     : isPartialTableCell(content)
-    ? {
-        type: "tableCell",
-        content: ([] as InlineContent<T, S>[]).concat(content.content as any),
-        props: {
-          backgroundColor: content.props?.backgroundColor ?? "default",
-          textColor: content.props?.textColor ?? "default",
-          textAlignment: content.props?.textAlignment ?? "left",
-          colspan: content.props?.colspan ?? 1,
-          rowspan: content.props?.rowspan ?? 1,
-        },
-      }
-    : {
-        type: "tableCell",
-        content: ([] as InlineContent<T, S>[]).concat(content as any),
-        props: {
-          backgroundColor: "default",
-          textColor: "default",
-          textAlignment: "left",
-          colspan: 1,
-          rowspan: 1,
-        },
-      };
+      ? {
+          type: "tableCell",
+          content: ([] as InlineContent<T, S>[]).concat(content.content as any),
+          props: {
+            backgroundColor: content.props?.backgroundColor ?? "default",
+            textColor: content.props?.textColor ?? "default",
+            textAlignment: content.props?.textAlignment ?? "left",
+            colspan: content.props?.colspan ?? 1,
+            rowspan: content.props?.rowspan ?? 1,
+          },
+        }
+      : {
+          type: "tableCell",
+          content: ([] as InlineContent<T, S>[]).concat(content as any),
+          props: {
+            backgroundColor: "default",
+            textColor: "default",
+            textAlignment: "left",
+            colspan: 1,
+            rowspan: 1,
+          },
+        };
 }
 
 export function isPartialTableCell<
   T extends InlineContentSchema,
-  S extends StyleSchema
+  S extends StyleSchema,
 >(
   content:
     | TableCell<T, S>
     | PartialInlineContent<T, S>
     | PartialTableCell<T, S>
     | undefined
-    | null
+    | null,
 ): content is PartialTableCell<T, S> {
   return (
     content !== undefined &&
@@ -66,14 +69,14 @@ export function isPartialTableCell<
 
 export function isTableCell<
   T extends InlineContentSchema,
-  S extends StyleSchema
+  S extends StyleSchema,
 >(
   content:
     | TableCell<T, S>
     | PartialInlineContent<T, S>
     | PartialTableCell<T, S>
     | undefined
-    | null
+    | null,
 ): content is TableCell<T, S> {
   return (
     isPartialTableCell(content) &&
@@ -86,7 +89,7 @@ export function getColspan(
   cell:
     | TableCell<any, any>
     | PartialTableCell<any, any>
-    | PartialInlineContent<any, any>
+    | PartialInlineContent<any, any>,
 ): number {
   if (isTableCell(cell)) {
     return cell.props.colspan ?? 1;
@@ -98,7 +101,7 @@ export function getRowspan(
   cell:
     | TableCell<any, any>
     | PartialTableCell<any, any>
-    | PartialInlineContent<any, any>
+    | PartialInlineContent<any, any>,
 ): number {
   if (isTableCell(cell)) {
     return cell.props.rowspan ?? 1;

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

@@ -330,7 +330,8 @@ export declare function setupTestEnv(): () => BlockNoteEditor<import("../../inde
                     default: true;
                 };
                 previewWidth: {
-                    default: number;
+                    default: undefined;
+                    type: "number";
                 };
             };
             content: "none";
@@ -360,7 +361,8 @@ export declare function setupTestEnv(): () => BlockNoteEditor<import("../../inde
                     default: true;
                 };
                 previewWidth: {
-                    default: number;
+                    default: undefined;
+                    type: "number";
                 };
             };
             content: "none";
@@ -392,7 +394,8 @@ export declare function setupTestEnv(): () => BlockNoteEditor<import("../../inde
                     default: true;
                 };
                 previewWidth: {
-                    default: number;
+                    default: undefined;
+                    type: "number";
                 };
             };
             content: "none";
@@ -422,7 +425,8 @@ export declare function setupTestEnv(): () => BlockNoteEditor<import("../../inde
                     default: true;
                 };
                 previewWidth: {
-                    default: number;
+                    default: undefined;
+                    type: "number";
                 };
             };
             content: "none";

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

@@ -22,7 +22,8 @@ export declare const imagePropSchema: {
         default: true;
     };
     previewWidth: {
-        default: number;
+        default: undefined;
+        type: "number";
     };
 };
 export declare const imageBlockConfig: {
@@ -48,7 +49,8 @@ export declare const imageBlockConfig: {
             default: true;
         };
         previewWidth: {
-            default: number;
+            default: undefined;
+            type: "number";
         };
     };
     content: "none";
@@ -87,7 +89,8 @@ export declare const ImageBlock: {
                 default: true;
             };
             previewWidth: {
-                default: number;
+                default: undefined;
+                type: "number";
             };
         };
         content: "none";
@@ -117,7 +120,8 @@ export declare const ImageBlock: {
                 default: true;
             };
             previewWidth: {
-                default: number;
+                default: undefined;
+                type: "number";
             };
         };
         content: "none";

package/types/src/blocks/ListItemBlockContent/getListItemContent.d.ts

@@ -0,0 +1,28 @@
+import { Fragment, Schema } from "prosemirror-model";
+/**
+ * This function is used to parse the content of a list item external HTML node.
+ *
+ * Due to a change in how prosemirror-model handles parsing elements, we have additional flexibility in how we can "fit" content into a list item.
+ *
+ * We've decided to take an approach that is similar to Notion. The core rules of the algorithm are:
+ *
+ *  - If the first child of an `li` has ONLY text content, take the text content, and flatten it into the list item. Subsequent siblings are carried over as is, as children of the list item.
+ *    - e.g. `<li><h1>Hello</h1><p>World</p></li> -> <li>Hello<blockGroup><blockContainer><p>World</p></blockContainer></blockGroup></li>`
+ *  - Else, take the content and insert it as children instead.
+ *    - e.g. `<li><img src="url" /></li> -> <li><p></p><blockGroup><blockContainer><img src="url" /></blockContainer></blockGroup></li>`
+ *
+ * This ensures that a list item's content is always valid ProseMirror content. Smoothing over differences between how external HTML may be rendered, and how ProseMirror expects content to be structured.
+ */
+export declare function getListItemContent(
+/**
+ * The `li` element to parse.
+ */
+_node: Node, 
+/**
+ * The schema to use for parsing.
+ */
+schema: Schema, 
+/**
+ * The name of the list item node.
+ */
+name: string): Fragment;

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

@@ -22,7 +22,8 @@ export declare const videoPropSchema: {
         default: true;
     };
     previewWidth: {
-        default: number;
+        default: undefined;
+        type: "number";
     };
 };
 export declare const videoBlockConfig: {
@@ -48,7 +49,8 @@ export declare const videoBlockConfig: {
             default: true;
         };
         previewWidth: {
-            default: number;
+            default: undefined;
+            type: "number";
         };
     };
     content: "none";
@@ -87,7 +89,8 @@ export declare const VideoBlock: {
                 default: true;
             };
             previewWidth: {
-                default: number;
+                default: undefined;
+                type: "number";
             };
         };
         content: "none";
@@ -117,7 +120,8 @@ export declare const VideoBlock: {
                 default: true;
             };
             previewWidth: {
-                default: number;
+                default: undefined;
+                type: "number";
             };
         };
         content: "none";

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

@@ -8,3 +8,4 @@ export declare const defaultBlockToHTML: <BSchema extends BlockSchema, I extends
     dom: HTMLElement;
     contentDOM?: HTMLElement;
 };
+export declare function mergeParagraphs(element: HTMLElement): void;

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

@@ -330,7 +330,8 @@ export declare const defaultBlockSpecs: {
                     default: true;
                 };
                 previewWidth: {
-                    default: number;
+                    default: undefined;
+                    type: "number";
                 };
             };
             content: "none";
@@ -360,7 +361,8 @@ export declare const defaultBlockSpecs: {
                     default: true;
                 };
                 previewWidth: {
-                    default: number;
+                    default: undefined;
+                    type: "number";
                 };
             };
             content: "none";
@@ -392,7 +394,8 @@ export declare const defaultBlockSpecs: {
                     default: true;
                 };
                 previewWidth: {
-                    default: number;
+                    default: undefined;
+                    type: "number";
                 };
             };
             content: "none";
@@ -422,7 +425,8 @@ export declare const defaultBlockSpecs: {
                     default: true;
                 };
                 previewWidth: {
-                    default: number;
+                    default: undefined;
+                    type: "number";
                 };
             };
             content: "none";
@@ -810,7 +814,8 @@ export declare const defaultBlockSchema: import("../index.js").BlockSchemaFromSp
                     default: true;
                 };
                 previewWidth: {
-                    default: number;
+                    default: undefined;
+                    type: "number";
                 };
             };
             content: "none";
@@ -840,7 +845,8 @@ export declare const defaultBlockSchema: import("../index.js").BlockSchemaFromSp
                     default: true;
                 };
                 previewWidth: {
-                    default: number;
+                    default: undefined;
+                    type: "number";
                 };
             };
             content: "none";
@@ -872,7 +878,8 @@ export declare const defaultBlockSchema: import("../index.js").BlockSchemaFromSp
                     default: true;
                 };
                 previewWidth: {
-                    default: number;
+                    default: undefined;
+                    type: "number";
                 };
             };
             content: "none";
@@ -902,7 +909,8 @@ export declare const defaultBlockSchema: import("../index.js").BlockSchemaFromSp
                     default: true;
                 };
                 previewWidth: {
-                    default: number;
+                    default: undefined;
+                    type: "number";
                 };
             };
             content: "none";

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

@@ -26,6 +26,7 @@ import { EventEmitter } from "../util/EventEmitter.js";
 export type BlockNoteExtensionFactory = (editor: BlockNoteEditor<any, any, any>) => BlockNoteExtension;
 export type BlockNoteExtension = AnyExtension | {
     plugin: Plugin;
+    priority?: number;
 };
 export type BlockCache<BSchema extends BlockSchema = any, ISchema extends InlineContentSchema = any, SSchema extends StyleSchema = any> = WeakMap<Node, Block<BSchema, ISchema, SSchema>>;
 export type BlockNoteEditorOptions<BSchema extends BlockSchema, ISchema extends InlineContentSchema, SSchema extends StyleSchema> = {
@@ -289,6 +290,7 @@ export declare class BlockNoteEditor<BSchema extends BlockSchema = DefaultBlockS
     readonly tableHandles?: TableHandlesProsemirrorPlugin<ISchema, SSchema>;
     readonly comments?: CommentsPlugin;
     private readonly showSelectionPlugin;
+    private readonly cursorPlugin;
     /**
      * The `uploadFile` method is what the editor uses when files need to be uploaded (for example when selecting an image to upload).
      * This method should set when creating the editor as this is application-specific.
@@ -378,8 +380,15 @@ export declare class BlockNoteEditor<BSchema extends BlockSchema = DefaultBlockS
      * @warning Not needed to call manually when using React, use BlockNoteView to take care of mounting
      */
     mount: (parentElement?: HTMLElement | null, contentComponent?: any) => void;
+    /**
+     * Get the underlying prosemirror state
+     * @note Prefer using `editor.transact` to read the current editor state, as that will ensure the state is up to date
+     * @see https://prosemirror.net/docs/ref/#state.EditorState
+     */
+    get prosemirrorState(): import("prosemirror-state").EditorState;
     /**
      * Get the underlying prosemirror view
+     * @see https://prosemirror.net/docs/ref/#view.EditorView
      */
     get prosemirrorView(): EditorView | undefined;
     get domElement(): HTMLDivElement | undefined;
@@ -441,7 +450,7 @@ export declare class BlockNoteEditor<BSchema extends BlockSchema = DefaultBlockS
      * Executes a callback whenever the editor's contents change.
      * @param callback The callback to execute.
      *
-     * @deprecated use `onChange` instead
+     * @deprecated use {@link BlockNoteEditor.onChange} instead
      */
     onEditorContentChange(callback: () => void): void;
     /**
@@ -516,12 +525,22 @@ export declare class BlockNoteEditor<BSchema extends BlockSchema = DefaultBlockS
         insertedBlocks: Block<BSchema, ISchema, SSchema>[];
         removedBlocks: Block<BSchema, ISchema, SSchema>[];
     };
+    /**
+     * Undo the last action.
+     */
+    undo(): boolean;
+    /**
+     * Redo the last action.
+     */
+    redo(): boolean;
     /**
      * Insert a piece of content at the current cursor position.
      *
      * @param content can be a string, or array of partial inline content elements
      */
-    insertInlineContent(content: PartialInlineContent<ISchema, SSchema>): void;
+    insertInlineContent(content: PartialInlineContent<ISchema, SSchema>, { updateSelection }?: {
+        updateSelection?: boolean;
+    }): void;
     /**
      * Gets the active text styles at the text cursor position or at the end of the current selection if it's active.
      */

package/types/src/extensions/Collaboration/CursorPlugin.d.ts

@@ -0,0 +1,31 @@
+import { Plugin } from "prosemirror-state";
+import { Awareness } from "y-protocols/awareness.js";
+import * as Y from "yjs";
+export type CollaborationUser = {
+    name: string;
+    color: string;
+    [key: string]: string;
+};
+export declare class CursorPlugin {
+    private collaboration;
+    plugin: Plugin;
+    private provider;
+    private recentlyUpdatedCursors;
+    constructor(collaboration: {
+        fragment: Y.XmlFragment;
+        user: CollaborationUser;
+        provider: {
+            awareness: Awareness;
+        };
+        renderCursor?: (user: CollaborationUser) => HTMLElement;
+        showCursorLabels?: "always" | "activity";
+    });
+    get priority(): number;
+    private renderCursor;
+    updateUser: (user: {
+        name: string;
+        color: string;
+        [key: string]: string;
+    }) => void;
+    static defaultCursorRender: (user: CollaborationUser) => HTMLSpanElement;
+}

package/types/src/extensions/Collaboration/SyncPlugin.d.ts

@@ -0,0 +1,7 @@
+import { Plugin } from "prosemirror-state";
+import type * as Y from "yjs";
+export declare class SyncPlugin {
+    plugin: Plugin;
+    constructor(fragment: Y.XmlFragment);
+    get priority(): number;
+}

package/types/src/extensions/Collaboration/UndoPlugin.d.ts

@@ -0,0 +1,6 @@
+import { Plugin } from "prosemirror-state";
+export declare class UndoPlugin {
+    plugin: Plugin;
+    constructor();
+    get priority(): number;
+}

package/types/src/extensions/FilePanel/FilePanelPlugin.d.ts

@@ -13,7 +13,7 @@ export declare class FilePanelView<I extends InlineContentSchema, S extends Styl
     private readonly pmView;
     state?: FilePanelState<I, S>;
     emitUpdate: () => void;
-    constructor(editor: BlockNoteEditor<Record<string, FileBlockConfig>, I, S>, pluginKey: PluginKey, pmView: EditorView, emitUpdate: (state: FilePanelState<I, S>) => void);
+    constructor(editor: BlockNoteEditor<Record<string, FileBlockConfig>, I, S>, pluginKey: PluginKey<FilePanelState<I, S>>, pmView: EditorView, emitUpdate: (state: FilePanelState<I, S>) => void);
     mouseDownHandler: () => void;
     dragstartHandler: () => void;
     scrollHandler: () => void;

package/types/src/i18n/locales/index.d.ts

@@ -13,6 +13,8 @@ export * from "./no.js";
 export * from "./pl.js";
 export * from "./pt.js";
 export * from "./ru.js";
+export * from "./sk.js";
 export * from "./uk.js";
 export * from "./vi.js";
 export * from "./zh.js";
+export * from "./zh-tw.js";