Made test functions pluggable for test cases

Author: matthewlipski

packages/core/src/api/tests/clipboard/clipboardTestUtil.ts

@@ -1,7 +1,16 @@
 import { Node, Slice } from "@tiptap/pm/model";
+import { Selection } from "@tiptap/pm/state";
 import { EditorView } from "@tiptap/pm/view";
 import * as pmView from "@tiptap/pm/view";
 
+import { PartialBlock } from "../../../blocks/defaultBlocks.js";
+import { BlockNoteEditor } from "../../../editor/BlockNoteEditor.js";
+import {
+  BlockSchema,
+  InlineContentSchema,
+  StyleSchema,
+} from "../../../schema/index.js";
+
 // Helper function to get the position of a text node with given text content.
 // By default, returns the position just before the node, but can be just after
 // instead if `after` is set to true.
@@ -49,6 +58,30 @@ export const getPosOfTableCellNode = (doc: Node, textContent: string) => {
   return ret;
 };
 
+export const setupClipboardTest = <
+  B extends BlockSchema,
+  I extends InlineContentSchema,
+  S extends StyleSchema
+>(
+  editor: BlockNoteEditor<B, I, S>,
+  document: PartialBlock<B, I, S>[],
+  getSelection: (pmDoc: Node) => Selection
+) => {
+  if (!editor.prosemirrorView) {
+    throw new Error("Editor view not initialized.");
+  }
+
+  (window as any).__TEST_OPTIONS.mockID = 0;
+
+  editor.replaceBlocks(editor.document, document);
+
+  editor.dispatch(
+    editor._tiptapEditor.state.tr.setSelection(
+      getSelection(editor.prosemirrorView.state.doc)
+    )
+  );
+};
+
 function sliceSingleNode(slice: Slice) {
   return slice.openStart === 0 &&
     slice.openEnd === 0 &&

packages/core/src/api/tests/clipboard/copy/copyTestCase.ts

@@ -0,0 +1,19 @@
+import { Node } from "@tiptap/pm/model";
+import { Selection } from "@tiptap/pm/state";
+
+import { PartialBlock } from "../../../../blocks/defaultBlocks.js";
+import {
+  BlockSchema,
+  InlineContentSchema,
+  StyleSchema,
+} from "../../../../schema/index.js";
+
+export type CopyTestCase<
+  B extends BlockSchema,
+  I extends InlineContentSchema,
+  S extends StyleSchema
+> = {
+  name: string;
+  document: PartialBlock<B, I, S>[];
+  getCopySelection: (pmDoc: Node) => Selection;
+};

packages/core/src/api/tests/clipboard/copy/copyTestExecutors.ts

@@ -0,0 +1,69 @@
+import { prettify } from "htmlfy";
+import { expect } from "vitest";
+
+import { BlockNoteEditor } from "../../../../editor/BlockNoteEditor.js";
+import {
+  BlockSchema,
+  InlineContentSchema,
+  StyleSchema,
+} from "../../../../schema/index.js";
+import { selectedFragmentToHTML } from "../../../clipboard/toClipboard/copyExtension.js";
+import { setupClipboardTest } from "../clipboardTestUtil.js";
+import { CopyTestCase } from "./copyTestCase.js";
+
+export const testCopyBlockNoteHTML = async <
+  B extends BlockSchema,
+  I extends InlineContentSchema,
+  S extends StyleSchema
+>(
+  editor: BlockNoteEditor<B, I, S>,
+  testCase: CopyTestCase<B, I, S>
+) => {
+  setupClipboardTest(editor, testCase.document, testCase.getCopySelection);
+
+  const { clipboardHTML } = selectedFragmentToHTML(
+    editor.prosemirrorView!,
+    editor
+  );
+
+  await expect(prettify(clipboardHTML, { tag_wrap: true })).toMatchFileSnapshot(
+    `./__snapshots__/blocknote/html/${testCase.name}.html`
+  );
+};
+
+export const testCopyHTML = async <
+  B extends BlockSchema,
+  I extends InlineContentSchema,
+  S extends StyleSchema
+>(
+  editor: BlockNoteEditor<B, I, S>,
+  testCase: CopyTestCase<B, I, S>
+) => {
+  setupClipboardTest(editor, testCase.document, testCase.getCopySelection);
+
+  const { externalHTML } = selectedFragmentToHTML(
+    editor.prosemirrorView!,
+    editor
+  );
+
+  await expect(prettify(externalHTML, { tag_wrap: true })).toMatchFileSnapshot(
+    `./__snapshots__/text/html/${testCase.name}.html`
+  );
+};
+
+export const testCopyMarkdown = async <
+  B extends BlockSchema,
+  I extends InlineContentSchema,
+  S extends StyleSchema
+>(
+  editor: BlockNoteEditor<B, I, S>,
+  testCase: CopyTestCase<B, I, S>
+) => {
+  setupClipboardTest(editor, testCase.document, testCase.getCopySelection);
+
+  const { markdown } = selectedFragmentToHTML(editor.prosemirrorView!, editor);
+
+  await expect(markdown).toMatchFileSnapshot(
+    `./__snapshots__/text/plain/${testCase.name}.md`
+  );
+};