@blocknote/core 0.44.2 → 0.45.0

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

@@ -1,9 +1,9 @@
 import { EditorOptions, FocusPosition, Editor as TiptapEditor } from "@tiptap/core";
 import { type Command, type Plugin, type Transaction } from "@tiptap/pm/state";
 import { Node, Schema } from "prosemirror-model";
-import * as Y from "yjs";
 import type { BlocksChanged } from "../api/getBlocksChangedByTransaction.js";
 import { Block, BlockNoteSchema, DefaultBlockSchema, DefaultInlineContentSchema, DefaultStyleSchema, PartialBlock } from "../blocks/index.js";
+import type { CollaborationOptions } from "../extensions/Collaboration/Collaboration.js";
 import type { Dictionary } from "../i18n/dictionary.js";
 import type { BlockIdentifier, BlockNoteDOMAttributes, BlockSchema, BlockSpecs, CustomBlockNoteSchema, InlineContentSchema, InlineContentSpecs, PartialInlineContent, Styles, StyleSchema, StyleSpecs } from "../schema/index.js";
 import "../style.css";
@@ -30,37 +30,8 @@ export interface BlockNoteEditorOptions<BSchema extends BlockSchema, ISchema ext
     /**
      * When enabled, allows for collaboration between multiple users.
      * See [Real-time Collaboration](https://www.blocknotejs.org/docs/advanced/real-time-collaboration) for more info.
-     *
-     * @remarks `CollaborationOptions`
      */
-    collaboration?: {
-        /**
-         * 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)
-         */
-        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";
-    };
+    collaboration?: CollaborationOptions;
     /**
      * Use default BlockNote font and reset the styles of <p> <li> <h1> elements etc., that are used in BlockNote.
      *
@@ -481,9 +452,9 @@ export declare class BlockNoteEditor<BSchema extends BlockSchema = DefaultBlockS
      * @returns A function to remove the callback.
      */
     onBeforeChange(callback: (context: {
-        getChanges: () => BlocksChanged<any, any, any>;
+        getChanges: () => BlocksChanged<BSchema, ISchema, SSchema>;
         tr: Transaction;
-    }) => boolean | void): (() => void) | undefined;
+    }) => boolean | void): () => void;
     /**
      * Gets a snapshot of the current text cursor position.
      * @returns A snapshot of the current text cursor position.
@@ -510,7 +481,7 @@ export declare class BlockNoteEditor<BSchema extends BlockSchema = DefaultBlockS
      * If the selection starts / ends halfway through a block, the returned block will be
      * only the part of the block that is included in the selection.
      */
