@blocknote/core 0.8.5 → 0.9.2

package/types/src/extensions/Blocks/api/blockTypes.d.ts

@@ -3,10 +3,22 @@ import { Node, NodeConfig } from "@tiptap/core";
 import { BlockNoteEditor } from "../../../BlockNoteEditor";
 import { InlineContent, PartialInlineContent } from "./inlineContentTypes";
 import { DefaultBlockSchema } from "./defaultBlocks";
-export type TipTapNodeConfig<Name extends string, Options = any, Storage = any> = {
+export type BlockNoteDOMElement = "editor" | "blockContainer" | "blockGroup" | "blockContent" | "inlineContent";
+export type BlockNoteDOMAttributes = Partial<{
+    [DOMElement in BlockNoteDOMElement]: Record<string, string>;
+}>;
+export type TipTapNodeConfig<Name extends string, Options extends {
+    domAttributes?: BlockNoteDOMAttributes;
+} = {
+    domAttributes?: BlockNoteDOMAttributes;
+}, Storage = any> = {
     [K in keyof NodeConfig<Options, Storage>]: K extends "name" ? Name : K extends "group" ? never : NodeConfig<Options, Storage>[K];
 };
-export type TipTapNode<Name extends string, Options = any, Storage = any> = Node<Options, Storage> & {
+export type TipTapNode<Name extends string, Options extends {
+    domAttributes?: BlockNoteDOMAttributes;
+} = {
+    domAttributes?: BlockNoteDOMAttributes;
+}, Storage = any> = Node<Options, Storage> & {
     name: Name;
     group: "blockContent";
 };
@@ -45,7 +57,7 @@ export type BlockConfig<Type extends string, PSchema extends PropSchema, Contain
 };
 export type BlockSpec<Type extends string, PSchema extends PropSchema> = {
     readonly propSchema: PSchema;
-    node: TipTapNode<Type>;
+    node: TipTapNode<Type, any>;
 };
 export type TypesMatch<Blocks extends Record<string, BlockSpec<string, PropSchema>>> = Blocks extends {
     [Type in keyof Blocks]: Type extends string ? Blocks[Type] extends BlockSpec<Type, PropSchema> ? Blocks[Type] : never : never;

package/types/src/extensions/Blocks/api/defaultBlocks.d.ts

@@ -26,7 +26,15 @@ export declare const defaultBlockSchema: {
                 values: readonly ["left", "center", "right", "justify"];
             };
         };
-        readonly node: import("./blockTypes").TipTapNode<"paragraph">;
+        readonly node: import("./blockTypes").TipTapNode<"paragraph", {
+            domAttributes?: Partial<{
+                blockContainer: Record<string, string>;
+                blockGroup: Record<string, string>;
+                editor: Record<string, string>;
+                blockContent: Record<string, string>;
+                inlineContent: Record<string, string>;
+            }> | undefined;
+        }, any>;
     };
     readonly heading: {
         readonly propSchema: {
@@ -45,7 +53,15 @@ export declare const defaultBlockSchema: {
                 values: readonly ["left", "center", "right", "justify"];
             };
         };
-        readonly node: import("./blockTypes").TipTapNode<"heading">;
+        readonly node: import("./blockTypes").TipTapNode<"heading", {
+            domAttributes?: Partial<{
+                blockContainer: Record<string, string>;
+                blockGroup: Record<string, string>;
+                editor: Record<string, string>;
+                blockContent: Record<string, string>;
+                inlineContent: Record<string, string>;
+            }> | undefined;
+        }, any>;
     };
     readonly bulletListItem: {
         readonly propSchema: {
@@ -60,7 +76,15 @@ export declare const defaultBlockSchema: {
                 values: readonly ["left", "center", "right", "justify"];
             };
         };
-        readonly node: import("./blockTypes").TipTapNode<"bulletListItem">;
+        readonly node: import("./blockTypes").TipTapNode<"bulletListItem", {
+            domAttributes?: Partial<{
+                blockContainer: Record<string, string>;
+                blockGroup: Record<string, string>;
+                editor: Record<string, string>;
+                blockContent: Record<string, string>;
+                inlineContent: Record<string, string>;
+            }> | undefined;
+        }, any>;
     };
     readonly numberedListItem: {
         readonly propSchema: {
@@ -75,7 +99,15 @@ export declare const defaultBlockSchema: {
                 values: readonly ["left", "center", "right", "justify"];
             };
         };
-        readonly node: import("./blockTypes").TipTapNode<"numberedListItem">;
+        readonly node: import("./blockTypes").TipTapNode<"numberedListItem", {
+            domAttributes?: Partial<{
+                blockContainer: Record<string, string>;
+                blockGroup: Record<string, string>;
+                editor: Record<string, string>;
+                blockContent: Record<string, string>;
+                inlineContent: Record<string, string>;
+            }> | undefined;
+        }, any>;
     };
 };
 export type DefaultBlockSchema = TypesMatch<typeof defaultBlockSchema>;

