@fiduswriter/document 0.1.0-alpha.3 → 0.1.0-alpha.5

package/src/exporter/docx/{footnotes.js → footnotes.ts}

@@ -1,4 +1,7 @@
 import {descendantNodes} from "../tools/doc_content.js"
+import type {BibDB, CSL, DocSettings, ExportDoc, FidusNode, ImageDB} from "../../types.js"
+import type {XmlZip} from "../tools/xml_zip.js"
+import type {XMLElement} from "../tools/xml.js"
 import {DOCXExporterCitations} from "./citations.js"
 import {DOCXExporterImages} from "./images.js"
 import {DOCXExporterLists} from "./lists.js"
@@ -52,19 +55,48 @@ const DEFAULT_STYLE_FOOTNOTE_ANCHOR = `
     `
 
 export class DOCXExporterFootnotes {
+    doc: ExportDoc
+    docContent: FidusNode
+    settings: DocSettings
+    imageDB: ImageDB
+    bibDB: BibDB
+    xml: XmlZip
+    citations: DOCXExporterCitations
+    csl: CSL
+    lists: DOCXExporterLists
+    math: any
+    tables: any
+    rels: DOCXExporterRels
+
+    pmBib: FidusNode | false
+    fnPmJSON: FidusNode | false
+    images: DOCXExporterImages | null
+    augmentedCitations: DOCXExporterCitations | null
+    footnotes: FidusNode[][]
+    fnXML: string | null
+    fnRels: DOCXExporterRels | null
+    ctXML: XMLElement | null
+    styleXML: XMLElement | null
+    settingsXML: XMLElement | null
+    filePath: string
+    ctFilePath: string
+    settingsFilePath: string
+    styleFilePath: string
+    richtext: any
+
     constructor(
-        doc,
-        docContent,
-        settings,
-        imageDB,
-        bibDB,
-        xml,
-        citations,
-        csl,
-        lists,
-        math,
-        tables,
-        rels
+        doc: ExportDoc,
+        docContent: FidusNode,
+        settings: DocSettings,
+        imageDB: ImageDB,
+        bibDB: BibDB,
+        xml: XmlZip,
+        citations: DOCXExporterCitations,
+        csl: CSL,
+        lists: DOCXExporterLists,
+        math: any,
+        tables: any,
+        rels: DOCXExporterRels
     ) {
         this.doc = doc
         this.docContent = docContent
@@ -81,23 +113,26 @@ export class DOCXExporterFootnotes {
 
         this.pmBib = false
         this.fnPmJSON = false
-        this.images = false
-        this.augmentedCitations = false
+        this.images = null
+        this.augmentedCitations = null
         this.footnotes = [] // footnotes
-        this.fnXML = false
-        this.ctXML = false
-        this.styleXML = false
+        this.fnXML = null
+        this.fnRels = null
+        this.ctXML = null
+        this.styleXML = null
+        this.settingsXML = null
         this.filePath = "word/footnotes.xml"
         this.ctFilePath = "[Content_Types].xml"
         this.settingsFilePath = "word/settings.xml"
         this.styleFilePath = "word/styles.xml"
     }
 
-    init() {
+    init(): Promise<void> | Promise<undefined> {
         this.findFootnotes()
         if (
             this.footnotes.length ||
-            (this.citations.citFm.citationType === "note" &&
+            (this.citations.citFm &&
+                this.citations.citFm.citationType === "note" &&
                 this.citations.citInfos.length)
         ) {
             this.convertFootnotes()
@@ -105,7 +140,7 @@ export class DOCXExporterFootnotes {
             // Include the citinfos from the main body document so that they will be
             // used for calculating the bibliography as well
             this.augmentedCitations = new DOCXExporterCitations(
-                this.fnPmJSON,
+                this.fnPmJSON as FidusNode,
                 this.settings,
                 this.bibDB,
                 this.csl,
@@ -114,13 +149,13 @@ export class DOCXExporterFootnotes {
             )
 
             this.images = new DOCXExporterImages(
-                this.fnPmJSON,
+                this.fnPmJSON as FidusNode,
                 this.imageDB,
                 this.xml,
                 this.fnRels
             )
             this.lists = new DOCXExporterLists(
-                this.fnPmJSON,
+                this.fnPmJSON as FidusNode,
                 this.xml,
                 this.fnRels
             )
@@ -131,10 +166,10 @@ export class DOCXExporterFootnotes {
                     // Replace the main bibliography with the new one that
                     // includes both citations in main document
                     // and in the footnotes.
-                    this.pmBib = this.augmentedCitations.pmBib
-                    return this.fnRels.init()
+                    this.pmBib = this.augmentedCitations!.pmBib
+                    return this.fnRels!.init()
                 })
-                .then(() => this.images.init())
+                .then(() => this.images!.init())
                 .then(() => this.lists.init())
                 .then(() => this.initCt())
                 .then(() => this.setSettings())
@@ -146,7 +181,7 @@ export class DOCXExporterFootnotes {
         }
     }
 
-    initCt() {
+    initCt(): Promise<void> {
         return this.xml.getXml(this.ctFilePath).then(ctXML => {
             this.ctXML = ctXML
             this.addRelsToCt()
@@ -154,19 +189,22 @@ export class DOCXExporterFootnotes {
         })
     }
 
-    addRelsToCt() {
+    addRelsToCt(): void {
+        if (!this.ctXML) {
+            return
+        }
         const override = this.ctXML.query("Override", {
             PartName: `/${this.filePath}`
         })
         if (!override) {
             const types = this.ctXML.query("Types")
-            types.appendXML(
+            types?.appendXML(
                 `<Override PartName="/${this.filePath}" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.footnotes+xml"/>`
             )
         }
     }
 
-    addStyles() {
+    addStyles(): Promise<void> {
         return this.xml.getXml(this.styleFilePath).then(styleXML => {
             this.styleXML = styleXML
             this.addStyle("Footnote", DEFAULT_STYLE_FOOTNOTE)
@@ -175,23 +213,23 @@ export class DOCXExporterFootnotes {
         })
     }
 
-    addStyle(styleName, xml) {
-        if (!this.styleXML.query("w:style", {"w:styleId": styleName})) {
-            const stylesEl = this.styleXML.query("w:styles")
-            stylesEl.appendXML(xml)
+    addStyle(styleName: string, xml: string): void {
+        if (!this.styleXML!.query("w:style", {"w:styleId": styleName})) {
+            const stylesEl = this.styleXML!.query("w:styles")
+            stylesEl?.appendXML(xml)
         }
     }
 
-    findFootnotes() {
+    findFootnotes(): void {
         descendantNodes(this.docContent).forEach(node => {
             if (node.type === "footnote") {
-                this.footnotes.push(node.attrs.footnote)
+                this.footnotes.push(node.attrs?.footnote as FidusNode[])
             }
         })
     }
 
-    convertFootnotes() {
-        const fnContent = []
+    convertFootnotes(): void {
+        const fnContent: FidusNode[] = []
         this.footnotes.forEach(footnote => {
             fnContent.push({
                 type: "footnotecontainer",
@@ -204,7 +242,7 @@ export class DOCXExporterFootnotes {
         }
     }
 
-    createXml() {
+    createXml(): Promise<void> {
         this.richtext = new DOCXExporterRichtext(
             this.doc,
             this.lists,
@@ -221,17 +259,18 @@ export class DOCXExporterFootnotes {
         this.rels.addFootnoteRel()
         return this.xml.getXml(this.filePath, DEFAULT_XML).then(xml => {
             const footnotesEl = xml.query("w:footnotes")
-            footnotesEl.appendXML(this.fnXML)
-            this.xml = xml
+            footnotesEl?.appendXML(this.fnXML as string)
+            // Note: original code reassigned this.xml to the XMLElement here;
+            // that is not needed and conflicts with the XmlZip type.
         })
     }
 
-    setSettings() {
+    setSettings(): Promise<void> {
         return this.xml.getXml(this.settingsFilePath).then(settingsXML => {
             const footnotePr = settingsXML.query("w:footnotePr")
             if (!footnotePr) {
                 const settingsEl = settingsXML.query("w:settings")
-                settingsEl.appendXML(DEFAULT_SETTINGS_XML)
+                settingsEl?.appendXML(DEFAULT_SETTINGS_XML)
             }
             this.settingsXML = settingsXML
             return Promise.resolve()

package/src/exporter/docx/images.ts

@@ -0,0 +1,128 @@
+import {get} from "fwtoolkit"
+
+import type {FidusNode, ImageDB} from "../../types.js"
+import {descendantNodes} from "../tools/doc_content.js"
+import {svg2png} from "../tools/svg.js"
+import type {XMLElement} from "../tools/xml.js"
+import type {XmlZip} from "../tools/xml_zip.js"
+import type {DOCXExporterRels} from "./rels.js"
+
+interface ImageInfo {
+    id: number
+    width: number
+    height: number
+    title?: string
+}
+
+export class DOCXExporterImages {
+    docContent: FidusNode
+    imageDB: ImageDB
+    xml: XmlZip
+    rels: DOCXExporterRels
+
+    images: Record<string, ImageInfo>
+    ctXML: XMLElement | null
+
+    constructor(docContent: FidusNode, imageDB: ImageDB, xml: XmlZip, rels: DOCXExporterRels) {
+        this.docContent = docContent
+        this.imageDB = imageDB
+        this.xml = xml
+        this.rels = rels
+
+        this.images = {}
+        this.ctXML = null
+    }
+
+    init(): Promise<void> {
+        return this.xml.getXml("[Content_Types].xml").then(ctXML => {
+            this.ctXML = ctXML
+            return this.exportImages()
+        })
+    }
+
+    // add an image to the list of files
+    addImage(imgFileName: string, image: Blob): number {
+        const rId = this.rels.addImageRel(imgFileName)
+        this.addContentType(imgFileName.split(".").pop() || "")
+        this.xml.addExtraFile(`word/media/${imgFileName}`, image)
+        return rId
+    }
+
+    // add a global contenttype declaration for an image type (if needed)
+    addContentType(fileEnding: string): void {
+        if (!this.ctXML) {
+            return
+        }
+        const types = this.ctXML.query("Types")
+        if (!types) {
+            return
+        }
+        const contentDec = types.query("Default", {Extension: fileEnding})
+        if (!contentDec) {
+            const string = `<Default ContentType="image/${fileEnding}" Extension="${fileEnding}"/>`
+            types.appendXML(string)
+        }
+    }
+
+    // Find all images used in file and add these to the export zip.
+    // TODO: This will likely fail on image types docx doesn't support such as SVG.
+    // Try out and fix.
+    exportImages(): Promise<void> {
+        const usedImgs: (string | number)[] = []
+        descendantNodes(this.docContent).forEach(node => {
+            if (node.type === "image" && node.attrs?.image !== false) {
+                const imageId = node.attrs?.image as string | number | undefined
+                if (imageId !== undefined && !usedImgs.includes(imageId)) {
+                    usedImgs.push(imageId)
+                }
+            }
+        })
+        return new Promise(resolveExportImages => {
+            const p: Array<Promise<void>> = []
+            usedImgs.forEach(image => {
+                const imgDBEntry = this.imageDB.db[String(image)]
+                if (!imgDBEntry || !imgDBEntry.image) {
+                    return
+                }
+                p.push(
+                    get(imgDBEntry.image as string)
+                        .then(response => response.blob())
+                        .then(async blob => {
+                            if (blob.type === "image/svg+xml") {
+                                // DOCX doesn't support SVG. Convert to PNG.
+                                const {blob: pngBlob, width, height} = await svg2png(blob)
+                                const wImgId = this.addImage(
+                                    (imgDBEntry.image as string)
+                                        .split("/")
+                                        .pop()!
+                                        .replace(/.svg$/g, ".png"),
+                                    pngBlob
+                                )
+                                this.images[String(image)] = {
+                                    id: wImgId,
+                                    width,
+                                    height,
+                                    title: imgDBEntry.title as string | undefined
+                                }
+                            } else {
+                                const wImgId = this.addImage(
+                                    (imgDBEntry.image as string).split("/").pop()!,
+                                    blob
+                                )
+                                this.images[String(image)] = {
+                                    id: wImgId,
+                                    width: imgDBEntry.width as number,
+                                    height: imgDBEntry.height as number,
+                                    title: imgDBEntry.title as string | undefined
+                                }
+                            }
+                        })
+                )
+            })
+
+            Promise.all(p).then(() => {
+                resolveExportImages()
+            })
+        })
+    }
+}

package/src/exporter/docx/{index.js → index.ts}

@@ -1,9 +1,11 @@
 import download from "downloadjs"
 
 import {shortFileTitle} from "fwtoolkit"
+import type {BibDB, CSL, ExportDoc, FidusNode, ImageDB} from "../../types.js"
 import {fixTables, removeHidden, textContent} from "../tools/doc_content.js"
 import {createSlug} from "../tools/file.js"
-import {XmlZip} from "../tools/xml_zip.js"
+import type {XmlZip} from "../tools/xml_zip.js"
+import {XmlZip as XmlZipImpl} from "../tools/xml_zip.js"
 import {DOCXExporterCitations} from "./citations.js"
 import {DOCXExporterComments} from "./comments.js"
 import {DOCXExporterFootnotes} from "./footnotes.js"
@@ -29,23 +31,39 @@ TODO:
 */
 
 export class DOCXExporter {
-    constructor(doc, templateUrl, bibDB, imageDB, csl) {
+    doc: ExportDoc
+    templateUrl: string
+    bibDB: BibDB
+    imageDB: ImageDB
+    csl: CSL
+
+    docTitle: string
+    mimeType: string
+    docContent: any
+
+    constructor(
+        doc: ExportDoc,
+        templateUrl: string,
+        bibDB: BibDB,
+        imageDB: ImageDB,
+        csl: CSL
+    ) {
         this.doc = doc
         this.templateUrl = templateUrl
         this.bibDB = bibDB
         this.imageDB = imageDB
         this.csl = csl
 
-        this.docTitle = shortFileTitle(this.doc.title, this.doc.path)
+        this.docTitle = shortFileTitle(this.doc.title, this.doc.path || "")
         this.mimeType =
             "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
         this.docContent = moveFootnoteComments(
-            fixTables(removeHidden(this.doc.content))
+            fixTables(removeHidden(this.doc.content) as FidusNode)
         )
     }
 
-    init() {
-        const xml = new XmlZip(this.templateUrl, this.mimeType)
+    init(): Promise<void> {
+        const xml: XmlZip = new XmlZipImpl(this.templateUrl, this.mimeType)
 
         const tables = new DOCXExporterTables(xml)
         const math = new DOCXExporterMath(xml)
@@ -101,7 +119,7 @@ export class DOCXExporter {
 
         const comments = new DOCXExporterComments(
             this.docContent,
-            this.doc.comments,
+            this.doc.comments || {},
             xml,
             rels,
             richtext
@@ -133,7 +151,7 @@ export class DOCXExporter {
             .then(blob => this.download(blob))
     }
 
-    download(blob) {
+    download(blob: Blob): void {
         return download(
             blob,
             createSlug(this.docTitle) + ".docx",
@@ -141,16 +159,16 @@ export class DOCXExporter {
         )
     }
 
-    getBaseMetadata() {
+    getBaseMetadata(): any {
         const contributors = this.docContent.content.reduce(
-            (contributors, part) => {
+            (contributors: any[], part: any) => {
                 if (
                     part.type === "contributors_part" &&
                     part.attrs.metadata &&
                     part.content
                 ) {
                     return contributors.concat(
-                        part.content.map(node => ({
+                        part.content.map((node: any) => ({
                             ...node.attrs,
                             role: part.attrs.metadata
                         }))
@@ -162,21 +180,26 @@ export class DOCXExporter {
             []
         )
         return {
-            authors: contributors.filter(c => c.role === "authors"),
+            authors: contributors.filter((c: any) => c.role === "authors"),
             contributors,
-            keywords: this.docContent.content.reduce((keywords, part) => {
-                if (
-                    part.type === "tags_part" &&
-                    part.attrs.metadata === "keywords" &&
-                    part.content
-                ) {
-                    return keywords.concat(
-                        part.content.map(keywordNode => keywordNode.attrs.tag)
-                    )
-                } else {
-                    return keywords
-                }
-            }, []),
+            keywords: this.docContent.content.reduce(
+                (keywords: string[], part: any) => {
+                    if (
+                        part.type === "tags_part" &&
+                        part.attrs.metadata === "keywords" &&
+                        part.content
+                    ) {
+                        return keywords.concat(
+                            part.content.map(
+                                (keywordNode: any) => keywordNode.attrs.tag
+                            )
+                        )
+                    } else {
+                        return keywords
+                    }
+                },
+                []
+            ),
             title: textContent(this.docContent.content[0]),
             language: this.doc.settings.language,
             citationStyle: this.doc.settings.citationstyle