@blocknote/core 0.29.1 → 0.30.0

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,6 +525,14 @@ 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.
      *

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

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

@@ -0,0 +1,313 @@
+export declare const sk: {
+    slash_menu: {
+        heading: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        heading_2: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        heading_3: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        quote: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        numbered_list: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        bullet_list: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        check_list: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        paragraph: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        code_block: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        page_break: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        table: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        image: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        video: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        audio: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        file: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        emoji: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+    };
+    placeholders: Record<string | "default" | "emptyDocument", string | undefined>;
+    file_blocks: {
+        image: {
+            add_button_text: string;
+        };
+        video: {
+            add_button_text: string;
+        };
+        audio: {
+            add_button_text: string;
+        };
+        file: {
+            add_button_text: string;
+        };
+    };
+    side_menu: {
+        add_block_label: string;
+        drag_handle_label: string;
+    };
+    drag_handle: {
+        delete_menuitem: string;
+        colors_menuitem: string;
+        header_row_menuitem: string;
+        header_column_menuitem: string;
+    };
+    table_handle: {
+        delete_column_menuitem: string;
+        delete_row_menuitem: string;
+        add_left_menuitem: string;
+        add_right_menuitem: string;
+        add_above_menuitem: string;
+        add_below_menuitem: string;
+        split_cell_menuitem: string;
+        merge_cells_menuitem: string;
+        background_color_menuitem: string;
+    };
+    suggestion_menu: {
+        no_items_title: string;
+        loading: string;
+    };
+    color_picker: {
+        text_title: string;
+        background_title: string;
+        colors: {
+            default: string;
+            gray: string;
+            brown: string;
+            red: string;
+            orange: string;
+            yellow: string;
+            green: string;
+            blue: string;
+            purple: string;
+            pink: string;
+        };
+    };
+    formatting_toolbar: {
+        bold: {
+            tooltip: string;
+            secondary_tooltip: string;
+        };
+        italic: {
+            tooltip: string;
+            secondary_tooltip: string;
+        };
+        underline: {
+            tooltip: string;
+            secondary_tooltip: string;
+        };
+        strike: {
+            tooltip: string;
+            secondary_tooltip: string;
+        };
+        code: {
+            tooltip: string;
+            secondary_tooltip: string;
+        };
+        colors: {
+            tooltip: string;
+        };
+        link: {
+            tooltip: string;
+            secondary_tooltip: string;
+        };
+        file_caption: {
+            tooltip: string;
+            input_placeholder: string;
+        };
+        file_replace: {
+            tooltip: {
+                image: string;
+                video: string;
+                audio: string;
+                file: string;
+            };
+        };
+        file_rename: {
+            tooltip: {
+                image: string;
+                video: string;
+                audio: string;
+                file: string;
+            };
+            input_placeholder: {
+                image: string;
+                video: string;
+                audio: string;
+                file: string;
+            };
+        };
+        file_download: {
+            tooltip: {
+                image: string;
+                video: string;
+                audio: string;
+                file: string;
+            };
+        };
+        file_delete: {
+            tooltip: {
+                image: string;
+                video: string;
+                audio: string;
+                file: string;
+            };
+        };
+        file_preview_toggle: {
+            tooltip: string;
+        };
+        nest: {
+            tooltip: string;
+            secondary_tooltip: string;
+        };
+        unnest: {
+            tooltip: string;
+            secondary_tooltip: string;
+        };
+        align_left: {
+            tooltip: string;
+        };
+        align_center: {
+            tooltip: string;
+        };
+        align_right: {
+            tooltip: string;
+        };
+        align_justify: {
+            tooltip: string;
+        };
+        table_cell_merge: {
+            tooltip: string;
+        };
+        comment: {
+            tooltip: string;
+        };
+    };
+    file_panel: {
+        upload: {
+            title: string;
+            file_placeholder: {
+                image: string;
+                video: string;
+                audio: string;
+                file: string;
+            };
+            upload_error: string;
+        };
+        embed: {
+            title: string;
+            embed_button: {
+                image: string;
+                video: string;
+                audio: string;
+                file: string;
+            };
+            url_placeholder: string;
+        };
+    };
+    link_toolbar: {
+        delete: {
+            tooltip: string;
+        };
+        edit: {
+            text: string;
+            tooltip: string;
+        };
+        open: {
+            tooltip: string;
+        };
+        form: {
+            title_placeholder: string;
+            url_placeholder: string;
+        };
+    };
+    comments: {
+        actions: {
+            add_reaction: string;
+            resolve: string;
+            edit_comment: string;
+            delete_comment: string;
+            more_actions: string;
+        };
+        reactions: {
+            reacted_by: string;
+        };
+        sidebar: {
+            marked_as_resolved: string;
+            more_replies: (count: number) => string;
+        };
+    };
+    generic: {
+        ctrl_shortcut: string;
+    };
+};

package/types/src/i18n/locales/zh-tw.d.ts

@@ -0,0 +1,2 @@
+import type { Dictionary } from "../dictionary.js";
+export declare const zhTW: Dictionary;

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

@@ -24,7 +24,8 @@ export type FileBlockConfig = {
             default: boolean;
         };
         previewWidth?: {
-            default: number;
+            default: undefined;
+            type: "number";
         };
     };
     content: "none";

