@blocknote/core 0.10.0 → 0.11.0

package/types/src/api/testCases/cases/customInlineContent.d.ts

@@ -1,29 +0,0 @@
-import { EditorTestCases } from "..";
-import { DefaultBlockSchema, DefaultStyleSchema } from "../../../extensions/Blocks/api/defaultBlocks";
-import { InlineContentSchemaFromSpecs } from "../../../extensions/Blocks/api/inlineContent/types";
-declare const customInlineContent: {
-    mention: import("../../../extensions/Blocks/api/inlineContent/types").InlineContentSpec<{
-        type: "mention";
-        propSchema: {
-            user: {
-                default: string;
-            };
-        };
-        content: "none";
-    }>;
-    tag: import("../../../extensions/Blocks/api/inlineContent/types").InlineContentSpec<{
-        type: "tag";
-        propSchema: {};
-        content: "styled";
-    }>;
-    text: {
-        config: "text";
-        implementation: any;
-    };
-    link: {
-        config: "link";
-        implementation: any;
-    };
-};
-export declare const customInlineContentTestCases: EditorTestCases<DefaultBlockSchema, InlineContentSchemaFromSpecs<typeof customInlineContent>, DefaultStyleSchema>;
-export {};

package/types/src/api/testCases/cases/customStyles.d.ts

@@ -1,64 +0,0 @@
-import { EditorTestCases } from "..";
-import { DefaultBlockSchema, DefaultInlineContentSchema } from "../../../extensions/Blocks/api/defaultBlocks";
-import { StyleSchemaFromSpecs } from "../../../extensions/Blocks/api/styles/types";
-declare const customStyles: {
-    small: import("../../../extensions/Blocks/api/styles/types").StyleSpec<{
-        type: string;
-        propSchema: "boolean";
-    }>;
-    fontSize: import("../../../extensions/Blocks/api/styles/types").StyleSpec<{
-        type: string;
-        propSchema: "string";
-    }>;
-    bold: {
-        config: {
-            type: string;
-            propSchema: "boolean";
-        };
-        implementation: import("../../../extensions/Blocks/api/styles/types").StyleImplementation;
-    };
-    italic: {
-        config: {
-            type: string;
-            propSchema: "boolean";
-        };
-        implementation: import("../../../extensions/Blocks/api/styles/types").StyleImplementation;
-    };
-    underline: {
-        config: {
-            type: string;
-            propSchema: "boolean";
-        };
-        implementation: import("../../../extensions/Blocks/api/styles/types").StyleImplementation;
-    };
-    strike: {
-        config: {
-            type: string;
-            propSchema: "boolean";
-        };
-        implementation: import("../../../extensions/Blocks/api/styles/types").StyleImplementation;
-    };
-    code: {
-        config: {
-            type: string;
-            propSchema: "boolean";
-        };
-        implementation: import("../../../extensions/Blocks/api/styles/types").StyleImplementation;
-    };
-    textColor: {
-        config: {
-            type: string;
-            propSchema: "string";
-        };
-        implementation: import("../../../extensions/Blocks/api/styles/types").StyleImplementation;
-    };
-    backgroundColor: {
-        config: {
-            type: string;
-            propSchema: "string";
-        };
-        implementation: import("../../../extensions/Blocks/api/styles/types").StyleImplementation;
-    };
-};
-export declare const customStylesTestCases: EditorTestCases<DefaultBlockSchema, DefaultInlineContentSchema, StyleSchemaFromSpecs<typeof customStyles>>;
-export {};

package/types/src/api/testCases/cases/defaultSchema.d.ts

@@ -1,3 +0,0 @@
-import { EditorTestCases } from "..";
-import { DefaultBlockSchema, DefaultInlineContentSchema, DefaultStyleSchema } from "../../../extensions/Blocks/api/defaultBlocks";
-export declare const defaultSchemaTestCases: EditorTestCases<DefaultBlockSchema, DefaultInlineContentSchema, DefaultStyleSchema>;

package/types/src/api/testCases/index.d.ts

@@ -1,12 +0,0 @@
-import { BlockNoteEditor } from "../../BlockNoteEditor";
-import { BlockSchema, PartialBlock } from "../../extensions/Blocks/api/blocks/types";
-import { InlineContentSchema } from "../../extensions/Blocks/api/inlineContent/types";
-import { StyleSchema } from "../../extensions/Blocks/api/styles/types";
-export type EditorTestCases<B extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema> = {
-    name: string;
-    createEditor: () => BlockNoteEditor<B, I, S>;
-    documents: Array<{
-        name: string;
-        blocks: PartialBlock<B, I, S>[];
-    }>;
-};

