@blocknote/core 0.7.1-alpha.0 → 0.8.0

package/src/extensions/SlashMenu/SlashMenuExtension.ts

@@ -4,46 +4,50 @@ import { createSuggestionPlugin } from "../../shared/plugins/suggestion/Suggesti
 import { SuggestionsMenuFactory } from "../../shared/plugins/suggestion/SuggestionsMenuFactoryTypes";
 import { BaseSlashMenuItem } from "./BaseSlashMenuItem";
 import { BlockNoteEditor } from "../../BlockNoteEditor";
+import { BlockSchema } from "../Blocks/api/blockTypes";
 
-export type SlashMenuOptions = {
-  editor: BlockNoteEditor | undefined;
-  commands: BaseSlashMenuItem[] | undefined;
+export type SlashMenuOptions<BSchema extends BlockSchema> = {
+  editor: BlockNoteEditor<BSchema> | undefined;
+  commands: BaseSlashMenuItem<BSchema>[] | undefined;
   slashMenuFactory: SuggestionsMenuFactory<any> | undefined;
 };
 
 export const SlashMenuPluginKey = new PluginKey("suggestions-slash-commands");
 
-export const SlashMenuExtension = Extension.create<SlashMenuOptions>({
-  name: "slash-command",
+export const createSlashMenuExtension = <BSchema extends BlockSchema>() =>
+  Extension.create<SlashMenuOptions<BSchema>>({
+    name: "slash-command",
 
-  addOptions() {
-    return {
-      editor: undefined,
-      commands: undefined,
-      slashMenuFactory: undefined,
-    };
-  },
+    addOptions() {
+      return {
+        editor: undefined,
+        commands: undefined,
+        slashMenuFactory: undefined,
+      };
+    },
 
-  addProseMirrorPlugins() {
-    if (!this.options.slashMenuFactory || !this.options.commands) {
-      throw new Error("required args not defined for SlashMenuExtension");
-    }
+    addProseMirrorPlugins() {
+      if (!this.options.slashMenuFactory || !this.options.commands) {
+        throw new Error("required args not defined for SlashMenuExtension");
+      }
 
-    const commands = this.options.commands;
+      const commands = this.options.commands;
 
-    return [
-      createSuggestionPlugin<BaseSlashMenuItem>({
-        pluginKey: SlashMenuPluginKey,
-        editor: this.options.editor!,
-        defaultTriggerCharacter: "/",
-        suggestionsMenuFactory: this.options.slashMenuFactory!,
-        items: (query) => {
-          return commands.filter((cmd: BaseSlashMenuItem) => cmd.match(query));
-        },
-        onSelectItem: ({ item, editor }) => {
-          item.execute(editor);
-        },
-      }),
-    ];
-  },
-});
+      return [
+        createSuggestionPlugin<BaseSlashMenuItem<BSchema>, BSchema>({
+          pluginKey: SlashMenuPluginKey,
+          editor: this.options.editor!,
+          defaultTriggerCharacter: "/",
+          suggestionsMenuFactory: this.options.slashMenuFactory!,
+          items: (query) => {
+            return commands.filter((cmd: BaseSlashMenuItem<BSchema>) =>
+              cmd.match(query)
+            );
+          },
+          onSelectItem: ({ item, editor }) => {
+            item.execute(editor);
+          },
+        }),
+      ];
+    },
+  });

package/src/extensions/SlashMenu/defaultSlashMenuItems.tsx

@@ -1,8 +1,12 @@
-import { BaseSlashMenuItem } from "./BaseSlashMenuItem";
-import { PartialBlock } from "../Blocks/api/blockTypes";
 import { BlockNoteEditor } from "../../BlockNoteEditor";
+import { PartialBlock } from "../Blocks/api/blockTypes";
+import { DefaultBlockSchema } from "../Blocks/api/defaultBlocks";
+import { BaseSlashMenuItem } from "./BaseSlashMenuItem";
 
-function insertOrUpdateBlock(editor: BlockNoteEditor, block: PartialBlock) {
+function insertOrUpdateBlock<BSchema extends DefaultBlockSchema>(
+  editor: BlockNoteEditor<BSchema>,
+  block: PartialBlock<BSchema>
+) {
   const currentBlock = editor.getTextCursorPosition().block;
 
   if (
@@ -21,9 +25,9 @@ function insertOrUpdateBlock(editor: BlockNoteEditor, block: PartialBlock) {
 /**
  * An array containing commands for creating all default blocks.
  */
-export const defaultSlashMenuItems: BaseSlashMenuItem[] = [
+export const defaultSlashMenuItems = [
   // Command for creating a level 1 heading
-  new BaseSlashMenuItem(
+  new BaseSlashMenuItem<DefaultBlockSchema>(
     "Heading",
     (editor) =>
       insertOrUpdateBlock(editor, {
@@ -34,7 +38,7 @@ export const defaultSlashMenuItems: BaseSlashMenuItem[] = [
   ),
 
   // Command for creating a level 2 heading
-  new BaseSlashMenuItem(
+  new BaseSlashMenuItem<DefaultBlockSchema>(
     "Heading 2",
     (editor) =>
       insertOrUpdateBlock(editor, {
@@ -45,7 +49,7 @@ export const defaultSlashMenuItems: BaseSlashMenuItem[] = [
   ),
 
   // Command for creating a level 3 heading
-  new BaseSlashMenuItem(
+  new BaseSlashMenuItem<DefaultBlockSchema>(
     "Heading 3",
     (editor) =>
       insertOrUpdateBlock(editor, {
@@ -56,7 +60,7 @@ export const defaultSlashMenuItems: BaseSlashMenuItem[] = [
   ),
 
   // Command for creating an ordered list
-  new BaseSlashMenuItem(
+  new BaseSlashMenuItem<DefaultBlockSchema>(
     "Numbered List",
     (editor) =>
       insertOrUpdateBlock(editor, {
@@ -66,7 +70,7 @@ export const defaultSlashMenuItems: BaseSlashMenuItem[] = [
   ),
 
   // Command for creating a bullet list
-  new BaseSlashMenuItem(
+  new BaseSlashMenuItem<DefaultBlockSchema>(
     "Bullet List",
     (editor) =>
       insertOrUpdateBlock(editor, {
@@ -76,7 +80,7 @@ export const defaultSlashMenuItems: BaseSlashMenuItem[] = [
   ),
 
   // Command for creating a paragraph (pretty useless)
-  new BaseSlashMenuItem(
+  new BaseSlashMenuItem<DefaultBlockSchema>(
     "Paragraph",
     (editor) =>
       insertOrUpdateBlock(editor, {

package/src/extensions/SlashMenu/index.ts

@@ -1,5 +1,5 @@
 import { defaultSlashMenuItems } from "./defaultSlashMenuItems";
-import { SlashMenuExtension } from "./SlashMenuExtension";
+import { createSlashMenuExtension } from "./SlashMenuExtension";
 import { BaseSlashMenuItem } from "./BaseSlashMenuItem";
 
-export { defaultSlashMenuItems, BaseSlashMenuItem, SlashMenuExtension };
+export { defaultSlashMenuItems, BaseSlashMenuItem, createSlashMenuExtension };

package/src/index.ts

@@ -1,6 +1,8 @@
 export * from "./BlockNoteEditor";
 export * from "./BlockNoteExtensions";
+export * from "./extensions/Blocks/api/block";
 export * from "./extensions/Blocks/api/blockTypes";
+export * from "./extensions/Blocks/api/defaultBlocks";
 export * from "./extensions/DraggableBlocks/BlockSideMenuFactoryTypes";
 export * from "./extensions/FormattingToolbar/FormattingToolbarFactoryTypes";
 export * from "./extensions/HyperlinkToolbar/HyperlinkToolbarFactoryTypes";
@@ -10,3 +12,5 @@ export * from "./shared/EditorElement";
 export type { SuggestionItem } from "./shared/plugins/suggestion/SuggestionItem";
 export * from "./shared/plugins/suggestion/SuggestionsMenuFactoryTypes";
 export * from "./extensions/Blocks/api/inlineContentTypes";
+export * from "./extensions/Blocks/api/serialization";
+export * as blockStyles from "./extensions/Blocks/nodes/Block.module.css";

package/src/shared/plugins/suggestion/SuggestionPlugin.ts

@@ -10,8 +10,12 @@ import {
 } from "./SuggestionsMenuFactoryTypes";
 import { SuggestionItem } from "./SuggestionItem";
 import { BlockNoteEditor } from "../../../BlockNoteEditor";
+import { BlockSchema } from "../../../extensions/Blocks/api/blockTypes";
 
-export type SuggestionPluginOptions<T extends SuggestionItem> = {
+export type SuggestionPluginOptions<
+  T extends SuggestionItem,
+  BSchema extends BlockSchema
+> = {
   /**
    * The name of the plugin.
    *
@@ -22,7 +26,7 @@ export type SuggestionPluginOptions<T extends SuggestionItem> = {
   /**
    * The BlockNote editor.
    */
-  editor: BlockNoteEditor;
+  editor: BlockNoteEditor<BSchema>;
 
   /**
    * The character that should trigger the suggestion menu to pop up (e.g. a '/' for commands), when typed by the user.
@@ -38,7 +42,7 @@ export type SuggestionPluginOptions<T extends SuggestionItem> = {
    * this should be done manually. The `editor` and `range` properties passed
    * to the callback function might come in handy when doing this.
    */
-  onSelectItem?: (props: { item: T; editor: BlockNoteEditor }) => void;
+  onSelectItem?: (props: { item: T; editor: BlockNoteEditor<BSchema> }) => void;
 
   /**
    * A function that should supply the plugin with items to suggest, based on a certain query string.
@@ -81,15 +85,21 @@ function getDefaultPluginState<
   };
 }
 
-type SuggestionPluginViewOptions<T extends SuggestionItem> = {
-  editor: BlockNoteEditor;
+type SuggestionPluginViewOptions<
+  T extends SuggestionItem,
+  BSchema extends BlockSchema
+> = {
+  editor: BlockNoteEditor<BSchema>;
   pluginKey: PluginKey;
-  onSelectItem: (props: { item: T; editor: BlockNoteEditor }) => void;
+  onSelectItem: (props: { item: T; editor: BlockNoteEditor<BSchema> }) => void;
   suggestionsMenuFactory: SuggestionsMenuFactory<T>;
 };
 
-class SuggestionPluginView<T extends SuggestionItem> {
-  editor: BlockNoteEditor;
+class SuggestionPluginView<
+  T extends SuggestionItem,
+  BSchema extends BlockSchema
+> {
+  editor: BlockNoteEditor<BSchema>;
   pluginKey: PluginKey;
 
   suggestionsMenu: SuggestionsMenu<T>;
@@ -102,7 +112,7 @@ class SuggestionPluginView<T extends SuggestionItem> {
     pluginKey,
     onSelectItem: selectItemCallback = () => {},
     suggestionsMenuFactory,
-  }: SuggestionPluginViewOptions<T>) {
+  }: SuggestionPluginViewOptions<T, BSchema>) {
     this.editor = editor;
     this.pluginKey = pluginKey;
 
@@ -214,14 +224,17 @@ class SuggestionPluginView<T extends SuggestionItem> {
  * @param options options for configuring the plugin
  * @returns the prosemirror plugin
  */
-export function createSuggestionPlugin<T extends SuggestionItem>({
+export function createSuggestionPlugin<
+  T extends SuggestionItem,
+  BSchema extends BlockSchema
+>({
   pluginKey,
   editor,
   defaultTriggerCharacter,
   suggestionsMenuFactory,
   onSelectItem: selectItemCallback = () => {},
   items = () => [],
-}: SuggestionPluginOptions<T>) {
+}: SuggestionPluginOptions<T, BSchema>) {
   // Assertions
   if (defaultTriggerCharacter.length !== 1) {
     throw new Error("'char' should be a single character");
@@ -236,10 +249,13 @@ export function createSuggestionPlugin<T extends SuggestionItem>({
     key: pluginKey,
 
     view: (view: EditorView) =>
-      new SuggestionPluginView({
+      new SuggestionPluginView<T, BSchema>({
         editor: editor,
         pluginKey: pluginKey,
-        onSelectItem: (props: { item: T; editor: BlockNoteEditor }) => {
+        onSelectItem: (props: {
+          item: T;
+          editor: BlockNoteEditor<BSchema>;
+        }) => {
           deactivate(view);
           selectItemCallback(props);
         },

package/types/src/BlockNoteEditor.d.ts

@@ -1,24 +1,28 @@
+import { Node } from "prosemirror-model";
 import { Editor as TiptapEditor } from "@tiptap/core/dist/packages/core/src/Editor";
 import * as Y from "yjs";
 import { UiFactories } from "./BlockNoteExtensions";
-import { Block, BlockIdentifier, PartialBlock } from "./extensions/Blocks/api/blockTypes";
+import { Block, BlockIdentifier, BlockSchema, PartialBlock } from "./extensions/Blocks/api/blockTypes";
 import { TextCursorPosition } from "./extensions/Blocks/api/cursorPositionTypes";
+import { DefaultBlockSchema } from "./extensions/Blocks/api/defaultBlocks";
 import { Styles } from "./extensions/Blocks/api/inlineContentTypes";
 import { Selection } from "./extensions/Blocks/api/selectionTypes";
 import { BaseSlashMenuItem } from "./extensions/SlashMenu";
-export type BlockNoteEditorOptions = {
+export type BlockNoteEditorOptions<BSchema extends BlockSchema> = {
     enableBlockNoteExtensions: boolean;
     /**
      * UI element factories for creating a custom UI, including custom positioning
      * & rendering.
      */
-    uiFactories: UiFactories;
+    uiFactories: UiFactories<BSchema>;
     /**
      * TODO: why is this called slashCommands and not slashMenuItems?
      *
+     * (couldn't fix any type, see https://github.com/TypeCellOS/BlockNote/pull/191#discussion_r1210708771)
+     *
      * @default defaultSlashMenuItems from `./extensions/SlashMenu`
      */
-    slashCommands: BaseSlashMenuItem[];
+    slashCommands: BaseSlashMenuItem<any>[];
     /**
      * The HTML element that should be used as the parent element for the editor.
      *
@@ -34,15 +38,15 @@ export type BlockNoteEditorOptions = {
     /**
      *  A callback function that runs when the editor is ready to be used.
      */
-    onEditorReady: (editor: BlockNoteEditor) => void;
+    onEditorReady: (editor: BlockNoteEditor<BSchema>) => void;
     /**
      * A callback function that runs whenever the editor's contents change.
      */
-    onEditorContentChange: (editor: BlockNoteEditor) => void;
+    onEditorContentChange: (editor: BlockNoteEditor<BSchema>) => void;
     /**
      * A callback function that runs whenever the text cursor position changes.
      */
-    onTextCursorPositionChange: (editor: BlockNoteEditor) => void;
+    onTextCursorPositionChange: (editor: BlockNoteEditor<BSchema>) => void;
     /**
      * Locks the editor from being editable by the user if set to `false`.
      */
@@ -50,7 +54,7 @@ export type BlockNoteEditorOptions = {
     /**
      * The content that should be in the editor when it's created, represented as an array of partial block objects.
      */
-    initialContent: PartialBlock[];
+    initialContent: PartialBlock<BSchema>[];
     /**
      * Use default BlockNote font and reset the styles of <p> <li> <h1> elements etc., that are used in BlockNote.
      *
@@ -63,6 +67,10 @@ export type BlockNoteEditorOptions = {
      * @default "light"
      */
     theme: "light" | "dark";
+    /**
+     * A list of block types that should be available in the editor.
+     */
+    blockSchema: BSchema;
     /**
      * When enabled, allows for collaboration between multiple users.
      */
@@ -89,37 +97,43 @@ export type BlockNoteEditorOptions = {
     };
     _tiptapOptions: any;
 };
-export declare class BlockNoteEditor {
+export declare class BlockNoteEditor<BSchema extends BlockSchema = DefaultBlockSchema> {
     private readonly options;
     readonly _tiptapEditor: TiptapEditor & {
         contentComponent: any;
     };
-    private blockCache;
+    blockCache: WeakMap<Node, Block<BSchema>>;
+    readonly schema: BSchema;
     get domElement(): HTMLDivElement;
     focus(): void;
-    constructor(options?: Partial<BlockNoteEditorOptions>);
+    constructor(options?: Partial<BlockNoteEditorOptions<BSchema>>);
     /**
      * Gets a snapshot of all top-level (non-nested) blocks in the editor.
      * @returns A snapshot of all top-level (non-nested) blocks in the editor.
      */
-    get topLevelBlocks(): Block[];
+    get topLevelBlocks(): Block<BSchema>[];
     /**
      * Gets a snapshot of an existing block from the editor.
      * @param blockIdentifier The identifier of an existing block that should be retrieved.
      * @returns The block that matches the identifier, or `undefined` if no matching block was found.
      */
-    getBlock(blockIdentifier: BlockIdentifier): Block | undefined;
+    getBlock(blockIdentifier: BlockIdentifier): Block<BSchema> | undefined;
     /**
      * Traverses all blocks in the editor depth-first, and executes a callback for each.
      * @param callback The callback to execute for each block. Returning `false` stops the traversal.
      * @param reverse Whether the blocks should be traversed in reverse order.
      */
-    forEachBlock(callback: (block: Block) => boolean, reverse?: boolean): void;
+    forEachBlock(callback: (block: Block<BSchema>) => boolean, reverse?: boolean): void;
+    /**
+     * Executes a callback whenever the editor's contents change.
+     * @param callback The callback to execute.
+     */
+    onEditorContentChange(callback: () => void): void;
     /**
      * Gets a snapshot of the current text cursor position.
      * @returns A snapshot of the current text cursor position.
      */
-    getTextCursorPosition(): TextCursorPosition;
+    getTextCursorPosition(): TextCursorPosition<BSchema>;
     /**
      * Sets the text cursor position to the start or end of an existing block. Throws an error if the target block could
      * not be found.
@@ -130,7 +144,7 @@ export declare class BlockNoteEditor {
     /**
      * Gets a snapshot of the current selection.
      */
-    getSelection(): Selection | undefined;
+    getSelection(): Selection<BSchema> | undefined;
     /**
      * Checks if the editor is currently editable, or if it's locked.
      * @returns True if the editor is editable, false otherwise.
@@ -149,7 +163,7 @@ export declare class BlockNoteEditor {
      * @param placement Whether the blocks should be inserted just before, just after, or nested inside the
      * `referenceBlock`. Inserts the blocks at the start of the existing block's children if "nested" is used.
      */
-    insertBlocks(blocksToInsert: PartialBlock[], referenceBlock: BlockIdentifier, placement?: "before" | "after" | "nested"): void;
+    insertBlocks(blocksToInsert: PartialBlock<BSchema>[], referenceBlock: BlockIdentifier, placement?: "before" | "after" | "nested"): void;
     /**
      * Updates an existing block in the editor. Since updatedBlock is a PartialBlock object, some fields might not be
      * defined. These undefined fields are kept as-is from the existing block. Throws an error if the block to update could
@@ -157,7 +171,7 @@ export declare class BlockNoteEditor {
      * @param blockToUpdate The block that should be updated.
      * @param update A partial block which defines how the existing block should be changed.
      */
-    updateBlock(blockToUpdate: BlockIdentifier, update: PartialBlock): void;
+    updateBlock(blockToUpdate: BlockIdentifier, update: PartialBlock<BSchema>): void;
     /**
      * Removes existing blocks from the editor. Throws an error if any of the blocks could not be found.
      * @param blocksToRemove An array of identifiers for existing blocks that should be removed.
@@ -170,7 +184,7 @@ export declare class BlockNoteEditor {
      * @param blocksToRemove An array of blocks that should be replaced.
      * @param blocksToInsert An array of partial blocks to replace the old ones with.
      */
-    replaceBlocks(blocksToRemove: BlockIdentifier[], blocksToInsert: PartialBlock[]): void;
+    replaceBlocks(blocksToRemove: BlockIdentifier[], blocksToInsert: PartialBlock<BSchema>[]): void;
     /**
      * Gets the active text styles at the text cursor position or at the end of the current selection if it's active.
      */
@@ -226,7 +240,7 @@ export declare class BlockNoteEditor {
      * @param blocks An array of blocks that should be serialized into HTML.
      * @returns The blocks, serialized as an HTML string.
      */
-    blocksToHTML(blocks: Block[]): Promise<string>;
+    blocksToHTML(blocks: Block<BSchema>[]): Promise<string>;
     /**
      * Parses blocks from an HTML string. Tries to create `Block` objects out of any HTML block-level elements, and
      * `InlineNode` objects from any HTML inline elements, though not all element types are recognized. If BlockNote
@@ -234,14 +248,14 @@ export declare class BlockNoteEditor {
      * @param html The HTML string to parse blocks from.
      * @returns The blocks parsed from the HTML string.
      */
-    HTMLToBlocks(html: string): Promise<Block[]>;
+    HTMLToBlocks(html: string): Promise<Block<BSchema>[]>;
     /**
      * Serializes blocks into a Markdown string. The output is simplified as Markdown does not support all features of
      * BlockNote - children of blocks which aren't list items are un-nested and certain styles are removed.
      * @param blocks An array of blocks that should be serialized into Markdown.
      * @returns The blocks, serialized as a Markdown string.
      */
-    blocksToMarkdown(blocks: Block[]): Promise<string>;
+    blocksToMarkdown(blocks: Block<BSchema>[]): Promise<string>;
     /**
      * Creates a list of blocks from a Markdown string. Tries to create `Block` and `InlineNode` objects based on
      * Markdown syntax, though not all symbols are recognized. If BlockNote doesn't recognize a symbol, it will parse it
@@ -249,7 +263,7 @@ export declare class BlockNoteEditor {
      * @param markdown The Markdown string to parse blocks from.
      * @returns The blocks parsed from the Markdown string.
      */
-    markdownToBlocks(markdown: string): Promise<Block[]>;
+    markdownToBlocks(markdown: string): Promise<Block<BSchema>[]>;
     /**
      * Updates the user info for the current user that's shown to other collaborators.
      */

package/types/src/BlockNoteExtensions.d.ts

@@ -1,24 +1,31 @@
 import { Extensions } from "@tiptap/core";
 import { BlockNoteEditor } from "./BlockNoteEditor";
 import * as Y from "yjs";
+import { BlockSchema } from "./extensions/Blocks/api/blockTypes";
 import { BlockSideMenuFactory } from "./extensions/DraggableBlocks/BlockSideMenuFactoryTypes";
 import { FormattingToolbarFactory } from "./extensions/FormattingToolbar/FormattingToolbarFactoryTypes";
 import { HyperlinkToolbarFactory } from "./extensions/HyperlinkToolbar/HyperlinkToolbarFactoryTypes";
 import { BaseSlashMenuItem } from "./extensions/SlashMenu";
 import { SuggestionsMenuFactory } from "./shared/plugins/suggestion/SuggestionsMenuFactoryTypes";
-export type UiFactories = Partial<{
-    formattingToolbarFactory: FormattingToolbarFactory;
+export type UiFactories<BSchema extends BlockSchema> = Partial<{
+    formattingToolbarFactory: FormattingToolbarFactory<BSchema>;
     hyperlinkToolbarFactory: HyperlinkToolbarFactory;
-    slashMenuFactory: SuggestionsMenuFactory<BaseSlashMenuItem>;
-    blockSideMenuFactory: BlockSideMenuFactory;
+    slashMenuFactory: SuggestionsMenuFactory<BaseSlashMenuItem<BSchema>>;
+    blockSideMenuFactory: BlockSideMenuFactory<BSchema>;
 }>;
 /**
  * Get all the Tiptap extensions BlockNote is configured with by default
  */
-export declare const getBlockNoteExtensions: (opts: {
-    editor: BlockNoteEditor;
-    uiFactories: UiFactories;
-    slashCommands: BaseSlashMenuItem[];
+export declare const getBlockNoteExtensions: <BSchema extends Record<string, import("./extensions/Blocks/api/blockTypes").BlockSpec<string, import("./extensions/Blocks/api/blockTypes").PropSchema>>>(opts: {
+    editor: BlockNoteEditor<BSchema>;
+    uiFactories: Partial<{
+        formattingToolbarFactory: FormattingToolbarFactory<BSchema>;
+        hyperlinkToolbarFactory: HyperlinkToolbarFactory;
+        slashMenuFactory: SuggestionsMenuFactory<BaseSlashMenuItem<BSchema>>;
+        blockSideMenuFactory: BlockSideMenuFactory<BSchema>;
+    }>;
+    slashCommands: BaseSlashMenuItem<any>[];
+    blockSchema: BSchema;
     collaboration?: {
         fragment: Y.XmlFragment;
         user: {

package/types/src/api/blockManipulation/blockManipulation.d.ts

@@ -1,6 +1,6 @@
 import { Editor } from "@tiptap/core";
-import { BlockIdentifier, PartialBlock } from "../../extensions/Blocks/api/blockTypes";
-export declare function insertBlocks(blocksToInsert: PartialBlock[], referenceBlock: BlockIdentifier, placement: "before" | "after" | "nested" | undefined, editor: Editor): void;
-export declare function updateBlock(blockToUpdate: BlockIdentifier, update: PartialBlock, editor: Editor): void;
+import { BlockIdentifier, BlockSchema, PartialBlock } from "../../extensions/Blocks/api/blockTypes";
+export declare function insertBlocks<BSchema extends BlockSchema>(blocksToInsert: PartialBlock<BSchema>[], referenceBlock: BlockIdentifier, placement: "before" | "after" | "nested" | undefined, editor: Editor): void;
+export declare function updateBlock<BSchema extends BlockSchema>(blockToUpdate: BlockIdentifier, update: PartialBlock<BSchema>, editor: Editor): void;
 export declare function removeBlocks(blocksToRemove: BlockIdentifier[], editor: Editor): void;
-export declare function replaceBlocks(blocksToRemove: BlockIdentifier[], blocksToInsert: PartialBlock[], editor: Editor): void;
+export declare function replaceBlocks<BSchema extends BlockSchema>(blocksToRemove: BlockIdentifier[], blocksToInsert: PartialBlock<BSchema>[], editor: Editor): void;

package/types/src/api/formatConversions/formatConversions.d.ts

@@ -1,6 +1,6 @@
 import { Schema } from "prosemirror-model";
-import { Block } from "../../extensions/Blocks/api/blockTypes";
-export declare function blocksToHTML(blocks: Block[], schema: Schema): Promise<string>;
-export declare function HTMLToBlocks(html: string, schema: Schema): Promise<Block[]>;
-export declare function blocksToMarkdown(blocks: Block[], schema: Schema): Promise<string>;
-export declare function markdownToBlocks(markdown: string, schema: Schema): Promise<Block[]>;
+import { Block, BlockSchema } from "../../extensions/Blocks/api/blockTypes";
+export declare function blocksToHTML<BSchema extends BlockSchema>(blocks: Block<BSchema>[], schema: Schema): Promise<string>;
+export declare function HTMLToBlocks<BSchema extends BlockSchema>(html: string, blockSchema: BSchema, schema: Schema): Promise<Block<BSchema>[]>;
+export declare function blocksToMarkdown<BSchema extends BlockSchema>(blocks: Block<BSchema>[], schema: Schema): Promise<string>;
+export declare function markdownToBlocks<BSchema extends BlockSchema>(markdown: string, blockSchema: BSchema, schema: Schema): Promise<Block<BSchema>[]>;

package/types/src/api/nodeConversions/nodeConversions.d.ts

@@ -1,5 +1,5 @@
 import { Node, Schema } from "prosemirror-model";
-import { Block, PartialBlock } from "../../extensions/Blocks/api/blockTypes";
+import { Block, BlockSchema, PartialBlock } from "../../extensions/Blocks/api/blockTypes";
 import { PartialInlineContent } from "../../extensions/Blocks/api/inlineContentTypes";
 /**
  * converts an array of inline content elements to prosemirror nodes
@@ -8,8 +8,8 @@ export declare function inlineContentToNodes(blockContent: PartialInlineContent[
 /**
  * Converts a BlockNote block to a TipTap node.
  */
-export declare function blockToNode(block: PartialBlock, schema: Schema): Node;
+export declare function blockToNode<BSchema extends BlockSchema>(block: PartialBlock<BSchema>, schema: Schema): Node;
 /**
  * Convert a TipTap node to a BlockNote block.
  */
-export declare function nodeToBlock(node: Node, blockCache?: WeakMap<Node, Block>): Block;
+export declare function nodeToBlock<BSchema extends BlockSchema>(node: Node, blockSchema: BSchema, blockCache?: WeakMap<Node, Block<BSchema>>): Block<BSchema>;

package/types/src/api/nodeConversions/testUtil.d.ts

@@ -1,2 +1,2 @@
-import { Block, PartialBlock } from "../../extensions/Blocks/api/blockTypes";
-export declare function partialBlockToBlockForTesting(partialBlock: PartialBlock): Block;
+import { Block, BlockSchema, PartialBlock } from "../../extensions/Blocks/api/blockTypes";
+export declare function partialBlockToBlockForTesting<BSchema extends BlockSchema>(partialBlock: PartialBlock<BSchema>): Block<BSchema>;

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

@@ -1,9 +1,8 @@
-import { Attribute, Extension } from "@tiptap/core";
+import { Attribute } from "@tiptap/core";
 import { BlockConfig, BlockSchema, BlockSpec, PropSchema, TipTapNode, TipTapNodeConfig } from "./blockTypes";
+export declare function camelToDataKebab(str: string): string;
 export declare function propsToAttributes<BType extends string, PSchema extends PropSchema, ContainsInlineContent extends boolean, BSchema extends BlockSchema>(blockConfig: Omit<BlockConfig<BType, PSchema, ContainsInlineContent, BSchema>, "render">): Record<string, Attribute>;
 export declare function parse<BType extends string, PSchema extends PropSchema, ContainsInlineContent extends boolean, BSchema extends BlockSchema>(blockConfig: Omit<BlockConfig<BType, PSchema, ContainsInlineContent, BSchema>, "render">): {
-    getAttrs: (node: HTMLElement | string) => false | import("./blockTypes").Props<PSchema>;
-}[] | {
     tag: string;
 }[];
 export declare function render<BType extends string, PSchema extends PropSchema, ContainsInlineContent extends boolean, BSchema extends BlockSchema>(blockConfig: Omit<BlockConfig<BType, PSchema, ContainsInlineContent, BSchema>, "render">, HTMLAttributes: Record<string, any>): {
@@ -15,4 +14,3 @@ export declare function render<BType extends string, PSchema extends PropSchema,
 };
 export declare function createBlockSpec<BType extends string, PSchema extends PropSchema, ContainsInlineContent extends boolean, BSchema extends BlockSchema>(blockConfig: BlockConfig<BType, PSchema, ContainsInlineContent, BSchema>): BlockSpec<BType, PSchema>;
 export declare function createTipTapBlock<Type extends string>(config: TipTapNodeConfig<Type>): TipTapNode<Type>;
-export declare const CustomBlockSerializerExtension: Extension<any, any>;