chore(type): EditorFactory and setInitialYjsState

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

Author: max-nextcloud

src/EditorFactory.js src/EditorFactory.tssrc/EditorFactory.js renamed to src/EditorFactory.ts

@@ -5,21 +5,23 @@
 
 import 'proxy-polyfill'
 
-import { Editor } from '@tiptap/core'
+import { Editor, Extension } from '@tiptap/core'
 import hljs from 'highlight.js/lib/core'
 import { createLowlight } from 'lowlight'
 
+import type { Node } from '@tiptap/pm/model'
+import type { Connection } from './composables/useConnection'
 import { FocusTrap, PlainText, RichText } from './extensions/index.js'
 import { logger } from './helpers/logger.ts'
 
 const lowlight = createLowlight()
 
-const loadSyntaxHighlight = async (language) => {
+const loadSyntaxHighlight = async (language: string) => {
 	const list = hljs.listLanguages()
 	logger.debug('Supported languages', { list })
 	if (!lowlight.listLanguages().includes(language)) {
 		try {
-			logger.debug('Loading language', language)
+			logger.debug('Loading language ' + language)
 			// eslint-disable-next-line n/no-missing-import
 			const syntax = await import(
 				`../node_modules/highlight.js/lib/languages/${language}.js`
@@ -42,6 +44,11 @@ const createRichEditor = ({
 	connection,
 	relativePath,
 	isEmbedded = false,
+}: {
+	extensions?: Extension[]
+	connection?: Connection
+	relativePath?: string
+	isEmbedded?: boolean
 } = {}) => {
 	return new Editor({
 		editorProps,
@@ -53,7 +60,10 @@ const createRichEditor = ({
 	})
 }
 
-const createPlainEditor = ({ language = 'plaintext', extensions = [] } = {}) => {
+const createPlainEditor = ({
+	language = 'plaintext',
+	extensions = [],
+}: { language?: string; extensions?: Extension[] } = {}) => {
 	return new Editor({
 		editorProps,
 		extensions: [
@@ -68,7 +78,7 @@ const createPlainEditor = ({ language = 'plaintext', extensions = [] } = {}) =>
 	})
 }
 
-const serializePlainText = (doc) => {
+const serializePlainText = (doc: Node) => {
 	return doc.textContent
 }
 

src/components/Editor.vue

@@ -108,14 +108,14 @@ import { useSyntaxHighlighting } from '../composables/useSyntaxHighlighting.ts'
 import { CollaborationCaret } from '../extensions/index.js'
 import { exposeForDebugging, removeFromDebugging } from '../helpers/debug.ts'
 import { logger } from '../helpers/logger.ts'
-import { setInitialYjsState } from '../helpers/setInitialYjsState.js'
+import { setInitialYjsState } from '../helpers/setInitialYjsState.ts'
 import { ERROR_TYPE, IDLE_TIMEOUT } from '../services/SyncService.ts'
 import { fetchNode } from '../services/WebdavClient.ts'
 import {
 	createPlainEditor,
 	createRichEditor,
 	serializePlainText,
-} from './../EditorFactory.js'
+} from './../EditorFactory.ts'
 import { createMarkdownSerializer } from './../extensions/Markdown.js'
 import markdownit from './../markdownit/index.js'
 import isMobile from './../mixins/isMobile.js'

src/helpers/setInitialYjsState.js src/helpers/setInitialYjsState.tssrc/helpers/setInitialYjsState.js renamed to src/helpers/setInitialYjsState.ts

@@ -10,7 +10,11 @@ import { applyUpdate, Doc, encodeStateAsUpdate, XmlFragment } from 'yjs'
 import { createPlainEditor, createRichEditor } from '../EditorFactory.js'
 import markdownit from '../markdownit/index.js'
 
-export const setInitialYjsState = (ydoc, content, { isRichEditor }) => {
+export const setInitialYjsState = (
+	ydoc: Doc,
+	content: string,
+	{ isRichEditor }: { isRichEditor: boolean },
+) => {
 	const html = isRichEditor
 		? markdownit.render(content) + '<p/>'
 		: `<pre>${escapeHtml(content)}</pre>`
@@ -21,7 +25,7 @@ export const setInitialYjsState = (ydoc, content, { isRichEditor }) => {
 	const json = editor.getJSON()
 
 	const node = Node.fromJSON(editor.schema, json)
-	const getBaseDoc = (node) => {
+	const getBaseDoc = (node: Node) => {
 		const baseDoc = new Doc()
 		// In order to make the initial document state idempotent, we need to reset the clientID
 		// While this is not recommended, we cannot avoid it here as we lack another mechanism
@@ -30,7 +34,7 @@ export const setInitialYjsState = (ydoc, content, { isRichEditor }) => {
 		// it to the server immediately, however this would require read only sessions to be able
 		// to still push a state
 		baseDoc.clientID = 0
-		const type = /** @type {XmlFragment} */ (baseDoc.get('default', XmlFragment))
+		const type = /** @type {XmlFragment} */ baseDoc.get('default', XmlFragment)
 		if (!type.doc) {
 			// This should not happen but is aligned with the upstream implementation
 			// https://github.com/yjs/y-prosemirror/blob/8db24263770c2baaccb08e08ea9ef92dbcf8a9da/src/lib.js#L209

src/tests/markdown.spec.js

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
-import { createRichEditor } from '../EditorFactory.js'
+import { createRichEditor } from '../EditorFactory.ts'
 import { createMarkdownSerializer } from '../extensions/Markdown.js'
 import { typesAvailable } from './../markdownit/callouts.js'
 import markdownit from './../markdownit/index.js'

src/tests/nodes/Table.spec.js

@@ -4,7 +4,7 @@
  */
 
 import { test as baseTest } from 'vitest'
-import { createRichEditor } from '../../EditorFactory.js'
+import { createRichEditor } from '../../EditorFactory.ts'
 import { createMarkdownSerializer } from '../../extensions/Markdown.js'
 import { markdownThroughEditor } from '../testHelpers/markdown.js'
 

src/tests/plaintext.spec.js

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
-import { createPlainEditor, serializePlainText } from './../EditorFactory.js'
+import { createPlainEditor, serializePlainText } from './../EditorFactory.ts'
 import spec from './fixtures/spec.js'
 import xssFuzzVectors from './fixtures/xssFuzzVectors.js'
 

src/tests/testHelpers/builders.js

@@ -6,7 +6,7 @@
 import { Node } from '@tiptap/pm/model'
 import { builders } from 'prosemirror-test-builder'
 import { expect } from 'vitest'
-import { createRichEditor } from '../../EditorFactory.js'
+import { createRichEditor } from '../../EditorFactory.ts'
 
 /**
  * Get node builders from the default rich editor.

src/tests/testHelpers/markdown.js

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
-import { createRichEditor } from '../../EditorFactory.js'
+import { createRichEditor } from '../../EditorFactory.ts'
 import { createMarkdownSerializer } from '../../extensions/Markdown.js'
 import markdownit from '../../markdownit/index.js'
 

src/tests/tiptap.spec.js

@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: AGPL-3.0-or-later
  */
 
-import { createRichEditor } from '../EditorFactory.js'
+import { createRichEditor } from '../EditorFactory.ts'
 import markdownit from '../markdownit/index.js'
 
 const renderedHTML = (markdown) => {

src/tests/yjs.spec.js

@@ -8,7 +8,7 @@ import * as decoding from 'lib0/decoding'
 import * as encoding from 'lib0/encoding'
 import * as syncProtocol from 'y-protocols/sync'
 import { Doc, encodeStateAsUpdate } from 'yjs'
-import { createRichEditor } from '../EditorFactory.js'
+import { createRichEditor } from '../EditorFactory.ts'
 import { createMarkdownSerializer } from '../extensions/Markdown.js'
 import { decodeArrayBuffer } from '../helpers/base64.ts'
 import recorded from './fixtures/recorded.js'