feat: Initial clean release of CHM

packages/editor/ProseMirror/testing/createTestEditor.ts

@@ -0,0 +1,31 @@
+import { DOMParser as ProseMirrorDomParser } from 'prosemirror-model';
+import { EditorView } from 'prosemirror-view';
+import schema from '../schema';
+import { EditorState, Plugin } from 'prosemirror-state';
+
+export type PluginList = Plugin[]|(Plugin|Plugin[])[];
+
+interface Options {
+	parent?: HTMLElement;
+	html: string;
+	plugins?: PluginList;
+}
+
+const createTestEditor = ({ html, parent = null, plugins = [] }: Options) => {
+	if (parent === null) {
+		// Create a test parent -- some code adds tooltips, etc to view.dom.parent.
+		parent = document.createElement('div');
+	}
+
+	const htmlDocument = new DOMParser().parseFromString(html, 'text/html');
+	const proseMirrorDocument = ProseMirrorDomParser.fromSchema(schema).parse(htmlDocument);
+	return new EditorView(parent, {
+		state: EditorState.create({
+			doc: proseMirrorDocument,
+			plugins: plugins.flat(),
+			schema,
+		}),
+	});
+};
+
+export default createTestEditor;

packages/editor/ProseMirror/testing/createTestEditorWithSerializer.ts

@@ -0,0 +1,48 @@
+import originalMarkupPlugin from '../plugins/originalMarkupPlugin';
+import createTestEditor, { PluginList } from './createTestEditor';
+
+interface Props {
+	html: string;
+	plugins: PluginList;
+}
+
+const createTestEditorWithSerializer = (props: Props) => {
+	const serializer = new XMLSerializer();
+	const markupToHtml = originalMarkupPlugin(node => serializer.serializeToString(node));
+	const view = createTestEditor({
+		html: props.html,
+		plugins: [markupToHtml.plugin, ...props.plugins],
+	});
+
+	const normalizeHtml = (html: string) => {
+		const parsed = new DOMParser().parseFromString([
+			'<!DOCTYPE html>',
+			'<html>',
+			'<body>',
+			html,
+			'</body>',
+			'</html>',
+		].join(''), 'text/html');
+
+		// Remove extra XMLNS declarations. These are sometimes added by serialization
+		// done by the originalMarkupPlugin.
+		const namespacedRootElements = parsed.body.querySelectorAll(':scope > [xmlns]');
+		for (const element of namespacedRootElements) {
+			element.removeAttribute('xmlns');
+		}
+
+		return serializer.serializeToString(
+			parsed.querySelector('body'),
+		);
+	};
+
+	return {
+		view,
+		toHtml: () => {
+			return normalizeHtml(markupToHtml.stateToMarkup(view.state).trim());
+		},
+		normalizeHtml,
+	};
+};
+
+export default createTestEditorWithSerializer;

packages/editor/ProseMirror/testing/mockEditorApi.ts

@@ -0,0 +1,25 @@
+import { EditorView } from 'prosemirror-view';
+import joplinEditorApiPlugin, { getEditorApi, setEditorApi } from '../plugins/joplinEditorApiPlugin';
+import { htmlentities } from '@joplin/utils/html';
+import { RenderResult } from '../../../renderer/types';
+
+const mockEditorApi = () => {
+	const setup = (editor: EditorView) => {
+		editor.dispatch(setEditorApi(editor.state.tr, {
+			...getEditorApi(editor.state),
+			renderer: {
+				renderMarkupToHtml: jest.fn(async source => ({
+					html: `<pre class="joplin-source">${htmlentities(source)}</pre><p class="test-content">Mocked!</p></div>`,
+				} as RenderResult)),
+				renderHtmlToMarkup: jest.fn(),
+			},
+		}));
+	};
+
+	return {
+		plugin: joplinEditorApiPlugin,
+		setup,
+	};
+};
+
+export default mockEditorApi;