@blocknote/core 0.3.0 → 0.4.0

package/types/src/extensions/Blocks/api/inlineContentTypes.d.ts

@@ -0,0 +1,23 @@
+export type StyleTemplate<Type extends string, Props extends Record<string, string>> = {
+    type: Type;
+    props: Props;
+};
+export type Bold = StyleTemplate<"bold", {}>;
+export type Italic = StyleTemplate<"italic", {}>;
+export type Underline = StyleTemplate<"underline", {}>;
+export type Strikethrough = StyleTemplate<"strike", {}>;
+export type TextColor = StyleTemplate<"textColor", {
+    color: string;
+}>;
+export type BackgroundColor = StyleTemplate<"backgroundColor", {
+    color: string;
+}>;
+export type Link = StyleTemplate<"link", {
+    href: string;
+}>;
+export type Style = Bold | Italic | Underline | Strikethrough | TextColor | BackgroundColor | Link;
+export type StyledText = {
+    text: string;
+    styles: Style[];
+};
+export type InlineContent = StyledText;

package/types/src/extensions/Blocks/api/styleTypes.d.ts

@@ -0,0 +1,22 @@
+export type StyleTemplate<Type extends string, Props extends Record<string, string>> = {
+    type: Type;
+    props: Props;
+};
+export type Bold = StyleTemplate<"bold", {}>;
+export type Italic = StyleTemplate<"italic", {}>;
+export type Underline = StyleTemplate<"underline", {}>;
+export type Strikethrough = StyleTemplate<"strike", {}>;
+export type TextColor = StyleTemplate<"textColor", {
+    color: string;
+}>;
+export type BackgroundColor = StyleTemplate<"backgroundColor", {
+    color: string;
+}>;
+export type Link = StyleTemplate<"link", {
+    href: string;
+}>;
+export type Style = Bold | Italic | Underline | Strikethrough | TextColor | BackgroundColor | Link;
+export type StyledText = {
+    text: string;
+    styles: Style[];
+};

package/types/src/extensions/Blocks/nodes/BlockContainer.d.ts

@@ -1,5 +1,5 @@
 import { Node } from "@tiptap/core";
-import { BlockUpdate } from "../apiTypes";
+import { PartialBlock } from "../api/blockTypes";
 export interface IBlock {
     HTMLAttributes: Record<string, any>;
 }
@@ -10,8 +10,8 @@ declare module "@tiptap/core" {
             BNDeleteBlock: (posInBlock: number) => ReturnType;
             BNMergeBlocks: (posBetweenBlocks: number) => ReturnType;
             BNSplitBlock: (posInBlock: number, keepType: boolean) => ReturnType;
-            BNUpdateBlock: (posInBlock: number, blockUpdate: BlockUpdate) => ReturnType;
-            BNCreateOrUpdateBlock: (posInBlock: number, blockUpdate: BlockUpdate) => ReturnType;
+            BNUpdateBlock: (posInBlock: number, block: PartialBlock) => ReturnType;
+            BNCreateOrUpdateBlock: (posInBlock: number, block: PartialBlock) => ReturnType;
         };
     }
 }

package/types/src/extensions/FormattingToolbar/FormattingToolbarFactoryTypes.d.ts

@@ -1,5 +1,5 @@
 import { EditorElement, ElementFactory } from "../../shared/EditorElement";
