@blocknote/core 0.24.2 → 0.25.0

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

@@ -0,0 +1,49 @@
+import { Plugin } from "prosemirror-state";
+import type { CommentBody, ThreadStore, User } from "../../comments/index.js";
+import { BlockNoteEditor } from "../../editor/BlockNoteEditor.js";
+import { EventEmitter } from "../../util/EventEmitter.js";
+import { UserStore } from "./userstore/UserStore.js";
+export declare class CommentsPlugin extends EventEmitter<any> {
+    private readonly editor;
+    readonly threadStore: ThreadStore;
+    private readonly markType;
+    readonly plugin: Plugin;
+    readonly userStore: UserStore<User>;
+    private pendingComment;
+    private selectedThreadId;
+    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);
+    /**
+     * Subscribe to state updates
+     */
+    onUpdate(callback: (state: {
+        pendingComment: boolean;
+        selectedThreadId: string | undefined;
+    }) => 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/Comments/userstore/UserStore.d.ts

@@ -0,0 +1,31 @@
+import type { User } from "../../../comments/index.js";
+import { EventEmitter } from "../../../util/EventEmitter.js";
+/**
+ * The `UserStore` is used to retrieve and cache information about users.
+ *
+ * It does this by calling `resolveUsers` (which is user-defined in the Editor Options)
+ * for users that are not yet cached.
+ */
+export declare class UserStore<U extends User> extends EventEmitter<any> {
+    private readonly resolveUsers;
+    private userCache;
+    private loadingUsers;
+    constructor(resolveUsers: (userIds: string[]) => Promise<U[]>);
+    /**
+     * Load information about users based on an array of user ids.
+     */
+    loadUsers(userIds: string[]): Promise<void>;
+    /**
+     * Retrieve information about a user based on their id, if cached.
+     *
+     * The user will have to be loaded via `loadUsers` first
+     */
+    getUser(userId: string): U | undefined;
+    /**
+     * Subscribe to changes in the user store.
+     *
+     * @param cb - The callback to call when the user store changes.
+     * @returns A function to unsubscribe from the user store.
+     */
+    subscribe(cb: (users: Map<string, U>) => void): () => void;
+}

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

@@ -0,0 +1,15 @@
+import { Plugin } from "prosemirror-state";
+import { BlockNoteEditor } from "../../editor/BlockNoteEditor.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 {
+    private readonly editor;
+    readonly plugin: Plugin;
+    private enabled;
+    constructor(editor: BlockNoteEditor<any, any, any>);
+    setEnabled(enabled: boolean): void;
+    getEnabled(): boolean;
+}

package/types/src/extensions/TableHandles/TableHandlesPlugin.d.ts

@@ -1,5 +1,6 @@
 import { Plugin, PluginKey, PluginView } from "prosemirror-state";
 import { EditorView } from "prosemirror-view";
+import { RelativeCellIndices } from "../../api/blockManipulation/tables/tables.js";
 import { DefaultBlockSchema } from "../../blocks/defaultBlocks.js";
 import type { BlockNoteEditor } from "../../editor/BlockNoteEditor.js";
 import { BlockFromConfigNoChildren, BlockSchemaWithBlock, InlineContentSchema, StyleSchema } from "../../schema/index.js";
@@ -36,7 +37,7 @@ export declare class TableHandlesView<I extends InlineContentSchema, S extends S
     mouseUpHandler: (event: MouseEvent) => void;
     mouseMoveHandler: (event: MouseEvent) => false | undefined;
     dragOverHandler: (event: DragEvent) => void;
-    dropHandler: (event: DragEvent) => void;
+    dropHandler: (event: DragEvent) => boolean;
     update(): void;
     destroy(): void;
 }
@@ -78,4 +79,68 @@ export declare class TableHandlesProsemirrorPlugin<I extends InlineContentSchema
      * same cell regardless of which cell is hovered by the mouse cursor.
      */
     unfreezeHandles: () => void;