package/types/src/api/util/nodeUtil.d.ts

@@ -1,8 +0,0 @@
-import { Node } from "prosemirror-model";
-/**
- * Get a TipTap node by id
- */
-export declare function getNodeById(id: string, doc: Node): {
-    node: Node;
-    posBeforeNode: number;
-};

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

@@ -1,2 +0,0 @@
-import { Plugin } from "prosemirror-state";
-export declare const NonEditableBlockPlugin: () => Plugin<any>;

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

@@ -1,14 +0,0 @@
-import { Plugin } from "prosemirror-state";
-/**
- * This plugin tracks transformation of Block node attributes, so we can support CSS transitions.
- *
- * Problem it solves: ProseMirror recreates the DOM when transactions happen. So when a transaction changes a Node attribute,
- * it results in a completely new DOM element. This means CSS transitions don't work.
- *
- * Solution: When attributes change on a node, this plugin sets a data-* attribute with the "previous" value. This way we can still use CSS transitions. (See block.module.css)
- */
-export declare const PreviousBlockTypePlugin: () => Plugin<{
-    prevTransactionOldBlockAttrs: any;
-    currentTransactionOldBlockAttrs: any;
-    updatedBlocks: Set<string>;
-}>;

package/types/src/extensions/Blocks/api/blocks/createSpec.d.ts

@@ -1,35 +0,0 @@
-import { ParseRule } from "@tiptap/pm/model";
-import { BlockNoteEditor } from "../../../../BlockNoteEditor";
-import { InlineContentSchema } from "../inlineContent/types";
-import { StyleSchema } from "../styles/types";
-import { BlockConfig, BlockFromConfig, BlockSchemaWithBlock, PartialBlockFromConfig } from "./types";
-export type CustomBlockConfig = BlockConfig & {
-    content: "inline" | "none";
-};
-export type CustomBlockImplementation<T extends CustomBlockConfig, I extends InlineContentSchema, S extends StyleSchema> = {
-    render: (
-    /**
-     * The custom block to render
-     */
-    block: BlockFromConfig<T, I, S>, 
-    /**
-     * The BlockNote editor instance
-     * This is typed generically. If you want an editor with your custom schema, you need to
-     * cast it manually, e.g.: `const e = editor as BlockNoteEditor<typeof mySchema>;`
-     */
-    editor: BlockNoteEditor<BlockSchemaWithBlock<T["type"], T>, I, S>) => {
-        dom: HTMLElement;
-        contentDOM?: HTMLElement;
-        destroy?: () => void;
-    };
-    toExternalHTML?: (block: BlockFromConfig<T, I, S>, editor: BlockNoteEditor<BlockSchemaWithBlock<T["type"], T>, I, S>) => {
-        dom: HTMLElement;
-        contentDOM?: HTMLElement;
-    };
-    parse?: (el: HTMLElement) => PartialBlockFromConfig<T, I, S>["props"] | undefined;
-};
-export declare function getParseRules(config: BlockConfig, customParseFunction: CustomBlockImplementation<any, any, any>["parse"]): ParseRule[];
-export declare function createBlockSpec<T extends CustomBlockConfig, I extends InlineContentSchema, S extends StyleSchema>(blockConfig: T, blockImplementation: CustomBlockImplementation<T, I, S>): {
-    config: T;
-    implementation: import("./types").TiptapBlockImplementation<T, any, InlineContentSchema, StyleSchema>;
-};

package/types/src/extensions/Blocks/api/blocks/internal.d.ts

