@fiduswriter/editor 0.1.19 → 0.1.21

package/src/exporter/native/{revision.js → revision.ts}

@@ -1,20 +1,28 @@
+import type {BibDB, ExportDoc, ImageDB, UploadRevision} from "@fiduswriter/document"
 import {SaveRevision as GenericSaveRevision} from "@fiduswriter/document/exporter/native"
 import {createSlug} from "@fiduswriter/document/exporter/tools/file"
 import {addAlert, addProgress, gettext, post, shortFileTitle} from "fwtoolkit"
+import type {App} from "../../types.js"
 import {DocumentTemplateExporter} from "../../document_template/exporter.js"
 
 export class SaveRevision extends GenericSaveRevision {
-    constructor(doc, imageDB, bibDB, note, app) {
+    constructor(
+        doc: ExportDoc,
+        imageDB: ImageDB,
+        bibDB: BibDB,
+        note: string,
+        app: App
+    ) {
         const title = shortFileTitle(doc.title, doc.path || "")
         const task = addProgress(
             "info",
             `${title}: ${gettext("Saving revision...")}`,
             {autoClose: 6000}
         )
-        const progressCallback = (message, percentage) =>
-            task.update(percentage, message)
+        const progressCallback = (message: string, percentage?: number | null) =>
+            task.update(percentage ?? null, message)
 
-        const onError = error => {
+        const onError = (error: unknown) => {
             task.close()
             addAlert("error", gettext("Revision file could not be generated."))
             if (app.isOffline()) {
@@ -29,12 +37,12 @@ export class SaveRevision extends GenericSaveRevision {
             }
         }
 
-        const getTemplateFiles = (docId, token) => {
+        const getTemplateFiles = (docId: number | string, token: string | boolean) => {
             const templateExporter = new DocumentTemplateExporter(
                 docId,
                 "/api/document/get_template_for_doc/",
                 false,
-                token
+                token as string | false
             )
             return templateExporter.init().then(() => ({
                 textFiles: templateExporter.textFiles,
@@ -42,7 +50,7 @@ export class SaveRevision extends GenericSaveRevision {
             }))
         }
 
-        const uploadRevision = (blob, doc) => {
+        const uploadRevision: UploadRevision = (blob, doc) => {
             return post(
                 "/api/document/upload/",
                 {
@@ -53,7 +61,7 @@ export class SaveRevision extends GenericSaveRevision {
                     file: {
                         file: blob,
                         filename: `${createSlug(
-                            shortFileTitle(doc.title, doc.path)
+                            shortFileTitle(doc.title as string, doc.path as string)
                         )}.fidus`
                     }
                 }
@@ -84,7 +92,7 @@ export class SaveRevision extends GenericSaveRevision {
         })
     }
 
-    init() {
+    init(): Promise<unknown> {
         return super.init().then(result => {
             addAlert("success", gettext("Revision saved."))
             return result

package/src/footnotes/{editor.js → editor.ts}

@@ -5,7 +5,8 @@ import {buildKeymap} from "prosemirror-example-setup"
 import {gapCursor} from "prosemirror-gapcursor"
 import {history} from "prosemirror-history"
 import {keymap} from "prosemirror-keymap"
-import {EditorState} from "prosemirror-state"
+import {Node, Schema} from "prosemirror-model"
+import {EditorState, Transaction} from "prosemirror-state"
 import {Step} from "prosemirror-transform"
 import {EditorView} from "prosemirror-view"
 
@@ -29,16 +30,32 @@ import {
 } from "../state_plugins/index.js"
 import {amendTransaction} from "../track/index.js"
 import {accessRightsPlugin} from "./state_plugins/index.js"
+import type {Editor} from "../types.js"
+
+interface FootnoteMod {
+    editor: Editor
+    footnotes?: any
+    fnEditor?: ModFootnoteEditor
+    layout?: any
+}
 
 /* Functions related to the footnote editor instance */
 export class ModFootnoteEditor {
-    constructor(mod) {
+    mod: FootnoteMod
+    schema: Schema
+    fnStatePlugins: [any, ((doc: Node) => any)?][]
+    view!: EditorView
+
+    constructor(mod: FootnoteMod) {
         mod.fnEditor = this
         this.mod = mod
-        this.schema = fnSchema
+        this.schema = fnSchema as Schema
         // Decryption of end-to-end encrypted images is provided by the main
         // app and injected into the reusable footnote schema here.
-        this.schema.cached.decryptImage = (imageEntry, _dom) => {
+        ;(this.schema as any).cached.decryptImage = (
+            imageEntry: any,
+            _dom: any
+        ) => {
             const key = this.mod.editor.e2ee?.key
             if (!key) {
                 return Promise.reject(new Error("No E2EE key available"))
@@ -74,7 +91,7 @@ export class ModFootnoteEditor {
         ]
     }
 
-    init() {
+    init(): void {
         const doc = this.schema.nodeFromJSON({type: "doc", content: []}),
             plugins = this.fnStatePlugins.map(plugin => {
                 if (plugin[1]) {
@@ -85,7 +102,7 @@ export class ModFootnoteEditor {
             })
 
         this.view = new EditorView(
-            document.getElementById("footnote-box-container"),
+            document.getElementById("footnote-box-container") as HTMLElement,
             {
                 state: EditorState.create({
                     schema: this.schema,
@@ -103,9 +120,9 @@ export class ModFootnoteEditor {
                     // Skip if creating new footnote by typing directly into empty footnote editor.
                     if (
                         tr.docChanged &&
-                        tr.steps[0].jsonID === "replace" &&
-                        tr.steps[0].from === 0 &&
-                        tr.steps[0].to === 0 &&
+                        (tr.steps[0] as any).jsonID === "replace" &&
+                        (tr.steps[0] as any).from === 0 &&
+                        (tr.steps[0] as any).to === 0 &&
                         !remote &&
                         !fromMain
                     ) {
@@ -127,7 +144,7 @@ export class ModFootnoteEditor {
     }
 
     // Find out if we need to recalculate the bibliography
-    onTransaction(tr) {
+    onTransaction(tr: Transaction): void {
         const mainMeta = tr.getMeta("toMain")
         if (tr.getMeta("remote") || (!mainMeta && !tr.docChanged)) {
             return
@@ -146,7 +163,9 @@ export class ModFootnoteEditor {
                             // Full insertion or deletion of footnotes mean that the from will be in-between footnotes
                             // and have a depth of zero. We ignore these changes as they will have originated from
                             // the main editor.
-                            const $pos = tr.docs[index].resolve(step.from)
+                            const $pos = tr.docs[index].resolve(
+                                (step as any).from
+                            )
                             if ($pos.depth === 0) {
                                 return -1
                             }
@@ -172,7 +191,7 @@ export class ModFootnoteEditor {
         }
     }
 
-    applyDiffs(diffs, cid) {
+    applyDiffs(diffs: any[], cid: number): void {
         const steps = diffs.map(j => Step.fromJSON(this.view.state.schema, j))
         const clientIds = diffs.map(_ => cid)
         const tr = receiveTransaction(this.view.state, steps, clientIds)
@@ -180,10 +199,10 @@ export class ModFootnoteEditor {
         this.view.dispatch(tr)
     }
 
-    renderAllFootnotes() {
+    renderAllFootnotes(): void {
         const content = getFootnoteMarkerContents(
             this.mod.editor.view.state
-        ).map(fnContent => ({
+        ).map((fnContent: any) => ({
             type: "footnotecontainer",
             content: fnContent
         }))
@@ -203,8 +222,8 @@ export class ModFootnoteEditor {
         this.view.updateState(newState)
     }
 
-    renderFootnote(content, index = 0, tr) {
-        const node = fnNodeToPmNode(content)
+    renderFootnote(content: any, index = 0, tr: Transaction): void {
+        const node = fnNodeToPmNode(content) as Node
         let pos = 0
         for (let i = 0; i < index; i++) {
             pos += tr.doc.child(i).nodeSize
@@ -212,8 +231,8 @@ export class ModFootnoteEditor {
         tr.insert(pos, node)
     }
 
-    removeFootnote(index, tr) {
-        if (this.mod.editor.mod.collab.doc.receiving) {
+    removeFootnote(index: number, tr: Transaction): void {
+        if ((this.mod.editor.mod.collab as any).doc.receiving) {
             return
         }
 

package/src/footnotes/index.ts

@@ -0,0 +1,21 @@
+import {ModFootnoteEditor} from "./editor.js"
+import {ModFootnoteLayout} from "./layout.js"
+import type {Editor} from "../types.js"
+
+export class ModFootnotes {
+    editor: Editor
+    fnEditor: ModFootnoteEditor
+    layout: ModFootnoteLayout
+
+    constructor(editor: Editor) {
+        editor.mod.footnotes = this
+        this.editor = editor
+        this.fnEditor = new ModFootnoteEditor(this)
+        this.layout = new ModFootnoteLayout(this)
+    }
+
+    init(): void {
+        this.fnEditor.init()
+        this.layout.init()
+    }
+}

package/src/footnotes/{layout.js → layout.ts}

@@ -1,14 +1,30 @@
 import fastdom from "fastdom"
+
 import {getFootnoteMarkers} from "../state_plugins/index.js"
+import type {Editor} from "../types.js"
+
+const fastdomImpl = fastdom as any
+
+interface FootnoteMarker {
+    from: number
+    to: number
+}
 
 /* A class to make footnotes appear correctly off the side of their referrer. */
 export class ModFootnoteLayout {
-    constructor(mod) {
+    mod: {
+        editor: Editor
+        [key: string]: any
+    }
+    editor: Editor
+
+    constructor(mod: {editor: Editor; [key: string]: any}) {
         mod.layout = this
         this.mod = mod
+        this.editor = mod.editor
     }
 
-    init() {
+    init(): void {
         // Add two elements to hold dynamic CSS info about comments.
         const styleContainers = document.createElement("temp")
         styleContainers.innerHTML =
@@ -18,18 +34,19 @@ export class ModFootnoteLayout {
         }
     }
 
-    updateDOM() {
+    updateDOM(): void {
         // Handle the CSS layout of the footnotes on the screen.
         // DOM write phase - nothing to do.
-        fastdom.measure(() => {
+        fastdomImpl.measure(() => {
             // DOM read phase
             const footnoteBoxes = document.querySelectorAll(
                     "#footnote-box-container .footnote-container"
                 ),
-                referrers = getFootnoteMarkers(this.mod.editor.view.state)
+                referrers = getFootnoteMarkers(this.editor.view.state)
             if (
                 (!referrers.length &&
-                    this.mod.editor.mod.citations.citationType !== "note") ||
+                    (this.editor.mod.citations as any).citationType !==
+                        "note") ||
                 referrers.length !== footnoteBoxes.length
             ) {
                 // Apparently not all footnote boxes have been drawn or there are none. Abort for now.
@@ -38,11 +55,16 @@ export class ModFootnoteLayout {
             const footnoteBoxContainer = document.getElementById(
                 "footnote-box-container"
             )
+            if (!footnoteBoxContainer) {
+                return
+            }
             let footnotePlacementStyle = ""
 
             if (getComputedStyle(footnoteBoxContainer).display === "block") {
                 // We are in mobile/tablet mode. We don't need to place footnotes.
-            } else if (this.mod.editor.mod.citations.citationType === "note") {
+            } else if (
+                (this.editor.mod.citations as any).citationType === "note"
+            ) {
                 const totalOffset =
                     footnoteBoxContainer.getBoundingClientRect().top
                 /* Citations are also in footnotes, so both citation footnotes
@@ -57,7 +79,7 @@ export class ModFootnoteLayout {
                     citationFootnoteIndex = 0,
                     totalEditorOffset = totalOffset,
                     totalCitationOffset = totalOffset
-                this.mod.editor.view.state.doc.descendants((node, pos) => {
+                this.editor.view.state.doc.descendants((node, pos) => {
                     if (
                         node.isInline &&
                         (node.type.name === "footnote" ||
@@ -72,7 +94,7 @@ export class ModFootnoteLayout {
                                     footnoteBox.getBoundingClientRect(),
                                 footnoteBoxHeight = footnoteBoxCoords.height,
                                 referrerTop =
-                                    this.mod.editor.view.coordsAtPos(pos).top
+                                    this.editor.view.coordsAtPos(pos).top
                             editorFootnoteIndex++
                             if (!referrerTop) {
                                 // footnote is not shown. Also hide the footnote from the editor.
@@ -84,13 +106,11 @@ export class ModFootnoteLayout {
                                 totalEditorOffset <
                                     totalCitationOffset + topMargin
                             ) {
-                                topMargin = Number.parseInt(
-                                    Math.max(
-                                        referrerTop - totalEditorOffset,
-                                        totalCitationOffset -
-                                            totalEditorOffset +
-                                            topMargin
-                                    )
+                                topMargin = Math.max(
+                                    referrerTop - totalEditorOffset,
+                                    totalCitationOffset -
+                                        totalEditorOffset +
+                                        topMargin
                                 )
                                 footnotePlacementStyle += `${selector} {margin-top: ${topMargin}px;}\n`
                             }
@@ -100,9 +120,7 @@ export class ModFootnoteLayout {
                                 citationFootnotes.length > citationFootnoteIndex
                             ) {
                                 const footnoteBox =
-                                        citationFootnotes[
-                                            citationFootnoteIndex
-                                        ],
+                                        citationFootnotes[citationFootnoteIndex],
                                     selector =
                                         ".footnote-citation:nth-of-type(" +
                                         (citationFootnoteIndex + 1) +
@@ -112,7 +130,7 @@ export class ModFootnoteLayout {
                                     footnoteBoxHeight =
                                         footnoteBoxCoords.height,
                                     referrerTop =
-                                        this.mod.editor.view.coordsAtPos(
+                                        this.editor.view.coordsAtPos(
                                             pos
                                         ).top
                                 citationFootnoteIndex++
@@ -126,13 +144,11 @@ export class ModFootnoteLayout {
                                     totalCitationOffset <
                                         totalEditorOffset + topMargin
                                 ) {
-                                    topMargin = Number.parseInt(
-                                        Math.max(
-                                            referrerTop - totalCitationOffset,
-                                            topMargin +
-                                                totalEditorOffset -
-                                                totalCitationOffset
-                                        )
+                                    topMargin = Math.max(
+                                        referrerTop - totalCitationOffset,
+                                        topMargin +
+                                            totalEditorOffset -
+                                            totalCitationOffset
                                     )
                                     footnotePlacementStyle += `${selector} {margin-top: ${topMargin}px;}\n`
                                 }
@@ -149,13 +165,13 @@ export class ModFootnoteLayout {
                  * We use the existing footnote markers referrers to find the
                  * placement.
                  */
-                referrers.forEach((referrer, index) => {
+                referrers.forEach((referrer: FootnoteMarker, index: number) => {
                     const footnoteBox = footnoteBoxes[index]
 
                     const footnoteBoxCoords =
                             footnoteBox.getBoundingClientRect(),
                         footnoteBoxHeight = footnoteBoxCoords.height,
-                        referrerTop = this.mod.editor.view.coordsAtPos(
+                        referrerTop = this.editor.view.coordsAtPos(
                             referrer.from
                         ).top,
                         selector = `.footnote-container:nth-of-type(${index + 1})`
@@ -167,22 +183,23 @@ export class ModFootnoteLayout {
                     let topMargin = 10
 
                     if (referrerTop > totalOffset) {
-                        topMargin = Number.parseInt(referrerTop - totalOffset)
+                        topMargin = referrerTop - totalOffset
                         footnotePlacementStyle += `${selector} {margin-top: ${topMargin}px;}\n`
                     }
                     totalOffset += footnoteBoxHeight + topMargin
                 })
             }
 
-            fastdom.mutate(() => {
+            fastdomImpl.mutate(() => {
                 //DOM write phase
+                const placementStyleEl = document.getElementById(
+                    "footnote-placement-style"
+                )
                 if (
-                    document.getElementById("footnote-placement-style")
-                        .innerHTML != footnotePlacementStyle
+                    placementStyleEl &&
+                    placementStyleEl.innerHTML != footnotePlacementStyle
                 ) {
-                    document.getElementById(
-                        "footnote-placement-style"
-                    ).innerHTML = footnotePlacementStyle
+                    placementStyleEl.innerHTML = footnotePlacementStyle
                 }
             })
         })

package/src/footnotes/state_plugins/{access_rights.js → access_rights.ts}

@@ -1,13 +1,15 @@
 import {Plugin, PluginKey} from "prosemirror-state"
+import type {Transaction} from "prosemirror-state"
 
 import {COMMENT_ONLY_ROLES, READ_ONLY_ROLES} from "../../index.js"
+import type {Editor} from "../../types.js"
 
 const key = new PluginKey("accessRights")
 
-export const accessRightsPlugin = options =>
+export const accessRightsPlugin = (options: {editor: Editor}) =>
     new Plugin({
         key,
-        filterTransaction: (tr, _state) => {
+        filterTransaction: (tr: Transaction, _state) => {
             let allowed = true
             const remote = tr.getMeta("remote")
             const fromMain = tr.getMeta("fromMain")
@@ -17,10 +19,10 @@ export const accessRightsPlugin = options =>
 
             if (
                 (COMMENT_ONLY_ROLES.includes(
-                    options.editor.docInfo.access_rights
+                    options.editor.docInfo.access_rights!
                 ) ||
                     READ_ONLY_ROLES.includes(
-                        options.editor.docInfo.access_rights
+                        options.editor.docInfo.access_rights!
                     )) &&
                 tr.docChanged
             ) {

package/src/global.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Global functions and values provided by Fidus Writer's runtime environment.
+ * These are injected by the Django JavaScript catalog and other runtime scripts.
+ */
+
+declare global {
+    function gettext(msgid: string): string
+
+    function interpolate(
+        fmt: string,
+        args: Array<string | number>,
+        named?: boolean
+    ): string
+
+    function staticUrl(path: string): string
+
+    const csrfToken: string
+
+    interface MathVirtualKeyboard {
+        show(): void
+        hide(): void
+    }
+
+    interface Window {
+        mathVirtualKeyboard?: MathVirtualKeyboard
+    }
+}
+
+export {}

package/src/images/edit_dialog/{model.js → model.ts}

@@ -2,4 +2,4 @@
 // This stub keeps the editor package buildable until a decision is made on
 // whether image editing belongs in @fiduswriter/editor, @fiduswriter/common,
 // or a separate package.
-export const imageEditModel = () => ({content: []})
+export const imageEditModel = (): {content: unknown[]} => ({content: []})