@blocknote/core 0.42.3 → 0.43.0

package/src/editor/BlockNoteExtensions.ts

@@ -1,325 +0,0 @@
-import { AnyExtension, Extension, extensions, Node } from "@tiptap/core";
-import { Gapcursor } from "@tiptap/extension-gapcursor";
-import { History } from "@tiptap/extension-history";
-import { Link } from "@tiptap/extension-link";
-import { Text } from "@tiptap/extension-text";
-import { Plugin } from "prosemirror-state";
-import * as Y from "yjs";
-
-import { createDropFileExtension } from "../api/clipboard/fromClipboard/fileDropExtension.js";
-import { createPasteFromClipboardExtension } from "../api/clipboard/fromClipboard/pasteExtension.js";
-import { createCopyToClipboardExtension } from "../api/clipboard/toClipboard/copyExtension.js";
-import type { ThreadStore, User } from "../comments/index.js";
-import { BackgroundColorExtension } from "../extensions/BackgroundColor/BackgroundColorExtension.js";
-import { BlockChangePlugin } from "../extensions/BlockChange/BlockChangePlugin.js";
-import { CursorPlugin } from "../extensions/Collaboration/CursorPlugin.js";
-import { ForkYDocPlugin } from "../extensions/Collaboration/ForkYDocPlugin.js";
-import { SyncPlugin } from "../extensions/Collaboration/SyncPlugin.js";
-import { UndoPlugin } from "../extensions/Collaboration/UndoPlugin.js";
-import { SchemaMigrationPlugin } from "../extensions/Collaboration/schemaMigration/SchemaMigrationPlugin.js";
-import { CommentMark } from "../extensions/Comments/CommentMark.js";
-import { CommentsPlugin } from "../extensions/Comments/CommentsPlugin.js";
-import { FilePanelProsemirrorPlugin } from "../extensions/FilePanel/FilePanelPlugin.js";
-import { FormattingToolbarProsemirrorPlugin } from "../extensions/FormattingToolbar/FormattingToolbarPlugin.js";
-import { HardBreak } from "../extensions/HardBreak/HardBreak.js";
-import { KeyboardShortcutsExtension } from "../extensions/KeyboardShortcuts/KeyboardShortcutsExtension.js";
-import { LinkToolbarProsemirrorPlugin } from "../extensions/LinkToolbar/LinkToolbarPlugin.js";
-import {
-  DEFAULT_LINK_PROTOCOL,
-  VALID_LINK_PROTOCOLS,
-} from "../extensions/LinkToolbar/protocols.js";
-import { NodeSelectionKeyboardPlugin } from "../extensions/NodeSelectionKeyboard/NodeSelectionKeyboardPlugin.js";
-import { PlaceholderPlugin } from "../extensions/Placeholder/PlaceholderPlugin.js";
-import { PreviousBlockTypePlugin } from "../extensions/PreviousBlockType/PreviousBlockTypePlugin.js";
-import { ShowSelectionPlugin } from "../extensions/ShowSelection/ShowSelectionPlugin.js";
-import { SideMenuProsemirrorPlugin } from "../extensions/SideMenu/SideMenuPlugin.js";
-import { SuggestionMenuProseMirrorPlugin } from "../extensions/SuggestionMenu/SuggestionPlugin.js";
-import {
-  SuggestionAddMark,
-  SuggestionDeleteMark,
-  SuggestionModificationMark,
-} from "../extensions/Suggestions/SuggestionMarks.js";
-import { TableHandlesProsemirrorPlugin } from "../extensions/TableHandles/TableHandlesPlugin.js";
-import { TextAlignmentExtension } from "../extensions/TextAlignment/TextAlignmentExtension.js";
-import { TextColorExtension } from "../extensions/TextColor/TextColorExtension.js";
-import { TrailingNode } from "../extensions/TrailingNode/TrailingNodeExtension.js";
-import UniqueID from "../extensions/UniqueID/UniqueID.js";
-import { BlockContainer, BlockGroup, Doc } from "../pm-nodes/index.js";
-import {
-  BlockNoteDOMAttributes,
-  BlockSchema,
-  BlockSpecs,
-  InlineContentSchema,
-  InlineContentSpecs,
-  StyleSchema,
-  StyleSpecs,
-} from "../schema/index.js";
-import type {
-  BlockNoteEditor,
-  BlockNoteEditorOptions,
-  SupportedExtension,
-} from "./BlockNoteEditor.js";
-import { BlockNoteSchema } from "../blocks/BlockNoteSchema.js";
-
-type ExtensionOptions<
-  BSchema extends BlockSchema,
-  I extends InlineContentSchema,
-  S extends StyleSchema,
-> = {
-  editor: BlockNoteEditor<BSchema, I, S>;
-  domAttributes: Partial<BlockNoteDOMAttributes>;
-  blockSpecs: BlockSpecs;
-  inlineContentSpecs: InlineContentSpecs;
-  styleSpecs: StyleSpecs;
-  trailingBlock: boolean | undefined;
-  collaboration?: {
-    fragment: Y.XmlFragment;
-    user: {
-      name: string;
-      color: string;
-      [key: string]: string;
-    };
-    provider: any;
-    renderCursor?: (user: any) => HTMLElement;
-    showCursorLabels?: "always" | "activity";
-  };
-  disableExtensions: string[] | undefined;
-  setIdAttribute?: boolean;
-  animations: boolean;
-  tableHandles: boolean;
-  dropCursor: (opts: any) => Plugin;
-  placeholders: Record<
-    string | "default" | "emptyDocument",
-    string | undefined
-  >;
-  tabBehavior?: "prefer-navigate-ui" | "prefer-indent";
-  comments?: {
-    schema?: BlockNoteSchema<any, any, any>;
-    threadStore: ThreadStore;
-    resolveUsers?: (userIds: string[]) => Promise<User[]>;
-  };
-  pasteHandler: BlockNoteEditorOptions<any, any, any>["pasteHandler"];
-};
-
-/**
- * Get all the Tiptap extensions BlockNote is configured with by default
- */
-export const getBlockNoteExtensions = <
-  BSchema extends BlockSchema,
-  I extends InlineContentSchema,
-  S extends StyleSchema,
->(
-  opts: ExtensionOptions<BSchema, I, S>,
-) => {
-  const ret: Record<string, SupportedExtension> = {};
-  const tiptapExtensions = getTipTapExtensions(opts);
-
-  for (const ext of tiptapExtensions) {
-    ret[ext.name] = ext;
-  }
-
-  if (opts.collaboration) {
-    ret["ySyncPlugin"] = new SyncPlugin(opts.collaboration.fragment);
-    ret["yUndoPlugin"] = new UndoPlugin({ editor: opts.editor });
-
-    if (opts.collaboration.provider?.awareness) {
-      ret["yCursorPlugin"] = new CursorPlugin(opts.collaboration);
-    }
-    ret["forkYDocPlugin"] = new ForkYDocPlugin({
-      editor: opts.editor,
-      collaboration: opts.collaboration,
-    });
-    ret["schemaMigrationPlugin"] = new SchemaMigrationPlugin(
-      opts.collaboration.fragment,
-    );
-  }
-
-  // Note: this is pretty hardcoded and will break when user provides plugins with same keys.
-  // Define name on plugins instead and not make this a map?
-  ret["formattingToolbar"] = new FormattingToolbarProsemirrorPlugin(
-    opts.editor,
-  );
-  ret["linkToolbar"] = new LinkToolbarProsemirrorPlugin(opts.editor);
-  ret["sideMenu"] = new SideMenuProsemirrorPlugin(opts.editor);
-  ret["suggestionMenus"] = new SuggestionMenuProseMirrorPlugin(opts.editor);
-  ret["filePanel"] = new FilePanelProsemirrorPlugin(opts.editor as any);
-  ret["placeholder"] = new PlaceholderPlugin(opts.editor, opts.placeholders);
-
-  if (opts.animations ?? true) {
-    ret["animations"] = new PreviousBlockTypePlugin();
-  }
-
-  if (opts.tableHandles) {
-    ret["tableHandles"] = new TableHandlesProsemirrorPlugin(opts.editor as any);
-  }
-
-  ret["nodeSelectionKeyboard"] = new NodeSelectionKeyboardPlugin();
-  ret["blockChange"] = new BlockChangePlugin();
-
-  ret["showSelection"] = new ShowSelectionPlugin(opts.editor);
-
-  if (opts.comments) {
-    ret["comments"] = new CommentsPlugin(
-      opts.editor,
-      opts.comments.threadStore,
-      CommentMark.name,
-      opts.comments.resolveUsers,
-      opts.comments.schema,
-    );
-  }
-
-  const disableExtensions: string[] = opts.disableExtensions || [];
-  for (const ext of disableExtensions) {
-    delete ret[ext];
-  }
-
-  return ret;
-};
-
-let LINKIFY_INITIALIZED = false;
-
-/**
- * Get all the Tiptap extensions BlockNote is configured with by default
- */
-const getTipTapExtensions = <
-  BSchema extends BlockSchema,
-  I extends InlineContentSchema,
-  S extends StyleSchema,
->(
-  opts: ExtensionOptions<BSchema, I, S>,
-) => {
-  const tiptapExtensions: AnyExtension[] = [
-    extensions.ClipboardTextSerializer,
-    extensions.Commands,
-    extensions.Editable,
-    extensions.FocusEvents,
-    extensions.Tabindex,
-
-    // DevTools,
-    Gapcursor,
-
-    // DropCursor,
-    Extension.create({
-      name: "dropCursor",
-      addProseMirrorPlugins: () => [
-        opts.dropCursor({
-          width: 5,
-          color: "#ddeeff",
-          editor: opts.editor,
-        }),
-      ],
-    }),
-
-    UniqueID.configure({
-      // everything from bnBlock group (nodes that represent a BlockNote block should have an id)
-      types: ["blockContainer", "columnList", "column"],
-      setIdAttribute: opts.setIdAttribute,
-    }),
-    HardBreak,
-    // Comments,
-
-    // basics:
-    Text,
-
-    // marks:
-    SuggestionAddMark,
-    SuggestionDeleteMark,
-    SuggestionModificationMark,
-    Link.extend({
-      inclusive: false,
-    }).configure({
-      defaultProtocol: DEFAULT_LINK_PROTOCOL,
-      // only call this once if we have multiple editors installed. Or fix https://github.com/ueberdosis/tiptap/issues/5450
-      protocols: LINKIFY_INITIALIZED ? [] : VALID_LINK_PROTOCOLS,
-    }),
-    ...(Object.values(opts.styleSpecs).map((styleSpec) => {
-      return styleSpec.implementation.mark.configure({
-        editor: opts.editor as any,
-      });
-    }) as any[]),
-
-    TextColorExtension,
-
-    BackgroundColorExtension,
-    TextAlignmentExtension,
-
-    // make sure escape blurs editor, so that we can tab to other elements in the host page (accessibility)
-    Extension.create({
-      name: "OverrideEscape",
-      addKeyboardShortcuts() {
-        return {
-          Escape: () => {
-            if (opts.editor.suggestionMenus.shown) {
-              // escape is handled by suggestionmenu
-              return false;
-            }
-            return this.editor.commands.blur();
-          },
-        };
-      },
-    }),
-
-    // nodes
-    Doc,
-    BlockContainer.configure({
-      editor: opts.editor,
-      domAttributes: opts.domAttributes,
-    }),
-    KeyboardShortcutsExtension.configure({
-      editor: opts.editor,
-      tabBehavior: opts.tabBehavior,
-    }),
-    BlockGroup.configure({
-      domAttributes: opts.domAttributes,
-    }),
-    ...Object.values(opts.inlineContentSpecs)
-      .filter((a) => a.config !== "link" && a.config !== "text")
-      .map((inlineContentSpec) => {
-        return inlineContentSpec.implementation!.node.configure({
-          editor: opts.editor as any,
-        });
-      }),
-
-    ...Object.values(opts.blockSpecs).flatMap((blockSpec) => {
-      return [
-        // the node extension implementations
-        ...("node" in blockSpec.implementation
-          ? [
-              (blockSpec.implementation.node as Node).configure({
-                editor: opts.editor,
-                domAttributes: opts.domAttributes,
-              }),
-            ]
-          : []),
-      ];
-    }),
-    createCopyToClipboardExtension(opts.editor),
-    createPasteFromClipboardExtension(
-      opts.editor,
-      opts.pasteHandler ||
-        ((context: {
-          defaultPasteHandler: (context?: {
-            prioritizeMarkdownOverHTML?: boolean;
-            plainTextAsMarkdown?: boolean;
-          }) => boolean | undefined;
-        }) => context.defaultPasteHandler()),
-    ),
-    createDropFileExtension(opts.editor),
-
-    // This needs to be at the bottom of this list, because Key events (such as enter, when selecting a /command),
-    // should be handled before Enter handlers in other components like splitListItem
-    ...(opts.trailingBlock === undefined || opts.trailingBlock
-      ? [TrailingNode]
-      : []),
-    ...(opts.comments ? [CommentMark] : []),
-  ];
-
-  LINKIFY_INITIALIZED = true;
-
-  if (!opts.collaboration) {
-    // disable history extension when collaboration is enabled as y-prosemirror takes care of undo / redo
-    tiptapExtensions.push(History);
-  }
-
-  return tiptapExtensions;
-};

