@blocknote/core 0.8.2 → 0.8.3

package/src/extensions/SlashMenu/defaultSlashMenuItems.ts

@@ -0,0 +1,109 @@
+import { BlockNoteEditor } from "../../BlockNoteEditor";
+import { BlockSchema, PartialBlock } from "../Blocks/api/blockTypes";
+import { BaseSlashMenuItem } from "./BaseSlashMenuItem";
+import { defaultBlockSchema } from "../Blocks/api/defaultBlocks";
+
+function insertOrUpdateBlock<BSchema extends BlockSchema>(
+  editor: BlockNoteEditor<BSchema>,
+  block: PartialBlock<BSchema>
+) {
+  const currentBlock = editor.getTextCursorPosition().block;
+
+  if (
+    (currentBlock.content.length === 1 &&
+      currentBlock.content[0].type === "text" &&
+      currentBlock.content[0].text === "/") ||
+    currentBlock.content.length === 0
+  ) {
+    editor.updateBlock(currentBlock, block);
+  } else {
+    editor.insertBlocks([block], currentBlock, "after");
+    editor.setTextCursorPosition(editor.getTextCursorPosition().nextBlock!);
+  }
+}
+
+export const getDefaultSlashMenuItems = <BSchema extends BlockSchema>(
+  // This type casting is weird, but it's the best way of doing it, as it allows
+  // the schema type to be automatically inferred if it is defined, or be
+  // inferred as any if it is not defined. I don't think it's possible to make it
+  // infer to DefaultBlockSchema if it is not defined.
+  schema: BSchema = defaultBlockSchema as unknown as BSchema
+) => {
+  const slashMenuItems: BaseSlashMenuItem<BSchema>[] = [];
+
+  if ("heading" in schema && "level" in schema.heading.propSchema) {
+    // Command for creating a level 1 heading
+    if (schema.heading.propSchema.level.values?.includes("1")) {
+      slashMenuItems.push({
+        name: "Heading",
+        aliases: ["h", "heading1", "h1"],
+        execute: (editor) =>
+          insertOrUpdateBlock(editor, {
+            type: "heading",
+            props: { level: "1" },
+          } as PartialBlock<BSchema>),
+      });
+    }
+
+    // Command for creating a level 2 heading
+    if (schema.heading.propSchema.level.values?.includes("2")) {
+      slashMenuItems.push({
+        name: "Heading 2",
+        aliases: ["h2", "heading2", "subheading"],
+        execute: (editor) =>
+          insertOrUpdateBlock(editor, {
+            type: "heading",
+            props: { level: "2" },
+          } as PartialBlock<BSchema>),
+      });
+    }
+
+    // Command for creating a level 3 heading
+    if (schema.heading.propSchema.level.values?.includes("3")) {
+      slashMenuItems.push({
+        name: "Heading 3",
+        aliases: ["h3", "heading3", "subheading"],
+        execute: (editor) =>
+          insertOrUpdateBlock(editor, {
+            type: "heading",
+            props: { level: "3" },
+          } as PartialBlock<BSchema>),
+      });
+    }
+  }
+
+  if ("bulletListItem" in schema) {
+    slashMenuItems.push({
+      name: "Bullet List",
+      aliases: ["ul", "list", "bulletlist", "bullet list"],
+      execute: (editor) =>
+        insertOrUpdateBlock(editor, {
+          type: "bulletListItem",
+        } as PartialBlock<BSchema>),
+    });
+  }
+
+  if ("numberedListItem" in schema) {
+    slashMenuItems.push({
+      name: "Numbered List",
+      aliases: ["li", "list", "numberedlist", "numbered list"],
+      execute: (editor) =>
+        insertOrUpdateBlock(editor, {
+          type: "numberedListItem",
+        } as PartialBlock<BSchema>),
+    });
+  }
+
+  if ("paragraph" in schema) {
+    slashMenuItems.push({
+      name: "Paragraph",
+      aliases: ["p"],
+      execute: (editor) =>
+        insertOrUpdateBlock(editor, {
+          type: "paragraph",
+        } as PartialBlock<BSchema>),
+    });
+  }
+
+  return slashMenuItems;
+};

