@blocknote/core 0.11.2 → 0.12.1

package/src/schema/blocks/types.ts

@@ -1,18 +1,18 @@
 /** Define the main block types **/
-import { Extension, Node } from "@tiptap/core";
+import type { Extension, Node } from "@tiptap/core";
 
 import type { BlockNoteEditor } from "../../editor/BlockNoteEditor";
-import {
+import type {
   InlineContent,
   InlineContentSchema,
   PartialInlineContent,
 } from "../inlineContent/types";
-import { PropSchema, Props } from "../propTypes";
-import { StyleSchema } from "../styles/types";
+import type { PropSchema, Props } from "../propTypes";
+import type { StyleSchema } from "../styles/types";
 
 export type BlockNoteDOMElement =
   | "editor"
-  | "blockContainer"
+  | "block"
   | "blockGroup"
   | "blockContent"
   | "inlineContent";
@@ -41,7 +41,7 @@ export type TiptapBlockImplementation<
   node: Node;
   toInternalHTML: (
     block: BlockFromConfigNoChildren<T, I, S> & {
-      children: Block<B, I, S>[];
+      children: BlockNoDefaults<B, I, S>[];
     },
     editor: BlockNoteEditor<B, I, S>
   ) => {
@@ -50,7 +50,7 @@ export type TiptapBlockImplementation<
   };
   toExternalHTML: (
     block: BlockFromConfigNoChildren<T, I, S> & {
-      children: Block<B, I, S>[];
+      children: BlockNoDefaults<B, I, S>[];
     },
     editor: BlockNoteEditor<B, I, S>
   ) => {
@@ -142,7 +142,7 @@ export type BlockFromConfig<
   I extends InlineContentSchema,
   S extends StyleSchema
 > = BlockFromConfigNoChildren<B, I, S> & {
-  children: Block<BlockSchema, I, S>[];
+  children: BlockNoDefaults<BlockSchema, I, S>[];
 };
 
 // Converts each block spec into a Block object without children. We later merge
@@ -158,12 +158,12 @@ type BlocksWithoutChildren<
 
 // Converts each block spec into a Block object without children, merges them
 // into a union type, and adds a children property
-export type Block<
+export type BlockNoDefaults<
   BSchema extends BlockSchema,
   I extends InlineContentSchema,
   S extends StyleSchema
 > = BlocksWithoutChildren<BSchema, I, S>[keyof BSchema] & {
-  children: Block<BSchema, I, S>[];
+  children: BlockNoDefaults<BSchema, I, S>[];
 };
 
 export type SpecificBlock<
@@ -172,7 +172,7 @@ export type SpecificBlock<
   I extends InlineContentSchema,
   S extends StyleSchema
 > = BlocksWithoutChildren<BSchema, I, S>[BType] & {
-  children: Block<BSchema, I, S>[];
+  children: BlockNoDefaults<BSchema, I, S>[];
 };
 
 /** CODE FOR PARTIAL BLOCKS, analogous to above
@@ -219,7 +219,7 @@ type PartialBlocksWithoutChildren<
   >;
 };
 
-export type PartialBlock<
+export type PartialBlockNoDefaults<
   BSchema extends BlockSchema,
   I extends InlineContentSchema,
   S extends StyleSchema
@@ -229,7 +229,7 @@ export type PartialBlock<
   S
 >[keyof PartialBlocksWithoutChildren<BSchema, I, S>] &
   Partial<{
-    children: PartialBlock<BSchema, I, S>[];
+    children: PartialBlockNoDefaults<BSchema, I, S>[];
   }>;
 
 export type SpecificPartialBlock<
@@ -238,7 +238,7 @@ export type SpecificPartialBlock<
   BType extends keyof BSchema,
   S extends StyleSchema
 > = PartialBlocksWithoutChildren<BSchema, I, S>[BType] & {
-  children?: Block<BSchema, I, S>[];
+  children?: BlockNoDefaults<BSchema, I, S>[];
 };
 
 export type PartialBlockFromConfig<
@@ -246,7 +246,7 @@ export type PartialBlockFromConfig<
   I extends InlineContentSchema,
   S extends StyleSchema
 > = PartialBlockFromConfigNoChildren<B, I, S> & {
-  children?: Block<BlockSchema, I, S>[];
+  children?: BlockNoDefaults<BlockSchema, I, S>[];
 };
 
 export type BlockIdentifier = { id: string } | string;

package/src/schema/inlineContent/createSpec.ts

@@ -98,8 +98,8 @@ export function createInlineContentSpec<
       const output = inlineContentImplementation.render(
         nodeToCustomInlineContent(
           node,
-          editor.inlineContentSchema,
-          editor.styleSchema
+          editor.schema.inlineContentSchema,
+          editor.schema.styleSchema
         ) as any as InlineContentFromConfig<T, S> // TODO: fix cast
       );
 

package/src/schema/inlineContent/types.ts

@@ -74,7 +74,7 @@ export type PartialCustomInlineContentFromConfig<
 > = {
   type: I["type"];
   props?: Props<I["propSchema"]>;
-  content: I["content"] extends "styled"
+  content?: I["content"] extends "styled"
     ? StyledText<S>[] | string
     : I["content"] extends "plain"
     ? string

package/src/util/browser.ts

@@ -1,8 +1,8 @@
 export const isAppleOS = () =>
-    typeof navigator !== "undefined" &&
-    (/Mac/.test(navigator.platform) ||
-        (/AppleWebKit/.test(navigator.userAgent) &&
-            /Mobile\/\w+/.test(navigator.userAgent)));
+  typeof navigator !== "undefined" &&
+  (/Mac/.test(navigator.platform) ||
+    (/AppleWebKit/.test(navigator.userAgent) &&
+      /Mobile\/\w+/.test(navigator.userAgent)));
 
 export function formatKeyboardShortcut(shortcut: string) {
   if (isAppleOS()) {
@@ -16,3 +16,5 @@ export function mergeCSSClasses(...classes: string[]) {
   return classes.filter((c) => c).join(" ");
 }
 
+export const isSafari = () =>
+  /^((?!chrome|android).)*safari/i.test(navigator.userAgent);

package/src/util/typescript.ts

@@ -1,5 +1,8 @@
 export class UnreachableCaseError extends Error {
-    constructor(val: never) {
-        super(`Unreachable case: ${val}`);
-    }
-}
+  constructor(val: never) {
+    super(`Unreachable case: ${val}`);
+  }
+}
+
+// TODO: change for built-in version of typescript 5.4 after upgrade
+export type NoInfer<T> = [T][T extends any ? 0 : never];

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

@@ -1,5 +1,7 @@
+import { Node } from "prosemirror-model";
+import { Block, PartialBlock } from "../../blocks/defaultBlocks";
 import type { BlockNoteEditor } from "../../editor/BlockNoteEditor";
-import { Block, BlockIdentifier, BlockSchema, InlineContentSchema, PartialBlock, StyleSchema } from "../../schema";
+import { BlockIdentifier, BlockSchema, InlineContentSchema, StyleSchema } from "../../schema";
 export declare function insertBlocks<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(blocksToInsert: PartialBlock<BSchema, I, S>[], referenceBlock: BlockIdentifier, placement: "before" | "after" | "nested" | undefined, editor: BlockNoteEditor<BSchema, I, S>): Block<BSchema, I, S>[];
 export declare function updateBlock<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(blockToUpdate: BlockIdentifier, update: PartialBlock<BSchema, I, S>, editor: BlockNoteEditor<BSchema, I, S>): Block<BSchema, I, S>;
 export declare function removeBlocks<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(blocksToRemove: BlockIdentifier[], editor: BlockNoteEditor<BSchema, I, S>): Block<BSchema, I, S>[];
@@ -7,3 +9,6 @@ export declare function replaceBlocks<BSchema extends BlockSchema, I extends Inl
     insertedBlocks: Block<BSchema, I, S>[];
     removedBlocks: Block<BSchema, I, S>[];
 };
+export declare function insertContentAt<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(position: any, nodes: Node[], editor: BlockNoteEditor<BSchema, I, S>, options?: {
+    updateSelection: boolean;
+}): boolean;

package/types/src/api/exporters/html/externalHTMLExporter.d.ts

@@ -1,6 +1,7 @@
 import { Fragment, Schema } from "prosemirror-model";
+import { PartialBlock } from "../../../blocks/defaultBlocks";
 import type { BlockNoteEditor } from "../../../editor/BlockNoteEditor";
-import { BlockSchema, InlineContentSchema, PartialBlock, StyleSchema } from "../../../schema";
+import { BlockSchema, InlineContentSchema, StyleSchema } from "../../../schema";
 export interface ExternalHTMLExporter<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema> {
     exportBlocks: (blocks: PartialBlock<BSchema, I, S>[]) => string;
     exportProseMirrorFragment: (fragment: Fragment) => string;

package/types/src/api/exporters/html/internalHTMLSerializer.d.ts

@@ -1,6 +1,7 @@
 import { Fragment, Schema } from "prosemirror-model";
+import { PartialBlock } from "../../../blocks/defaultBlocks";
 import type { BlockNoteEditor } from "../../../editor/BlockNoteEditor";
-import { BlockSchema, InlineContentSchema, PartialBlock, StyleSchema } from "../../../schema";
+import { BlockSchema, InlineContentSchema, StyleSchema } from "../../../schema";
 export interface InternalHTMLSerializer<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema> {
     serializeProseMirrorFragment: (fragment: Fragment) => string;
     serializeBlocks: (blocks: PartialBlock<BSchema, I, S>[]) => string;

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

@@ -1,5 +1,6 @@
 import { Schema } from "prosemirror-model";
+import { Block } from "../../../blocks/defaultBlocks";
 import type { BlockNoteEditor } from "../../../editor/BlockNoteEditor";
-import { Block, BlockSchema, InlineContentSchema, StyleSchema } from "../../../schema";
+import { BlockSchema, InlineContentSchema, StyleSchema } from "../../../schema";
 export declare function cleanHTMLToMarkdown(cleanHTMLString: string): string;
 export declare function blocksToMarkdown<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(blocks: Block<BSchema, I, S>[], schema: Schema, editor: BlockNoteEditor<BSchema, I, S>): string;

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

@@ -0,0 +1,2 @@
+import { Editor } from "@tiptap/core";
+export declare const getCurrentBlockContentType: (editor: Editor) => string | undefined;

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

@@ -1,5 +1,6 @@
 import { Node, Schema } from "@tiptap/pm/model";
-import type { Block, BlockSchema, InlineContent, InlineContentSchema, PartialBlock, PartialInlineContent, PartialTableContent, StyleSchema } from "../../schema";
+import type { BlockSchema, InlineContent, InlineContentSchema, PartialInlineContent, PartialTableContent, StyleSchema } from "../../schema";
+import type { Block, PartialBlock } from "../../blocks/defaultBlocks";
 /**
  * converts an array of inline content elements to prosemirror nodes
  */

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

@@ -1,3 +1,4 @@
 import { Schema } from "prosemirror-model";
-import { Block, BlockSchema, InlineContentSchema, StyleSchema } from "../../../schema";
+import { BlockSchema, InlineContentSchema, StyleSchema } from "../../../schema";
+import { Block } from "../../../blocks/defaultBlocks";
 export declare function HTMLToBlocks<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(html: string, blockSchema: BSchema, icSchema: I, styleSchema: S, pmSchema: Schema): Promise<Block<BSchema, I, S>[]>;

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

@@ -1,3 +1,4 @@
 import { Schema } from "prosemirror-model";
-import { Block, BlockSchema, InlineContentSchema, StyleSchema } from "../../../schema";
+import { Block } from "../../../blocks/defaultBlocks";
+import { BlockSchema, InlineContentSchema, StyleSchema } from "../../../schema";
 export declare function markdownToBlocks<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(markdown: string, blockSchema: BSchema, icSchema: I, styleSchema: S, pmSchema: Schema): Promise<Block<BSchema, I, S>[]>;

package/types/src/api/testUtil/cases/customBlocks.d.ts

@@ -1,7 +1,7 @@
 import { EditorTestCases } from "../index";
 import { DefaultInlineContentSchema, DefaultStyleSchema } from "../../../blocks/defaultBlocks";
-import { BlockSchemaFromSpecs } from "../../../schema/blocks/types";
-declare const customSpecs: {
+import { BlockNoteSchema } from "../../../editor/BlockNoteSchema";
+declare const schema: BlockNoteSchema<import("../../..").BlockSchemaFromSpecs<{
     simpleImage: {
         config: {
             type: "simpleImage";
@@ -25,7 +25,7 @@ declare const customSpecs: {
             };
             content: "none";
         };
-        implementation: import("../../../schema/blocks/types").TiptapBlockImplementation<{
+        implementation: import("../../..").TiptapBlockImplementation<{
             type: "simpleImage";
             propSchema: {
                 textAlignment: {
@@ -65,7 +65,7 @@ declare const customSpecs: {
             };
             content: "inline";
         };
-        implementation: import("../../../schema/blocks/types").TiptapBlockImplementation<{
+        implementation: import("../../..").TiptapBlockImplementation<{
             type: "customParagraph";
             propSchema: {
                 backgroundColor: {
@@ -99,7 +99,7 @@ declare const customSpecs: {
             };
             content: "inline";
         };
-        implementation: import("../../../schema/blocks/types").TiptapBlockImplementation<{
+        implementation: import("../../..").TiptapBlockImplementation<{
             type: "simpleCustomParagraph";
             propSchema: {
                 backgroundColor: {
@@ -133,7 +133,7 @@ declare const customSpecs: {
                 };
             };
         };
-        implementation: import("../../../schema/blocks/types").TiptapBlockImplementation<{
+        implementation: import("../../..").TiptapBlockImplementation<{
             type: "paragraph";
             content: "inline";
             propSchema: {
@@ -171,7 +171,7 @@ declare const customSpecs: {
                 };
             };
         };
-        implementation: import("../../../schema/blocks/types").TiptapBlockImplementation<{
+        implementation: import("../../..").TiptapBlockImplementation<{
             type: "heading";
             content: "inline";
             propSchema: {
@@ -209,7 +209,7 @@ declare const customSpecs: {
                 };
             };
         };
-        implementation: import("../../../schema/blocks/types").TiptapBlockImplementation<{
+        implementation: import("../../..").TiptapBlockImplementation<{
             type: "bulletListItem";
             content: "inline";
             propSchema: {
@@ -243,7 +243,7 @@ declare const customSpecs: {
                 };
             };
         };
-        implementation: import("../../../schema/blocks/types").TiptapBlockImplementation<{
+        implementation: import("../../..").TiptapBlockImplementation<{
             type: "numberedListItem";
             content: "inline";
             propSchema: {
@@ -283,7 +283,7 @@ declare const customSpecs: {
             };
             content: "none";
         };
-        implementation: import("../../../schema/blocks/types").TiptapBlockImplementation<{
+        implementation: import("../../..").TiptapBlockImplementation<{
             type: "image";
             propSchema: {
                 textAlignment: {
@@ -323,7 +323,7 @@ declare const customSpecs: {
                 };
             };
         };
-        implementation: import("../../../schema/blocks/types").TiptapBlockImplementation<{
+        implementation: import("../../..").TiptapBlockImplementation<{
             type: "table";
             content: "table";
             propSchema: {
@@ -340,6 +340,65 @@ declare const customSpecs: {
             };
         }, any, import("../../..").InlineContentSchema, import("../../..").StyleSchema>;
     };
-};
-export declare const customBlocksTestCases: EditorTestCases<BlockSchemaFromSpecs<typeof customSpecs>, DefaultInlineContentSchema, DefaultStyleSchema>;
+}>, import("../../..").InlineContentSchemaFromSpecs<{
+    text: {
+        config: "text";
+        implementation: any;
+    };
+    link: {
+        config: "link";
+        implementation: any;
+    };
+}>, import("../../..").StyleSchemaFromSpecs<{
+    bold: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../..").StyleImplementation;
+    };
+    italic: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../..").StyleImplementation;
+    };
+    underline: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../..").StyleImplementation;
+    };
+    strike: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../..").StyleImplementation;
+    };
+    code: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../..").StyleImplementation;
+    };
+    textColor: {
+        config: {
+            type: string;
+            propSchema: "string";
+        };
+        implementation: import("../../..").StyleImplementation;
+    };
+    backgroundColor: {
+        config: {
+            type: string;
+            propSchema: "string";
+        };
+        implementation: import("../../..").StyleImplementation;
+    };
+}>>;
+export declare const customBlocksTestCases: EditorTestCases<typeof schema.blockSchema, DefaultInlineContentSchema, DefaultStyleSchema>;
 export {};