package/src/editor/managers/CollaborationManager.ts

@@ -1,212 +0,0 @@
-import * as Y from "yjs";
-import { redoCommand, undoCommand } from "y-prosemirror";
-import { CommentsPlugin } from "../../extensions/Comments/CommentsPlugin.js";
-import { CommentMark } from "../../extensions/Comments/CommentMark.js";
-import { ForkYDocPlugin } from "../../extensions/Collaboration/ForkYDocPlugin.js";
-import { SyncPlugin } from "../../extensions/Collaboration/SyncPlugin.js";
-import { UndoPlugin } from "../../extensions/Collaboration/UndoPlugin.js";
-import { CursorPlugin } from "../../extensions/Collaboration/CursorPlugin.js";
-import type { ThreadStore, User } from "../../comments/index.js";
-import type { BlockNoteEditor } from "../BlockNoteEditor.js";
-import { CustomBlockNoteSchema } from "../../schema/schema.js";
-
-export interface CollaborationOptions {
-  /**
-   * The Yjs XML fragment that's used for collaboration.
-   */
-  fragment: Y.XmlFragment;
-  /**
-   * The user info for the current user that's shown to other collaborators.
-   */
-  user: {
-    name: string;
-    color: string;
-  };
-  /**
-   * A Yjs provider (used for awareness / cursor information)
-   * Can be null for comments-only mode
-   */
-  provider: any;
-  /**
-   * Optional function to customize how cursors of users are rendered
-   */
-  renderCursor?: (user: any) => HTMLElement;
-  /**
-   * Optional flag to set when the user label should be shown with the default
-   * collaboration cursor. Setting to "always" will always show the label,
-   * while "activity" will only show the label when the user moves the cursor
-   * or types. Defaults to "activity".
-   */
-  showCursorLabels?: "always" | "activity";
-  /**
-   * Comments configuration - can be used with or without collaboration
-   */
-  comments?: {
-    schema?: CustomBlockNoteSchema<any, any, any>;
-    threadStore: ThreadStore;
-  };
-  /**
-   * Function to resolve user IDs to user objects - required for comments
-   */
-  resolveUsers?: (userIds: string[]) => Promise<User[]>;
-}
-
-/**
- * CollaborationManager handles all collaboration-related functionality
- * This manager is completely optional and can be tree-shaken if not used
- */
-export class CollaborationManager {
-  private editor: BlockNoteEditor;
-  private options: CollaborationOptions;
-  private _commentsPlugin?: CommentsPlugin;
-  private _forkYDocPlugin?: ForkYDocPlugin;
-  private _syncPlugin?: SyncPlugin;
-  private _undoPlugin?: UndoPlugin;
-  private _cursorPlugin?: CursorPlugin;
-
-  constructor(editor: BlockNoteEditor, options: CollaborationOptions) {
-    this.editor = editor;
-    this.options = options;
-  }
-
-  /**
-   * Get the sync plugin instance
-   */
-  public get syncPlugin(): SyncPlugin | undefined {
-    return this._syncPlugin;
-  }
-
-  /**
-   * Get the undo plugin instance
-   */
-  public get undoPlugin(): UndoPlugin | undefined {
-    return this._undoPlugin;
-  }
-
-  /**
-   * Get the cursor plugin instance
-   */
-  public get cursorPlugin(): CursorPlugin | undefined {
-    return this._cursorPlugin;
-  }
-
-  /**
-   * Get the fork YDoc plugin instance
-   */
-  public get forkYDocPlugin(): ForkYDocPlugin | undefined {
-    return this._forkYDocPlugin;
-  }
-
-  // Initialize collaboration plugins
-  public initExtensions(): Record<string, unknown> {
-    // Only create collaboration plugins when real-time collaboration is enabled
-    const extensions: Record<string, unknown> = {};
-
-    // Initialize sync plugin
-    this._syncPlugin = new SyncPlugin(this.options.fragment);
-    extensions.ySyncPlugin = this._syncPlugin;
-
-    // Initialize undo plugin
-    this._undoPlugin = new UndoPlugin({ editor: this.editor });
-    extensions.yUndoPlugin = this._undoPlugin;
-
-    // Initialize cursor plugin if provider has awareness
-    if (this.options.provider?.awareness) {
-      this._cursorPlugin = new CursorPlugin(this.options);
-      extensions.yCursorPlugin = this._cursorPlugin;
-    }
-
-    // Initialize fork YDoc plugin
-    this._forkYDocPlugin = new ForkYDocPlugin({
-      editor: this.editor,
-      collaboration: this.options,
-    });
-    extensions.forkYDocPlugin = this._forkYDocPlugin;
-
-    if (this.options.comments) {
-      if (!this.options.resolveUsers) {
-        throw new Error("resolveUsers is required when using comments");
-      }
-
-      // Create CommentsPlugin instance and add it to editor extensions
-      this._commentsPlugin = new CommentsPlugin(
-        this.editor,
-        this.options.comments.threadStore,
-        CommentMark.name,
-        this.options.resolveUsers,
-        this.options.comments.schema,
-      );
-
-      // Add the comments plugin to the editor's extensions
-      extensions.comments = this._commentsPlugin;
-      extensions.commentMark = CommentMark;
-    }
-    return extensions;
-  }
-
-  /**
-   * Update the user info for the current user that's shown to other collaborators
-   */
-  public updateUserInfo(user: { name: string; color: string }) {
-    const cursor = this.cursorPlugin;
-    if (!cursor) {
-      throw new Error(
-        "Cannot update collaboration user info when collaboration is disabled.",
-      );
-    }
-    cursor.updateUser(user);
-  }
-
-  /**
-   * Get the collaboration undo command
-   */
-  public getUndoCommand() {
-    return undoCommand;
-  }
-
-  /**
-   * Get the collaboration redo command
-   */
-  public getRedoCommand() {
-    return redoCommand;
-  }
-
-  /**
-   * Check if initial content should be avoided due to collaboration
-   */
-  public shouldAvoidInitialContent(): boolean {
-    // Only avoid initial content when real-time collaboration is enabled
-    // (i.e., when we have a provider)
-    return !!this.options.provider;
-  }
-
-  /**
-   * Get the collaboration options
-   */
-  public getOptions(): CollaborationOptions {
-    return this.options;
-  }
-
-  /**
-   * Get the comments plugin if available
-   */
-  public get comments(): CommentsPlugin | undefined {
-    return this._commentsPlugin;
-  }
-
-  /**
-   * Check if comments are enabled
-   */
-  public get hasComments(): boolean {
-    return !!this.options.comments;
-  }
-
-  /**
-   * Get the resolveUsers function
-   */
-  public get resolveUsers():
-    | ((userIds: string[]) => Promise<User[]>)
-    | undefined {
-    return this.options.resolveUsers;
-  }
-}