package/src/extensions/UniqueID/UniqueID.ts

@@ -1,7 +1,6 @@
 import {
   combineTransactionSteps,
   Extension,
-  findChildren,
   findChildrenInRange,
   getChangedRanges,
 } from "@tiptap/core";
@@ -87,35 +86,35 @@ const UniqueID = Extension.create({
     ];
   },
   // check initial content for missing ids
-  onCreate() {
-    // Don’t do this when the collaboration extension is active
-    // because this may update the content, so Y.js tries to merge these changes.
-    // This leads to empty block nodes.
-    // See: https://github.com/ueberdosis/tiptap/issues/2400
-    if (
-      this.editor.extensionManager.extensions.find(
-        (extension) => extension.name === "collaboration"
-      )
-    ) {
-      return;
-    }
-    const { view, state } = this.editor;
-    const { tr, doc } = state;
-    const { types, attributeName, generateID } = this.options;
-    const nodesWithoutId = findChildren(doc, (node) => {
-      return (
-        types.includes(node.type.name) && node.attrs[attributeName] === null
-      );
-    });
-    nodesWithoutId.forEach(({ node, pos }) => {
-      tr.setNodeMarkup(pos, undefined, {
-        ...node.attrs,
-        [attributeName]: generateID(),
-      });
-    });
-    tr.setMeta("addToHistory", false);
-    view.dispatch(tr);
-  },
+  // onCreate() {
+  //   // Don’t do this when the collaboration extension is active
+  //   // because this may update the content, so Y.js tries to merge these changes.
+  //   // This leads to empty block nodes.
+  //   // See: https://github.com/ueberdosis/tiptap/issues/2400
+  //   if (
+  //     this.editor.extensionManager.extensions.find(
+  //       (extension) => extension.name === "collaboration"
+  //     )
+  //   ) {
+  //     return;
+  //   }
+  //   const { view, state } = this.editor;
+  //   const { tr, doc } = state;
+  //   const { types, attributeName, generateID } = this.options;
+  //   const nodesWithoutId = findChildren(doc, (node) => {
+  //     return (
+  //       types.includes(node.type.name) && node.attrs[attributeName] === null
+  //     );
+  //   });
+  //   nodesWithoutId.forEach(({ node, pos }) => {
+  //     tr.setNodeMarkup(pos, undefined, {
+  //       ...node.attrs,
+  //       [attributeName]: generateID(),
+  //     });
+  //   });
+  //   tr.setMeta("addToHistory", false);
+  //   view.dispatch(tr);
+  // },
   addProseMirrorPlugins() {
     let dragSourceElement: any = null;
     let transformPasted = false;

package/src/index.ts

@@ -3,14 +3,15 @@ export * from "./BlockNoteExtensions";
 export * from "./extensions/Blocks/api/block";
 export * from "./extensions/Blocks/api/blockTypes";
 export * from "./extensions/Blocks/api/defaultBlocks";
-export * from "./extensions/DraggableBlocks/BlockSideMenuFactoryTypes";
-export * from "./extensions/FormattingToolbar/FormattingToolbarFactoryTypes";
-export * from "./extensions/HyperlinkToolbar/HyperlinkToolbarFactoryTypes";
-export { defaultSlashMenuItems } from "./extensions/SlashMenu/defaultSlashMenuItems";
-export * from "./extensions/SlashMenu/BaseSlashMenuItem";
-export * from "./shared/EditorElement";
-export type { SuggestionItem } from "./shared/plugins/suggestion/SuggestionItem";
-export * from "./shared/plugins/suggestion/SuggestionsMenuFactoryTypes";
 export * from "./extensions/Blocks/api/inlineContentTypes";
 export * from "./extensions/Blocks/api/serialization";
 export * as blockStyles from "./extensions/Blocks/nodes/Block.module.css";
+export * from "./extensions/FormattingToolbar/FormattingToolbarPlugin";
+export * from "./extensions/HyperlinkToolbar/HyperlinkToolbarPlugin";
+export * from "./extensions/SideMenu/SideMenuPlugin";
+export * from "./extensions/SlashMenu/BaseSlashMenuItem";
+export * from "./extensions/SlashMenu/SlashMenuPlugin";
+export { getDefaultSlashMenuItems } from "./extensions/SlashMenu/defaultSlashMenuItems";
+export * from "./shared/BaseUiElementTypes";
+export type { SuggestionItem } from "./shared/plugins/suggestion/SuggestionItem";
+export * from "./shared/plugins/suggestion/SuggestionPlugin";

package/src/node_modules/.vitest/results.json

@@ -0,0 +1 @@
+{"version":"0.28.5","results":[["/api/formatConversions/formatConversions.test.ts",{"duration":109,"failed":false}],["/api/nodeConversions/nodeConversions.test.ts",{"duration":32,"failed":false}],["/api/blockManipulation/blockManipulation.test.ts",{"duration":38,"failed":false}],["/BlockNoteEditor.test.ts",{"duration":4,"failed":false}]]}

package/src/shared/BaseUiElementTypes.ts

@@ -0,0 +1,8 @@
+export type BaseUiElementCallbacks = {
+  destroy: () => void;
+};
+
+export type BaseUiElementState = {
+  show: boolean;
+  referencePos: DOMRect;
+};

package/src/shared/EditorElement.ts

@@ -1,16 +0,0 @@
-export type RequiredStaticParams = Record<string, any> & {
-  getReferenceRect: () => DOMRect;
-};
-export type RequiredDynamicParams = Record<string, any> & {};
-
-export type EditorElement<ElementDynamicParams extends RequiredDynamicParams> =
-  {
-    element: HTMLElement | undefined;
-    render: (params: ElementDynamicParams, isHidden: boolean) => void;
-    hide: () => void;
-  };
-
-export type ElementFactory<
-  ElementStaticParams extends RequiredStaticParams,
-  ElementDynamicParams extends RequiredDynamicParams
-> = (staticParams: ElementStaticParams) => EditorElement<ElementDynamicParams>;

package/src/shared/EventEmitter.ts

@@ -0,0 +1,58 @@
+// from https://raw.githubusercontent.com/ueberdosis/tiptap/develop/packages/core/src/EventEmitter.ts (MIT)
+
+type StringKeyOf<T> = Extract<keyof T, string>;
+type CallbackType<
+  T extends Record<string, any>,
+  EventName extends StringKeyOf<T>
+> = T[EventName] extends any[] ? T[EventName] : [T[EventName]];
+type CallbackFunction<
+  T extends Record<string, any>,
+  EventName extends StringKeyOf<T>
+> = (...props: CallbackType<T, EventName>) => any;
+
+export class EventEmitter<T extends Record<string, any>> {
+  private callbacks: { [key: string]: Function[] } = {};
+
+  public on<EventName extends StringKeyOf<T>>(
+    event: EventName,
+    fn: CallbackFunction<T, EventName>
+  ) {
+    if (!this.callbacks[event]) {
+      this.callbacks[event] = [];
+    }
+
+    this.callbacks[event].push(fn);
+
+    return () => this.off(event, fn);
+  }
+
+  protected emit<EventName extends StringKeyOf<T>>(
+    event: EventName,
+    ...args: CallbackType<T, EventName>
+  ) {
+    const callbacks = this.callbacks[event];
+
+    if (callbacks) {
+      callbacks.forEach((callback) => callback.apply(this, args));
+    }
+  }
+
+  public off<EventName extends StringKeyOf<T>>(
+    event: EventName,
+    fn?: CallbackFunction<T, EventName>
+  ) {
+    const callbacks = this.callbacks[event];
+
+    if (callbacks) {
+      if (fn) {
+        this.callbacks[event] = callbacks.filter((callback) => callback !== fn);
+      } else {
+        delete this.callbacks[event];
+      }
+    }
+  }
+
+  protected removeAllListeners(): void {
+    this.callbacks = {};
+  }
+}

package/src/shared/plugins/suggestion/SuggestionItem.ts

@@ -1,6 +1,3 @@
-/**
- * A generic interface used in all suggestion menus (slash menu, mentions, etc)
- */
-export class SuggestionItem {
-  constructor(public name: string, public match: (query: string) => boolean) {}
-}
+export type SuggestionItem = {
+  name: string;
+};