WIP: chore(type): markdown extension

Signed-off-by: Max <max@nextcloud.com>

Author: max-nextcloud

src/extensions/Markdown.js src/extensions/Markdown.tssrc/extensions/Markdown.js renamed to src/extensions/Markdown.ts

@@ -3,7 +3,6 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
-/* eslint-disable jsdoc/require-param-type */
 /* eslint-disable jsdoc/require-param-description */
 
 /*
@@ -24,13 +23,28 @@
  * https://github.com/ProseMirror/prosemirror-markdown#class-markdownserializer
  */
 
+import type { MarkType, Node, NodeType, Schema, Slice } from '@tiptap/pm/model'
+
 import { Extension, getExtensionField } from '@tiptap/core'
 import { DOMParser } from '@tiptap/pm/model'
 import { Plugin, PluginKey } from '@tiptap/pm/state'
 import { defaultMarkdownSerializer, MarkdownSerializer } from 'prosemirror-markdown'
 import markdownit from '../markdownit/index.js'
 import transformPastedHTML from './transformPastedHTML.ts'
 
+declare module '@tiptap/core' {
+	interface MarkConfig {
+		toMarkdown: {
+			default: null
+		}
+	}
+	interface NodeConfig {
+		toMarkdown: {
+			default: null
+		}
+	}
+}
+
 const Markdown = Extension.create({
 	name: 'markdown',
 
@@ -76,7 +90,7 @@ const Markdown = Extension.create({
 					},
 					clipboardTextParser(str, $context, _, view) {
 						const parser = DOMParser.fromSchema(view.state.schema)
-						const doc = document.cloneNode(false)
+						const doc = document.cloneNode(false) as Document
 						const dom = doc.createElement('div')
 						if (shiftKey) {
 							// Treat double newlines as paragraph breaks when pasting as plaintext
@@ -96,20 +110,22 @@ const Markdown = Extension.create({
 						})
 					},
 					clipboardTextSerializer: (slice) => {
-						const traverseNodes = (slice) => {
+						const traverseNodes = (slice: Slice | Node) => {
 							if (
 								slice.content.childCount > 1
-								|| slice.content.firstChild?.childCount > 1
+								|| (slice.content.firstChild?.childCount ?? 0) > 1
 							) {
 								// Selected several nodes or several children of one block node
 								return clipboardSerializer(this.editor.schema).serialize(slice.content)
-							} else if (slice.isLeaf) {
-								return slice.textContent
-							} else {
+							} else if (slice.content.firstChild?.isLeaf) {
+								return slice.content.firstChild.textContent
+							} else if (slice.content.firstChild) {
 								// Only one block node selected, copy it's child content
 								// Required to not copy wrapping block node when selecting e.g. one table
 								// cell, one list item or the content of block quotes/callouts.
 								return traverseNodes(slice.content.firstChild)
+							} else {
+								return '' // empty fragment
 							}
 						}
 
@@ -129,15 +145,17 @@ const Markdown = Extension.create({
  * @param schema.nodes
  * @param schema.marks
  */
-function createMarkdownSerializer({ nodes, marks }) {
+function createMarkdownSerializer(schema: {
+	nodes: Record<string, NodeType>
+	marks: Record<string, MarkType>
+}) {
 	return {
 		serializer: new MarkdownSerializer(
-			extractNodesToMarkdown(nodes),
-			extractMarksToMarkdown(marks),
+			extractNodesToMarkdown(schema.nodes),
+			extractMarksToMarkdown(schema.marks),
 		),
-		serialize(content, options) {
+		serialize(content: Node) {
 			return this.serializer.serialize(content, {
-				...options,
 				tightLists: true,
 			})
 		},
@@ -146,19 +164,16 @@ function createMarkdownSerializer({ nodes, marks }) {
 
 /**
  *
- * @param root0
- * @param root0.nodes
- * @param root0.marks
+ * @param schema or the editorc
  */
-function clipboardSerializer({ nodes, marks }) {
+function clipboardSerializer(schema: Schema) {
 	return {
 		serializer: new MarkdownSerializer(
-			extractNodesToMarkdown(nodes),
-			extractToPlaintext(marks),
+			extractNodesToMarkdown(schema.nodes),
+			extractToPlaintext(schema.marks),
 		),
-		serialize(content, options) {
+		serialize(content: Node) {
 			return this.serializer.serialize(content, {
-				...options,
 				tightLists: true,
 			})
 		},
@@ -169,7 +184,7 @@ function clipboardSerializer({ nodes, marks }) {
  *
  * @param marks
  */
-function extractToPlaintext(marks) {
+function extractToPlaintext(marks: Record<string, MarkType>) {
 	const blankMark = {
 		open: '',
 		close: '',
@@ -186,7 +201,7 @@ function extractToPlaintext(marks) {
  *
  * @param nodesOrMarks
  */
-function extractToMarkdown(nodesOrMarks) {
+function extractToMarkdown(nodesOrMarks: Record<string, (NodeType | MarkType)>) {
 	const nodeOrMarkEntries = Object.entries(nodesOrMarks)
 		.map(([name, nodeOrMark]) => [name, nodeOrMark.spec.toMarkdown])
 		.filter(([, toMarkdown]) => toMarkdown)
@@ -198,7 +213,7 @@ function extractToMarkdown(nodesOrMarks) {
  *
  * @param nodes
  */
-function extractNodesToMarkdown(nodes) {
+function extractNodesToMarkdown(nodes: Record<string, NodeType>) {
 	const defaultNodes = convertNames(defaultMarkdownSerializer.nodes)
 	const nodesToMarkdown = extractToMarkdown(nodes)
 	return { ...defaultNodes, ...nodesToMarkdown }
@@ -208,21 +223,24 @@ function extractNodesToMarkdown(nodes) {
  *
  * @param marks
  */
-function extractMarksToMarkdown(marks) {
+function extractMarksToMarkdown(marks: Record<string, MarkType>) {
 	const defaultMarks = convertNames(defaultMarkdownSerializer.marks)
 	const marksToMarkdown = extractToMarkdown(marks)
 	return { ...defaultMarks, ...marksToMarkdown }
 }
 
+type NodeSerializerSpecs = typeof defaultMarkdownSerializer.nodes
+type MarkSerializerSpecs = typeof defaultMarkdownSerializer.marks
+
 /**
  *
- * @param object
+ * @param specs
  */
-function convertNames(object) {
-	const convert = (name) => {
+function convertNames(specs: NodeSerializerSpecs | MarkSerializerSpecs) {
+	const convert = (name: string) => {
 		return name.replace(/_(\w)/g, (_m, letter) => letter.toUpperCase())
 	}
-	return Object.fromEntries(Object.entries(object).map(([name, value]) => [convert(name), value]))
+	return Object.fromEntries(Object.entries(specs).map(([name, value]) => [convert(name), value]))
 }
 
 export { createMarkdownSerializer }

src/tests/nodes/Mathematics.spec.js src/tests/nodes/Mathematics.spec.tssrc/tests/nodes/Mathematics.spec.js renamed to src/tests/nodes/Mathematics.spec.ts

@@ -6,9 +6,9 @@
 import { getExtensionField } from '@tiptap/core'
 import markdownit from '../../markdownit/index.js'
 import { MathBlock, MathInline } from '../../nodes/Mathematics.js'
-import editorTest from '../testHelpers/editorTest.js'
+import testEditor from '../testHelpers/testEditor.ts'
 
-const test = editorTest.override('extensions', [MathBlock, MathInline])
+const test = testEditor.override('extensions', [MathBlock, MathInline])
 
 describe('Mathematics nodes', () => {
 	describe('Node structure', () => {

src/tests/testHelpers/editorTest.ts src/tests/testHelpers/testEditor.tssrc/tests/testHelpers/editorTest.ts renamed to src/tests/testHelpers/testEditor.ts

@@ -3,7 +3,7 @@ import type { Editor, Extensions } from '@tiptap/core'
 import { test as baseTest } from 'vitest'
 import { createMarkdownSerializer } from '../../extensions/Markdown.js'
 import markdownit from '../../markdownit/index.js'
-import createCustomEditor from './createCustomEditor.ts'
+import createCustomEditor from './createCustomEditor.js'
 
 export default baseTest.extend<{
 	editor: Editor