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

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

@@ -1,15 +1,25 @@
 import {escapeText} from "fwtoolkit"
 
+import type {CSL, CSLStyle, ExportMetadata} from "../../types.js"
+import type {XMLElement} from "../tools/xml.js"
+import type {XmlZip} from "../tools/xml_zip.js"
+
 export class DOCXExporterMetadata {
-    constructor(xml, metadata, csl = null) {
+    xml: XmlZip
+    metadata: ExportMetadata
+    csl: CSL | null
+    coreXML: XMLElement | null
+    customXML: XMLElement | null
+
+    constructor(xml: XmlZip, metadata: ExportMetadata, csl: CSL | null = null) {
         this.xml = xml
         this.metadata = metadata
         this.csl = csl
-        this.coreXML = false
-        this.customXML = false
+        this.coreXML = null
+        this.customXML = null
     }
 
-    init() {
+    init(): Promise<void> {
         return this.xml.getXml("docProps/core.xml").then(coreXML => {
             this.coreXML = coreXML
             this.addMetadata()
@@ -17,8 +27,8 @@ export class DOCXExporterMetadata {
         })
     }
 
-    async hasBibliography() {
-        if (!this.csl || !this.metadata.citationStyle) {
+    async hasBibliography(): Promise<string> {
+        if (!this.csl || !this.metadata.citationStyle || !this.csl.getStyle) {
             return "0"
         }
         try {
@@ -33,20 +43,28 @@ export class DOCXExporterMetadata {
         }
     }
 
-    addMetadata() {
+    addMetadata(): void {
+        if (!this.coreXML) {
+            return
+        }
         const corePropertiesEl = this.coreXML.query("cp:coreProperties")
+        if (!corePropertiesEl) {
+            return
+        }
 
         // Title
-        let titleEl = this.coreXML.query("dc:title")
+        let titleEl: XMLElement | null = this.coreXML.query("dc:title") ?? null
         if (!titleEl) {
             corePropertiesEl.appendXML("<dc:title></dc:title>")
             titleEl = corePropertiesEl.lastElementChild
         }
-        titleEl.innerXML = escapeText(this.metadata.title)
+        if (titleEl) {
+            titleEl.innerXML = escapeText(this.metadata.title)
+        }
         // Authors
 
         const authors = this.metadata.authors.map(author => {
-            const nameParts = []
+            const nameParts: string[] = []
             if (author.firstname) {
                 nameParts.push(author.firstname)
             }
@@ -61,55 +79,65 @@ export class DOCXExporterMetadata {
         })
         const lastAuthor = authors.length
             ? escapeText(authors[0])
-            : gettext("Unknown")
+            : "Unknown"
         const allAuthors = authors.length
             ? escapeText(authors.join(";"))
-            : gettext("Unknown")
-        let allAuthorsEl = this.coreXML.query("dc:creator")
+            : "Unknown"
+        let allAuthorsEl: XMLElement | null = this.coreXML.query("dc:creator") ?? null
 
         if (!allAuthorsEl) {
             corePropertiesEl.appendXML("<dc:creator></dc:creator>")
             allAuthorsEl = corePropertiesEl.lastElementChild
         }
-        allAuthorsEl.innerXML = allAuthors
-        let lastAuthorEl = this.coreXML.query("dc:lastModifiedBy")
+        if (allAuthorsEl) {
+            allAuthorsEl.innerXML = allAuthors
+        }
+        let lastAuthorEl: XMLElement | null = this.coreXML.query("dc:lastModifiedBy") ?? null
         if (!lastAuthorEl) {
             corePropertiesEl.appendXML(
                 "<dc:lastModifiedBy></dc:lastModifiedBy>"
             )
             lastAuthorEl = corePropertiesEl.lastElementChild
         }
-        lastAuthorEl.innerXML = lastAuthor
+        if (lastAuthorEl) {
+            lastAuthorEl.innerXML = lastAuthor
+        }
         // Keywords
         if (this.metadata.keywords.length) {
             // It is not really clear how keywords should be separated in DOCX files,
             // so we use ", ".
             const keywordsString = escapeText(this.metadata.keywords.join(", "))
 
-            let keywordsEl = this.coreXML.query("cp:keywords")
+            let keywordsEl: XMLElement | null = this.coreXML.query("cp:keywords") ?? null
             if (!keywordsEl) {
                 corePropertiesEl.appendXML("<cp:keywords></cp:keywords>")
                 keywordsEl = corePropertiesEl.lastElementChild
             }
-            keywordsEl.innerXML = keywordsString
+            if (keywordsEl) {
+                keywordsEl.innerXML = keywordsString
+            }
         }
 
         // time
         const date = new Date()
         const dateString = date.toISOString().split(".")[0] + "Z"
         const createdEl = this.coreXML.query("dcterms:created")
-        createdEl.innerXML = dateString
-        let modifiedEl = this.coreXML.query("dcterms:modified")
+        if (createdEl) {
+            createdEl.innerXML = dateString
+        }
+        let modifiedEl: XMLElement | null = this.coreXML.query("dcterms:modified") ?? null
         if (!modifiedEl) {
             corePropertiesEl.appendXML(
                 '<dcterms:modified xsi:type="dcterms:W3CDTF"></dcterms:modified>'
             )
             modifiedEl = corePropertiesEl.lastElementChild
         }
-        modifiedEl.innerXML = dateString
+        if (modifiedEl) {
+            modifiedEl.innerXML = dateString
+        }
     }
 
-    async addCustomProperties() {
+    async addCustomProperties(): Promise<void> {
         // Create or update docProps/custom.xml with citation style information
         const customXmlContent = `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <Properties xmlns="http://schemas.openxmlformats.org/officeDocument/2006/custom-properties" xmlns:vt="http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes">
@@ -117,31 +145,35 @@ export class DOCXExporterMetadata {
 
         const customXML = await this.xml.getXml(
             "docProps/custom.xml",
-            Promise.resolve(customXmlContent)
+            customXmlContent
         )
         this.customXML = customXML
 
         // Add citation style property
         if (this.metadata.citationStyle) {
             const propertiesEl = this.customXML.query("Properties")
+            if (!propertiesEl) {
+                return Promise.resolve()
+            }
 
             // Remove any existing ZOTERO_PREF_ properties
             const existingZoteroProps = this.customXML
                 .queryAll("property")
                 .filter(
-                    prop =>
-                        prop.getAttribute("name") &&
-                        prop.getAttribute("name").startsWith("ZOTERO_PREF_")
+                    prop => {
+                        const name = String(prop.getAttribute("name"))
+                        return name && name.startsWith("ZOTERO_PREF_")
+                    }
                 )
             existingZoteroProps.forEach(prop =>
-                prop.parentElement.removeChild(prop)
+                prop.parentElement!.removeChild(prop)
             )
 
             // Find the highest pid to determine the next one
             const existingProperties = this.customXML.queryAll("property")
             let maxPid = 0
             existingProperties.forEach(prop => {
-                const pid = parseInt(prop.getAttribute("pid"))
+                const pid = parseInt(String(prop.getAttribute("pid")))
                 if (pid > maxPid) {
                     maxPid = pid
                 }
@@ -156,7 +188,7 @@ export class DOCXExporterMetadata {
 
             // Split content into chunks of 255 characters (DOCX limit)
             const chunkSize = 255
-            const chunks = []
+            const chunks: string[] = []
             for (let i = 0; i < dataContent.length; i += chunkSize) {
                 chunks.push(dataContent.substring(i, i + chunkSize))
             }
@@ -170,7 +202,7 @@ export class DOCXExporterMetadata {
                 propertiesEl.appendXML(propertyXML)
                 // Set the text content after appending (textContent escapes XML characters)
                 const lpwstrEl =
-                    propertiesEl.lastElementChild.query("vt:lpwstr")
+                    propertiesEl.lastElementChild?.query("vt:lpwstr")
                 if (lpwstrEl) {
                     lpwstrEl.textContent = chunk
                 }
@@ -183,30 +215,34 @@ export class DOCXExporterMetadata {
         return Promise.resolve()
     }
 
-    async addContributorProperties() {
+    async addContributorProperties(): Promise<void> {
         if (!this.metadata.contributors || !this.metadata.contributors.length) {
             return Promise.resolve()
         }
 
-        const propertiesEl = this.customXML.query("Properties")
+        const propertiesEl = this.customXML!.query("Properties")
+        if (!propertiesEl) {
+            return Promise.resolve()
+        }
 
         // Remove any existing fidus_contributor_ properties
-        const existingContributorProps = this.customXML
+        const existingContributorProps = this.customXML!
             .queryAll("property")
             .filter(
-                prop =>
-                    prop.getAttribute("name") &&
-                    prop.getAttribute("name").startsWith("fidus_contributor_")
+                prop => {
+                    const name = String(prop.getAttribute("name"))
+                    return name && name.startsWith("fidus_contributor_")
+                }
             )
         existingContributorProps.forEach(prop =>
-            prop.parentElement.removeChild(prop)
+            prop.parentElement!.removeChild(prop)
         )
 
         // Find the highest pid
-        const existingProperties = this.customXML.queryAll("property")
+        const existingProperties = this.customXML!.queryAll("property")
         let maxPid = 0
         existingProperties.forEach(prop => {
-            const pid = parseInt(prop.getAttribute("pid"))
+            const pid = parseInt(String(prop.getAttribute("pid")))
             if (pid > maxPid) {
                 maxPid = pid
             }
@@ -220,7 +256,7 @@ export class DOCXExporterMetadata {
 <vt:i4></vt:i4>
 </property>`
         propertiesEl.appendXML(countXML)
-        const countEl = propertiesEl.lastElementChild.query("vt:i4")
+        const countEl = propertiesEl.lastElementChild?.query("vt:i4")
         if (countEl) {
             countEl.textContent = String(contributors.length)
         }
@@ -228,7 +264,7 @@ export class DOCXExporterMetadata {
         // Add property for each contributor
         contributors.forEach((contributor, index) => {
             const num = index + 1
-            const nameParts = []
+            const nameParts: string[] = []
             if (contributor.firstname) {
                 nameParts.push(contributor.firstname)
             }
@@ -277,7 +313,7 @@ export class DOCXExporterMetadata {
 </property>`
                 propertiesEl.appendXML(propertyXML)
                 const lpwstrEl =
-                    propertiesEl.lastElementChild.query("vt:lpwstr")
+                    propertiesEl.lastElementChild?.query("vt:lpwstr")
                 if (lpwstrEl) {
                     lpwstrEl.textContent = field.value
                 }

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

@@ -1,6 +1,8 @@
-// manages the .rels files. Need to initialize one for each of document.xml and footnotes.xml
 import {escapeText} from "fwtoolkit"
 
+import type {XMLElement} from "../tools/xml.js"
+import type {XmlZip} from "../tools/xml_zip.js"
+
 const DEFAULT_XML = `<?xml version="1.0" encoding="UTF-8"?>
 <Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"></Relationships>`
 
@@ -13,20 +15,31 @@ const DEFAULT_HYPERLINK_STYLE = `<w:style w:type="character" w:styleId="Internet
 </w:style>`
 
 export class DOCXExporterRels {
-    constructor(xml, docName) {
+    xml: XmlZip
+    docName: string
+    relsXML: XMLElement | null
+    ctXML: XMLElement | null
+    relIdCounter: number
+    filePath: string
+    ctFilePath: string
+    styleXML: XMLElement | null
+    styleFilePath: string
+    hyperLinkStyle: string | null
+
+    constructor(xml: XmlZip, docName: string) {
         this.xml = xml
         this.docName = docName
-        this.relsXML = false
-        this.ctXML = false
+        this.relsXML = null
+        this.ctXML = null
         this.relIdCounter = -1
         this.filePath = `word/_rels/${this.docName}.xml.rels`
         this.ctFilePath = "[Content_Types].xml"
-        this.styleXML = false
+        this.styleXML = null
         this.styleFilePath = "word/styles.xml"
-        this.hyperLinkStyle = false
+        this.hyperLinkStyle = null
     }
 
-    init() {
+    init(): Promise<void> {
         return Promise.all([
             this.initCt()
                 .then(() => {
@@ -35,15 +48,16 @@ export class DOCXExporterRels {
                 .then(xml => {
                     this.relsXML = xml
                     this.findMaxRelId()
+                    return Promise.resolve()
                 }),
             this.xml.getXml(this.styleFilePath).then(styleXML => {
                 this.styleXML = styleXML
                 return Promise.resolve()
             })
-        ])
+        ]).then(() => undefined)
     }
 
-    initCt() {
+    initCt(): Promise<void> {
         return this.xml.getXml(this.ctFilePath).then(ctXML => {
             this.ctXML = ctXML
             this.addRelsToCt()
@@ -52,12 +66,15 @@ export class DOCXExporterRels {
     }
 
     // Go through a rels xml file and file all the listed relations
-    findMaxRelId() {
+    findMaxRelId(): void {
+        if (!this.relsXML) {
+            return
+        }
         const rels = this.relsXML.queryAll("Relationship")
 
         rels.forEach(rel => {
             const id = Number.parseInt(
-                rel.getAttribute("Id").replace(/\D/g, "")
+                String(rel.getAttribute("Id")).replace(/\D/g, "")
             )
             if (id > this.relIdCounter) {
                 this.relIdCounter = id
@@ -65,127 +82,131 @@ export class DOCXExporterRels {
         })
     }
 
-    addRelsToCt() {
-        const override = this.ctXML.query("Overrid", {
+    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-package.relationships+xml"/>`
             )
         }
     }
 
     // Add a relationship for a link
-    addLinkRel(link) {
-        const rels = this.relsXML.query("Relationships")
+    addLinkRel(link: string): number {
+        const rels = this.relsXML!.query("Relationships")
         const rId = ++this.relIdCounter
         const string = `<Relationship Id="rId${rId}" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink" Target="${escapeText(link)}" TargetMode="External"/>`
-        rels.appendXML(string)
+        rels?.appendXML(string)
         return rId
     }
 
-    addLinkStyle() {
+    addLinkStyle(): void {
         if (this.hyperLinkStyle) {
             // already added
             return
         }
-        const hyperLinkEl = this.styleXML.query("w:name", {
+        const hyperLinkEl = this.styleXML!.query("w:name", {
             "w:val": "Hyperlink"
         })
         if (hyperLinkEl) {
-            this.hyperLinkStyle =
-                hyperLinkEl.parentElement.getAttribute("w:styleId")
+            this.hyperLinkStyle = String(
+                hyperLinkEl.parentElement!.getAttribute("w:styleId")
+            )
         } else {
-            const stylesEl = this.styleXML.query("w:styles")
-            stylesEl.appendXML(DEFAULT_HYPERLINK_STYLE)
+            const stylesEl = this.styleXML!.query("w:styles")
+            stylesEl?.appendXML(DEFAULT_HYPERLINK_STYLE)
             this.hyperLinkStyle = "InternetLink"
         }
     }
 
     // add a relationship for an image
-    addImageRel(imgFileName) {
-        const rels = this.relsXML.query("Relationships")
+    addImageRel(imgFileName: string): number {
+        const rels = this.relsXML!.query("Relationships")
         const rId = ++this.relIdCounter
         const string = `<Relationship Id="rId${rId}" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/image" Target="media/${escapeText(imgFileName)}"/>`
-        rels.appendXML(string)
+        rels?.appendXML(string)
         return rId
     }
 
-    addFootnoteRel() {
-        const footnotesRel = this.relsXML.query("Relationship", {
+    addFootnoteRel(): number {
+        const footnotesRel = this.relsXML!.query("Relationship", {
             Target: "footnotes.xml"
         })
         if (footnotesRel) {
             // Rel exists already
             const fnRId = Number.parseInt(
-                footnotesRel.getAttribute("Id").replace(/\D/g, "")
+                String(footnotesRel.getAttribute("Id")).replace(/\D/g, "")
             )
             return fnRId
         }
-        const rels = this.relsXML.query("Relationships")
+        const rels = this.relsXML!.query("Relationships")
         const rId = ++this.relIdCounter
         const string = `<Relationship Id="rId${rId}" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/footnotes" Target="footnotes.xml"/>`
-        rels.appendXML(string)
+        rels?.appendXML(string)
         return rId
     }
 
-    addNumberingRel() {
-        const numberingRel = this.relsXML.query("Relationship", {
+    addNumberingRel(): number {
+        const numberingRel = this.relsXML!.query("Relationship", {
             Target: "numbering.xml"
         })
         if (numberingRel) {
             // Rel exists already
             const nuRId = Number.parseInt(
-                numberingRel.getAttribute("Id").replace(/\D/g, "")
+                String(numberingRel.getAttribute("Id")).replace(/\D/g, "")
             )
             return nuRId
         }
-        const rels = this.relsXML.query("Relationships")
+        const rels = this.relsXML!.query("Relationships")
         const rId = ++this.relIdCounter
         const string = `<Relationship Id="rId${rId}" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering" Target="numbering.xml"/>`
-        rels.appendXML(string)
+        rels?.appendXML(string)
         return rId
     }
 
-    addCommentsRel() {
-        const commentsRel = this.relsXML.query("Relationship", {
+    addCommentsRel(): void {
+        const commentsRel = this.relsXML!.query("Relationship", {
             Target: "comments.xml"
         })
         if (commentsRel) {
             return
         }
-        const rels = this.relsXML.query("Relationships")
+        const rels = this.relsXML!.query("Relationships")
         const string = `<Relationship Id="rId${++this.relIdCounter}" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/comments" Target="comments.xml"/>`
-        rels.appendXML(string)
-        const override = this.ctXML.query("Override", {
+        rels?.appendXML(string)
+        const override = this.ctXML!.query("Override", {
             PartName: "/word/comments.xml"
         })
         if (!override) {
-            const types = this.ctXML.query("Types")
-            types.appendXML(
+            const types = this.ctXML!.query("Types")
+            types?.appendXML(
                 '<Override PartName="/word/comments.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.comments+xml"/>'
             )
         }
     }
 
-    addCommentsExtendedRel() {
-        const commentsExtendedRel = this.relsXML.query("Relationship", {
+    addCommentsExtendedRel(): void {
+        const commentsExtendedRel = this.relsXML!.query("Relationship", {
             Target: "commentsExtended.xml"
         })
         if (commentsExtendedRel) {
             return
         }
-        const rels = this.relsXML.query("Relationships")
+        const rels = this.relsXML!.query("Relationships")
         const string = `<Relationship Id="rId${++this.relIdCounter}" Type="http://schemas.microsoft.com/office/2011/relationships/commentsExtended" Target="commentsExtended.xml"/>`
-        rels.appendXML(string)
-        const override = this.ctXML.query("Override", {
+        rels?.appendXML(string)
+        const override = this.ctXML!.query("Override", {
             PartName: "/word/commentsExtended.xml"
         })
         if (!override) {
-            const types = this.ctXML.query("Types")
-            types.appendXML(
+            const types = this.ctXML!.query("Types")
+            types?.appendXML(
                 '<Override PartName="/word/commentsExtended.xml" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.commentsExtended+xml"/>'
             )
         }