package/src/editor/managers/ExtensionManager.ts

@@ -1,130 +0,0 @@
-import { FilePanelProsemirrorPlugin } from "../../extensions/FilePanel/FilePanelPlugin.js";
-import { FormattingToolbarProsemirrorPlugin } from "../../extensions/FormattingToolbar/FormattingToolbarPlugin.js";
-import { LinkToolbarProsemirrorPlugin } from "../../extensions/LinkToolbar/LinkToolbarPlugin.js";
-import { ShowSelectionPlugin } from "../../extensions/ShowSelection/ShowSelectionPlugin.js";
-import { SideMenuProsemirrorPlugin } from "../../extensions/SideMenu/SideMenuPlugin.js";
-import { SuggestionMenuProseMirrorPlugin } from "../../extensions/SuggestionMenu/SuggestionPlugin.js";
-import { TableHandlesProsemirrorPlugin } from "../../extensions/TableHandles/TableHandlesPlugin.js";
-import { BlockNoteExtension } from "../BlockNoteExtension.js";
-import { BlockNoteEditor } from "../BlockNoteEditor.js";
-
-export class ExtensionManager {
-  constructor(private editor: BlockNoteEditor) {}
-
-  /**
-   * Shorthand to get a typed extension from the editor, by
-   * just passing in the extension class.
-   *
-   * @param ext - The extension class to get
-   * @param key - optional, the key of the extension in the extensions object (defaults to the extension name)
-   * @returns The extension instance
-   */
-  public extension<T extends BlockNoteExtension>(
-    ext: { new (...args: any[]): T } & typeof BlockNoteExtension,
-    key = ext.key(),
-  ): T {
-    const extension = this.editor.extensions[key] as T;
-    if (!extension) {
-      throw new Error(`Extension ${key} not found`);
-    }
-    return extension;
-  }
-
-  /**
-   * Get all extensions
-   */
-  public getExtensions() {
-    return this.editor.extensions;
-  }
-
-  /**
-   * Get a specific extension by key
-   */
-  public getExtension(key: string) {
-    return this.editor.extensions[key];
-  }
-
-  /**
-   * Check if an extension exists
-   */
-  public hasExtension(key: string): boolean {
-    return key in this.editor.extensions;
-  }
-
-  // Plugin getters - these provide access to the core BlockNote plugins
-
-  /**
-   * Get the formatting toolbar plugin
-   */
-  public get formattingToolbar(): FormattingToolbarProsemirrorPlugin {
-    return this.editor.extensions[
-      "formattingToolbar"
-    ] as FormattingToolbarProsemirrorPlugin;
-  }
-
-  /**
-   * Get the link toolbar plugin
-   */
-  public get linkToolbar(): LinkToolbarProsemirrorPlugin<any, any, any> {
-    return this.editor.extensions[
-      "linkToolbar"
-    ] as LinkToolbarProsemirrorPlugin<any, any, any>;
-  }
-
-  /**
-   * Get the side menu plugin
-   */
-  public get sideMenu(): SideMenuProsemirrorPlugin<any, any, any> {
-    return this.editor.extensions["sideMenu"] as SideMenuProsemirrorPlugin<
-      any,
-      any,
-      any
-    >;
-  }
-
-  /**
-   * Get the suggestion menus plugin
-   */
-  public get suggestionMenus(): SuggestionMenuProseMirrorPlugin<any, any, any> {
-    return this.editor.extensions[
-      "suggestionMenus"
-    ] as SuggestionMenuProseMirrorPlugin<any, any, any>;
-  }
-
-  /**
-   * Get the file panel plugin (if available)
-   */
-  public get filePanel(): FilePanelProsemirrorPlugin<any, any> | undefined {
-    return this.editor.extensions["filePanel"] as
-      | FilePanelProsemirrorPlugin<any, any>
-      | undefined;
-  }
-
-  /**
-   * Get the table handles plugin (if available)
-   */
-  public get tableHandles():
-    | TableHandlesProsemirrorPlugin<any, any>
-    | undefined {
-    return this.editor.extensions["tableHandles"] as
-      | TableHandlesProsemirrorPlugin<any, any>
-      | undefined;
-  }
-
-  /**
-   * Get the show selection plugin
-   */
-  public get showSelectionPlugin(): ShowSelectionPlugin {
-    return this.editor.extensions["showSelection"] as ShowSelectionPlugin;
-  }
-
-  /**
-   * Check if collaboration is enabled (Yjs or Liveblocks)
-   */
-  public get isCollaborationEnabled(): boolean {
-    return (
-      this.hasExtension("ySyncPlugin") ||
-      this.hasExtension("liveblocksExtension")
-    );
-  }
-}