@blocknote/core 0.42.2 → 0.43.0

package/types/src/editor/managers/CollaborationManager.d.ts

@@ -1,115 +0,0 @@
-import * as Y from "yjs";
-import { CommentsPlugin } from "../../extensions/Comments/CommentsPlugin.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 declare class CollaborationManager {
-    private editor;
-    private options;
-    private _commentsPlugin?;
-    private _forkYDocPlugin?;
-    private _syncPlugin?;
-    private _undoPlugin?;
-    private _cursorPlugin?;
-    constructor(editor: BlockNoteEditor, options: CollaborationOptions);
-    /**
-     * Get the sync plugin instance
-     */
-    get syncPlugin(): SyncPlugin | undefined;
-    /**
-     * Get the undo plugin instance
-     */
-    get undoPlugin(): UndoPlugin | undefined;
-    /**
-     * Get the cursor plugin instance
-     */
-    get cursorPlugin(): CursorPlugin | undefined;
-    /**
-     * Get the fork YDoc plugin instance
-     */
-    get forkYDocPlugin(): ForkYDocPlugin | undefined;
-    initExtensions(): Record<string, unknown>;
-    /**
-     * Update the user info for the current user that's shown to other collaborators
-     */
-    updateUserInfo(user: {
-        name: string;
-        color: string;
-    }): void;
-    /**
-     * Get the collaboration undo command
-     */
-    getUndoCommand(): import("prosemirror-state").Command;
-    /**
-     * Get the collaboration redo command
-     */
-    getRedoCommand(): import("prosemirror-state").Command;
-    /**
-     * Check if initial content should be avoided due to collaboration
-     */
-    shouldAvoidInitialContent(): boolean;
-    /**
-     * Get the collaboration options
-     */
-    getOptions(): CollaborationOptions;
-    /**
-     * Get the comments plugin if available
-     */
-    get comments(): CommentsPlugin | undefined;
-    /**
-     * Check if comments are enabled
-     */
-    get hasComments(): boolean;
-    /**
-     * Get the resolveUsers function
-     */
-    get resolveUsers(): ((userIds: string[]) => Promise<User[]>) | undefined;
-}

package/types/src/editor/managers/ExtensionManager.d.ts

