@blocknote/core 0.21.0 → 0.23.0

package/src/schema/blocks/internal.ts

@@ -46,7 +46,10 @@ export function propsToAttributes(propSchema: PropSchema): Attributes {
             return null;
           }
 
-          if (typeof spec.default === "boolean") {
+          if (
+            (spec.default === undefined && spec.type === "boolean") ||
+            (spec.default !== undefined && typeof spec.default === "boolean")
+          ) {
             if (value === "true") {
               return true;
             }
@@ -58,7 +61,10 @@ export function propsToAttributes(propSchema: PropSchema): Attributes {
             return null;
           }
 
-          if (typeof spec.default === "number") {
+          if (
+            (spec.default === undefined && spec.type === "number") ||
+            (spec.default !== undefined && typeof spec.default === "number")
+          ) {
             const asNumber = parseFloat(value);
             const isNumeric =
               !Number.isNaN(asNumber) && Number.isFinite(asNumber);
@@ -72,12 +78,14 @@ export function propsToAttributes(propSchema: PropSchema): Attributes {
 
           return value;
         },
-        renderHTML: (attributes) =>
-          attributes[name] !== spec.default
+        renderHTML: (attributes) => {
+          // don't render to html if the value is the same as the default
+          return attributes[name] !== spec.default
             ? {
                 [camelToDataKebab(name)]: attributes[name],
               }
-            : {},
+            : {};
+        },
       };
     });
 
@@ -173,7 +181,9 @@ export function wrapInBlockStructure<
   // which are already added as HTML attributes to the parent `blockContent`
   // element (inheritedProps) and props set to their default values.
   for (const [prop, value] of Object.entries(blockProps)) {
-    if (!inheritedProps.includes(prop) && value !== propSchema[prop].default) {
+    const spec = propSchema[prop];
+    const defaultValue = spec.default;
+    if (!inheritedProps.includes(prop) && value !== defaultValue) {
       blockContent.setAttribute(camelToDataKebab(prop), value);
     }
   }

package/src/schema/inlineContent/internal.ts

@@ -34,7 +34,10 @@ export function addInlineContentAttributes<
   // Adds props as HTML attributes in kebab-case with "data-" prefix. Skips props
   // set to their default values.
   Object.entries(inlineContentProps)
-    .filter(([prop, value]) => value !== propSchema[prop].default)
+    .filter(([prop, value]) => {
+      const spec = propSchema[prop];
+      return value !== spec.default;
+    })
     .map(([prop, value]) => {
       return [camelToDataKebab(prop), value];
     })

package/src/schema/propTypes.ts

@@ -1,9 +1,24 @@
-// Defines a single prop spec, which includes the default value the prop should
-// take and possible values it can take.
-export type PropSpec<PType extends boolean | number | string> = {
-  values?: readonly PType[];
-  default: PType;
-};
+// The PropSpec specifies the type of a prop and possibly a default value.
+// Note that props are always optional when used as "input"
+// (i.e., when creating a PartialBlock, for example by calling `insertBlocks({...})`)
+//
+// However, internally they're always set to `default`, unless a prop is marked optional
+//
+// At some point we should migrate this to zod or effect-schema
+export type PropSpec<PType extends boolean | number | string> =
+  | {
+      // We infer the type of the prop from the default value
+      default: PType;
+      // a list of possible values, for example for a string prop (this will then be used as a string union type)
+      values?: readonly PType[];
+    }
+  | {
+      default: undefined;
+      // Because there is no default value (for an optional prop, the default value is undefined),
+      // we need to specify the type of the prop manually (we can't infer it from the default value)
+      type: "string" | "number" | "boolean";
+      values?: readonly PType[];
+    };
 
 // Defines multiple block prop specs. The key of each prop is the name of the
 // prop, while the value is a corresponding prop spec. This should be included
@@ -16,17 +31,25 @@ export type PropSchema = Record<string, PropSpec<boolean | number | string>>;
 // each prop spec into a union type of its possible values, or a string if no
 // values are specified.
 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
+  // for required props, get type from type of "default" value,
+  // and if values are specified, get type from values
+  [PName in keyof PSchema]: (
+    PSchema[PName] extends { default: boolean } | { type: "boolean" }
+      ? PSchema[PName]["values"] extends readonly boolean[]
+        ? 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
+  ) extends infer T
+    ? PSchema[PName] extends { optional: true }
+      ? T | undefined
+      : T
     : never;
 };

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

@@ -137,6 +137,10 @@ export declare function setupTestEnv(): () => BlockNoteEditor<import("../../inde
             type: "numberedListItem";
             content: "inline";
             propSchema: {
+                start: {
+                    default: undefined;
+                    type: "number";
+                };
                 backgroundColor: {
                     default: "default";
                 };
@@ -153,6 +157,10 @@ export declare function setupTestEnv(): () => BlockNoteEditor<import("../../inde
             type: "numberedListItem";
             content: "inline";
             propSchema: {
+                start: {
+                    default: undefined;
+                    type: "number";
+                };
                 backgroundColor: {
                     default: "default";
                 };

package/types/src/api/clipboard/clipboardInternal.test.d.ts

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

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

@@ -0,0 +1,509 @@
+import { BlockNoteSchema } from "../../editor/BlockNoteSchema.js";
+export declare const schema: BlockNoteSchema<import("../../schema/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("../../schema/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("../../schema/index.js").InlineContentSchema, import("../../schema/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("../../schema/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("../../schema/index.js").InlineContentSchema, import("../../schema/index.js").StyleSchema>;
+    };
+    codeBlock: {
+        config: {
+            type: "codeBlock";
+            content: "inline";
+            propSchema: {
+                language: {
+                    default: string;
+                    values: string[];
+                };
+            };
+        };
+        implementation: import("../../schema/index.js").TiptapBlockImplementation<{
+            type: "codeBlock";
+            content: "inline";
+            propSchema: {
+                language: {
+                    default: string;
+                    values: string[];
+                };
+            };
+        }, any, import("../../schema/index.js").InlineContentSchema, import("../../schema/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("../../schema/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("../../schema/index.js").InlineContentSchema, import("../../schema/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("../../schema/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("../../schema/index.js").InlineContentSchema, import("../../schema/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("../../schema/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("../../schema/index.js").InlineContentSchema, import("../../schema/index.js").StyleSchema>;
+    };
+    table: {
+        config: {
+            type: "table";
+            content: "table";
+            propSchema: {
+                textColor: {
+                    default: "default";
+                };
+            };
+        };
+        implementation: import("../../schema/index.js").TiptapBlockImplementation<{
+            type: "table";
+            content: "table";
+            propSchema: {
+                textColor: {
+                    default: "default";
+                };
+            };
+        }, any, import("../../schema/index.js").InlineContentSchema, import("../../schema/index.js").StyleSchema>;
+    };
+    file: {
+        config: {
+            type: "file";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+        };
+        implementation: import("../../schema/index.js").TiptapBlockImplementation<{
+            type: "file";
+            propSchema: {
+                backgroundColor: {
+                    default: "default";
+                };
+                name: {
+                    default: "";
+                };
+                url: {
+                    default: "";
+                };
+                caption: {
+                    default: "";
+                };
+            };
+            content: "none";
+            isFileBlock: true;
+        }, any, import("../../schema/index.js").InlineContentSchema, import("../../schema/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("../../schema/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("../../schema/index.js").InlineContentSchema, import("../../schema/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("../../schema/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("../../schema/index.js").InlineContentSchema, import("../../schema/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("../../schema/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("../../schema/index.js").InlineContentSchema, import("../../schema/index.js").StyleSchema>;
+    };
+}>, import("../../schema/index.js").InlineContentSchemaFromSpecs<{
+    text: {
+        config: "text";
+        implementation: any;
+    };
+    link: {
+        config: "link";
+        implementation: any;
+    };
+}>, import("../../schema/index.js").StyleSchemaFromSpecs<{
+    bold: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../schema/index.js").StyleImplementation;
+    };
+    italic: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../schema/index.js").StyleImplementation;
+    };
+    underline: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../schema/index.js").StyleImplementation;
+    };
+    strike: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../schema/index.js").StyleImplementation;
+    };
+    code: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../schema/index.js").StyleImplementation;
+    };
+    textColor: {
+        config: {
+            type: string;
+            propSchema: "string";
+        };
+        implementation: import("../../schema/index.js").StyleImplementation;
+    };
+    backgroundColor: {
+        config: {
+            type: string;
+            propSchema: "string";
+        };
+        implementation: import("../../schema/index.js").StyleImplementation;
+    };
+}>>;

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

@@ -265,6 +265,10 @@ declare const schema: BlockNoteSchema<import("../../../schema/index.js").BlockSc
             type: "numberedListItem";
             content: "inline";
             propSchema: {
+                start: {
+                    default: undefined;
+                    type: "number";
+                };
                 backgroundColor: {
                     default: "default";
                 };
@@ -281,6 +285,10 @@ declare const schema: BlockNoteSchema<import("../../../schema/index.js").BlockSc
             type: "numberedListItem";
             content: "inline";
             propSchema: {
+                start: {
+                    default: undefined;
+                    type: "number";
+                };
                 backgroundColor: {
                     default: "default";
                 };