package/types/src/extensions/Blocks/helpers/getBlockInfoFromPos.d.ts

@@ -1,14 +1,22 @@
 import { Node, NodeType } from "prosemirror-model";
-export type BlockInfo = {
+export type BlockInfoWithoutPositions = {
     id: string;
     node: Node;
     contentNode: Node;
     contentType: NodeType;
     numChildBlocks: number;
+};
+export type BlockInfo = BlockInfoWithoutPositions & {
     startPos: number;
     endPos: number;
     depth: number;
 };
+/**
+ * Helper function for `getBlockInfoFromPos`, returns information regarding
+ * provided blockContainer node.
+ * @param blockContainer The blockContainer node to retrieve info for.
+ */
+export declare function getBlockInfo(blockContainer: Node): BlockInfoWithoutPositions;
 /**
  * Retrieves information regarding the nearest blockContainer node in a
  * ProseMirror doc, relative to a position.

package/types/src/extensions/Blocks/index.d.ts

@@ -1 +1,4 @@
-export declare const blocks: any[];
+import { Node } from "@tiptap/core";
+export { BlockContainer } from "./nodes/BlockContainer";
+export { BlockGroup } from "./nodes/BlockGroup";
+export declare const Doc: Node<any, any>;

package/types/src/extensions/Blocks/nodes/BlockContainer.d.ts

@@ -1,8 +1,5 @@
 import { Node } from "@tiptap/core";
 import { BlockSchema, PartialBlock } from "../api/blockTypes";
-export interface IBlock {
-    HTMLAttributes: Record<string, any>;
-}
 declare module "@tiptap/core" {
     interface Commands<ReturnType> {
         block: {
@@ -18,4 +15,12 @@ declare module "@tiptap/core" {
 /**
  * The main "Block node" documents consist of
  */
-export declare const BlockContainer: Node<IBlock, any>;
+export declare const BlockContainer: Node<{
+    domAttributes?: Partial<{
+        blockContainer: Record<string, string>;
+        blockGroup: Record<string, string>;
+        editor: Record<string, string>;
+        blockContent: Record<string, string>;
+        inlineContent: Record<string, string>;
+    }> | undefined;
+}, any>;

package/types/src/extensions/Blocks/nodes/BlockContent/HeadingBlockContent/HeadingBlockContent.d.ts

@@ -1 +1,9 @@
-export declare const HeadingBlockContent: import("../../../api/blockTypes").TipTapNode<"heading">;
+export declare const HeadingBlockContent: import("../../../api/blockTypes").TipTapNode<"heading", {
+    domAttributes?: Partial<{
+        blockContainer: Record<string, string>;
+        blockGroup: Record<string, string>;
+        editor: Record<string, string>;
+        blockContent: Record<string, string>;
+        inlineContent: Record<string, string>;
+    }> | undefined;
+}, any>;

package/types/src/extensions/Blocks/nodes/BlockContent/ListItemBlockContent/BulletListItemBlockContent/BulletListItemBlockContent.d.ts

@@ -1 +1,9 @@
-export declare const BulletListItemBlockContent: import("../../../../api/blockTypes").TipTapNode<"bulletListItem">;
+export declare const BulletListItemBlockContent: import("../../../../api/blockTypes").TipTapNode<"bulletListItem", {
+    domAttributes?: Partial<{
+        blockContainer: Record<string, string>;
+        blockGroup: Record<string, string>;
+        editor: Record<string, string>;
+        blockContent: Record<string, string>;
+        inlineContent: Record<string, string>;
+    }> | undefined;
+}, any>;

package/types/src/extensions/Blocks/nodes/BlockContent/ListItemBlockContent/NumberedListItemBlockContent/NumberedListItemBlockContent.d.ts

@@ -1 +1,9 @@
-export declare const NumberedListItemBlockContent: import("../../../../api/blockTypes").TipTapNode<"numberedListItem">;
+export declare const NumberedListItemBlockContent: import("../../../../api/blockTypes").TipTapNode<"numberedListItem", {
+    domAttributes?: Partial<{
+        blockContainer: Record<string, string>;
+        blockGroup: Record<string, string>;
+        editor: Record<string, string>;
+        blockContent: Record<string, string>;
+        inlineContent: Record<string, string>;
+    }> | undefined;
+}, any>;

package/types/src/extensions/Blocks/nodes/BlockContent/ParagraphBlockContent/ParagraphBlockContent.d.ts

@@ -1 +1,9 @@
-export declare const ParagraphBlockContent: import("../../../api/blockTypes").TipTapNode<"paragraph">;
+export declare const ParagraphBlockContent: import("../../../api/blockTypes").TipTapNode<"paragraph", {
+    domAttributes?: Partial<{
+        blockContainer: Record<string, string>;
+        blockGroup: Record<string, string>;
+        editor: Record<string, string>;
+        blockContent: Record<string, string>;
+        inlineContent: Record<string, string>;
+    }> | undefined;
+}, any>;

package/types/src/extensions/Blocks/nodes/BlockGroup.d.ts

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

package/types/src/extensions/Blocks/nodes/TableCell.d.ts

@@ -0,0 +1,5 @@
+import { Node } from "@tiptap/core";
+export interface TableCellOptions {
+    HTMLAttributes: Record<string, any>;
+}
+export declare const TableCell: Node<TableCellOptions, any>;

package/types/src/extensions/Blocks/nodes/TableRow.d.ts

@@ -0,0 +1,5 @@
+import { Node } from "@tiptap/core";
+export interface TableRowOptions {
+    HTMLAttributes: Record<string, any>;
+}
+export declare const TableRow: Node<TableRowOptions, any>;

package/types/src/extensions/SideMenu/MultipleNodeSelection.d.ts

@@ -1,5 +1,5 @@
-import { Selection } from "prosemirror-state";
 import { Node, ResolvedPos, Slice } from "prosemirror-model";
+import { Selection } from "prosemirror-state";
 import { Mappable } from "prosemirror-transform";
 /**
  * This class represents an editor selection which spans multiple nodes/blocks. It's currently only used to allow users

package/types/src/index.d.ts

@@ -15,3 +15,4 @@ export { getDefaultSlashMenuItems } from "./extensions/SlashMenu/defaultSlashMen
 export * from "./shared/BaseUiElementTypes";
 export type { SuggestionItem } from "./shared/plugins/suggestion/SuggestionItem";
 export * from "./shared/plugins/suggestion/SuggestionPlugin";
+export * from "./shared/utils";

package/types/src/shared/utils.d.ts

@@ -1,5 +1,6 @@
 export declare const isAppleOS: () => boolean;
 export declare function formatKeyboardShortcut(shortcut: string): string;
+export declare function mergeCSSClasses(...classes: string[]): string;
 export declare class UnreachableCaseError extends Error {
     constructor(val: never);
 }

package/src/node_modules/.vitest/results.json

@@ -1 +0,0 @@
-{"version":"0.28.5","results":[["/api/formatConversions/formatConversions.test.ts",{"duration":109,"failed":false}],["/api/nodeConversions/nodeConversions.test.ts",{"duration":32,"failed":false}],["/api/blockManipulation/blockManipulation.test.ts",{"duration":38,"failed":false}],["/BlockNoteEditor.test.ts",{"duration":4,"failed":false}]]}

package/types/src/EventEmitter.d.ts

@@ -1,11 +0,0 @@
-type StringKeyOf<T> = Extract<keyof T, string>;
-type CallbackType<T extends Record<string, any>, EventName extends StringKeyOf<T>> = T[EventName] extends any[] ? T[EventName] : [T[EventName]];
-type CallbackFunction<T extends Record<string, any>, EventName extends StringKeyOf<T>> = (...props: CallbackType<T, EventName>) => any;
-export declare class EventEmitter<T extends Record<string, any>> {
-    private callbacks;
-    on<EventName extends StringKeyOf<T>>(event: EventName, fn: CallbackFunction<T, EventName>): this;
-    protected emit<EventName extends StringKeyOf<T>>(event: EventName, ...args: CallbackType<T, EventName>): this;
-    off<EventName extends StringKeyOf<T>>(event: EventName, fn?: CallbackFunction<T, EventName>): this;
-    protected removeAllListeners(): void;
-}
-export {};

package/types/src/extensions/DraggableBlocks/DraggableBlocksExtension.d.ts

@@ -1,16 +0,0 @@
-import { Editor, Extension } from "@tiptap/core";
-import { BlockSideMenuFactory } from "./BlockSideMenuFactoryTypes";
-import { BlockNoteEditor } from "../../BlockNoteEditor";
-import { BlockSchema } from "../Blocks/api/blockTypes";
-export type DraggableBlocksOptions<BSchema extends BlockSchema> = {
-    tiptapEditor: Editor;
-    editor: BlockNoteEditor<BSchema>;
-    blockSideMenuFactory: BlockSideMenuFactory<BSchema>;
-};
-/**
- * This extension adds a menu to the side of blocks which features various BlockNote functions such as adding and
- * removing blocks. More importantly, it adds a drag handle which allows the user to drag and drop blocks.
- *
- * code based on https://github.com/ueberdosis/tiptap/issues/323#issuecomment-506637799
- */
-export declare const createDraggableBlocksExtension: <BSchema extends Record<string, import("../Blocks/api/blockTypes").BlockSpec<string, import("../Blocks/api/blockTypes").PropSchema>>>() => Extension<DraggableBlocksOptions<BSchema>, any>;

package/types/src/extensions/DraggableBlocks/DraggableBlocksPlugin.d.ts

@@ -1,55 +0,0 @@
-import { PluginView } from "@tiptap/pm/state";
-import { Plugin, PluginKey } from "prosemirror-state";
-import { BlockNoteEditor } from "../../BlockNoteEditor";
-import { BaseUiElementCallbacks, BaseUiElementState } from "../../shared/BaseUiElementTypes";
-import { Block, BlockSchema } from "../Blocks/api/blockTypes";
-import { Editor } from "@tiptap/core";
-export type SideMenuCallbacks = BaseUiElementCallbacks & {
-    addBlock: () => void;
-    freezeMenu: () => void;
-    unfreezeMenu: () => void;
-    blockDragStart: (event: DragEvent) => void;
-    blockDragEnd: () => void;
-};
-export type SideMenuState<BSchema extends BlockSchema> = BaseUiElementState & {
-    block: Block<BSchema>;
-};
-export declare class SideMenuView<BSchema extends BlockSchema> implements PluginView {
-    editor: BlockNoteEditor<BSchema>;
-    ttEditor: Editor;
-    private sideMenuState?;
-    updateSideMenu: () => void;
-    horizontalPosAnchoredAtRoot: boolean;
-    horizontalPosAnchor: number;
-    hoveredBlock: HTMLElement | undefined;
-    isDragging: boolean;
-    menuFrozen: boolean;
-    constructor(editor: BlockNoteEditor<BSchema>, tiptapEditor: Editor, updateSideMenu: (sideMenuState: SideMenuState<BSchema>) => void);
-    /**
-     * Sets isDragging when dragging text.
-     */
-    onDragStart: () => void;
-    /**
-     * If the event is outside the editor contents,
-     * we dispatch a fake event, so that we can still drop the content
-     * when dragging / dropping to the side of the editor
-     */
-    onDrop: (event: DragEvent) => void;
-    /**
-     * If the event is outside the editor contents,
-     * we dispatch a fake event, so that we can still drop the content
-     * when dragging / dropping to the side of the editor
-     */
-    onDragOver: (event: DragEvent) => void;
-    onKeyDown: (_event: KeyboardEvent) => void;
-    onMouseDown: (_event: MouseEvent) => void;
-    onMouseMove: (event: MouseEvent) => void;
-    onScroll: () => void;
-    destroy(): void;
-    addBlock(): void;
-}
-export declare const sideMenuPluginKey: PluginKey<any>;
-export declare function setupSideMenu<BSchema extends BlockSchema>(editor: BlockNoteEditor<BSchema>, tiptapEditor: Editor, updateSideMenu: (sideMenuState: SideMenuState<BSchema>) => void): {
-    plugin: Plugin;
-    callbacks: Omit<SideMenuCallbacks, "destroy">;
-};

package/types/src/extensions/DraggableBlocks/MultipleNodeSelection.d.ts

@@ -1,24 +0,0 @@
-import { Selection } from "prosemirror-state";
-import { Node, ResolvedPos, Slice } from "prosemirror-model";
-import { Mappable } from "prosemirror-transform";
-/**
- * This class represents an editor selection which spans multiple nodes/blocks. It's currently only used to allow users
- * to drag multiple blocks at the same time. Expects the selection anchor and head to be between nodes, i.e. just before
- * the first target node and just after the last, and that anchor and head are at the same nesting level.
- *
- * Partially based on ProseMirror's NodeSelection implementation:
- * (https://github.com/ProseMirror/prosemirror-state/blob/master/src/selection.ts)
- * MultipleNodeSelection differs from NodeSelection in the following ways:
- * 1. Stores which nodes are included in the selection instead of just a single node.
- * 2. Already expects the selection to start just before the first target node and ends just after the last, while a
- * NodeSelection automatically sets both anchor and head to just before the single target node.
- */
-export declare class MultipleNodeSelection extends Selection {
-    nodes: Array<Node>;
-    constructor($anchor: ResolvedPos, $head: ResolvedPos);
-    static create(doc: Node, from: number, to?: number): MultipleNodeSelection;
-    content(): Slice;
-    eq(selection: Selection): boolean;
-    map(doc: Node, mapping: Mappable): Selection;
-    toJSON(): any;
-}

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

@@ -1,11 +0,0 @@
-import { Extension } from "@tiptap/core";
-import { BlockNoteEditor, BlockSchema } from "../..";
-import { FormattingToolbarFactory } from "./FormattingToolbarFactoryTypes";
-export type FormattingToolbarOptions<BSchema extends BlockSchema> = {
-    formattingToolbarFactory: FormattingToolbarFactory<BSchema>;
-    editor: BlockNoteEditor<BSchema>;
-};
-/**
- * The menu that is displayed when selecting a piece of text.
- */
-export declare const createFormattingToolbarExtension: <BSchema extends Record<string, import("../..").BlockSpec<string, import("../..").PropSchema>>>() => Extension<FormattingToolbarOptions<BSchema>, any>;

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

@@ -1,10 +0,0 @@
-import { EditorElement, ElementFactory } from "../../shared/EditorElement";
-import { BlockNoteEditor } from "../../BlockNoteEditor";
-import { BlockSchema } from "../Blocks/api/blockTypes";
-export type FormattingToolbarStaticParams<BSchema extends BlockSchema> = {
-    editor: BlockNoteEditor<BSchema>;
-    getReferenceRect: () => DOMRect;
-};
-export type FormattingToolbarDynamicParams = {};
-export type FormattingToolbar = EditorElement<FormattingToolbarDynamicParams>;
-export type FormattingToolbarFactory<BSchema extends BlockSchema> = ElementFactory<FormattingToolbarStaticParams<BSchema>, FormattingToolbarDynamicParams>;

package/types/src/extensions/HyperlinkToolbar/HyperlinkMark.d.ts

@@ -1,8 +0,0 @@
-import { HyperlinkToolbarPluginProps } from "./HyperlinkToolbarPlugin";
-/**
- * This custom link includes a special menu for editing/deleting/opening the link.
- * The menu will be triggered by hovering over the link with the mouse,
- * or by moving the cursor inside the link text
- */
-declare const Hyperlink: import("@tiptap/core").Mark<HyperlinkToolbarPluginProps, any>;
-export default Hyperlink;

package/types/src/extensions/SlashMenu/SlashMenuExtension.d.ts

@@ -1,13 +0,0 @@
-import { Extension } from "@tiptap/core";
-import { PluginKey } from "prosemirror-state";
-import { SuggestionsMenuFactory } from "../../shared/plugins/suggestion/SuggestionsMenuFactoryTypes";
-import { BaseSlashMenuItem } from "./BaseSlashMenuItem";
-import { BlockNoteEditor } from "../../BlockNoteEditor";
-import { BlockSchema } from "../Blocks/api/blockTypes";
-export type SlashMenuOptions<BSchema extends BlockSchema> = {
-    editor: BlockNoteEditor<BSchema> | undefined;
-    commands: BaseSlashMenuItem<BSchema>[] | undefined;
-    slashMenuFactory: SuggestionsMenuFactory<any> | undefined;
-};
-export declare const SlashMenuPluginKey: PluginKey<any>;
-export declare const createSlashMenuExtension: <BSchema extends Record<string, import("../Blocks/api/blockTypes").BlockSpec<string, import("../Blocks/api/blockTypes").PropSchema>>>() => Extension<SlashMenuOptions<BSchema>, any>;

package/types/src/extensions/SlashMenu/index.d.ts

@@ -1,3 +0,0 @@
-import { getDefaultSlashMenuItems } from "./defaultSlashMenuItems";
-import { BaseSlashMenuItem } from "./BaseSlashMenuItem";
-export { getDefaultSlashMenuItems, BaseSlashMenuItem };

package/types/src/shared/plugins/suggestion/SuggestionsMenuFactoryTypes.d.ts

@@ -1,12 +0,0 @@
-import { EditorElement, ElementFactory } from "../../EditorElement";
-import { SuggestionItem } from "./SuggestionItem";
-export type SuggestionsMenuStaticParams<T extends SuggestionItem> = {
-    itemCallback: (item: T) => void;
-    getReferenceRect: () => DOMRect;
-};
-export type SuggestionsMenuDynamicParams<T extends SuggestionItem> = {
-    items: T[];
-    keyboardHoveredItemIndex: number;
-};
-export type SuggestionsMenu<T extends SuggestionItem> = EditorElement<SuggestionsMenuDynamicParams<T>>;
-export type SuggestionsMenuFactory<T extends SuggestionItem> = ElementFactory<SuggestionsMenuStaticParams<T>, SuggestionsMenuDynamicParams<T>>;