@blocknote/core 0.3.0 → 0.4.0

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

@@ -33,6 +33,7 @@ export const BulletListItemBlockContent = Node.create({
 
   parseHTML() {
     return [
+      // Case for regular HTML list structure.
       {
         tag: "li",
         getAttrs: (element) => {
@@ -46,18 +47,35 @@ export const BulletListItemBlockContent = Node.create({
             return false;
           }
 
-          // Case for BlockNote list structure.
-          if (parent.getAttribute("data-content-type") === "bulletListItem") {
+          if (parent.tagName === "UL") {
             return {};
           }
 
-          // Case for regular HTML list structure.
-          if (parent.tagName === "UL") {
+          return false;
+        },
+        node: "blockContainer",
+      },
+      // Case for BlockNote list structure.
+      {
+        tag: "p",
+        getAttrs: (element) => {
+          if (typeof element === "string") {
+            return false;
+          }
+
+          const parent = element.parentElement;
+
+          if (parent === null) {
+            return false;
+          }
+
+          if (parent.getAttribute("data-content-type") === "bulletListItem") {
             return {};
           }
 
           return false;
         },
+        priority: 300,
         node: "blockContainer",
       },
     ];
@@ -70,7 +88,7 @@ export const BulletListItemBlockContent = Node.create({
         class: styles.blockContent,
         "data-content-type": this.name,
       }),
-      ["li", 0],
+      ["p", 0],
     ];
   },
 });

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

@@ -1,7 +1,7 @@
 import { InputRule, mergeAttributes, Node } from "@tiptap/core";
-import { NumberedListIndexingPlugin } from "./NumberedListIndexingPlugin";
 import styles from "../../../Block.module.css";
 import { handleEnter } from "../ListItemKeyboardShortcuts";
+import { NumberedListIndexingPlugin } from "./NumberedListIndexingPlugin";
 
 export const NumberedListItemBlockContent = Node.create({
   name: "numberedListItem",
@@ -52,6 +52,8 @@ export const NumberedListItemBlockContent = Node.create({
 
   parseHTML() {
     return [
+      // Case for regular HTML list structure.
+      // (e.g.: when pasting from other apps)
       {
         tag: "li",
         getAttrs: (element) => {
@@ -65,18 +67,36 @@ export const NumberedListItemBlockContent = Node.create({
             return false;
           }
 
-          // Case for BlockNote list structure.
-          if (parent.getAttribute("data-content-type") === "numberedListItem") {
+          if (parent.tagName === "OL") {
             return {};
           }
 
-          // Case for regular HTML list structure.
-          if (parent.tagName === "OL") {
+          return false;
+        },
+        node: "blockContainer",
+      },
+      // Case for BlockNote list structure.
+      // (e.g.: when pasting from blocknote)
+      {
+        tag: "p",
+        getAttrs: (element) => {
+          if (typeof element === "string") {
+            return false;
+          }
+
+          const parent = element.parentElement;
+
+          if (parent === null) {
+            return false;
+          }
+
+          if (parent.getAttribute("data-content-type") === "numberedListItem") {
             return {};
           }
 
           return false;
         },
+        priority: 300,
         node: "blockContainer",
       },
     ];
@@ -89,7 +109,9 @@ export const NumberedListItemBlockContent = Node.create({
         class: styles.blockContent,
         "data-content-type": this.name,
       }),
-      ["li", 0],
+      // we use a <p> tag, because for <li> tags we'd need to add a <ul> parent for around siblings to be semantically correct,
+      // which would be quite cumbersome
+      ["p", 0],
     ];
   },
 });

package/src/extensions/FormattingToolbar/FormattingToolbarFactoryTypes.ts

@@ -1,5 +1,5 @@
 import { EditorElement, ElementFactory } from "../../shared/EditorElement";
-import { Block, BlockUpdate } from "../Blocks/apiTypes";
+import { Block, PartialBlock } from "../Blocks/api/blockTypes";
 
 export type FormattingToolbarStaticParams = {
   toggleBold: () => void;
@@ -17,7 +17,7 @@ export type FormattingToolbarStaticParams = {
   increaseBlockIndent: () => void;
   decreaseBlockIndent: () => void;
 
-  updateBlock: (blockUpdate: BlockUpdate) => void;
+  updateBlock: (updatedBlock: PartialBlock) => void;
 };
 
 export type FormattingToolbarDynamicParams = {

package/src/extensions/FormattingToolbar/FormattingToolbarPlugin.ts

@@ -6,7 +6,7 @@ import {
 } from "@tiptap/core";
 import { EditorState, Plugin, PluginKey } from "prosemirror-state";
 import { EditorView } from "prosemirror-view";
-import { Block, BlockUpdate } from "../Blocks/apiTypes";
+import { Block, PartialBlock } from "../Blocks/api/blockTypes";
 import { getBlockInfoFromPos } from "../Blocks/helpers/getBlockInfoFromPos";
 import {
   FormattingToolbar,
@@ -288,11 +288,11 @@ export class FormattingToolbarView {
         this.editor.view.focus();
         this.editor.commands.liftListItem("blockContainer");
       },
-      updateBlock: (blockUpdate: BlockUpdate) => {
+      updateBlock: (updatedBlock: PartialBlock) => {
         this.editor.view.focus();
         this.editor.commands.BNUpdateBlock(
           this.editor.state.selection.from,
-          blockUpdate
+          updatedBlock
         );
       },
     };

package/src/extensions/SlashMenu/SlashMenuExtension.ts

@@ -2,11 +2,10 @@ import { Extension } from "@tiptap/core";
 import { PluginKey } from "prosemirror-state";
 import { createSuggestionPlugin } from "../../shared/plugins/suggestion/SuggestionPlugin";
 import { SuggestionsMenuFactory } from "../../shared/plugins/suggestion/SuggestionsMenuFactoryTypes";
-import defaultCommands from "./defaultCommands";
 import { SlashMenuItem } from "./SlashMenuItem";
 
 export type SlashMenuOptions = {
-  commands: { [key: string]: SlashMenuItem };
+  commands: SlashMenuItem[] | undefined;
   slashMenuFactory: SuggestionsMenuFactory<any> | undefined;
 };
 
@@ -17,16 +16,18 @@ export const SlashMenuExtension = Extension.create<SlashMenuOptions>({
 
   addOptions() {
     return {
-      commands: defaultCommands,
-      slashMenuFactory: undefined, // TODO: fix undefined
+      commands: undefined,
+      slashMenuFactory: undefined,
     };
   },
 
   addProseMirrorPlugins() {
-    if (!this.options.slashMenuFactory) {
-      throw new Error("UI Element factory not defined for SlashMenuExtension");
+    if (!this.options.slashMenuFactory || !this.options.commands) {
+      throw new Error("required args not defined for SlashMenuExtension");
     }
 
+    const commands = this.options.commands;
+
     return [
       createSuggestionPlugin<SlashMenuItem>({
         pluginKey: SlashMenuPluginKey,
@@ -34,12 +35,6 @@ export const SlashMenuExtension = Extension.create<SlashMenuOptions>({
         defaultTriggerCharacter: "/",
         suggestionsMenuFactory: this.options.slashMenuFactory!,
         items: (query) => {
-          const commands = [];
-
-          for (const key in this.options.commands) {
-            commands.push(this.options.commands[key]);
-          }
-
           return commands.filter((cmd: SlashMenuItem) => cmd.match(query));
         },
         onSelectItem: ({ item, editor, range }) => {

package/src/extensions/SlashMenu/SlashMenuItem.ts

@@ -17,7 +17,10 @@ export class SlashMenuItem implements SuggestionItem {
   constructor(
     public readonly name: string,
     public readonly execute: (editor: Editor, range: Range) => void,
-    public readonly aliases: string[] = []
+    public readonly aliases: string[] = [],
+    public readonly group: string,
+    public readonly hint?: string,
+    public readonly shortcut?: string
   ) {}
 
   match(query: string): boolean {

package/src/extensions/SlashMenu/{defaultCommands.tsx → defaultSlashCommands.tsx}

@@ -1,12 +1,13 @@
-import { SlashMenuItem } from "./SlashMenuItem";
 import { Editor, Range } from "@tiptap/core";
+import { formatKeyboardShortcut } from "../../shared/utils";
+import { SlashMenuItem } from "./SlashMenuItem";
 
 /**
  * An array containing commands for creating all default blocks.
  */
-const defaultCommands: { [key: string]: SlashMenuItem } = {
+export const defaultSlashCommands: SlashMenuItem[] = [
   // Command for creating a level 1 heading
-  heading: new SlashMenuItem(
+  new SlashMenuItem(
     "Heading",
     (editor: Editor, range: Range) => {
       return editor
@@ -21,11 +22,14 @@ const defaultCommands: { [key: string]: SlashMenuItem } = {
         })
         .run();
     },
-    ["h", "heading1", "h1"]
+    ["h", "heading1", "h1"],
+    "Headings",
+    "Used for a top-level heading",
+    formatKeyboardShortcut("Mod-Alt-1")
   ),
 
   // Command for creating a level 2 heading
-  heading2: new SlashMenuItem(
+  new SlashMenuItem(
     "Heading 2",
     (editor: Editor, range: Range) => {
       return editor
@@ -40,11 +44,14 @@ const defaultCommands: { [key: string]: SlashMenuItem } = {
         })
         .run();
     },
-    ["h2", "heading2", "subheading"]
+    ["h2", "heading2", "subheading"],
+    "Headings",
+    "Used for key sections",
+    formatKeyboardShortcut("Mod-Alt-2")
   ),
 
   // Command for creating a level 3 heading
-  heading3: new SlashMenuItem(
+  new SlashMenuItem(
     "Heading 3",
     (editor: Editor, range: Range) => {
       return editor
@@ -59,11 +66,14 @@ const defaultCommands: { [key: string]: SlashMenuItem } = {
         })
         .run();
     },
-    ["h3", "heading3", "subheading"]
+    ["h3", "heading3", "subheading"],
+    "Headings",
+    "Used for subsections and group headings",
+    formatKeyboardShortcut("Mod-Alt-3")
   ),
 
   // Command for creating an ordered list
-  numberedList: new SlashMenuItem(
+  new SlashMenuItem(
     "Numbered List",
     (editor: Editor, range: Range) => {
       return editor
@@ -76,11 +86,14 @@ const defaultCommands: { [key: string]: SlashMenuItem } = {
         })
         .run();
     },
-    ["li", "list", "numberedlist", "numbered list"]
+    ["li", "list", "numberedlist", "numbered list"],
+    "Basic blocks",
+    "Used to display a numbered list",
+    "Mod-Alt-7"
   ),
 
   // Command for creating a bullet list
-  bulletList: new SlashMenuItem(
+  new SlashMenuItem(
     "Bullet List",
     (editor: Editor, range: Range) => {
       return editor
@@ -93,11 +106,14 @@ const defaultCommands: { [key: string]: SlashMenuItem } = {
         })
         .run();
     },
-    ["ul", "list", "bulletlist", "bullet list"]
+    ["ul", "list", "bulletlist", "bullet list"],
+    "Basic blocks",
+    "Used to display an unordered list",
+    "Mod-Alt-9"
   ),
 
   // Command for creating a paragraph (pretty useless)
-  paragraph: new SlashMenuItem(
+  new SlashMenuItem(
     "Paragraph",
     (editor: Editor, range: Range) => {
       return editor
@@ -110,7 +126,10 @@ const defaultCommands: { [key: string]: SlashMenuItem } = {
         })
         .run();
     },
-    ["p"]
+    ["p"],
+    "Basic blocks",
+    "Used for the body of your document",
+    "Mod-Alt-0"
   ),
 
   //     replaceRangeWithNode(editor, range, node);
@@ -216,6 +235,4 @@ const defaultCommands: { [key: string]: SlashMenuItem } = {
   //   TableIcon,
   //   "Used to create a simple table"
   // ),
-};
-
-export default defaultCommands;
+];

package/src/extensions/SlashMenu/index.ts

@@ -1,6 +1,9 @@
+import { defaultSlashCommands } from "./defaultSlashCommands";
 import { SlashMenuExtension } from "./SlashMenuExtension";
-import defaultCommands from "./defaultCommands";
+import { SlashMenuItem } from "./SlashMenuItem";
 
-export { defaultCommands };
-
-export default SlashMenuExtension;
+export {
+  defaultSlashCommands,
+  SlashMenuItem as SlashCommand,
+  SlashMenuExtension,
+};

package/src/extensions/UniqueID/UniqueID.ts

@@ -123,7 +123,7 @@ const UniqueID = Extension.create({
       new Plugin({
         key: new PluginKey("uniqueID"),
         appendTransaction: (transactions, oldState, newState) => {
-          console.log("appendTransaction");
+          // console.log("appendTransaction");
           const docChanges =
             transactions.some((transaction) => transaction.docChanged) &&
             !oldState.doc.eq(newState.doc);

package/src/index.ts

@@ -1,10 +1,12 @@
 export * from "./BlockNoteEditor";
 export * from "./BlockNoteExtensions";
-export type { Block, BlockUpdate } from "./extensions/Blocks/apiTypes";
-export * from "./extensions/FormattingToolbar/FormattingToolbarFactoryTypes";
+export * from "./extensions/Blocks/api/blockTypes";
 export * from "./extensions/DraggableBlocks/BlockSideMenuFactoryTypes";
+export * from "./extensions/FormattingToolbar/FormattingToolbarFactoryTypes";
 export * from "./extensions/HyperlinkToolbar/HyperlinkToolbarFactoryTypes";
+export { defaultSlashCommands } from "./extensions/SlashMenu/defaultSlashCommands";
 export * from "./extensions/SlashMenu/SlashMenuItem";
 export * from "./shared/EditorElement";
 export type { SuggestionItem } from "./shared/plugins/suggestion/SuggestionItem";
 export * from "./shared/plugins/suggestion/SuggestionsMenuFactoryTypes";
+export * from "../src/api/Editor";

package/types/src/BlockNoteEditor.d.ts

@@ -1,13 +1,22 @@
-import { Editor, EditorOptions } from "@tiptap/core";
+import { Editor } from "@tiptap/core";
+import { Editor as EditorAPI } from "./api/Editor";
 import { UiFactories } from "./BlockNoteExtensions";
-export type BlockNoteEditorOptions = EditorOptions & {
+import { SlashCommand } from "./extensions/SlashMenu";
+export type BlockNoteEditorOptions = {
     enableBlockNoteExtensions: boolean;
     disableHistoryExtension: boolean;
     uiFactories: UiFactories;
+    slashCommands: SlashCommand[];
+    parentElement: HTMLElement;
+    editorDOMAttributes: Record<string, string>;
+    onUpdate: () => void;
+    onCreate: () => void;
+    _tiptapOptions: any;
 };
-export declare class BlockNoteEditor {
-    readonly tiptapEditor: Editor & {
+export declare class BlockNoteEditor extends EditorAPI {
+    readonly _tiptapEditor: Editor & {
         contentComponent: any;
     };
+    get domElement(): HTMLDivElement;
     constructor(options?: Partial<BlockNoteEditorOptions>);
 }

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

@@ -0,0 +1 @@
+export {};

package/types/src/BlockNoteExtensions.d.ts

@@ -1,9 +1,10 @@
 import { Extensions } from "@tiptap/core";
+import { BlockSideMenuFactory } from "./extensions/DraggableBlocks/BlockSideMenuFactoryTypes";
 import { FormattingToolbarFactory } from "./extensions/FormattingToolbar/FormattingToolbarFactoryTypes";
 import { HyperlinkToolbarFactory } from "./extensions/HyperlinkToolbar/HyperlinkToolbarFactoryTypes";
-import { SuggestionsMenuFactory } from "./shared/plugins/suggestion/SuggestionsMenuFactoryTypes";
-import { BlockSideMenuFactory } from "./extensions/DraggableBlocks/BlockSideMenuFactoryTypes";
+import { SlashCommand } from "./extensions/SlashMenu";
 import { SlashMenuItem } from "./extensions/SlashMenu/SlashMenuItem";
+import { SuggestionsMenuFactory } from "./shared/plugins/suggestion/SuggestionsMenuFactoryTypes";
 export type UiFactories = Partial<{
     formattingToolbarFactory: FormattingToolbarFactory;
     hyperlinkToolbarFactory: HyperlinkToolbarFactory;
@@ -13,4 +14,7 @@ export type UiFactories = Partial<{
 /**
  * Get all the Tiptap extensions BlockNote is configured with by default
  */
-export declare const getBlockNoteExtensions: (uiFactories: UiFactories) => Extensions;
+export declare const getBlockNoteExtensions: (opts: {
+    uiFactories: UiFactories;
+    slashCommands: SlashCommand[];
+}) => Extensions;

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

@@ -0,0 +1,73 @@
+import { Editor as TiptapEditor } from "@tiptap/core";
+import { Node } from "prosemirror-model";
+import { Block, PartialBlock } from "../extensions/Blocks/api/blockTypes";
+import { TextCursorPosition } from "../extensions/Blocks/api/cursorPositionTypes";
+export declare class Editor {
+    private tiptapEditor;
+    private blockCache;
+    constructor(tiptapEditor: TiptapEditor, blockCache?: WeakMap<Node, Block>);
+    /**
+     * Gets a list of all top-level blocks that are in the editor.
+     */
+    get allBlocks(): Block[];
+    /**
+     * Gets information regarding the position of the text cursor in the editor.
+     */
+    get textCursorPosition(): TextCursorPosition;
+    /**
+     * Inserts multiple blocks before, after, or nested inside an existing block in the editor.
+     * @param blocksToInsert An array of blocks to insert.
+     * @param blockToInsertAt An existing block, marking where the new blocks should be inserted at.
+     * @param placement Determines whether the blocks should be inserted just before, just after, or nested inside the
+     * existing block.
+     */
+    insertBlocks(blocksToInsert: PartialBlock[], blockToInsertAt: Block, placement?: "before" | "after" | "nested"): void;
+    /**
+     * Updates a block in the editor to the given specification.
+     * @param blockToUpdate The block that should be updated.
+     * @param updatedBlock The specification that the block should be updated to.
+     */
+    updateBlock(blockToUpdate: Block, updatedBlock: PartialBlock): void;
+    /**
+     * Removes multiple blocks from the editor. Throws an error if any of the blocks could not be found.
+     * @param blocksToRemove An array of blocks that should be removed.
+     */
+    removeBlocks(blocksToRemove: Block[]): void;
+    /**
+     * Replaces multiple blocks in the editor with several other blocks. If the provided blocks to remove are not adjacent
+     * to each other, the new blocks are inserted at the position of the first block in the array. Throws an error if any
+     * of the blocks could not be found.
+     * @param blocksToRemove An array of blocks that should be replaced.
+     * @param blocksToInsert An array of blocks to replace the old ones with.
+     */
+    replaceBlocks(blocksToRemove: Block[], blocksToInsert: PartialBlock[]): void;
+    /**
+     * Executes a callback function whenever the editor's content changes.
+     * @param callback The callback function to execute.
+     */
+    onContentChange(callback: () => void): void;
+    /**
+     * Serializes a list of blocks into an HTML string. The output is not the same as what's rendered by the editor, and
+     * is simplified in order to better conform to HTML standards. Block structuring elements are removed, children of
+     * blocks which aren't list items are lifted out of them, and list items blocks are wrapped in `ul`/`ol` tags.
+     * @param blocks The list of blocks to serialize into HTML.
+     */
+    blocksToHTML(blocks: Block[]): Promise<string>;
+    /**
+     * Creates a list of blocks from an HTML string.
+     * @param htmlString The HTML string to create a list of blocks from.
+     */
+    HTMLToBlocks(htmlString: string): Promise<Block[]>;
+    /**
+     * Serializes a list of blocks into a Markdown string. The output is simplified as Markdown does not support all
+     * features of BlockNote. Block structuring elements are removed, children of blocks which aren't list items are
+     * lifted out of them, and certain styles are removed.
+     * @param blocks The list of blocks to serialize into Markdown.
+     */
+    blocksToMarkdown(blocks: Block[]): Promise<string>;
+    /**
+     * Creates a list of blocks from a Markdown string.
+     * @param markdownString The Markdown string to create a list of blocks from.
+     */
+    markdownToBlocks(markdownString: string): Promise<Block[]>;
+}

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

@@ -0,0 +1,6 @@
+import { Editor } from "@tiptap/core";
+import { Block, PartialBlock } from "../../extensions/Blocks/api/blockTypes";
+export declare function insertBlocks(blocksToInsert: PartialBlock[], blockToInsertAt: Block, placement: "before" | "after" | "nested" | undefined, editor: Editor): void;
+export declare function updateBlock(blockToUpdate: Block, updatedBlock: PartialBlock, editor: Editor): void;
+export declare function removeBlocks(blocksToRemove: Block[], editor: Editor): void;
+export declare function replaceBlocks(blocksToRemove: Block[], blocksToInsert: PartialBlock[], editor: Editor): void;

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

@@ -0,0 +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(htmlString: string, schema: Schema): Promise<Block[]>;
+export declare function blocksToMarkdown(blocks: Block[], schema: Schema): Promise<string>;
+export declare function markdownToBlocks(markdownString: string, schema: Schema): Promise<Block[]>;

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

@@ -0,0 +1,6 @@
+import { Parent as HASTParent } from "hast";
+/**
+ * Rehype plugin which removes <u> tags. Used to remove underlines before converting HTML to markdown, as Markdown
+ * doesn't support underlines.
+ */
+export declare function removeUnderlines(): (tree: HASTParent) => void;

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

@@ -0,0 +1,16 @@
+import { Parent as HASTParent } from "hast";
+type SimplifyBlocksOptions = {
+    orderedListItemBlockTypes: Set<string>;
+    unorderedListItemBlockTypes: Set<string>;
+};
+/**
+ * Rehype plugin which converts the HTML output string rendered by BlockNote into a simplified structure which better
+ * follows HTML standards. It does several things:
+ * - Removes all block related div elements, leaving only the actual content inside the block.
+ * - Lifts nested blocks to a higher level for all block types that don't represent list items.
+ * - Wraps blocks which represent list items in corresponding ul/ol HTML elements and restructures them to comply
+ * with HTML list structure.
+ * @param options Options for specifying which block types represent ordered and unordered list items.
+ */
+export declare function simplifyBlocks(options: SimplifyBlocksOptions): (tree: HASTParent) => void;
+export {};

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

@@ -0,0 +1,8 @@
+import { Node, Schema } from "prosemirror-model";
+import { Block, PartialBlock } from "../../extensions/Blocks/api/blockTypes";
+export declare function blockToNode(block: PartialBlock, schema: Schema): Node;
+export declare function getNodeById(id: string, doc: Node): {
+    node: Node;
+    posBeforeNode: number;
+};
+export declare function nodeToBlock(node: Node, blockCache?: WeakMap<Node, Block>): Block;

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

@@ -0,0 +1,6 @@
+import { Parent as HASTParent } from "hast";
+/**
+ * Rehype plugin which removes <u> tags. Used to remove underlines before converting HTML to markdown, as Markdown
+ * doesn't support underlines.
+ */
+export declare function removeUnderlines(): (tree: HASTParent) => void;

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

@@ -0,0 +1,16 @@
+import { Parent as HASTParent } from "hast";
+type SimplifyBlocksOptions = {
+    orderedListItemBlockTypes: Set<string>;
+    unorderedListItemBlockTypes: Set<string>;
+};
+/**
+ * Rehype plugin which converts the HTML output string rendered by BlockNote into a simplified structure which better
+ * follows HTML standards. It does several things:
+ * - Removes all block related div elements, leaving only the actual content inside the block.
+ * - Lifts nested blocks to a higher level for all block types that don't represent list items.
+ * - Wraps blocks which represent list items in corresponding ul/ol HTML elements and restructures them to comply
+ * with HTML list structure.
+ * @param options Options for specifying which block types represent ordered and unordered list items.
+ */
+export declare function simplifyBlocks(options: SimplifyBlocksOptions): (tree: HASTParent) => void;
+export {};

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

@@ -0,0 +1,18 @@
+export type BlockSpec<Type extends string, Props extends Record<string, string>> = {
+    id: string;
+    children: Block[];
+    type: Type;
+    props: Props;
+};
+export type BlockSpecUpdate<Spec> = Spec extends BlockSpec<infer Type, infer Props> ? {
+    type: Type;
+    props?: Partial<Props>;
+} : never;
+export type NumberedListItemBlock = BlockSpec<"numberedListItem", {}>;
+export type BulletListItemBlock = BlockSpec<"bulletListItem", {}>;
+export type HeadingBlock = BlockSpec<"heading", {
+    level: "1" | "2" | "3";
+}>;
+export type ParagraphBlock = BlockSpec<"paragraph", {}>;
+export type Block = ParagraphBlock | HeadingBlock | BulletListItemBlock | NumberedListItemBlock;
+export type BlockUpdate = BlockSpecUpdate<Block>;

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

@@ -0,0 +1,36 @@
+/** Define the main block types **/
+import { InlineContent } from "./inlineContentTypes";
+export type BlockTemplate<Type extends string, Props extends Record<string, string>> = {
+    id: string;
+    type: Type;
+    props: Props;
+    content: InlineContent[];
+    children: Block[];
+};
+export type GlobalProps = {
+    backgroundColor: string;
+    textColor: string;
+    textAlignment: "left" | "center" | "right" | "justify";
+};
+export type NumberedListItemBlock = BlockTemplate<"numberedListItem", GlobalProps>;
+export type BulletListItemBlock = BlockTemplate<"bulletListItem", GlobalProps>;
+export type HeadingBlock = BlockTemplate<"heading", GlobalProps & {
+    level: "1" | "2" | "3";
+}>;
+export type ParagraphBlock = BlockTemplate<"paragraph", GlobalProps>;
+export type Block = ParagraphBlock | HeadingBlock | BulletListItemBlock | NumberedListItemBlock;
+/** Define "Partial Blocks", these are for updating or creating blocks */
+export type PartialBlockTemplate<B extends Block> = B extends Block ? Partial<Omit<B, "props" | "children" | "content" | "type">> & {
+    type: B["type"];
+    props?: Partial<B["props"]>;
+    content?: string | B["content"];
+    children?: PartialBlock[];
+} : never;
+export type PartialBlock = PartialBlockTemplate<Block>;
+export type BlockPropsTemplate<Props> = Props extends Block["props"] ? keyof Props : never;
+/**
+ * Expose blockProps. This is currently not very nice, but it's expected this
+ * will change anyway once we allow for custom blocks
+ */
+export declare const globalProps: Array<keyof GlobalProps>;
+export declare const blockProps: Record<Block["type"], Set<string>>;

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

@@ -0,0 +1,4 @@
+import { Block } from "./blockTypes";
+export type TextCursorPosition = {
+    block: Block;
+};