@blocknote/core 0.29.1 → 0.30.1

package/src/schema/blocks/types.ts

@@ -45,7 +45,8 @@ export type FileBlockConfig = {
     };
     // File preview width in px.
     previewWidth?: {
-      default: number;
+      default: undefined;
+      type: "number";
     };
   };
   content: "none";
@@ -73,7 +74,7 @@ export type TiptapBlockImplementation<
   T extends BlockConfig,
   B extends BlockSchema,
   I extends InlineContentSchema,
-  S extends StyleSchema
+  S extends StyleSchema,
 > = {
   requiredExtensions?: Array<Extension | Node>;
   node: Node;
@@ -81,7 +82,7 @@ export type TiptapBlockImplementation<
     block: BlockFromConfigNoChildren<T, I, S> & {
       children: BlockNoDefaults<B, I, S>[];
     },
-    editor: BlockNoteEditor<B, I, S>
+    editor: BlockNoteEditor<B, I, S>,
   ) => {
     dom: HTMLElement;
     contentDOM?: HTMLElement;
@@ -90,7 +91,7 @@ export type TiptapBlockImplementation<
     block: BlockFromConfigNoChildren<T, I, S> & {
       children: BlockNoDefaults<B, I, S>[];
     },
-    editor: BlockNoteEditor<B, I, S>
+    editor: BlockNoteEditor<B, I, S>,
   ) => {
     dom: HTMLElement;
     contentDOM?: HTMLElement;
@@ -102,7 +103,7 @@ export type BlockSpec<
   T extends BlockConfig,
   B extends BlockSchema,
   I extends InlineContentSchema,
-  S extends StyleSchema
+  S extends StyleSchema,
 > = {
   config: T;
   implementation: TiptapBlockImplementation<NoInfer<T>, B, I, S>;
@@ -140,7 +141,7 @@ export type BlockSchemaFromSpecs<T extends BlockSpecs> = {
 
 export type BlockSchemaWithBlock<
   BType extends string,
-  C extends BlockConfig
+  C extends BlockConfig,
 > = {
   [k in BType]: C;
 };
@@ -155,7 +156,7 @@ export type TableCellProps = {
 
 export type TableCell<
   I extends InlineContentSchema,
-  S extends StyleSchema = StyleSchema
+  S extends StyleSchema = StyleSchema,
 > = {
   type: "tableCell";
   props: TableCellProps;
@@ -164,7 +165,7 @@ export type TableCell<
 
 export type TableContent<
   I extends InlineContentSchema,
-  S extends StyleSchema = StyleSchema
+  S extends StyleSchema = StyleSchema,
 > = {
   type: "tableContent";
   columnWidths: (number | undefined)[];
@@ -181,7 +182,7 @@ export type TableContent<
 export type BlockFromConfigNoChildren<
   B extends BlockConfig,
   I extends InlineContentSchema,
-  S extends StyleSchema
+  S extends StyleSchema,
 > = {
   id: string;
   type: B["type"];
@@ -189,16 +190,16 @@ export type BlockFromConfigNoChildren<
   content: B["content"] extends "inline"
     ? InlineContent<I, S>[]
     : B["content"] extends "table"
-    ? TableContent<I, S>
-    : B["content"] extends "none"
-    ? undefined
-    : never;
+      ? TableContent<I, S>
+      : B["content"] extends "none"
+        ? undefined
+        : never;
 };
 
 export type BlockFromConfig<
   B extends BlockConfig,
   I extends InlineContentSchema,
-  S extends StyleSchema
+  S extends StyleSchema,
 > = BlockFromConfigNoChildren<B, I, S> & {
   children: BlockNoDefaults<BlockSchema, I, S>[];
 };
@@ -209,7 +210,7 @@ export type BlockFromConfig<
 type BlocksWithoutChildren<
   BSchema extends BlockSchema,
   I extends InlineContentSchema,
-  S extends StyleSchema
+  S extends StyleSchema,
 > = {
   [BType in keyof BSchema]: BlockFromConfigNoChildren<BSchema[BType], I, S>;
 };
@@ -219,7 +220,7 @@ type BlocksWithoutChildren<
 export type BlockNoDefaults<
   BSchema extends BlockSchema,
   I extends InlineContentSchema,
-  S extends StyleSchema
+  S extends StyleSchema,
 > = BlocksWithoutChildren<BSchema, I, S>[keyof BSchema] & {
   children: BlockNoDefaults<BSchema, I, S>[];
 };
@@ -228,7 +229,7 @@ export type SpecificBlock<
   BSchema extends BlockSchema,
   BType extends keyof BSchema,
   I extends InlineContentSchema,
-  S extends StyleSchema
+  S extends StyleSchema,
 > = BlocksWithoutChildren<BSchema, I, S>[BType] & {
   children: BlockNoDefaults<BSchema, I, S>[];
 };
@@ -242,7 +243,7 @@ export type SpecificBlock<
 
 export type PartialTableCell<
   I extends InlineContentSchema,
-  S extends StyleSchema = StyleSchema
+  S extends StyleSchema = StyleSchema,
 > = {
   type: "tableCell";
   props?: Partial<TableCellProps>;
@@ -251,7 +252,7 @@ export type PartialTableCell<
 
 export type PartialTableContent<
   I extends InlineContentSchema,
-  S extends StyleSchema = StyleSchema
+  S extends StyleSchema = StyleSchema,
 > = {
   type: "tableContent";
   columnWidths?: (number | undefined)[];
@@ -265,7 +266,7 @@ export type PartialTableContent<
 type PartialBlockFromConfigNoChildren<
   B extends BlockConfig,
   I extends InlineContentSchema,
-  S extends StyleSchema
+  S extends StyleSchema,
 > = {
   id?: string;
   type?: B["type"];
@@ -273,14 +274,14 @@ type PartialBlockFromConfigNoChildren<
   content?: B["content"] extends "inline"
     ? PartialInlineContent<I, S>
     : B["content"] extends "table"
-    ? PartialTableContent<I, S>
-    : undefined;
+      ? PartialTableContent<I, S>
+      : undefined;
 };
 
 type PartialBlocksWithoutChildren<
   BSchema extends BlockSchema,
   I extends InlineContentSchema,
-  S extends StyleSchema
+  S extends StyleSchema,
 > = {
   [BType in keyof BSchema]: PartialBlockFromConfigNoChildren<
     BSchema[BType],
@@ -292,7 +293,7 @@ type PartialBlocksWithoutChildren<
 export type PartialBlockNoDefaults<
   BSchema extends BlockSchema,
   I extends InlineContentSchema,
-  S extends StyleSchema
+  S extends StyleSchema,
 > = PartialBlocksWithoutChildren<
   BSchema,
   I,
@@ -306,7 +307,7 @@ export type SpecificPartialBlock<
   BSchema extends BlockSchema,
   I extends InlineContentSchema,
   BType extends keyof BSchema,
-  S extends StyleSchema
+  S extends StyleSchema,
 > = PartialBlocksWithoutChildren<BSchema, I, S>[BType] & {
   children?: BlockNoDefaults<BSchema, I, S>[];
 };
@@ -314,7 +315,7 @@ export type SpecificPartialBlock<
 export type PartialBlockFromConfig<
   B extends BlockConfig,
   I extends InlineContentSchema,
-  S extends StyleSchema
+  S extends StyleSchema,
 > = PartialBlockFromConfigNoChildren<B, I, S> & {
   children?: BlockNoDefaults<BlockSchema, I, S>[];
 };

package/src/schema/inlineContent/createSpec.ts

@@ -25,7 +25,7 @@ export type CustomInlineContentImplementation<
   T extends CustomInlineContentConfig,
   // B extends BlockSchema,
   // I extends InlineContentSchema,
-  S extends StyleSchema
+  S extends StyleSchema,
 > = {
   render: (
     /**
@@ -33,14 +33,14 @@ export type CustomInlineContentImplementation<
      */
     inlineContent: InlineContentFromConfig<T, S>,
     updateInlineContent: (
-      update: PartialCustomInlineContentFromConfig<T, S>
+      update: PartialCustomInlineContentFromConfig<T, S>,
     ) => void,
     /**
      * 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<any, any, S>
+    editor: BlockNoteEditor<any, any, S>,
     // (note) if we want to fix the manual cast, we need to prevent circular references and separate block definition and render implementations
     // or allow manually passing <BSchema>, but that's not possible without passing the other generics because Typescript doesn't support partial inferred generics
   ) => {
@@ -51,7 +51,7 @@ export type CustomInlineContentImplementation<
 };
 
 export function getInlineContentParseRules(
-  config: CustomInlineContentConfig
+  config: CustomInlineContentConfig,
 ): TagParseRule[] {
   return [
     {
@@ -71,10 +71,10 @@ export function getInlineContentParseRules(
 
 export function createInlineContentSpec<
   T extends CustomInlineContentConfig,
-  S extends StyleSchema
+  S extends StyleSchema,
 >(
   inlineContentConfig: T,
-  inlineContentImplementation: CustomInlineContentImplementation<T, S>
+  inlineContentImplementation: CustomInlineContentImplementation<T, S>,
 ): InlineContentSpec<T> {
   const node = Node.create({
     name: inlineContentConfig.type,
@@ -105,31 +105,31 @@ export function createInlineContentSpec<
         nodeToCustomInlineContent(
           node,
           editor.schema.inlineContentSchema,
-          editor.schema.styleSchema
+          editor.schema.styleSchema,
         ) as any as InlineContentFromConfig<T, S>, // TODO: fix cast
         () => {
           // No-op
         },
-        editor
+        editor,
       );
 
       return addInlineContentAttributes(
         output,
         inlineContentConfig.type,
         node.attrs as Props<T["propSchema"]>,
-        inlineContentConfig.propSchema
+        inlineContentConfig.propSchema,
       );
     },
 
     addNodeView() {
       return ({ node, getPos }) => {
-        const editor = this.options.editor;
+        const editor = this.options.editor as BlockNoteEditor<any, any, S>;
 
         const output = inlineContentImplementation.render(
           nodeToCustomInlineContent(
             node,
             editor.schema.inlineContentSchema,
-            editor.schema.styleSchema
+            editor.schema.styleSchema,
           ) as any as InlineContentFromConfig<T, S>, // TODO: fix cast
           (update) => {
             if (typeof getPos === "boolean") {
@@ -138,22 +138,18 @@ export function createInlineContentSpec<
 
             const content = inlineContentToNodes([update], editor.pmSchema);
 
-            editor.dispatch(
-              editor.prosemirrorView.state.tr.replaceWith(
-                getPos(),
-                getPos() + node.nodeSize,
-                content
-              )
+            editor.transact((tr) =>
+              tr.replaceWith(getPos(), getPos() + node.nodeSize, content),
             );
           },
-          editor
+          editor,
         );
 
         return addInlineContentAttributes(
           output,
           inlineContentConfig.type,
           node.attrs as Props<T["propSchema"]>,
-          inlineContentConfig.propSchema
+          inlineContentConfig.propSchema,
         );
       };
     },
@@ -161,6 +157,6 @@ export function createInlineContentSpec<
 
   return createInlineContentSpecFromTipTapNode(
     node,
-    inlineContentConfig.propSchema
+    inlineContentConfig.propSchema,
   ) as InlineContentSpec<T>; // TODO: fix cast
 }

package/src/schema/inlineContent/internal.ts

@@ -16,7 +16,7 @@ import {
 // is lost on internal copy & paste.
 export function addInlineContentAttributes<
   IType extends string,
-  PSchema extends PropSchema
+  PSchema extends PropSchema,
 >(
   element: {
     dom: HTMLElement;
@@ -24,7 +24,7 @@ export function addInlineContentAttributes<
   },
   inlineContentType: IType,
   inlineContentProps: Props<PSchema>,
-  propSchema: PSchema
+  propSchema: PSchema,
 ): {
   dom: HTMLElement;
   contentDOM?: HTMLElement;
@@ -52,9 +52,9 @@ export function addInlineContentAttributes<
 
 // see https://github.com/TypeCellOS/BlockNote/pull/435
 export function addInlineContentKeyboardShortcuts<
-  T extends CustomInlineContentConfig
+  T extends CustomInlineContentConfig,
 >(
-  config: T
+  config: T,
 ): {
   [p: string]: KeyboardShortcutCommand;
 } {
@@ -75,7 +75,7 @@ export function addInlineContentKeyboardShortcuts<
 // config and implementation that conform to the type of Config
 export function createInternalInlineContentSpec<T extends InlineContentConfig>(
   config: T,
-  implementation: InlineContentImplementation<T>
+  implementation: InlineContentImplementation<T>,
 ) {
   return {
     config,
@@ -85,7 +85,7 @@ export function createInternalInlineContentSpec<T extends InlineContentConfig>(
 
 export function createInlineContentSpecFromTipTapNode<
   T extends Node,
-  P extends PropSchema
+  P extends PropSchema,
 >(node: T, propSchema: P) {
   return createInternalInlineContentSpec(
     {
@@ -95,14 +95,14 @@ export function createInlineContentSpecFromTipTapNode<
     },
     {
       node,
-    }
+    },
   );
 }
 
 export function getInlineContentSchemaFromSpecs<T extends InlineContentSpecs>(
-  specs: T
+  specs: T,
 ) {
   return Object.fromEntries(
-    Object.entries(specs).map(([key, value]) => [key, value.config])
+    Object.entries(specs).map(([key, value]) => [key, value.config]),
   ) as InlineContentSchemaFromSpecs<T>;
 }

package/src/schema/inlineContent/types.ts

@@ -44,55 +44,55 @@ export type InlineContentSchemaFromSpecs<T extends InlineContentSpecs> = {
 
 export type CustomInlineContentFromConfig<
   I extends CustomInlineContentConfig,
-  S extends StyleSchema
+  S extends StyleSchema,
 > = {
   type: I["type"];
   props: Props<I["propSchema"]>;
   content: I["content"] extends "styled"
     ? StyledText<S>[]
     : I["content"] extends "plain"
-    ? string
-    : I["content"] extends "none"
-    ? undefined
-    : never;
+      ? string
+      : I["content"] extends "none"
+        ? undefined
+        : never;
 };
 
 export type InlineContentFromConfig<
   I extends InlineContentConfig,
-  S extends StyleSchema
+  S extends StyleSchema,
 > = I extends "text"
   ? StyledText<S>
   : I extends "link"
-  ? Link<S>
-  : I extends CustomInlineContentConfig
-  ? CustomInlineContentFromConfig<I, S>
-  : never;
+    ? Link<S>
+    : I extends CustomInlineContentConfig
+      ? CustomInlineContentFromConfig<I, S>
+      : never;
 
 export type PartialCustomInlineContentFromConfig<
   I extends CustomInlineContentConfig,
-  S extends StyleSchema
+  S extends StyleSchema,
 > = {
   type: I["type"];
   props?: Props<I["propSchema"]>;
   content?: I["content"] extends "styled"
     ? StyledText<S>[] | string
     : I["content"] extends "plain"
-    ? string
-    : I["content"] extends "none"
-    ? undefined
-    : never;
+      ? string
+      : I["content"] extends "none"
+        ? undefined
+        : never;
 };
 
 export type PartialInlineContentFromConfig<
   I extends InlineContentConfig,
-  S extends StyleSchema
+  S extends StyleSchema,
 > = I extends "text"
   ? string | StyledText<S>
   : I extends "link"
-  ? PartialLink<S>
-  : I extends CustomInlineContentConfig
-  ? PartialCustomInlineContentFromConfig<I, S>
-  : never;
+    ? PartialLink<S>
+    : I extends CustomInlineContentConfig
+      ? PartialCustomInlineContentFromConfig<I, S>
+      : never;
 
 export type StyledText<T extends StyleSchema> = {
   type: "text";
@@ -112,33 +112,33 @@ export type PartialLink<T extends StyleSchema> = Omit<Link<T>, "content"> & {
 
 export type InlineContent<
   I extends InlineContentSchema,
-  T extends StyleSchema
+  T extends StyleSchema,
 > = InlineContentFromConfig<I[keyof I], T>;
 
 type PartialInlineContentElement<
   I extends InlineContentSchema,
-  T extends StyleSchema
+  T extends StyleSchema,
 > = PartialInlineContentFromConfig<I[keyof I], T>;
 
 export type PartialInlineContent<
   I extends InlineContentSchema,
-  T extends StyleSchema
+  T extends StyleSchema,
 > = PartialInlineContentElement<I, T>[] | string;
 
 export function isLinkInlineContent<T extends StyleSchema>(
-  content: InlineContent<any, T>
+  content: InlineContent<any, T>,
 ): content is Link<T> {
   return content.type === "link";
 }
 
 export function isPartialLinkInlineContent<T extends StyleSchema>(
-  content: PartialInlineContentElement<any, T>
+  content: PartialInlineContentElement<any, T>,
 ): content is PartialLink<T> {
   return typeof content !== "string" && content.type === "link";
 }
 
 export function isStyledTextInlineContent<T extends StyleSchema>(
-  content: PartialInlineContentElement<any, T>
+  content: PartialInlineContentElement<any, T>,
 ): content is StyledText<T> {
   return typeof content !== "string" && content.type === "text";
 }

package/src/schema/propTypes.ts

@@ -39,14 +39,14 @@ export type Props<PSchema extends PropSchema> = {
         ? PSchema[PName]["values"][number]
         : boolean
       : PSchema[PName] extends { default: number } | { type: "number" }
-      ? PSchema[PName]["values"] extends readonly number[]
-        ? PSchema[PName]["values"][number]
-        : number
-      : PSchema[PName] extends { default: string } | { type: "string" }
-      ? PSchema[PName]["values"] extends readonly string[]
-        ? PSchema[PName]["values"][number]
-        : string
-      : never
+        ? PSchema[PName]["values"] extends readonly number[]
+          ? PSchema[PName]["values"][number]
+          : number
+        : PSchema[PName] extends { default: string } | { type: "string" }
+          ? PSchema[PName]["values"] extends readonly string[]
+            ? PSchema[PName]["values"][number]
+            : string
+          : never
   ) extends infer T
     ? PSchema[PName] extends { optional: true }
       ? T | undefined

package/src/schema/styles/createSpec.ts

@@ -42,7 +42,7 @@ export function getStyleParseRules(config: StyleConfig): ParseRule[] {
 
 export function createStyleSpec<T extends StyleConfig>(
   styleConfig: T,
-  styleImplementation: CustomStyleImplementation<T>
+  styleImplementation: CustomStyleImplementation<T>,
 ): StyleSpec<T> {
   const mark = Mark.create({
     name: styleConfig.type,
@@ -75,7 +75,7 @@ export function createStyleSpec<T extends StyleConfig>(
         renderResult,
         styleConfig.type,
         mark.attrs.stringValue,
-        styleConfig.propSchema
+        styleConfig.propSchema,
       );
     },
   });

package/src/schema/styles/internal.ts

@@ -9,7 +9,7 @@ import {
 } from "./types.js";
 
 export function stylePropsToAttributes(
-  propSchema: StylePropSchema
+  propSchema: StylePropSchema,
 ): Attributes {
   if (propSchema === "boolean") {
     return {};
@@ -34,7 +34,7 @@ export function stylePropsToAttributes(
 // on internal copy & paste.
 export function addStyleAttributes<
   SType extends string,
-  PSchema extends StylePropSchema
+  PSchema extends StylePropSchema,
 >(
   element: {
     dom: HTMLElement;
@@ -42,7 +42,7 @@ export function addStyleAttributes<
   },
   styleType: SType,
   styleValue: PSchema extends "boolean" ? undefined : string,
-  propSchema: PSchema
+  propSchema: PSchema,
 ): {
   dom: HTMLElement;
   contentDOM?: HTMLElement;
@@ -66,7 +66,7 @@ export function addStyleAttributes<
 // config and implementation that conform to the type of Config
 export function createInternalStyleSpec<T extends StyleConfig>(
   config: T,
-  implementation: StyleImplementation
+  implementation: StyleImplementation,
 ) {
   return {
     config,
@@ -76,7 +76,7 @@ export function createInternalStyleSpec<T extends StyleConfig>(
 
 export function createStyleSpecFromTipTapMark<
   T extends Mark,
-  P extends StylePropSchema
+  P extends StylePropSchema,
 >(mark: T, propSchema: P) {
   return createInternalStyleSpec(
     {
@@ -85,12 +85,12 @@ export function createStyleSpecFromTipTapMark<
     },
     {
       mark,
-    }
+    },
   );
 }
 
 export function getStyleSchemaFromSpecs<T extends StyleSpecs>(specs: T) {
   return Object.fromEntries(
-    Object.entries(specs).map(([key, value]) => [key, value.config])
+    Object.entries(specs).map(([key, value]) => [key, value.config]),
   ) as StyleSchemaFromSpecs<T>;
 }

package/src/schema/styles/types.ts

@@ -37,6 +37,6 @@ export type Styles<T extends StyleSchema> = {
   [K in keyof T]?: T[K]["propSchema"] extends "boolean"
     ? boolean
     : T[K]["propSchema"] extends "string"
-    ? string
-    : never;
+      ? string
+      : never;
 };

package/src/util/EventEmitter.ts

@@ -3,11 +3,11 @@
 type StringKeyOf<T> = Extract<keyof T, string>;
 type CallbackType<
   T extends Record<string, any>,
-  EventName extends StringKeyOf<T>
+  EventName extends StringKeyOf<T>,
 > = T[EventName] extends any[] ? T[EventName] : [T[EventName]];
 type CallbackFunction<
   T extends Record<string, any>,
-  EventName extends StringKeyOf<T>
+  EventName extends StringKeyOf<T>,
 > = (...props: CallbackType<T, EventName>) => any;
 
 export class EventEmitter<T extends Record<string, any>> {
@@ -16,7 +16,7 @@ export class EventEmitter<T extends Record<string, any>> {
 
   public on<EventName extends StringKeyOf<T>>(
     event: EventName,
-    fn: CallbackFunction<T, EventName>
+    fn: CallbackFunction<T, EventName>,
   ) {
     if (!this.callbacks[event]) {
       this.callbacks[event] = [];
@@ -40,7 +40,7 @@ export class EventEmitter<T extends Record<string, any>> {
 
   public off<EventName extends StringKeyOf<T>>(
     event: EventName,
-    fn?: CallbackFunction<T, EventName>
+    fn?: CallbackFunction<T, EventName>,
   ) {
     const callbacks = this.callbacks[event];
 

package/src/util/README.md

@@ -1,3 +1,3 @@
 ### @blocknote/core/src/@util
 
-Contains generic utility files with helper functions / classes.
+Contains generic utility files with helper functions / classes.

package/src/util/combineByGroup.ts

@@ -12,7 +12,7 @@ export function combineByGroup<T extends { group?: string }>(
   for (const additionalItems of additionalItemsArray) {
     for (const additionalItem of additionalItems) {
       const lastItemWithSameGroup = combinedItems.findLastIndex(
-        (item) => item.group === additionalItem.group
+        (item) => item.group === additionalItem.group,
       );
       if (lastItemWithSameGroup === -1) {
         combinedItems.push(additionalItem as T);