-    getSelectionCutBlocks(): {
+    getSelectionCutBlocks(expandToWords?: boolean): {
         blocks: Block<Record<string, import("../index.js").BlockConfig<string, import("../index.js").PropSchema, "inline" | "none" | "table">>, InlineContentSchema, StyleSchema>[];
         blockCutAtStart: string | undefined;
         blockCutAtEnd: string | undefined;

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

@@ -78,6 +78,10 @@ export interface Extension<State = any, Key extends string = string> {
      * Add additional tiptap extensions to the editor.
      */
     readonly tiptapExtensions?: ReadonlyArray<AnyExtension>;
+    /**
+     * Add additional BlockNote extensions to the editor.
+     */
+    readonly blockNoteExtensions?: ReadonlyArray<ExtensionFactoryInstance>;
 }
 /**
  * An input rule is what is used to replace text in a block when a regular expression match is found.

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

@@ -1,8 +1,8 @@
-import { BlockIdentifier, BlockSchema, InlineContentSchema, StyleSchema } from "../../schema/index.js";
 import { DefaultBlockSchema, DefaultInlineContentSchema, DefaultStyleSchema } from "../../blocks/defaultBlocks.js";
-import { Selection } from "../selectionTypes.js";
-import { TextCursorPosition } from "../cursorPositionTypes.js";
+import { BlockIdentifier, BlockSchema, InlineContentSchema, StyleSchema } from "../../schema/index.js";
 import { BlockNoteEditor } from "../BlockNoteEditor.js";
+import { TextCursorPosition } from "../cursorPositionTypes.js";
+import { Selection } from "../selectionTypes.js";
 export declare class SelectionManager<BSchema extends BlockSchema = DefaultBlockSchema, ISchema extends InlineContentSchema = DefaultInlineContentSchema, SSchema extends StyleSchema = DefaultStyleSchema> {
     private editor;
     constructor(editor: BlockNoteEditor<BSchema, ISchema, SSchema>);
@@ -20,7 +20,7 @@ export declare class SelectionManager<BSchema extends BlockSchema = DefaultBlock
      * If the selection starts / ends halfway through a block, the returned block will be
      * only the part of the block that is included in the selection.
      */
-    getSelectionCutBlocks(): {
+    getSelectionCutBlocks(expandToWords?: boolean): {
         blocks: import("../../index.js").Block<Record<string, import("../../index.js").BlockConfig<string, import("../../index.js").PropSchema, "inline" | "none" | "table">>, InlineContentSchema, StyleSchema>[];
         blockCutAtStart: string | undefined;
         blockCutAtEnd: string | undefined;

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

@@ -0,0 +1,76 @@
+import type * as Y from "yjs";
+import type { Awareness } from "y-protocols/awareness";
+export type 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)
+     */
+    provider?: {
+        awareness?: Awareness;
+    };
+    /**
+     * 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";
+};
+export declare const CollaborationExtension: (options: CollaborationOptions) => import("../../index.js").ExtensionFactoryInstance<{
+    readonly key: "collaboration";
+    readonly blockNoteExtensions: readonly [import("../../index.js").ExtensionFactoryInstance<{
+        readonly key: "yForkDoc";
+        readonly store: import("@tanstack/store").Store<{
+            isForked: boolean;
+        }, (cb: {
+            isForked: boolean;
+        }) => {
+            isForked: boolean;
+        }>;
+        readonly fork: () => void;
+        readonly merge: ({ keepChanges }: {
+            keepChanges: boolean;
+        }) => void;
+    }>, import("../../index.js").ExtensionFactoryInstance<{
+        readonly key: "yCursor";
+        readonly prosemirrorPlugins: any[];
+        readonly dependsOn: readonly ["ySync"];
+        readonly updateUser: (user: {
+            name: string;
+            color: string;
+            [key: string]: string;
+        }) => void;
+    }>, import("../../index.js").ExtensionFactoryInstance<{
+        readonly key: "ySync";
+        readonly prosemirrorPlugins: readonly [any];
+        readonly runsBefore: readonly ["default"];
+    }>, import("../../index.js").ExtensionFactoryInstance<{
+        readonly key: "yUndo";
+        readonly prosemirrorPlugins: readonly [import("prosemirror-state").Plugin<{
+            undoManager: Y.UndoManager;
+            prevSel: any;
+            hasUndoOps: boolean;
+            hasRedoOps: boolean;
+        }>];
+        readonly dependsOn: readonly ["yCursor", "ySync"];
+        readonly undoCommand: import("prosemirror-state").Command;
+        readonly redoCommand: import("prosemirror-state").Command;
+    }>, import("../../index.js").ExtensionFactoryInstance<{
+        readonly key: "schemaMigration";
+        readonly prosemirrorPlugins: readonly [import("prosemirror-state").Plugin<any>];
+    }>];
+}>;

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

@@ -1,14 +1,5 @@
-import * as Y from "yjs";
-export declare const ForkYDocExtension: (options: {
-    fragment: Y.XmlFragment;
-    user: {
-        name: string;
-        color: string;
-    };
-    provider: any;
-    renderCursor?: (user: any) => HTMLElement;
-    showCursorLabels?: "always" | "activity";
-}) => import("../../index.js").ExtensionFactoryInstance<{
+import { CollaborationOptions } from "./Collaboration.js";
+export declare const ForkYDocExtension: (options: CollaborationOptions) => import("../../index.js").ExtensionFactoryInstance<{
     readonly key: "yForkDoc";
     readonly store: import("@tanstack/store").Store<{
         isForked: boolean;

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

@@ -1,20 +1,12 @@
+import { CollaborationOptions } from "./Collaboration.js";
 export type CollaborationUser = {
     name: string;
     color: string;
     [key: string]: string;
 };
-export declare const YCursorExtension: (options: {
-    fragment: import("yjs").XmlFragment;
-    user: {
-        name: string;
-        color: string;
-    };
-    provider: any;
-    renderCursor?: (user: any) => HTMLElement;
-    showCursorLabels?: "always" | "activity";
-}) => import("../../index.js").ExtensionFactoryInstance<{
+export declare const YCursorExtension: (options: CollaborationOptions) => import("../../index.js").ExtensionFactoryInstance<{
     readonly key: "yCursor";
-    readonly prosemirrorPlugins: readonly [any];
+    readonly prosemirrorPlugins: any[];
     readonly dependsOn: readonly ["ySync"];
     readonly updateUser: (user: {
         name: string;

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

@@ -1,7 +1,5 @@
-import { XmlFragment } from "yjs";
-export declare const YSyncExtension: (options: {
-    fragment: XmlFragment;
-}) => import("../../index.js").ExtensionFactoryInstance<{
+import { CollaborationOptions } from "./Collaboration.js";
+export declare const YSyncExtension: (options: Pick<CollaborationOptions, "fragment">) => import("../../index.js").ExtensionFactoryInstance<{
     readonly key: "ySync";
     readonly prosemirrorPlugins: readonly [any];
     readonly runsBefore: readonly ["default"];

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

@@ -1,4 +1,4 @@
-export declare const YUndoExtension: (options?: any) => import("../../index.js").ExtensionFactoryInstance<{
+export declare const YUndoExtension: () => import("../../index.js").ExtensionFactoryInstance<{
     readonly key: "yUndo";
     readonly prosemirrorPlugins: readonly [import("prosemirror-state").Plugin<{
         undoManager: import("yjs").UndoManager;

package/types/src/index.d.ts

@@ -1,7 +1,7 @@
 export * from "./api/blockManipulation/commands/insertBlocks/insertBlocks.js";
 export * from "./api/blockManipulation/commands/replaceBlocks/replaceBlocks.js";
-export * from "./api/blockManipulation/commands/updateBlock/updateBlock.js";
 export * from "./api/blockManipulation/commands/replaceBlocks/util/fixColumnList.js";
+export * from "./api/blockManipulation/commands/updateBlock/updateBlock.js";
 export * from "./api/exporters/html/externalHTMLExporter.js";
 export * from "./api/exporters/html/internalHTMLSerializer.js";
 export * from "./api/getBlockInfoFromPos.js";
@@ -19,6 +19,7 @@ export * from "./i18n/dictionary.js";
 export * from "./schema/index.js";
 export * from "./util/browser.js";
 export * from "./util/combineByGroup.js";
+export * from "./util/expandToWords.js";
 export * from "./util/string.js";
 export * from "./util/table.js";
 export * from "./util/typescript.js";

package/types/src/util/expandToWords.d.ts

@@ -0,0 +1,13 @@
+import type { Node, ResolvedPos } from "prosemirror-model";
+/**
+ * Expands a range (start to end) to include the rest of the word if it starts or ends within a word
+ */
+export declare function expandPMRangeToWords(doc: Node, range: {
+    $from: ResolvedPos;
+    $to: ResolvedPos;
+}): {
+    $from: ResolvedPos;
+    $to: ResolvedPos;
+    from: number;
+    to: number;
+};