-import { Block, BlockUpdate } from "../Blocks/apiTypes";
+import { Block, PartialBlock } from "../Blocks/api/blockTypes";
 export type FormattingToolbarStaticParams = {
     toggleBold: () => void;
     toggleItalic: () => void;
@@ -11,7 +11,7 @@ export type FormattingToolbarStaticParams = {
     setTextAlignment: (textAlignment: "left" | "center" | "right" | "justify") => void;
     increaseBlockIndent: () => void;
     decreaseBlockIndent: () => void;
-    updateBlock: (blockUpdate: BlockUpdate) => void;
+    updateBlock: (updatedBlock: PartialBlock) => void;
 };
 export type FormattingToolbarDynamicParams = {
     boldIsActive: boolean;

package/types/src/extensions/SlashMenu/SlashMenuExtension.d.ts

@@ -3,9 +3,7 @@ import { PluginKey } from "prosemirror-state";
 import { SuggestionsMenuFactory } from "../../shared/plugins/suggestion/SuggestionsMenuFactoryTypes";
 import { SlashMenuItem } from "./SlashMenuItem";
 export type SlashMenuOptions = {
-    commands: {
-        [key: string]: SlashMenuItem;
-    };
+    commands: SlashMenuItem[] | undefined;
     slashMenuFactory: SuggestionsMenuFactory<any> | undefined;
 };
 export declare const SlashMenuPluginKey: PluginKey<any>;

package/types/src/extensions/SlashMenu/SlashMenuItem.d.ts

@@ -9,6 +9,9 @@ export declare class SlashMenuItem implements SuggestionItem {
     readonly name: string;
     readonly execute: (editor: Editor, range: Range) => void;
     readonly aliases: string[];
+    readonly group: string;
+    readonly hint?: string | undefined;
+    readonly shortcut?: string | undefined;
     /**
      * Constructs a new slash-command.
      *
@@ -16,6 +19,6 @@ export declare class SlashMenuItem implements SuggestionItem {
      * @param execute The callback for creating a new node
      * @param aliases Aliases for this command
      */
-    constructor(name: string, execute: (editor: Editor, range: Range) => void, aliases?: string[]);
+    constructor(name: string, execute: (editor: Editor, range: Range) => void, aliases: string[], group: string, hint?: string | undefined, shortcut?: string | undefined);
     match(query: string): boolean;
 }

package/types/src/extensions/SlashMenu/index.d.ts

@@ -1,4 +1,4 @@
+import { defaultSlashCommands } from "./defaultSlashCommands";
 import { SlashMenuExtension } from "./SlashMenuExtension";
-import defaultCommands from "./defaultCommands";
-export { defaultCommands };
-export default SlashMenuExtension;
+import { SlashMenuItem } from "./SlashMenuItem";
+export { defaultSlashCommands, SlashMenuItem as SlashCommand, SlashMenuExtension, };

package/types/src/index.d.ts

@@ -1,10 +1,12 @@
 export * from "./BlockNoteEditor";
 export * from "./BlockNoteExtensions";
-export type { Block, BlockUpdate } from "./extensions/Blocks/apiTypes";
-export * from "./extensions/FormattingToolbar/FormattingToolbarFactoryTypes";
+export * from "./extensions/Blocks/api/blockTypes";
 export * from "./extensions/DraggableBlocks/BlockSideMenuFactoryTypes";
+export * from "./extensions/FormattingToolbar/FormattingToolbarFactoryTypes";
 export * from "./extensions/HyperlinkToolbar/HyperlinkToolbarFactoryTypes";
+export { defaultSlashCommands } from "./extensions/SlashMenu/defaultSlashCommands";
 export * from "./extensions/SlashMenu/SlashMenuItem";
 export * from "./shared/EditorElement";
 export type { SuggestionItem } from "./shared/plugins/suggestion/SuggestionItem";
 export * from "./shared/plugins/suggestion/SuggestionsMenuFactoryTypes";
+export * from "../src/api/Editor";

package/src/extensions/Blocks/apiTypes.ts

@@ -1,48 +0,0 @@
-export type BlockSpec<
-  // Type of the block.
-  // Examples might include: "paragraph", "heading", or "bulletListItem".
-  Type extends string,
-  // Changeable props which affect the block's behaviour or appearance.
-  // An example might be: { textAlignment: "left" | "right" | "center" | "justify" } for a paragraph block.
-  Props extends Record<string, string>
-> = {
-  type: Type;
-  props: Props;
-};
-
-export type BlockSpecUpdate<Spec> = Spec extends BlockSpec<
-  infer Type,
-  infer Props
->
-  ? {
-      type: Type;
-      props?: Partial<Props>;
-    }
-  : never;
-
-export type NumberedListItemBlock = BlockSpec<"numberedListItem", {}>;
-
-export type BulletListItemBlock = BlockSpec<"bulletListItem", {}>;
-
-export type HeadingBlock = BlockSpec<
-  "heading",
-  {
-    level: "1" | "2" | "3";
-  }
->;
-
-export type ParagraphBlock = BlockSpec<"paragraph", {}>;
-
-export type Block =
-  | ParagraphBlock
-  | HeadingBlock
-  | BulletListItemBlock
-  | NumberedListItemBlock;
-
-export type BlockUpdate = BlockSpecUpdate<Block>;
-
-/*
-TODO:
- 1) guard read / writes (now we just pass on internal node attrs)
- 2) where to locate this code / types
-*/