@blocknote/core 0.30.1 → 0.31.0

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

@@ -0,0 +1,541 @@
+import { BlockNoteSchema } from "../../editor/BlockNoteSchema.js";
+export declare const schema: BlockNoteSchema<import("../../index.js").BlockSchemaFromSpecs<{
+    customParagraph: any;
+    paragraph: {
+        config: {
+            type: "paragraph";
+            content: "inline";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        };
+        implementation: import("../../index.js").TiptapBlockImplementation<{
+            type: "paragraph";
+            content: "inline";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        }, any, import("../../index.js").InlineContentSchema, import("../../index.js").StyleSchema>;
+    };
+    heading: {
+        config: {
+            type: "heading";
+            content: "inline";
+            propSchema: {
+                level: {
+                    default: number;
+                    values: readonly [1, 2, 3];
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        };
+        implementation: import("../../index.js").TiptapBlockImplementation<{
+            type: "heading";
+            content: "inline";
+            propSchema: {
+                level: {
+                    default: number;
+                    values: readonly [1, 2, 3];
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        }, any, import("../../index.js").InlineContentSchema, import("../../index.js").StyleSchema>;
+    };
+    quote: {
+        config: {
+            type: "quote";
+            content: "inline";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        };
+        implementation: import("../../index.js").TiptapBlockImplementation<{
+            type: "quote";
+            content: "inline";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        }, any, import("../../index.js").InlineContentSchema, import("../../index.js").StyleSchema>;
+    };
+    codeBlock: {
+        config: {
+            type: "codeBlock";
+            content: "inline";
+            propSchema: {
+                language: {
+                    default: string;
+                };
+            };
+        };
+        implementation: import("../../index.js").TiptapBlockImplementation<{
+            type: "codeBlock";
+            content: "inline";
+            propSchema: {
+                language: {
+                    default: string;
+                };
+            };
+        }, any, import("../../index.js").InlineContentSchema, import("../../index.js").StyleSchema>;
+    };
+    bulletListItem: {
+        config: {
+            type: "bulletListItem";
+            content: "inline";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        };
+        implementation: import("../../index.js").TiptapBlockImplementation<{
+            type: "bulletListItem";
+            content: "inline";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        }, any, import("../../index.js").InlineContentSchema, import("../../index.js").StyleSchema>;
+    };
+    numberedListItem: {
+        config: {
+            type: "numberedListItem";
+            content: "inline";
+            propSchema: {
+                start: {
+                    default: undefined;
+                    type: "number";
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        };
+        implementation: import("../../index.js").TiptapBlockImplementation<{
+            type: "numberedListItem";
+            content: "inline";
+            propSchema: {
+                start: {
+                    default: undefined;
+                    type: "number";
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        }, any, import("../../index.js").InlineContentSchema, import("../../index.js").StyleSchema>;
+    };
+    checkListItem: {
+        config: {
+            type: "checkListItem";
+            content: "inline";
+            propSchema: {
+                checked: {
+                    default: false;
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        };
+        implementation: import("../../index.js").TiptapBlockImplementation<{
+            type: "checkListItem";
+            content: "inline";
+            propSchema: {
+                checked: {
+                    default: false;
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                textColor: {
+                    default: "default";
+                };
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+            };
+        }, any, import("../../index.js").InlineContentSchema, import("../../index.js").StyleSchema>;
+    };
+    table: {
+        config: {
+            type: "table";
+            content: "table";
+            propSchema: {
+                textColor: {
+                    default: "default";
+                };
+            };
+        };
+        implementation: import("../../index.js").TiptapBlockImplementation<{
+            type: "table";
+            content: "table";
+            propSchema: {
+                textColor: {
+                    default: "default";
+                };
+            };
+        }, any, import("../../index.js").InlineContentSchema, import("../../index.js").StyleSchema>;
+    };
+    file: {
+        config: {
+            type: "file";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+        };
+        implementation: import("../../index.js").TiptapBlockImplementation<{
+            type: "file";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+        }, any, import("../../index.js").InlineContentSchema, import("../../index.js").StyleSchema>;
+    };
+    image: {
+        config: {
+            type: "image";
+            propSchema: {
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+                showPreview: {
+                    default: true;
+                };
+                previewWidth: {
+                    default: number;
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+            fileBlockAccept: string[];
+        };
+        implementation: import("../../index.js").TiptapBlockImplementation<{
+            type: "image";
+            propSchema: {
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+                showPreview: {
+                    default: true;
+                };
+                previewWidth: {
+                    default: number;
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+            fileBlockAccept: string[];
+        }, any, import("../../index.js").InlineContentSchema, import("../../index.js").StyleSchema>;
+    };
+    video: {
+        config: {
+            type: "video";
+            propSchema: {
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+                showPreview: {
+                    default: true;
+                };
+                previewWidth: {
+                    default: number;
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+            fileBlockAccept: string[];
+        };
+        implementation: import("../../index.js").TiptapBlockImplementation<{
+            type: "video";
+            propSchema: {
+                textAlignment: {
+                    default: "left";
+                    values: readonly ["left", "center", "right", "justify"];
+                };
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+                showPreview: {
+                    default: true;
+                };
+                previewWidth: {
+                    default: number;
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+            fileBlockAccept: string[];
+        }, any, import("../../index.js").InlineContentSchema, import("../../index.js").StyleSchema>;
+    };
+    audio: {
+        config: {
+            type: "audio";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+                showPreview: {
+                    default: true;
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+            fileBlockAccept: string[];
+        };
+        implementation: import("../../index.js").TiptapBlockImplementation<{
+            type: "audio";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+                showPreview: {
+                    default: true;
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+            fileBlockAccept: string[];
+        }, any, import("../../index.js").InlineContentSchema, import("../../index.js").StyleSchema>;
+    };
+}>, import("../../index.js").InlineContentSchemaFromSpecs<{
+    text: {
+        config: "text";
+        implementation: any;
+    };
+    link: {
+        config: "link";
+        implementation: any;
+    };
+}>, import("../../index.js").StyleSchemaFromSpecs<{
+    bold: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../index.js").StyleImplementation;
+    };
+    italic: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../index.js").StyleImplementation;
+    };
+    underline: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../index.js").StyleImplementation;
+    };
+    strike: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../index.js").StyleImplementation;
+    };
+    code: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../index.js").StyleImplementation;
+    };
+    textColor: {
+        config: {
+            type: string;
+            propSchema: "string";
+        };
+        implementation: import("../../index.js").StyleImplementation;
+    };
+    backgroundColor: {
+        config: {
+            type: string;
+            propSchema: "string";
+        };
+        implementation: import("../../index.js").StyleImplementation;
+    };
+}>>;

package/types/src/api/exporters/html/htmlConversion.test.d.ts

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

package/types/src/api/exporters/markdown/markdownExporter.test.d.ts

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

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

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

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

@@ -1,6 +1,6 @@
-import { Node, Schema } from "@tiptap/pm/model";
-import type { BlockSchema, InlineContent, InlineContentSchema, StyleSchema, TableContent } from "../../schema/index.js";
+import { Node, Schema, Slice } from "@tiptap/pm/model";
 import type { Block } from "../../blocks/defaultBlocks.js";
+import type { BlockSchema, InlineContent, InlineContentSchema, StyleSchema, TableContent } from "../../schema/index.js";
 /**
  * Converts an internal (prosemirror) table node contentto a BlockNote Tablecontent
  */
@@ -16,3 +16,40 @@ export declare function nodeToCustomInlineContent<I extends InlineContentSchema,
  * TODO: test changes
  */
 export declare function nodeToBlock<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(node: Node, schema: Schema, blockSchema?: BSchema, inlineContentSchema?: I, styleSchema?: S, blockCache?: import("../../index.js").BlockCache<any, any, any>): Block<BSchema, I, S>;
+/**
+ * Convert a Prosemirror document to a BlockNote document (array of blocks)
+ */
+export declare function docToBlocks<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(doc: Node, schema: Schema, blockSchema?: BSchema, inlineContentSchema?: I, styleSchema?: S, blockCache?: import("../../index.js").BlockCache<any, any, any>): Block<BSchema, I, S>[];
+/**
+ *
+ * Parse a Prosemirror Slice into a BlockNote selection. The prosemirror schema looks like this:
+ *
+ * <blockGroup>
+ *   <blockContainer> (main content of block)
+ *       <p, heading, etc.>
+ *   <blockGroup> (only if blocks has children)
+ *     <blockContainer> (child block)
+ *       <p, heading, etc.>
+ *     </blockContainer>
+ *    <blockContainer> (child block 2)
+ *       <p, heading, etc.>
+ *     </blockContainer>
+ *   </blockContainer>
+ *  </blockGroup>
+ * </blockGroup>
+ *
+ */
+export declare function prosemirrorSliceToSlicedBlocks<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(slice: Slice, schema: Schema, blockSchema?: BSchema, inlineContentSchema?: I, styleSchema?: S, blockCache?: WeakMap<Node, Block<BSchema, I, S>>): {
+    /**
+     * The blocks that are included in the selection.
+     */
+    blocks: Block<BSchema, I, S>[];
+    /**
+     * If a block was "cut" at the start of the selection, this will be the id of the block that was cut.
+     */
+    blockCutAtStart: string | undefined;
+    /**
+     * If a block was "cut" at the end of the selection, this will be the id of the block that was cut.
+     */
+    blockCutAtEnd: string | undefined;
+};

package/types/src/api/parsers/html/parseHTML.test.d.ts

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

package/types/src/api/parsers/markdown/parseMarkdown.test.d.ts

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

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

@@ -1,10 +1,10 @@
 import type { Node, Schema } from "prosemirror-model";
-import type { Transaction } from "prosemirror-state";
+import { Transform } from "prosemirror-transform";
+import { BlockNoteSchema } from "../editor/BlockNoteSchema.js";
 import type { BlockSchema } from "../schema/blocks/types.js";
 import type { InlineContentSchema } from "../schema/inlineContent/types.js";
 import type { StyleSchema } from "../schema/styles/types.js";
-import { BlockNoteSchema } from "../editor/BlockNoteSchema.js";
-export declare function getPmSchema(trOrNode: Transaction | Node): Schema<any, any>;
+export declare function getPmSchema(trOrNode: Transform | Node): Schema<any, any>;
 export declare function getBlockNoteSchema<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(schema: Schema): BlockNoteSchema<BSchema, I, S>;
 export declare function getBlockSchema<BSchema extends BlockSchema>(schema: Schema): BSchema;
 export declare function getInlineContentSchema<I extends InlineContentSchema>(schema: Schema): I;