@fiduswriter/editor 0.1.20 → 0.1.21

package/src/document_template/{index.js → index.ts}

@@ -6,25 +6,54 @@ import {
     get,
     shortFileTitle
 } from "fwtoolkit"
-import {SaveCopy} from "../exporter/native/index.js"
 import {E2EEKeyManager} from "fwtoolkit/e2ee/key-manager"
 import {
     createPasswordDialog,
     enterPasswordDialog
 } from "fwtoolkit/e2ee/password-dialog"
 
+import type {Editor} from "../types.js"
+import {SaveCopy} from "../exporter/native/index.js"
+
 export {serializeHelp} from "./schema.js"
 
+interface DocumentTemplate {
+    title: string
+}
+
+interface ExportTemplate {
+    title: string
+    file_type: "docx" | "odt"
+    template_file: string
+}
+
+interface DocumentStyle {
+    title: string
+    slug: string
+    documentstylefile_set: Array<[string, string]>
+}
+
 export class ModDocumentTemplate {
-    constructor(editor) {
+    editor: Editor
+    exportTemplates: ExportTemplate[]
+    documentStyles: DocumentStyle[]
+    documentTemplates: Record<string, DocumentTemplate>
+    citationStyles: Record<string, string>
+
+    constructor(editor: Editor) {
         editor.mod.documentTemplate = this
         this.editor = editor
         this.exportTemplates = []
         this.documentStyles = []
         this.documentTemplates = {}
+        this.citationStyles = {}
     }
 
-    setStyles(styles) {
+    setStyles(styles: {
+        export_templates: ExportTemplate[]
+        document_styles: DocumentStyle[]
+        document_templates: Record<string, DocumentTemplate>
+    }): void {
         this.exportTemplates = styles.export_templates
         this.documentStyles = styles.document_styles
         this.documentTemplates = styles.document_templates
@@ -33,8 +62,8 @@ export class ModDocumentTemplate {
         if (Object.keys(this.documentTemplates).length) {
             this.addCopyAsMenuEntry()
         }
-        if (this.editor.menu.headerView) {
-            this.editor.menu.headerView.update()
+        if ((this.editor.menu as any).headerView) {
+            ;(this.editor.menu as any).headerView.update()
         }
         //Cache the template files using Service Worker
         for (const key in styles.export_templates) {
@@ -49,8 +78,12 @@ export class ModDocumentTemplate {
         })
     }
 
-    addDocPartSettings() {
-        const hideableDocParts = []
+    addDocPartSettings(): void {
+        const hideableDocParts: Array<{
+            title: string
+            id: string
+            index: number
+        }> = []
         this.editor.view.state.doc.forEach((child, _offset, index) => {
             if (child.attrs.optional) {
                 hideableDocParts.push({
@@ -69,13 +102,13 @@ export class ModDocumentTemplate {
             type: "menu",
             tooltip: gettext("Choose which optional sections to enable."),
             order: 0,
-            disabled: editor => editor.docInfo.access_rights !== "write",
+            disabled: (editor: Editor) => editor.docInfo.access_rights !== "write",
             content: hideableDocParts.map(docPart => ({
                 title: docPart.title,
                 type: "setting",
                 tooltip: `${gettext("Show/hide")} ${docPart.title}`,
                 order: docPart.index,
-                action: editor => {
+                action: (editor: Editor) => {
                     let offset = 0
                     for (let i = 0; i < docPart.index; i++) {
                         offset += editor.view.state.doc.child(i).nodeSize
@@ -85,7 +118,7 @@ export class ModDocumentTemplate {
                         editor.view.state.tr
                             .setNodeMarkup(
                                 offset,
-                                false,
+                                null,
                                 Object.assign({}, node.attrs, {
                                     hidden: !node.attrs.hidden
                                 })
@@ -93,25 +126,27 @@ export class ModDocumentTemplate {
                             .setMeta("settings", true)
                     )
                 },
-                selected: editor =>
+                selected: (editor: Editor) =>
                     !editor.view.state.doc.child(docPart.index).attrs.hidden
             }))
         }
-        const settingsMenu = this.editor.menu.headerbarModel.content.find(
-            menu => menu.id === "settings"
+        const headerbarModel = (this.editor.menu as any).headerbarModel
+        const settingsMenu = headerbarModel.content.find(
+            (menu: any) => menu.id === "settings"
         )
         settingsMenu.content = settingsMenu.content.filter(
-            item => item.id !== "metadata"
+            (item: any) => item.id !== "metadata"
         )
         settingsMenu.content.unshift(metadataMenu)
     }
 
-    addCopyAsMenuEntry() {
-        const fileMenu = this.editor.menu.headerbarModel.content.find(
-            menu => menu.id === "file"
+    addCopyAsMenuEntry(): void {
+        const headerbarModel = (this.editor.menu as any).headerbarModel
+        const fileMenu = headerbarModel.content.find(
+            (menu: any) => menu.id === "file"
         )
         // Cancel if run already
-        if (fileMenu.content.find(menuItem => menuItem.id === "copy_as")) {
+        if (fileMenu.content.find((menuItem: any) => menuItem.id === "copy_as")) {
             return
         }
         fileMenu.content.push({
@@ -122,9 +157,9 @@ export class ModDocumentTemplate {
                 "Create copy of the current document with a specific template."
             ),
             order: 3.5,
-            action: editor => {
-                const isE2EE = editor.docInfo.e2ee
-                const e2eeMode = editor.app.settings.E2EE_MODE
+            action: (editor: Editor) => {
+                const isE2EE = (editor.docInfo as any).e2ee
+                const e2eeMode = (editor.app.settings as any).E2EE_MODE
                 const canToggleE2EE =
                     e2eeMode === "enabled" ||
                     (e2eeMode === "required" && !isE2EE) ||
@@ -148,11 +183,11 @@ export class ModDocumentTemplate {
                         ${gettext("Select document template for copy.")}
                         </p>
                         <select class="fw-button fw-large fw-light">${Object.entries(
-                            editor.mod.documentTemplate.documentTemplates
+                            (editor.mod as any).documentTemplate.documentTemplates
                         )
                             .map(
                                 ([importId, dt]) =>
-                                    `<option value="${escapeText(importId)}">${escapeText(dt.title)}</option>`
+                                    `<option value="${escapeText(importId)}">${escapeText((dt as DocumentTemplate).title)}</option>`
                             )
                             .join("")}</select>
                         ${e2eeHtml}`,
@@ -172,28 +207,32 @@ export class ModDocumentTemplate {
 
                                 const targetE2EE =
                                     canToggleE2EE &&
-                                    selectTemplateDialog.dialogEl.querySelector(
-                                        "#e2ee-copy-toggle"
+                                    (
+                                        selectTemplateDialog.dialogEl.querySelector(
+                                            "#e2ee-copy-toggle"
+                                        ) as HTMLInputElement | null
                                     )?.checked
 
-                                const doCopy = e2eeOptions => {
+                                const doCopy = (e2eeOptions: any) => {
                                     const copier = new SaveCopy(
-                                        editor.getDoc(),
-                                        editor.mod.db.bibDB,
-                                        editor.mod.db.imageDB,
+                                        editor.getDoc() as any,
+                                        (editor.mod.db as any).bibDB,
+                                        (editor.mod.db as any).imageDB,
                                         editor.user,
-                                        selectTemplateDialog.dialogEl.querySelector(
-                                            "select"
-                                        ).value,
+                                        (
+                                            selectTemplateDialog.dialogEl.querySelector(
+                                                "select"
+                                            ) as HTMLSelectElement
+                                        ).value as any,
                                         e2eeOptions
                                     )
                                     copier
                                         .init()
-                                        .then(({docInfo}) => {
+                                        .then(({docInfo}: any) => {
                                             const url = targetE2EE
                                                 ? `/document/${docInfo.id}/?e2ee=1`
                                                 : `/document/${docInfo.id}/`
-                                            editor.app.goTo(url)
+                                            ;(editor.app as any).goTo(url)
                                         })
                                         .catch(() => false)
                                     selectTemplateDialog.close()
@@ -207,14 +246,14 @@ export class ModDocumentTemplate {
                                             targetE2EE: false
                                         })
                                     } else {
-                                        enterPasswordDialog(async password => {
+                                        enterPasswordDialog(async (password: string) => {
                                             try {
                                                 const key =
                                                     await E2EEKeyManager.deriveKey(
                                                         password,
                                                         new Uint8Array(
                                                             atob(
-                                                                editor.docInfo
+                                                                (editor.docInfo as any)
                                                                     .e2ee_salt
                                                             )
                                                                 .split("")
@@ -224,7 +263,7 @@ export class ModDocumentTemplate {
                                                                     )
                                                                 )
                                                         ),
-                                                        editor.docInfo
+                                                        (editor.docInfo as any)
                                                             .e2ee_iterations ||
                                                             600000
                                                     )
@@ -244,7 +283,7 @@ export class ModDocumentTemplate {
                                     }
                                 } else if (!isE2EE && targetE2EE) {
                                     // Encrypting: need new password
-                                    createPasswordDialog(password => {
+                                    createPasswordDialog((password: string) => {
                                         doCopy({
                                             targetE2EE: true,
                                             targetPassword: password
@@ -252,8 +291,8 @@ export class ModDocumentTemplate {
                                     })
                                 } else if (isE2EE && targetE2EE) {
                                     // E2EE -> E2EE: need source key, then new password
-                                    const handlePasswords = sourceKey => {
-                                        createPasswordDialog(password => {
+                                    const handlePasswords = (sourceKey: any) => {
+                                        createPasswordDialog((password: string) => {
                                             doCopy({
                                                 sourceKey: sourceKey,
                                                 targetE2EE: true,
@@ -264,14 +303,14 @@ export class ModDocumentTemplate {
                                     if (editor.e2ee && editor.e2ee.key) {
                                         handlePasswords(editor.e2ee.key)
                                     } else {
-                                        enterPasswordDialog(async password => {
+                                        enterPasswordDialog(async (password: string) => {
                                             try {
                                                 const key =
                                                     await E2EEKeyManager.deriveKey(
                                                         password,
                                                         new Uint8Array(
                                                             atob(
-                                                                editor.docInfo
+                                                                (editor.docInfo as any)
                                                                     .e2ee_salt
                                                             )
                                                                 .split("")
@@ -281,7 +320,7 @@ export class ModDocumentTemplate {
                                                                     )
                                                                 )
                                                         ),
-                                                        editor.docInfo
+                                                        (editor.docInfo as any)
                                                             .e2ee_iterations ||
                                                             600000
                                                     )
@@ -309,23 +348,26 @@ export class ModDocumentTemplate {
                 })
                 selectTemplateDialog.open()
             },
-            disabled: editor => editor.app.isOffline()
+            disabled: (editor: Editor) => editor.app.isOffline()
         })
 
-        fileMenu.content = fileMenu.content.sort((a, b) => a.order - b.order)
+        fileMenu.content = fileMenu.content.sort(
+            (a: any, b: any) => a.order - b.order
+        )
     }
 
-    addExportTemplateMenuEntries() {
-        const exportMenu = this.editor.menu.headerbarModel.content.find(
-            menu => menu.id === "export"
+    addExportTemplateMenuEntries(): void {
+        const headerbarModel = (this.editor.menu as any).headerbarModel
+        const exportMenu = headerbarModel.content.find(
+            (menu: any) => menu.id === "export"
         )
         // Remove any previous entries in case we run this a second time
         exportMenu.content = exportMenu.content.filter(
-            menuItem => menuItem.class !== "export_template"
+            (menuItem: any) => menuItem.class !== "export_template"
         )
         // Find highest menu item under 100 to put templates at end of native exporter options.
         let order = 1
-        exportMenu.content.forEach(menuItem => {
+        exportMenu.content.forEach((menuItem: any) => {
             if (menuItem.order < 100 && menuItem.order > order) {
                 order = menuItem.order
             }
@@ -340,11 +382,11 @@ export class ModDocumentTemplate {
                     tooltip: gettext(
                         "Export the document to a DOCX file with the given template."
                     ),
-                    action: editor => {
+                    action: (editor: Editor) => {
                         import(
                             "@fiduswriter/document/exporter/docx/index"
-                        ).then(({DOCXExporter}) => {
-                            const doc = editor.getDoc()
+                        ).then(({DOCXExporter}: any) => {
+                            const doc = editor.getDoc() as any
                             const title = shortFileTitle(
                                 doc.title,
                                 doc.path || ""
@@ -357,16 +399,18 @@ export class ModDocumentTemplate {
                             const exporter = new DOCXExporter(
                                 doc,
                                 template.template_file,
-                                editor.mod.db.bibDB,
-                                editor.mod.db.imageDB,
+                                (editor.mod.db as any).bibDB,
+                                (editor.mod.db as any).imageDB,
                                 editor.app.csl
                             )
-                            exporter.progressCallback = (message, percentage) =>
-                                task.update(percentage, message)
+                            exporter.progressCallback = (
+                                message: string,
+                                percentage: number
+                            ) => task.update(percentage, message)
                             exporter.init()
                         })
                     },
-                    disabled: editor => editor.app.isOffline()
+                    disabled: (editor: Editor) => editor.app.isOffline()
                 }
             } else {
                 return {
@@ -377,10 +421,10 @@ export class ModDocumentTemplate {
                     tooltip: gettext(
                         "Export the document to an ODT file with the given template."
                     ),
-                    action: editor => {
+                    action: (editor: Editor) => {
                         import("@fiduswriter/document/exporter/odt/index").then(
-                            ({ODTExporter}) => {
-                                const doc = editor.getDoc()
+                            ({ODTExporter}: any) => {
+                                const doc = editor.getDoc() as any
                                 const title = shortFileTitle(
                                     doc.title,
                                     doc.path || ""
@@ -393,92 +437,89 @@ export class ModDocumentTemplate {
                                 const exporter = new ODTExporter(
                                     doc,
                                     template.template_file,
-                                    editor.mod.db.bibDB,
-                                    editor.mod.db.imageDB,
+                                    (editor.mod.db as any).bibDB,
+                                    (editor.mod.db as any).imageDB,
                                     editor.app.csl
                                 )
                                 exporter.progressCallback = (
-                                    message,
-                                    percentage
+                                    message: string,
+                                    percentage: number
                                 ) => task.update(percentage, message)
                                 exporter.init()
                             }
                         )
                     },
-                    disabled: editor => editor.app.isOffline()
+                    disabled: (editor: Editor) => editor.app.isOffline()
                 }
             }
         })
         exportMenu.content = exportMenu.content.concat(exportMenuEntries)
         exportMenu.content = exportMenu.content.sort(
-            (a, b) => a.order - b.order
+            (a: any, b: any) => a.order - b.order
         )
     }
 
-    addDocumentStylesMenuEntries() {
-        const settingsMenu = this.editor.menu.headerbarModel.content.find(
-                menu => menu.id === "settings"
+    addDocumentStylesMenuEntries(): void {
+        const headerbarModel = (this.editor.menu as any).headerbarModel
+        const settingsMenu = headerbarModel.content.find(
+                (menu: any) => menu.id === "settings"
             ),
             documentStyleMenu = settingsMenu.content.find(
-                menu => menu.id === "document_style"
+                (menu: any) => menu.id === "document_style"
             )
 
-        documentStyleMenu.content = this.documentStyles.map(docStyle => {
-            return {
-                title: docStyle.title,
-                type: "setting",
-                action: editor => {
-                    editor.view.dispatch(
-                        editor.view.state.tr
-                            .setDocAttribute("documentstyle", docStyle.slug)
-                            .setMeta("settings", true)
-                    )
-                },
-                selected: editor =>
-                    editor.view.state.doc.attrs.documentstyle === docStyle.slug,
-                disabled: editor => editor.app.isOffline()
-            }
-        })
+        documentStyleMenu.content = this.documentStyles.map(docStyle => ({
+            title: docStyle.title,
+            type: "setting",
+            action: (editor: Editor) => {
+                editor.view.dispatch(
+                    editor.view.state.tr
+                        .setDocAttribute("documentstyle", docStyle.slug)
+                        .setMeta("settings", true)
+                )
+            },
+            selected: (editor: Editor) =>
+                editor.view.state.doc.attrs.documentstyle === docStyle.slug,
+            disabled: (editor: Editor) => editor.app.isOffline()
+        }))
     }
 
-    getCitationStyles() {
-        return this.editor.app.csl.getStyles().then(styles => {
-            this.citationStyles = styles
-        })
+    getCitationStyles(): Promise<void> {
+        return (this.editor.app.csl as any)
+            .getStyles()
+            .then((styles: Record<string, string>) => {
+                this.citationStyles = styles
+            })
     }
 
-    addCitationStylesMenuEntries() {
-        const settingsMenu = this.editor.menu.headerbarModel.content.find(
-                menu => menu.id === "settings"
+    addCitationStylesMenuEntries(): void {
+        const headerbarModel = (this.editor.menu as any).headerbarModel
+        const settingsMenu = headerbarModel.content.find(
+                (menu: any) => menu.id === "settings"
             ),
             citationStyleMenu = settingsMenu.content.find(
-                menu => menu.id === "citation_style"
+                (menu: any) => menu.id === "citation_style"
             )
         if (citationStyleMenu) {
             citationStyleMenu.content =
                 this.editor.view.state.doc.attrs.citationstyles.map(
-                    citationstyle => {
-                        return {
-                            title: this.citationStyles[citationstyle],
-                            type: "setting",
-                            action: editor => {
-                                editor.view.dispatch(
-                                    editor.view.state.tr
-                                        .setDocAttribute(
-                                            "citationstyle",
-                                            citationstyle
-                                        )
-                                        .setMeta("settings", true)
-                                )
-                            },
-                            selected: editor => {
-                                return (
-                                    editor.view.state.doc.attrs
-                                        .citationstyle === citationstyle
-                                )
-                            }
-                        }
-                    }
+                    (citationstyle: string) => ({
+                        title: this.citationStyles[citationstyle],
+                        type: "setting",
+                        action: (editor: Editor) => {
+                            editor.view.dispatch(
+                                editor.view.state.tr
+                                    .setDocAttribute(
+                                        "citationstyle",
+                                        citationstyle
+                                    )
+                                    .setMeta("settings", true)
+                            )
+                        },
+                        selected: (editor: Editor) =>
+                            editor.view.state.doc.attrs.citationstyle ===
+                            citationstyle
+                    })
                 )
         }
     }