+    getCellsAtRowHandle: (block: BlockFromConfigNoChildren<DefaultBlockSchema["table"], any, any>, relativeRowIndex: RelativeCellIndices["row"]) => (RelativeCellIndices & {
+        cell: import("../../schema/index.js").TableCell<any, any>;
+    })[];
+    /**
+     * Get all the cells in a column of the table block.
+     */
+    getCellsAtColumnHandle: (block: BlockFromConfigNoChildren<DefaultBlockSchema["table"], any, any>, relativeColumnIndex: RelativeCellIndices["col"]) => (RelativeCellIndices & {
+        cell: import("../../schema/index.js").TableCell<any, any>;
+    })[];
+    /**
+     * Sets the selection to the given cell or a range of cells.
+     * @returns The new state after the selection has been set.
+     */
+    private setCellSelection;
+    /**
+     * Adds a row or column to the table using prosemirror-table commands
+     */
+    addRowOrColumn: (index: RelativeCellIndices["row"] | RelativeCellIndices["col"], direction: {
+        orientation: "row";
+        side: "above" | "below";
+    } | {
+        orientation: "column";
+        side: "left" | "right";
+    }) => boolean;
+    /**
+     * Removes a row or column from the table using prosemirror-table commands
+     */
+    removeRowOrColumn: (index: RelativeCellIndices["row"] | RelativeCellIndices["col"], direction: "row" | "column") => boolean;
+    /**
+     * Merges the cells in the table block.
+     */
+    mergeCells: (cellsToMerge?: {
+        relativeStartCell: RelativeCellIndices;
+        relativeEndCell: RelativeCellIndices;
+    }) => boolean;
+    /**
+     * Splits the cell in the table block.
+     * If no cell is provided, the current cell selected will be split.
+     */
+    splitCell: (relativeCellToSplit?: RelativeCellIndices) => boolean;
+    /**
+     * Gets the start and end cells of the current cell selection.
+     * @returns The start and end cells of the current cell selection.
+     */
+    getCellSelection: () => undefined | {
+        from: RelativeCellIndices;
+        to: RelativeCellIndices;
+        /**
+         * All of the cells that are within the selected range.
+         */
+        cells: RelativeCellIndices[];
+    };
+    /**
+     * Gets the direction of the merge based on the current cell selection.
+     *
+     * Returns undefined when there is no cell selection, or the selection is not within a table.
+     */
+    getMergeDirection: (block: BlockFromConfigNoChildren<DefaultBlockSchema["table"], any, any> | undefined) => "vertical" | "horizontal" | undefined;
+    cropEmptyRowsOrColumns: (block: BlockFromConfigNoChildren<DefaultBlockSchema["table"], any, any>, removeEmpty: "columns" | "rows") => {
+        cells: (import("../../schema/index.js").StyledText<any> | import("../../schema/index.js").Link<any> | import("../../schema/index.js").CustomInlineContentFromConfig<any, any>)[][] | import("../../schema/index.js").TableCell<any, any>[];
+    }[];
+    addRowsOrColumns: (block: BlockFromConfigNoChildren<DefaultBlockSchema["table"], any, any>, addType: "columns" | "rows", numToAdd: number) => {
+        cells: (import("../../schema/index.js").StyledText<any> | import("../../schema/index.js").Link<any> | import("../../schema/index.js").CustomInlineContentFromConfig<any, any>)[][] | import("../../schema/index.js").TableCell<any, any>[];
+    }[];
 }

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