@@ -1,45 +0,0 @@
-import { Attributes, Editor, Extension, Node, NodeConfig } from "@tiptap/core";
-import { BlockNoteEditor } from "../../../../BlockNoteEditor";
-import { InlineContentSchema } from "../inlineContent/types";
-import { StyleSchema } from "../styles/types";
-import { BlockConfig, BlockSchemaFromSpecs, BlockSchemaWithBlock, BlockSpecs, Props, PropSchema, SpecificBlock, TiptapBlockImplementation } from "./types";
-export declare function camelToDataKebab(str: string): string;
-export declare function propsToAttributes(propSchema: PropSchema): Attributes;
-export declare function getBlockFromPos<BType extends string, Config extends BlockConfig, BSchema extends BlockSchemaWithBlock<BType, Config>, I extends InlineContentSchema, S extends StyleSchema>(getPos: (() => number) | boolean, editor: BlockNoteEditor<BSchema, I, S>, tipTapEditor: Editor, type: BType): SpecificBlock<BSchema, BType, I, S>;
-export declare function wrapInBlockStructure<BType extends string, PSchema extends PropSchema>(element: {
-    dom: HTMLElement;
-    contentDOM?: HTMLElement;
-    destroy?: () => void;
-}, blockType: BType, blockProps: Props<PSchema>, propSchema: PSchema, domAttributes?: Record<string, string>): {
-    dom: HTMLElement;
-    contentDOM?: HTMLElement;
-    destroy?: () => void;
-};
-type StronglyTypedTipTapNode<Name extends string, Content extends "inline*" | "tableRow+" | ""> = Node & {
-    name: Name;
-    config: {
-        content: Content;
-    };
-};
-export declare function createStronglyTypedTiptapNode<Name extends string, Content extends "inline*" | "tableRow+" | "">(config: NodeConfig & {
-    name: Name;
-    content: Content;
-}): StronglyTypedTipTapNode<Name, Content>;
-export declare function createInternalBlockSpec<T extends BlockConfig>(config: T, implementation: TiptapBlockImplementation<T, any, InlineContentSchema, StyleSchema>): {
-    config: T;
-    implementation: TiptapBlockImplementation<T, any, InlineContentSchema, StyleSchema>;
-};
-export declare function createBlockSpecFromStronglyTypedTiptapNode<T extends Node, P extends PropSchema>(node: T, propSchema: P, requiredExtensions?: Array<Extension | Node>): {
-    config: {
-        type: T["name"];
-        content: T["config"]["content"] extends "inline*" ? "inline" : T["config"]["content"] extends "tableRow+" ? "table" : "none";
-        propSchema: P;
-    };
-    implementation: TiptapBlockImplementation<{
-        type: T["name"];
-        content: T["config"]["content"] extends "inline*" ? "inline" : T["config"]["content"] extends "tableRow+" ? "table" : "none";
-        propSchema: P;
-    }, any, InlineContentSchema, StyleSchema>;
-};
-export declare function getBlockSchemaFromSpecs<T extends BlockSpecs>(specs: T): BlockSchemaFromSpecs<T>;
-export {};

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