package/src/extensions/Collaboration/createCollaborationExtensions.ts

@@ -1,147 +0,0 @@
-import Collaboration from "@tiptap/extension-collaboration";
-import CollaborationCursor from "@tiptap/extension-collaboration-cursor";
-import { Awareness } from "y-protocols/awareness";
-import * as Y from "yjs";
-
-export const createCollaborationExtensions = (collaboration: {
-  fragment: Y.XmlFragment;
-  user: {
-    name: string;
-    color: string;
-    [key: string]: string;
-  };
-  provider: any;
-  renderCursor?: (user: any) => HTMLElement;
-  showCursorLabels?: "always" | "activity";
-}) => {
-  const tiptapExtensions = [];
-
-  tiptapExtensions.push(
-    Collaboration.configure({
-      fragment: collaboration.fragment,
-    })
-  );
-
-  const awareness = collaboration.provider?.awareness as Awareness | undefined;
-
-  if (awareness) {
-    const cursors = new Map<
-      number,
-      { element: HTMLElement; hideTimeout: NodeJS.Timeout | undefined }
-    >();
-
-    if (collaboration.showCursorLabels !== "always") {
-      awareness.on(
-        "change",
-        ({
-          updated,
-        }: {
-          added: Array<number>;
-          updated: Array<number>;
-          removed: Array<number>;
-        }) => {
-          for (const clientID of updated) {
-            const cursor = cursors.get(clientID);
-
-            if (cursor) {
-              cursor.element.setAttribute("data-active", "");
-
-              if (cursor.hideTimeout) {
-                clearTimeout(cursor.hideTimeout);
-              }
-
-              cursors.set(clientID, {
-                element: cursor.element,
-                hideTimeout: setTimeout(() => {
-                  cursor.element.removeAttribute("data-active");
-                }, 2000),
-              });
-            }
-          }
-        }
-      );
-    }
-
-    const renderCursor = (user: { name: string; color: string }) => {
-      const cursorElement = document.createElement("span");
-
-      cursorElement.classList.add("bn-collaboration-cursor__base");
-
-      const caretElement = document.createElement("span");
-      caretElement.setAttribute("contentedEditable", "false");
-      caretElement.classList.add("bn-collaboration-cursor__caret");
-      caretElement.setAttribute("style", `background-color: ${user.color}`);
-
-      const labelElement = document.createElement("span");
-
-      labelElement.classList.add("bn-collaboration-cursor__label");
-      labelElement.setAttribute("style", `background-color: ${user.color}`);
-      labelElement.insertBefore(document.createTextNode(user.name), null);
-
-      caretElement.insertBefore(labelElement, null);
-
-      cursorElement.insertBefore(document.createTextNode("\u2060"), null); // Non-breaking space
-      cursorElement.insertBefore(caretElement, null);
-      cursorElement.insertBefore(document.createTextNode("\u2060"), null); // Non-breaking space
-
-      return cursorElement;
-    };
-
-    const render = (
-      user: { color: string; name: string },
-      clientID: number
-    ) => {
-      let cursorData = cursors.get(clientID);
-
-      if (!cursorData) {
-        const cursorElement =
-          collaboration?.renderCursor?.(user) || renderCursor(user);
-
-        if (collaboration?.showCursorLabels !== "always") {
-          cursorElement.addEventListener("mouseenter", () => {
-            const cursor = cursors.get(clientID)!;
-            cursor.element.setAttribute("data-active", "");
-
-            if (cursor.hideTimeout) {
-              clearTimeout(cursor.hideTimeout);
-              cursors.set(clientID, {
-                element: cursor.element,
-                hideTimeout: undefined,
-              });
-            }
-          });
-
-          cursorElement.addEventListener("mouseleave", () => {
-            const cursor = cursors.get(clientID)!;
-
-            cursors.set(clientID, {
-              element: cursor.element,
-              hideTimeout: setTimeout(() => {
-                cursor.element.removeAttribute("data-active");
-              }, 2000),
-            });
-          });
-        }
-
-        cursorData = {
-          element: cursorElement,
-          hideTimeout: undefined,
-        };
-
-        cursors.set(clientID, cursorData);
-      }
-
-      return cursorData.element;
-    };
-
-    tiptapExtensions.push(
-      CollaborationCursor.configure({
-        user: collaboration.user,
-        render: render as any, // tiptap type not compatible with latest y-prosemirror
-        provider: collaboration.provider,
-      })
-    );
-  }
-
-  return tiptapExtensions;
-};

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

@@ -1,17 +0,0 @@
-import * as Y from "yjs";
-export declare const createCollaborationExtensions: (collaboration: {
-    fragment: Y.XmlFragment;
-    user: {
-        name: string;
-        color: string;
-        [key: string]: string;
-    };
-    provider: any;
-    renderCursor?: (user: any) => HTMLElement;
-    showCursorLabels?: "always" | "activity";
-}) => (import("@tiptap/core").Extension<import("@tiptap/extension-collaboration").CollaborationOptions, import("@tiptap/extension-collaboration").CollaborationStorage> | import("@tiptap/core").Extension<import("@tiptap/extension-collaboration-cursor").CollaborationCursorOptions, {
-    users: {
-        clientId: number;
-        [key: string]: any;
-    }[];
-}>)[];