@blocknote/core 0.47.0 → 0.47.2

package/types/src/schema/blocks/types.d.ts

@@ -57,12 +57,30 @@ export interface BlockConfig<T extends string = string, PS extends PropSchema =
      */
     content: C;
 }
+/**
+ * BlockConfigOrCreator is a union type of BlockConfig and a function that returns a BlockConfig.
+ * This is used to create block configs that can be passed to the createBlockSpec function.
+ */
+export type BlockConfigOrCreator<TName extends string = string, TProps extends PropSchema = PropSchema, TContent extends "inline" | "none" = "inline" | "none", TOptions extends Record<string, any> | undefined = Record<string, any> | undefined> = BlockConfig<TName, TProps, TContent> | (TOptions extends undefined ? () => BlockConfig<TName, TProps, TContent> : (options: Partial<TOptions>) => BlockConfig<TName, TProps, TContent>);
+/**
+ * ExtractBlockConfigFromConfigOrCreator is a helper type that extracts the BlockConfig type from a BlockConfigOrCreator.
+ */
+export type ExtractBlockConfigFromConfigOrCreator<ConfigOrCreator extends BlockConfig<string, PropSchema, "inline" | "none"> | ((...args: any[]) => BlockConfig<string, PropSchema, "inline" | "none">)> = ConfigOrCreator extends (...args: any[]) => infer Config ? Config : ConfigOrCreator;
 export type CustomBlockConfig<T extends string = string, PS extends PropSchema = PropSchema, C extends "inline" | "none" = "inline" | "none"> = BlockConfig<T, PS, C>;
 export type BlockSpec<T extends string = string, PS extends PropSchema = PropSchema, C extends "inline" | "none" | "table" = "inline" | "none" | "table"> = {
     config: BlockConfig<T, PS, C>;
     implementation: BlockImplementation<T, PS, C>;
     extensions?: (Extension | ExtensionFactoryInstance)[];
 };
+/**
+ * BlockSpecOrCreator is a union type of BlockSpec and a function that returns a BlockSpec.
+ * This is used to create block specs that can be passed to the createBlockSpec function.
+ */
+export type BlockSpecOrCreator<T extends string = string, PS extends PropSchema = PropSchema, C extends "inline" | "none" | "table" = "inline" | "none" | "table", TOptions extends Record<string, any> | undefined = Record<string, any> | undefined> = BlockSpec<T, PS, C> | (TOptions extends undefined ? () => BlockSpec<T, PS, C> : (options: Partial<TOptions>) => BlockSpec<T, PS, C>);
+/**
+ * ExtractBlockSpecFromSpecOrCreator is a helper type that extracts the BlockSpec type from a BlockSpecOrCreator.
+ */
+export type ExtractBlockSpecFromSpecOrCreator<SpecOrCreator extends BlockSpec<string, PropSchema, "inline" | "none"> | ((...args: any[]) => BlockSpec<string, PropSchema, "inline" | "none">)> = SpecOrCreator extends (...args: any[]) => infer Spec ? Spec : SpecOrCreator;
 /**
  * This allows de-coupling the types that we display to users versus the types we expose internally.
  *
@@ -91,6 +109,7 @@ export type LooseBlockSpec<T extends string = string, PS extends PropSchema = Pr
         }) => {
             dom: HTMLElement | DocumentFragment;
             contentDOM?: HTMLElement;
+            childrenDOM?: HTMLElement;
         } | undefined;
         node: Node;
     };
@@ -125,6 +144,7 @@ export type BlockSpecs = {
             }) => {
                 dom: HTMLElement | DocumentFragment;
                 contentDOM?: HTMLElement;
+                childrenDOM?: HTMLElement;
             } | undefined;
         };
         extensions?: BlockSpec<k>["extensions"];
@@ -265,6 +285,7 @@ export type BlockImplementation<TName extends string = string, TProps extends Pr
     }) => {
         dom: HTMLElement | DocumentFragment;
         contentDOM?: HTMLElement;
+        childrenDOM?: HTMLElement;
     } | undefined;
     /**
      * Parses an external HTML element into a block of this type when it returns the block props object, otherwise undefined
@@ -282,7 +303,16 @@ export type BlockImplementation<TName extends string = string, TProps extends Pr
     parseContent?: (options: {
         el: HTMLElement;
         schema: Schema;
-    }) => Fragment;
+    }) => Fragment | undefined;
 };
+/**
+ * BlockImplementationOrCreator is a union type of BlockImplementation and a function that returns a BlockImplementation.
+ * This is used to create block implementations that can be passed to the createBlockSpec function.
+ */
+export type BlockImplementationOrCreator<ConfigOrCreator extends BlockConfigOrCreator = BlockConfigOrCreator, TOptions extends Record<string, any> | undefined = Record<string, any> | undefined, Config extends ExtractBlockConfigFromConfigOrCreator<ConfigOrCreator> = ExtractBlockConfigFromConfigOrCreator<ConfigOrCreator>> = BlockImplementation<Config["type"], Config["propSchema"], Config["content"]> | (TOptions extends undefined ? () => BlockImplementation<Config["type"], Config["propSchema"], Config["content"]> : (options: Partial<TOptions>) => BlockImplementation<Config["type"], Config["propSchema"], Config["content"]>);
+/**
+ * ExtractBlockImplementationFromImplementationOrCreator is a helper type that extracts the BlockImplementation type from a BlockImplementationOrCreator.
+ */
+export type ExtractBlockImplementationFromImplementationOrCreator<ImplementationOrCreator extends BlockImplementation<string, PropSchema, "inline" | "none"> | ((...args: any[]) => BlockImplementation<string, PropSchema, "inline" | "none">)> = ImplementationOrCreator extends (...args: any[]) => infer Implementation ? Implementation : ImplementationOrCreator;
 export type CustomBlockImplementation<T extends string = string, PS extends PropSchema = PropSchema, C extends "inline" | "none" = "inline" | "none"> = BlockImplementation<T, PS, C>;
 export {};