@@ -97,6 +97,9 @@ export declare const de: {
         bulletListItem: string;
         numberedListItem: string;
         checkListItem: string;
+        new_comment: string;
+        edit_comment: string;
+        comment_reply: string;
     };
     file_blocks: {
         image: {
@@ -283,6 +286,18 @@ export declare const de: {
             url_placeholder: string;
         };
     };
+    comments: {
+        actions: {
+            add_reaction: string;
+            resolve: string;
+            edit_comment: string;
+            delete_comment: string;
+            more_actions: string;
+        };
+        reactions: {
+            reacted_by: string;
+        };
+    };
     generic: {
         ctrl_shortcut: string;
     };

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

@@ -113,6 +113,8 @@ export declare const en: {
     drag_handle: {
         delete_menuitem: string;
         colors_menuitem: string;
+        header_row_menuitem: string;
+        header_column_menuitem: string;
     };
     table_handle: {
         delete_column_menuitem: string;
@@ -121,6 +123,9 @@ export declare const en: {
         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;
@@ -210,6 +215,9 @@ export declare const en: {
         align_justify: {
             tooltip: string;
         };
+        table_cell_merge: {
+            tooltip: string;
+        };
         comment: {
             tooltip: string;
         };
@@ -242,6 +250,18 @@ export declare const en: {
             url_placeholder: string;
         };
     };
+    comments: {
+        actions: {
+            add_reaction: string;
+            resolve: string;
+            edit_comment: string;
+            delete_comment: string;
+            more_actions: string;
+        };
+        reactions: {
+            reacted_by: string;
+        };
+    };
     generic: {
         ctrl_shortcut: string;
     };

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

@@ -97,6 +97,9 @@ export declare const es: {
         bulletListItem: string;
         numberedListItem: string;
         checkListItem: string;
+        new_comment: string;
+        edit_comment: string;
+        comment_reply: string;
     };
     file_blocks: {
         image: {
@@ -248,6 +251,18 @@ export declare const es: {
             url_placeholder: string;
         };
     };
+    comments: {
+        actions: {
+            add_reaction: string;
+            resolve: string;
+            edit_comment: string;
+            delete_comment: string;
+            more_actions: string;
+        };
+        reactions: {
+            reacted_by: string;
+        };
+    };
     generic: {
         ctrl_shortcut: string;
     };

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

@@ -84,6 +84,9 @@ export declare const hr: {
             aliases: string[];
             group: string;
         };
+        comment: {
+            tooltip: string;
+        };
     };
     placeholders: {
         default: string;
@@ -91,6 +94,9 @@ export declare const hr: {
         bulletListItem: string;
         numberedListItem: string;
         checkListItem: string;
+        new_comment: string;
+        edit_comment: string;
+        comment_reply: string;
     };
     file_blocks: {
         image: {
@@ -242,6 +248,18 @@ export declare const hr: {
             url_placeholder: string;
         };
     };
+    comments: {
+        actions: {
+            add_reaction: string;
+            resolve: string;
+            edit_comment: string;
+            delete_comment: string;
+            more_actions: string;
+        };
+        reactions: {
+            reacted_by: string;
+        };
+    };
     generic: {
         ctrl_shortcut: string;
     };

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

@@ -97,6 +97,9 @@ export declare const it: {
         bulletListItem: string;
         numberedListItem: string;
         checkListItem: string;
+        new_comment: string;
+        edit_comment: string;
+        comment_reply: string;
     };
     file_blocks: {
         image: {
@@ -248,6 +251,18 @@ export declare const it: {
             url_placeholder: string;
         };
     };
+    comments: {
+        actions: {
+            add_reaction: string;
+            resolve: string;
+            edit_comment: string;
+            delete_comment: string;
+            more_actions: string;
+        };
+        reactions: {
+            reacted_by: string;
+        };
+    };
     generic: {
         ctrl_shortcut: string;
     };

package/types/src/index.d.ts

@@ -1,4 +1,5 @@
 import * as locales from "./i18n/locales/index.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";
@@ -6,9 +7,6 @@ export * from "./api/nodeUtil.js";
 export * from "./api/testUtil/index.js";
 export * from "./blocks/AudioBlockContent/AudioBlockContent.js";
 export * from "./blocks/CodeBlockContent/CodeBlockContent.js";
-export * from "./blocks/PageBreakBlockContent/PageBreakBlockContent.js";
-export * from "./blocks/PageBreakBlockContent/getPageBreakSlashMenuItems.js";
-export * from "./blocks/PageBreakBlockContent/schema.js";
 export * from "./blocks/FileBlockContent/FileBlockContent.js";
 export * from "./blocks/FileBlockContent/helpers/parse/parseEmbedElement.js";
 export * from "./blocks/FileBlockContent/helpers/parse/parseFigureElement.js";
@@ -20,6 +18,9 @@ export * from "./blocks/FileBlockContent/helpers/toExternalHTML/createFigureWith
 export * from "./blocks/FileBlockContent/helpers/toExternalHTML/createLinkWithCaption.js";
 export * from "./blocks/FileBlockContent/uploadToTmpFilesDotOrg_DEV_ONLY.js";
 export * from "./blocks/ImageBlockContent/ImageBlockContent.js";
+export * from "./blocks/PageBreakBlockContent/PageBreakBlockContent.js";
+export * from "./blocks/PageBreakBlockContent/getPageBreakSlashMenuItems.js";
+export * from "./blocks/PageBreakBlockContent/schema.js";
 export { EMPTY_CELL_HEIGHT, EMPTY_CELL_WIDTH, } from "./blocks/TableBlockContent/TableExtension.js";
 export * from "./blocks/VideoBlockContent/VideoBlockContent.js";
 export * from "./blocks/defaultBlockHelpers.js";
@@ -49,11 +50,11 @@ export * from "./schema/index.js";
 export * from "./util/browser.js";
 export * from "./util/combineByGroup.js";
 export * from "./util/esmDependencies.js";
+export * from "./util/table.js";
 export * from "./util/string.js";
 export * from "./util/typescript.js";
 export { UnreachableCaseError, assertEmpty } from "./util/typescript.js";
 export { locales };
-export * from "./api/blockManipulation/commands/updateBlock/updateBlock.js";
 export * from "./api/nodeConversions/blockToNode.js";
 export * from "./api/nodeConversions/nodeToBlock.js";
 export * from "./api/testUtil/partialBlockTestUtil.js";

package/types/src/pm-nodes/BlockContainer.d.ts

@@ -5,10 +5,10 @@ import type { BlockNoteEditor } from "../editor/BlockNoteEditor.js";
  */
 export declare const BlockContainer: Node<{
     domAttributes?: Partial<{
-        blockGroup: Record<string, string>;
-        blockContent: Record<string, string>;
         editor: Record<string, string>;
         block: Record<string, string>;
+        blockGroup: Record<string, string>;
+        blockContent: Record<string, string>;
         inlineContent: Record<string, string>;
     }> | undefined;
     editor: BlockNoteEditor<any, any, any>;

package/types/src/pm-nodes/BlockGroup.d.ts

@@ -1,10 +1,10 @@
 import { Node } from "@tiptap/core";
 export declare const BlockGroup: Node<{
     domAttributes?: Partial<{
-        blockGroup: Record<string, string>;
-        blockContent: Record<string, string>;
         editor: Record<string, string>;
         block: Record<string, string>;
+        blockGroup: Record<string, string>;
+        blockContent: Record<string, string>;
         inlineContent: Record<string, string>;
     }> | undefined;
 }, any>;

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

@@ -73,11 +73,25 @@ export type BlockSchemaFromSpecs<T extends BlockSpecs> = {
 export type BlockSchemaWithBlock<BType extends string, C extends BlockConfig> = {
     [k in BType]: C;
 };
+export type TableCellProps = {
+    backgroundColor: string;
+    textColor: string;
+    textAlignment: "left" | "center" | "right" | "justify";
+    colspan?: number;
+    rowspan?: number;
+};
+export type TableCell<I extends InlineContentSchema, S extends StyleSchema = StyleSchema> = {
+    type: "tableCell";
+    props: TableCellProps;
+    content: InlineContent<I, S>[];
+};
 export type TableContent<I extends InlineContentSchema, S extends StyleSchema = StyleSchema> = {
     type: "tableContent";
     columnWidths: (number | undefined)[];
+    headerRows?: number;
+    headerCols?: number;
     rows: {
-        cells: InlineContent<I, S>[][];
+        cells: InlineContent<I, S>[][] | TableCell<I, S>[];
     }[];
 };
 export type BlockFromConfigNoChildren<B extends BlockConfig, I extends InlineContentSchema, S extends StyleSchema> = {
@@ -104,11 +118,18 @@ export type SpecificBlock<BSchema extends BlockSchema, BType extends keyof BSche
  *create/update blocks in the editor.
  *
  */
+export type PartialTableCell<I extends InlineContentSchema, S extends StyleSchema = StyleSchema> = {
+    type: "tableCell";
+    props?: Partial<TableCellProps>;
+    content?: PartialInlineContent<I, S>;
+};
 export type PartialTableContent<I extends InlineContentSchema, S extends StyleSchema = StyleSchema> = {
     type: "tableContent";
     columnWidths?: (number | undefined)[];
+    headerRows?: number;
+    headerCols?: number;
     rows: {
-        cells: PartialInlineContent<I, S>[];
+        cells: PartialInlineContent<I, S>[] | PartialTableCell<I, S>[];
     }[];
 };
 type PartialBlockFromConfigNoChildren<B extends BlockConfig, I extends InlineContentSchema, S extends StyleSchema> = {

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

@@ -1,4 +1,4 @@
 export declare const isAppleOS: () => boolean;
 export declare function formatKeyboardShortcut(shortcut: string, ctrlText?: string): string;
-export declare function mergeCSSClasses(...classes: (string | undefined)[]): string;
+export declare function mergeCSSClasses(...classes: (string | false | undefined)[]): string;
 export declare const isSafari: () => boolean;

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

@@ -0,0 +1,12 @@
+import type { InlineContentSchema, StyleSchema, PartialInlineContent } from "../schema";
+import { PartialTableCell, TableCell } from "../schema/blocks/types.js";
+/**
+ * This will map a table cell to a TableCell object.
+ * This is useful for when we want to get the full table cell object from a partial table cell.
+ * It is guaranteed to return a new TableCell object.
+ */
+export declare function mapTableCell<T extends InlineContentSchema, S extends StyleSchema>(content: PartialInlineContent<T, S> | PartialTableCell<T, S> | TableCell<T, S>): TableCell<T, S>;
+export declare function isPartialTableCell<T extends InlineContentSchema, S extends StyleSchema>(content: TableCell<T, S> | PartialInlineContent<T, S> | PartialTableCell<T, S> | undefined | null): content is PartialTableCell<T, S>;
+export declare function isTableCell<T extends InlineContentSchema, S extends StyleSchema>(content: TableCell<T, S> | PartialInlineContent<T, S> | PartialTableCell<T, S> | undefined | null): content is TableCell<T, S>;
+export declare function getColspan(cell: TableCell<any, any> | PartialTableCell<any, any> | PartialInlineContent<any, any>): number;
+export declare function getRowspan(cell: TableCell<any, any> | PartialTableCell<any, any> | PartialInlineContent<any, any>): number;