@@ -1,114 +0,0 @@
-/** Define the main block types **/
-import { Extension, Node } from "@tiptap/core";
-import { BlockNoteEditor } from "../../../../BlockNoteEditor";
-import { InlineContent, InlineContentSchema, PartialInlineContent } from "../inlineContent/types";
-import { StyleSchema } from "../styles/types";
-export type BlockNoteDOMElement = "editor" | "blockContainer" | "blockGroup" | "blockContent" | "inlineContent";
-export type BlockNoteDOMAttributes = Partial<{
-    [DOMElement in BlockNoteDOMElement]: Record<string, string>;
-}>;
-export type PropSpec<PType extends boolean | number | string> = {
-    values?: readonly PType[];
-    default: PType;
-};
-export type PropSchema = Record<string, PropSpec<boolean | number | string>>;
-export type Props<PSchema extends PropSchema> = {
-    [PName in keyof PSchema]: PSchema[PName]["default"] extends boolean ? PSchema[PName]["values"] extends readonly boolean[] ? PSchema[PName]["values"][number] : boolean : PSchema[PName]["default"] extends number ? PSchema[PName]["values"] extends readonly number[] ? PSchema[PName]["values"][number] : number : PSchema[PName]["default"] extends string ? PSchema[PName]["values"] extends readonly string[] ? PSchema[PName]["values"][number] : string : never;
-};
-export type BlockConfig = {
-    type: string;
-    readonly propSchema: PropSchema;
-    content: "inline" | "none" | "table";
-};
-export type TiptapBlockImplementation<T extends BlockConfig, B extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema> = {
-    requiredExtensions?: Array<Extension | Node>;
-    node: Node;
-    toInternalHTML: (block: BlockFromConfigNoChildren<T, I, S> & {
-        children: Block<B, I, S>[];
-    }, editor: BlockNoteEditor<B, I, S>) => {
-        dom: HTMLElement;
-        contentDOM?: HTMLElement;
-    };
-    toExternalHTML: (block: BlockFromConfigNoChildren<T, I, S> & {
-        children: Block<B, I, S>[];
-    }, editor: BlockNoteEditor<B, I, S>) => {
-        dom: HTMLElement;
-        contentDOM?: HTMLElement;
-    };
-};
-export type BlockSpec<T extends BlockConfig, B extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema> = {
-    config: T;
-    implementation: TiptapBlockImplementation<T, B, I, S>;
-};
-type NamesMatch<Blocks extends Record<string, BlockConfig>> = Blocks extends {
-    [Type in keyof Blocks]: Type extends string ? Blocks[Type] extends {
-        type: Type;
-    } ? Blocks[Type] : never : never;
-} ? Blocks : never;
-export type BlockSchema = NamesMatch<Record<string, BlockConfig>>;
-export type BlockSpecs = Record<string, BlockSpec<any, any, InlineContentSchema, StyleSchema>>;
-export type BlockImplementations = Record<string, TiptapBlockImplementation<any, any, any, any>>;
-export type BlockSchemaFromSpecs<T extends BlockSpecs> = {
-    [K in keyof T]: T[K]["config"];
-};
-export type BlockSchemaWithBlock<BType extends string, C extends BlockConfig> = {
-    [k in BType]: C;
-};
-export type TableContent<I extends InlineContentSchema, S extends StyleSchema = StyleSchema> = {
-    type: "tableContent";
-    rows: {
-        cells: InlineContent<I, S>[][];
-    }[];
-};
-export type BlockFromConfigNoChildren<B extends BlockConfig, I extends InlineContentSchema, S extends StyleSchema> = {
-    id: string;
-    type: B["type"];
-    props: Props<B["propSchema"]>;
-    content: B["content"] extends "inline" ? InlineContent<I, S>[] : B["content"] extends "table" ? TableContent<I, S> : B["content"] extends "none" ? undefined : never;
-};
-export type BlockFromConfig<B extends BlockConfig, I extends InlineContentSchema, S extends StyleSchema> = BlockFromConfigNoChildren<B, I, S> & {
-    children: Block<BlockSchema, I, S>[];
-};
-type BlocksWithoutChildren<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema> = {
-    [BType in keyof BSchema]: BlockFromConfigNoChildren<BSchema[BType], I, S>;
-};
-export type Block<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema> = BlocksWithoutChildren<BSchema, I, S>[keyof BSchema] & {
-    children: Block<BSchema, I, S>[];
-};
-export type SpecificBlock<BSchema extends BlockSchema, BType extends keyof BSchema, I extends InlineContentSchema, S extends StyleSchema> = BlocksWithoutChildren<BSchema, I, S>[BType] & {
-    children: Block<BSchema, I, S>[];
-};
-/** CODE FOR PARTIAL BLOCKS, analogous to above
- *
- * Partial blocks are convenience-wrappers to make it easier to
- *create/update blocks in the editor.
- *
- */
-export type PartialTableContent<I extends InlineContentSchema, S extends StyleSchema = StyleSchema> = {
-    type: "tableContent";
-    rows: {
-        cells: PartialInlineContent<I, S>[];
-    }[];
-};
-type PartialBlockFromConfigNoChildren<B extends BlockConfig, I extends InlineContentSchema, S extends StyleSchema> = {
-    id?: string;
-    type?: B["type"];
-    props?: Partial<Props<B["propSchema"]>>;
-    content?: B["content"] extends "inline" ? PartialInlineContent<I, S> : B["content"] extends "table" ? PartialTableContent<I, S> : undefined;
-};
-type PartialBlocksWithoutChildren<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema> = {
-    [BType in keyof BSchema]: PartialBlockFromConfigNoChildren<BSchema[BType], I, S>;
-};
-export type PartialBlock<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema> = PartialBlocksWithoutChildren<BSchema, I, S>[keyof PartialBlocksWithoutChildren<BSchema, I, S>] & Partial<{
-    children: PartialBlock<BSchema, I, S>[];
-}>;
-export type SpecificPartialBlock<BSchema extends BlockSchema, I extends InlineContentSchema, BType extends keyof BSchema, S extends StyleSchema> = PartialBlocksWithoutChildren<BSchema, I, S>[BType] & {
-    children?: Block<BSchema, I, S>[];
-};
-export type PartialBlockFromConfig<B extends BlockConfig, I extends InlineContentSchema, S extends StyleSchema> = PartialBlockFromConfigNoChildren<B, I, S> & {
-    children?: Block<BlockSchema, I, S>[];
-};
-export type BlockIdentifier = {
-    id: string;
-} | string;
-export {};

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

@@ -1,8 +0,0 @@
-import { Block, BlockSchema } from "./blocks/types";
-import { InlineContentSchema } from "./inlineContent/types";
-import { StyleSchema } from "./styles/types";
-export type TextCursorPosition<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema> = {
-    block: Block<BSchema, I, S>;
-    prevBlock: Block<BSchema, I, S> | undefined;
-    nextBlock: Block<BSchema, I, S> | undefined;
-};