@@ -1,68 +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 declare class ExtensionManager {
-    private editor;
-    constructor(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
-     */
-    extension<T extends BlockNoteExtension>(ext: {
-        new (...args: any[]): T;
-    } & typeof BlockNoteExtension, key?: string): T;
-    /**
-     * Get all extensions
-     */
-    getExtensions(): Record<string, import("../BlockNoteEditor.js").SupportedExtension>;
-    /**
-     * Get a specific extension by key
-     */
-    getExtension(key: string): import("../BlockNoteEditor.js").SupportedExtension;
-    /**
-     * Check if an extension exists
-     */
-    hasExtension(key: string): boolean;
-    /**
-     * Get the formatting toolbar plugin
-     */
-    get formattingToolbar(): FormattingToolbarProsemirrorPlugin;
-    /**
-     * Get the link toolbar plugin
-     */
-    get linkToolbar(): LinkToolbarProsemirrorPlugin<any, any, any>;
-    /**
-     * Get the side menu plugin
-     */
-    get sideMenu(): SideMenuProsemirrorPlugin<any, any, any>;
-    /**
-     * Get the suggestion menus plugin
-     */
-    get suggestionMenus(): SuggestionMenuProseMirrorPlugin<any, any, any>;
-    /**
-     * Get the file panel plugin (if available)
-     */
-    get filePanel(): FilePanelProsemirrorPlugin<any, any> | undefined;
-    /**
-     * Get the table handles plugin (if available)
-     */
-    get tableHandles(): TableHandlesProsemirrorPlugin<any, any> | undefined;
-    /**
-     * Get the show selection plugin
-     */
-    get showSelectionPlugin(): ShowSelectionPlugin;
-    /**
-     * Check if collaboration is enabled (Yjs or Liveblocks)
-     */
-    get isCollaborationEnabled(): boolean;
-}

package/types/src/extensions/BlockChange/BlockChangePlugin.d.ts

@@ -1,15 +0,0 @@
-import { Transaction } from "prosemirror-state";
-import { BlocksChanged } from "../../api/getBlocksChangedByTransaction.js";
-import { BlockNoteExtension } from "../../editor/BlockNoteExtension.js";
-/**
- * This plugin can filter transactions before they are applied to the editor, but with a higher-level API than `filterTransaction` from prosemirror.
- */
-export declare class BlockChangePlugin extends BlockNoteExtension {
-    static key(): string;
-    private beforeChangeCallbacks;
-    constructor();
-    subscribe(callback: (context: {
-        getChanges: () => BlocksChanged<any, any, any>;
-        tr: Transaction;
-    }) => boolean | void): () => void;
-}

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

@@ -1,37 +0,0 @@
-import { Awareness } from "y-protocols/awareness.js";
-import * as Y from "yjs";
-import { BlockNoteExtension } from "../../editor/BlockNoteExtension.js";
-export type CollaborationUser = {
-    name: string;
-    color: string;
-    [key: string]: string;
-};
-export declare class CursorPlugin extends BlockNoteExtension {
-    private collaboration;
-    static key(): string;
-    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;
-    /**
-     * Determine whether the foreground color should be white or black based on a provided background color
-     * Inspired by: https://stackoverflow.com/a/3943023
-     *
-     */
-    static isDarkColor(bgColor: string): boolean;
-    static defaultCursorRender: (user: CollaborationUser) => HTMLSpanElement;
-}

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

@@ -1,41 +0,0 @@
-import { BlockNoteEditor, BlockNoteEditorOptions } from "../../editor/BlockNoteEditor.js";
-import { BlockNoteExtension } from "../../editor/BlockNoteExtension.js";
-export declare class ForkYDocPlugin extends BlockNoteExtension<{
-    forked: boolean;
-}> {
-    static key(): string;
-    private editor;
-    private collaboration;
-    constructor({ editor, collaboration, }: {
-        editor: BlockNoteEditor<any, any, any>;
-        collaboration: BlockNoteEditorOptions<any, any, any>["collaboration"];
-    });
-    /**
-     * To find a fragment in another ydoc, we need to search for it.
-     */
-    private findTypeInOtherYdoc;
-    /**
-     * Whether the editor is editing a forked document,
-     * preserving a reference to the original document and the forked document.
-     */
-    get isForkedFromRemote(): boolean;
-    /**
-     * Stores whether the editor is editing a forked document,
-     * preserving a reference to the original document and the forked document.
-     */
-    private forkedState;
-    /**
-     * Fork the Y.js document from syncing to the remote,
-     * allowing modifications to the document without affecting the remote.
-     * These changes can later be rolled back or applied to the remote.
-     */
-    fork(): void;
-    /**
-     * Resume syncing the Y.js document to the remote
-     * If `keepChanges` is true, any changes that have been made to the forked document will be applied to the original document.
-     * Otherwise, the original document will be restored and the changes will be discarded.
-     */
-    merge({ keepChanges }: {
-        keepChanges: boolean;
-    }): void;
-}

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

@@ -1,7 +0,0 @@
-import type * as Y from "yjs";
-import { BlockNoteExtension } from "../../editor/BlockNoteExtension.js";
-export declare class SyncPlugin extends BlockNoteExtension {
-    static key(): string;
-    constructor(fragment: Y.XmlFragment);
-    get priority(): number;
-}

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

@@ -1,9 +0,0 @@
-import { BlockNoteEditor } from "../../editor/BlockNoteEditor.js";
-import { BlockNoteExtension } from "../../editor/BlockNoteExtension.js";
-export declare class UndoPlugin extends BlockNoteExtension {
-    static key(): string;
-    constructor({ editor }: {
-        editor: BlockNoteEditor<any, any, any>;
-    });
-    get priority(): number;
-}

package/types/src/extensions/Collaboration/schemaMigration/SchemaMigrationPlugin.d.ts

@@ -1,7 +0,0 @@
-import * as Y from "yjs";
-import { BlockNoteExtension } from "../../../editor/BlockNoteExtension.js";
-export declare class SchemaMigrationPlugin extends BlockNoteExtension {
-    private migrationDone;
-    static key(): string;
-    constructor(fragment: Y.XmlFragment);
-}

package/types/src/extensions/Comments/CommentsPlugin.d.ts

@@ -1,66 +0,0 @@
-import type { CommentBody, ThreadStore, User } from "../../comments/index.js";
-import { BlockNoteEditor } from "../../editor/BlockNoteEditor.js";
-import { BlockNoteExtension } from "../../editor/BlockNoteExtension.js";
-import { CustomBlockNoteSchema } from "../../schema/schema.js";
-import { UserStore } from "./userstore/UserStore.js";
-export declare class CommentsPlugin extends BlockNoteExtension {
-    private readonly editor;
-    readonly threadStore: ThreadStore;
-    private readonly markType;
-    readonly resolveUsers: undefined | ((userIds: string[]) => Promise<User[]>);
-    readonly commentEditorSchema?: CustomBlockNoteSchema<any, any, any> | undefined;
-    static key(): string;
-    readonly userStore: UserStore<User>;
-    /**
-     * Whether a comment is currently being composed
-     */
-    private pendingComment;
-    /**
-     * The currently selected thread id
-     */
-    private selectedThreadId;
-    /**
-     * Store the positions of all threads in the document.
-     * this can be used later to implement a floating sidebar
-     */
-    private threadPositions;
-    private emitStateUpdate;
-    /**
-     * when a thread is resolved or deleted, we need to update the marks to reflect the new state
-     */
-    private updateMarksFromThreads;
-    constructor(editor: BlockNoteEditor<any, any, any>, threadStore: ThreadStore, markType: string, resolveUsers: undefined | ((userIds: string[]) => Promise<User[]>), commentEditorSchema?: CustomBlockNoteSchema<any, any, any> | undefined);
-    /**
-     * Subscribe to state updates
-     */
-    onUpdate(callback: (state: {
-        pendingComment: boolean;
-        selectedThreadId: string | undefined;
-        threadPositions: Map<string, {
-            from: number;
-            to: number;
-        }>;
-    }) => void): () => void;
-    /**
-     * Set the selected thread
-     */
-    selectThread(threadId: string | undefined): void;
-    /**
-     * Start a pending comment (e.g.: when clicking the "Add comment" button)
-     */
-    startPendingComment(): void;
-    /**
-     * Stop a pending comment (e.g.: user closes the comment composer)
-     */
-    stopPendingComment(): void;
-    /**
-     * Create a thread at the current selection
-     */
-    createThread(options: {
-        initialComment: {
-            body: CommentBody;
-            metadata?: any;
-        };
-        metadata?: any;
-    }): Promise<void>;
-}

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

@@ -1,31 +0,0 @@
-import { EditorState, PluginKey, PluginView } from "prosemirror-state";
-import { EditorView } from "prosemirror-view";
-import type { BlockNoteEditor } from "../../editor/BlockNoteEditor.js";
-import { BlockNoteExtension } from "../../editor/BlockNoteExtension.js";
-import { UiElementPosition } from "../../extensions-shared/UiElementPosition.js";
-import type { BlockFromConfig, InlineContentSchema, StyleSchema } from "../../schema/index.js";
-export type FilePanelState<I extends InlineContentSchema, S extends StyleSchema> = UiElementPosition & {
-    block: BlockFromConfig<any, I, S>;
-};
-export declare class FilePanelView<I extends InlineContentSchema, S extends StyleSchema> implements PluginView {
-    private readonly editor;
-    private readonly pluginKey;
-    private readonly pmView;
-    state?: FilePanelState<I, S>;
-    emitUpdate: () => void;
-    constructor(editor: BlockNoteEditor<Record<string, any>, I, S>, pluginKey: PluginKey<FilePanelState<I, S>>, pmView: EditorView, emitUpdate: (state: FilePanelState<I, S>) => void);
-    mouseDownHandler: () => void;
-    dragstartHandler: () => void;
-    scrollHandler: () => void;
-    update(view: EditorView, prevState: EditorState): void;
-    closeMenu: () => void;
-    destroy(): void;
-}
-export declare class FilePanelProsemirrorPlugin<I extends InlineContentSchema, S extends StyleSchema> extends BlockNoteExtension {
-    static key(): string;
-    private view;
-    constructor(editor: BlockNoteEditor<Record<string, any>, I, S>);
-    get shown(): boolean;
-    onUpdate(callback: (state: FilePanelState<I, S>) => void): () => void;
-    closeMenu: () => void | undefined;
-}

package/types/src/extensions/FormattingToolbar/FormattingToolbarPlugin.d.ts

@@ -1,41 +0,0 @@
-import { EditorState, PluginKey, PluginView } from "prosemirror-state";
-import { EditorView } from "prosemirror-view";
-import type { BlockNoteEditor } from "../../editor/BlockNoteEditor.js";
-import { BlockNoteExtension } from "../../editor/BlockNoteExtension.js";
-import { UiElementPosition } from "../../extensions-shared/UiElementPosition.js";
-import { BlockSchema, InlineContentSchema, StyleSchema } from "../../schema/index.js";
-export type FormattingToolbarState = UiElementPosition;
-export declare class FormattingToolbarView implements PluginView {
-    private readonly editor;
-    private readonly pmView;
-    state?: FormattingToolbarState;
-    emitUpdate: () => void;
-    preventHide: boolean;
-    preventShow: boolean;
-    shouldShow: (props: {
-        view: EditorView;
-        state: EditorState;
-        from: number;
-        to: number;
-    }) => boolean;
-    constructor(editor: BlockNoteEditor<BlockSchema, InlineContentSchema, StyleSchema>, pmView: EditorView, emitUpdate: (state: FormattingToolbarState) => void);
-    blurHandler: (event: FocusEvent) => void;
-    isElementWithinEditorWrapper: (element: Node | null) => boolean;
-    viewMousedownHandler: (e: MouseEvent) => void;
-    mouseupHandler: () => void;
-    dragHandler: () => void;
-    scrollHandler: () => void;
-    update(view: EditorView, oldState?: EditorState): void;
-    destroy(): void;
-    closeMenu: () => void;
-    getSelectionBoundingBox(): DOMRect;
-}
-export declare const formattingToolbarPluginKey: PluginKey<any>;
-export declare class FormattingToolbarProsemirrorPlugin extends BlockNoteExtension {
-    static key(): string;
-    private view;
-    constructor(editor: BlockNoteEditor<any, any, any>);
-    get shown(): boolean;
-    onUpdate(callback: (state: FormattingToolbarState) => void): () => void;
-    closeMenu: () => void;
-}

package/types/src/extensions/LinkToolbar/LinkToolbarPlugin.d.ts

@@ -1,42 +0,0 @@
-import { PluginKey } from "prosemirror-state";
-import type { BlockNoteEditor } from "../../editor/BlockNoteEditor.js";
-import { BlockNoteExtension } from "../../editor/BlockNoteExtension.js";
-import { UiElementPosition } from "../../extensions-shared/UiElementPosition.js";
-import { BlockSchema, InlineContentSchema, StyleSchema } from "../../schema/index.js";
-export type LinkToolbarState = UiElementPosition & {
-    url: string;
-    text: string;
-};
-export declare const linkToolbarPluginKey: PluginKey<any>;
-export declare class LinkToolbarProsemirrorPlugin<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema> extends BlockNoteExtension {
-    static key(): string;
-    private view;
-    constructor(editor: BlockNoteEditor<BSchema, I, S>);
-    onUpdate(callback: (state: LinkToolbarState) => void): () => void;
-    /**
-     * Edit the currently hovered link.
-     */
-    editLink: (url: string, text: string) => void;
-    /**
-     * Delete the currently hovered link.
-     */
-    deleteLink: () => void;
-    /**
-     * When hovering on/off links using the mouse cursor, the link toolbar will
-     * open & close with a delay.
-     *
-     * This function starts the delay timer, and should be used for when the mouse
-     * cursor enters the link toolbar.
-     */
-    startHideTimer: () => void;
-    /**
-     * When hovering on/off links using the mouse cursor, the link toolbar will
-     * open & close with a delay.
-     *
-     * This function stops the delay timer, and should be used for when the mouse
-     * cursor exits the link toolbar.
-     */
-    stopHideTimer: () => void;
-    get shown(): boolean;
-    closeMenu: () => void;
-}

package/types/src/extensions/NodeSelectionKeyboard/NodeSelectionKeyboardPlugin.d.ts

@@ -1,5 +0,0 @@
-import { BlockNoteExtension } from "../../editor/BlockNoteExtension.js";
-export declare class NodeSelectionKeyboardPlugin extends BlockNoteExtension {
-    static key(): string;
-    constructor();
-}

package/types/src/extensions/Placeholder/PlaceholderPlugin.d.ts

@@ -1,6 +0,0 @@
-import type { BlockNoteEditor } from "../../editor/BlockNoteEditor.js";
-import { BlockNoteExtension } from "../../editor/BlockNoteExtension.js";
-export declare class PlaceholderPlugin extends BlockNoteExtension {
-    static key(): string;
-    constructor(editor: BlockNoteEditor<any, any, any>, placeholders: Record<string | "default" | "emptyDocument", string | undefined>);
-}

package/types/src/extensions/ShowSelection/ShowSelectionPlugin.d.ts

@@ -1,15 +0,0 @@
-import { BlockNoteEditor } from "../../editor/BlockNoteEditor.js";
-import { BlockNoteExtension } from "../../editor/BlockNoteExtension.js";
-/**
- * Plugin that shows adds a decoration around the current selection
- * This can be used to highlight the current selection in the UI even when the
- * text editor is not focused.
- */
-export declare class ShowSelectionPlugin extends BlockNoteExtension {
-    private readonly editor;
-    static key(): string;
-    private enabled;
-    constructor(editor: BlockNoteEditor<any, any, any>);
-    setEnabled(enabled: boolean): void;
-    getEnabled(): boolean;
-}

package/types/src/extensions/SuggestionMenu/SuggestionPlugin.d.ts

@@ -1,31 +0,0 @@
-import type { BlockNoteEditor } from "../../editor/BlockNoteEditor.js";
-import { BlockNoteExtension } from "../../editor/BlockNoteExtension.js";
-import { UiElementPosition } from "../../extensions-shared/UiElementPosition.js";
-import { BlockSchema, InlineContentSchema, StyleSchema } from "../../schema/index.js";
-export type SuggestionMenuState = UiElementPosition & {
-    query: string;
-    ignoreQueryLength?: boolean;
-};
-/**
- * A ProseMirror plugin for suggestions, designed to make '/'-commands possible as well as mentions.
- *
- * This is basically a simplified version of TipTap's [Suggestions](https://github.com/ueberdosis/tiptap/tree/db92a9b313c5993b723c85cd30256f1d4a0b65e1/packages/suggestion) plugin.
- *
- * This version is adapted from the aforementioned version in the following ways:
- * - This version supports generic items instead of only strings (to allow for more advanced filtering for example)
- * - This version hides some unnecessary complexity from the user of the plugin.
- * - This version handles key events differently
- */
-export declare class SuggestionMenuProseMirrorPlugin<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema> extends BlockNoteExtension {
-    static key(): string;
-    private view;
-    private triggerCharacters;
-    constructor(editor: BlockNoteEditor<BSchema, I, S>);
-    onUpdate(triggerCharacter: string, callback: (state: SuggestionMenuState) => void): () => void;
-    addTriggerCharacter: (triggerCharacter: string) => void;
-    removeTriggerCharacter: (triggerCharacter: string) => void;
-    closeMenu: () => void;
-    clearQuery: () => void;
-    get shown(): boolean;
-}
-export declare function createSuggestionMenu<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(editor: BlockNoteEditor<BSchema, I, S>, triggerCharacter: string): void;

package/types/src/extensions/TrailingNode/TrailingNodeExtension.d.ts

@@ -1,13 +0,0 @@
-import { Extension } from "@tiptap/core";
-/**
- * Extension based on:
- * - https://github.com/ueberdosis/tiptap/blob/v1/packages/tiptap-extensions/src/extensions/TrailingNode.js
- * - https://github.com/remirror/remirror/blob/e0f1bec4a1e8073ce8f5500d62193e52321155b9/packages/prosemirror-trailing-node/src/trailing-node-plugin.ts
- */
-export interface TrailingNodeOptions {
-    node: string;
-}
-/**
- * Add a trailing node to the document so the user can always click at the bottom of the document and start typing
- */
-export declare const TrailingNode: Extension<TrailingNodeOptions, any>;