@fiduswriter/books-document 0.1.6 → 0.1.8

package/src/exporter/docx/index.ts

@@ -3,7 +3,7 @@
  */
 
 import type {Schema} from "prosemirror-model"
-import type {CSL, User} from "@fiduswriter/document"
+import type {CSL, ExportMetadata, FidusNode, User} from "@fiduswriter/document"
 import type {ProgressCallback} from "@fiduswriter/document/exporter/tools/progress"
 import {
     fixTables,
@@ -36,7 +36,7 @@ export class DOCXBookExporter {
     user: User
     docList: DocumentListEntry[]
     templateUrl: string
-    updated: any
+    updated: number
     textFiles: Array<Record<string, unknown>>
     httpFiles: Array<Record<string, unknown>>
     mimeType: string
@@ -48,7 +48,7 @@ export class DOCXBookExporter {
         book: Book,
         user: User,
         docList: DocumentListEntry[],
-        updated: any
+        updated: number
     ) {
         this.schema = schema
         this.csl = csl
@@ -88,13 +88,14 @@ export class DOCXBookExporter {
         this.book.chapters.sort((a, b) => (a.number > b.number ? 1 : -1))
         const xml = new XmlZip(this.templateUrl, this.mimeType)
 
-        const tables = new DOCXExporterTables(xml as any)
-        const math = new DOCXExporterMath(xml as any)
-        const render = new DOCXBookExporterRender(xml as any)
-        const rels = new DOCXExporterRels(xml as any, "document")
+        const tables = new DOCXExporterTables(xml)
+        const math = new DOCXExporterMath(xml)
+        const render = new DOCXBookExporterRender(xml)
+        const rels = new DOCXExporterRels(xml, "document")
         const metadata = new DOCXExporterMetadata(
-            xml as any,
-            this.getBaseMetadata() as any
+            xml,
+            this.getBaseMetadata(),
+            this.csl
         )
 
         return xml
@@ -104,7 +105,7 @@ export class DOCXBookExporter {
             .then(() => math.init())
             .then(() => render.init())
             .then(() => rels.init())
-            .then(() => this.exportChapters(xml as any, render, rels, math, tables))
+            .then(() => this.exportChapters(xml, render, rels, math, tables))
             .then(() => {
                 this.progressCallback?.(gettext("Finalizing DOCX book..."), 90)
                 return xml.prepareBlob()
@@ -119,11 +120,11 @@ export class DOCXBookExporter {
     }
 
     exportChapters(
-        xml: any,
+        xml: XmlZip,
         render: DOCXBookExporterRender,
-        rels: any,
-        math: any,
-        tables: any
+        rels: DOCXExporterRels,
+        math: DOCXExporterMath,
+        tables: DOCXExporterTables
     ): Promise<void> {
         return this.book.chapters
             .map((chapter, chapterIndex) => {
@@ -134,12 +135,14 @@ export class DOCXBookExporter {
                     }
                     const docContent = moveFootnoteComments(
                         fixTables(
-                            removeHidden(doc.rawContent as any) as any
-                        ) as any
-                    ) as any
+                            removeHidden(
+                                doc.rawContent as unknown as FidusNode
+                            ) as FidusNode
+                        )
+                    )
 
                     const images = new DOCXExporterImages(
-                        docContent as any,
+                        docContent,
                         {db: doc.images || {}},
                         xml,
                         rels
@@ -154,7 +157,7 @@ export class DOCXBookExporter {
                     )
 
                     const footnotes = new DOCXExporterFootnotes(
-                        doc as any,
+                        doc,
                         docContent,
                         doc.settings,
                         {db: doc.images || {}},
@@ -169,7 +172,7 @@ export class DOCXBookExporter {
                     )
 
                     const richtext = new DOCXExporterRichtext(
-                        doc as any,
+                        doc,
                         doc.settings,
                         lists,
                         footnotes,
@@ -197,7 +200,7 @@ export class DOCXBookExporter {
                         .then(() => {
                             const pmBib = footnotes.pmBib || citations.pmBib
                             render.render(
-                                docContent as any,
+                                docContent,
                                 pmBib,
                                 doc.settings,
                                 richtext,
@@ -227,7 +230,7 @@ export class DOCXBookExporter {
             .then(() => render.assemble())
     }
 
-    getBaseMetadata(): Record<string, unknown> {
+    getBaseMetadata(): ExportMetadata {
         const authors = this.book.metadata.author?.length
             ? [{institution: this.book.metadata.author}]
             : []
@@ -238,6 +241,7 @@ export class DOCXBookExporter {
             : []
         return {
             authors,
+            contributors: [],
             keywords,
             title: this.book.title,
             language: this.book.settings.language

package/src/exporter/docx/render.ts

@@ -1,13 +1,18 @@
+import {XMLElement} from "@fiduswriter/document/exporter/tools/xml"
+import type {XmlZip} from "@fiduswriter/document/exporter/tools/xml_zip"
+import {DOCXExporterCitations} from "@fiduswriter/document/exporter/docx/citations"
 import {DOCXExporterRender} from "@fiduswriter/document/exporter/docx/render"
+import {DOCXExporterRichtext} from "@fiduswriter/document/exporter/docx/richtext"
+import type {DocSettings, FidusNode} from "@fiduswriter/document"
 
 export class DOCXBookExporterRender extends DOCXExporterRender {
-    preamble: any
-    bodyTemplate: any
-    postamble: any
-    fileXML: any
-    bodyParts: any[]
+    preamble: XMLElement | null
+    bodyTemplate: XMLElement | null
+    postamble: XMLElement | null
+    fileXML: XMLElement | null
+    bodyParts: XMLElement[]
 
-    constructor(xml: any) {
+    constructor(xml: XmlZip) {
         super(xml)
 
         this.preamble = null
@@ -19,14 +24,16 @@ export class DOCXBookExporterRender extends DOCXExporterRender {
 
     init(): Promise<void> {
         return super.init().then(() => {
-            this.fileXML = this.text
-            const text = this.fileXML.query("w:body")
+            this.fileXML = this.text as XMLElement
+            const text = this.fileXML.query("w:body") as XMLElement
             this.preamble = text.cloneNode(false)
             this.bodyTemplate = text.cloneNode(false)
             this.postamble = text.cloneNode(false)
-            let currentSection = this.bodyTemplate
-            const textChildren = Array.from(text.children)
-            textChildren.forEach((node: any) => {
+            let currentSection: XMLElement | null = this.bodyTemplate
+            const textChildren = Array.from(text.children).filter(
+                (node): node is XMLElement => node instanceof XMLElement
+            )
+            textChildren.forEach(node => {
                 const bookmarkStart = node.query("w:bookmarkStart")
                 if (bookmarkStart) {
                     const bookmarkName = String(
@@ -40,16 +47,23 @@ export class DOCXBookExporterRender extends DOCXExporterRender {
                         currentSection = this.postamble
                     }
                 }
-                currentSection.appendChild(node)
+                currentSection!.appendChild(node)
             })
             return Promise.resolve()
         })
     }
 
-    render(...args: any[]): void {
-        const [docContent, pmBib, settings, richtext, citations, chapterIndex] = args
-        this.text = this.bodyTemplate.cloneNode(true)
-        const bodyBookmark = (this.text as any).query("w:bookmarkStart", {
+    render(
+        docContent: FidusNode,
+        pmBib: unknown,
+        settings: DocSettings,
+        richtext: DOCXExporterRichtext,
+        citations: DOCXExporterCitations,
+        chapterIndex = 0
+    ): void {
+        this.text = this.bodyTemplate!.cloneNode(true)
+        const textEl = this.text as XMLElement
+        const bodyBookmark = textEl.query("w:bookmarkStart", {
             "w:name": "body"
         })
         if (bodyBookmark) {
@@ -89,11 +103,17 @@ export class DOCXBookExporterRender extends DOCXExporterRender {
             {title: "book.series_title", content: series_title},
             {title: "book.series_position", content: series_position}
         ]
-        const usedTags: any[] = []
-        const ambles = [this.preamble, this.postamble]
+        const usedTags: Array<{
+            title: string
+            content?: unknown
+            block: XMLElement
+        }> = []
+        const ambles = [this.preamble, this.postamble].filter(
+            (amble): amble is XMLElement => amble !== null
+        )
         ambles.forEach(amble => {
             const blocks = amble.queryAll(["w:p", "w:sectPr"])
-            blocks.forEach((block: any) => {
+            blocks.forEach(block => {
                 const text = block.textContent
                 tags.forEach(tag => {
                     const tagString = tag.title
@@ -107,13 +127,15 @@ export class DOCXBookExporterRender extends DOCXExporterRender {
     }
 
     assemble(): void {
-        const text = this.fileXML.query("w:body")
-        Array.from(this.preamble.children).forEach((node: any) =>
-            text.appendChild(node)
-        )
-        this.bodyParts.forEach((bodyPart: any, index: number) => {
-            const children = bodyPart.children.slice()
-            children.forEach((node: any) => {
+        const text = this.fileXML!.query("w:body") as XMLElement
+        Array.from(this.preamble!.children)
+            .filter((node): node is XMLElement => node instanceof XMLElement)
+            .forEach(node => text.appendChild(node))
+        this.bodyParts.forEach((bodyPart, index) => {
+            const children = bodyPart.children
+                .slice()
+                .filter((node): node is XMLElement => node instanceof XMLElement)
+            children.forEach(node => {
                 text.appendChild(node)
             })
             if (index < this.bodyParts.length - 1) {
@@ -135,8 +157,8 @@ export class DOCXBookExporterRender extends DOCXExporterRender {
                 )
             }
         })
-        Array.from(this.postamble.children).forEach((node: any) =>
-            text.appendChild(node)
-        )
+        Array.from(this.postamble!.children)
+            .filter((node): node is XMLElement => node instanceof XMLElement)
+            .forEach(node => text.appendChild(node))
     }
 }

package/src/exporter/epub/index.ts

@@ -12,7 +12,8 @@ import {ZipFileCreator} from "fwtoolkit/file/zip"
 import {gettext, get, staticUrl} from "fwtoolkit"
 import pretty from "pretty"
 
-import type {Book, BookStyles, CSL, DocumentListEntry, User} from "../../types.js"
+import type {Book, BookCoverImage, BookStyles, CSL, DocumentListEntry, User} from "../../types.js"
+import type {FidusNode} from "@fiduswriter/document"
 import {getMissingChapterData} from "../tools.js"
 import {
     containerTemplate,
@@ -179,7 +180,7 @@ export class EpubBookExporter {
                     contents: pretty(
                         epubBookCoverTemplate({
                             book: this.book,
-                            coverImage: coverImage as any,
+                            coverImage: coverImage as BookCoverImage & {image: string},
                             shortLang: this.book.settings.language.split("-")[0]
                         })
                     )
@@ -209,7 +210,7 @@ export class EpubBookExporter {
                             return false
                         }
 
-                        const docContent = removeHidden(doc.content as any) as any
+                        const docContent = removeHidden(doc.content) as FidusNode
 
                         const converter = new HTMLExporterConvert(
                             doc.title,
@@ -326,19 +327,19 @@ export class EpubBookExporter {
                             10
                         ),
                         modified: getTimestamp(new Date(this.updated * 1000)),
-                        styleSheets: this.styleSheets as any,
+                        styleSheets: this.styleSheets as Array<{filename: string}>,
                         math: this.math,
                         images: this.images.map(image => ({
                             ...image,
-                            mimeType: getImageMimeType(image.filename)
-                        })) as any,
+                            mimeType: getImageMimeType(image.filename) || undefined
+                        })),
                         fontFiles: this.fontFiles.map(font => ({
                             ...font,
-                            mimeType: getFontMimeType(font.filename)
-                        })) as any,
-                        chapters: this.chapters as any,
-                        user: this.user as any
-                    } as any)
+                            mimeType: getFontMimeType(font.filename) || undefined
+                        })),
+                        chapters: this.chapters,
+                        user: {name: this.user.name || ""}
+                    })
                 )
             },
             {
@@ -349,8 +350,12 @@ export class EpubBookExporter {
                         title: this.book.title,
                         idType: "fidus",
                         id: this.book.id,
-                        toc: toc as any
-                    } as any)
+                        toc: toc as Array<{
+                            link: string
+                            title: string
+                            children?: Array<{link: string; title: string}>
+                        }>
+                    })
                 )
             },
             {
@@ -358,9 +363,13 @@ export class EpubBookExporter {
                 contents: pretty(
                     navTemplate({
                         shortLang: this.book.settings.language.split("-")[0],
-                        toc: toc as any,
-                        styleSheets: this.styleSheets as any
-                    } as any)
+                        toc: toc as Array<{
+                            link: string
+                            title: string
+                            children?: Array<{link: string; title: string}>
+                        }>,
+                        styleSheets: this.styleSheets as Array<{filename: string}>
+                    })
                 )
             }
         ])

package/src/exporter/html/index.ts

@@ -61,7 +61,7 @@ export class HTMLBookExporter {
     book: Book
     user: User
     docList: DocumentListEntry[]
-    updated: any
+    updated: number
     multiDoc: boolean
     relativeUrls: boolean
     chapters: ChapterInfo[]
@@ -70,10 +70,10 @@ export class HTMLBookExporter {
     httpFiles: HttpFile[]
     math: boolean
     bibCSS: string
-    chapterTemplate: (...args: any[]) => string
-    indexTemplate: (...args: any[]) => string
-    singleFileHTMLBookTemplate: (...args: any[]) => string
-    singleFileHTMLBookCSSTemplate: (...args: any[]) => string
+    chapterTemplate: (args: Record<string, unknown>) => string
+    indexTemplate: (args: Record<string, unknown>) => string
+    singleFileHTMLBookTemplate: (args: Record<string, unknown>) => string
+    singleFileHTMLBookCSSTemplate: (args: Record<string, unknown>) => string
     styleSheets: StyleSheet[]
     progressCallback?: ProgressCallback
 
@@ -84,7 +84,7 @@ export class HTMLBookExporter {
         book: Book,
         user: User,
         docList: DocumentListEntry[],
-        updated: any,
+        updated: number,
         multiDoc = true,
         {relativeUrls = true} = {}
     ) {
@@ -103,12 +103,12 @@ export class HTMLBookExporter {
         this.httpFiles = []
         this.math = false
         this.bibCSS = ""
-        this.chapterTemplate = multiDoc
+        this.chapterTemplate = (multiDoc
             ? htmlBookExportTemplate
-            : (singleFileHTMLBookChapterTemplate as any)
-        this.indexTemplate = multiDoc
+            : singleFileHTMLBookChapterTemplate) as unknown as (args: Record<string, unknown>) => string
+        this.indexTemplate = (multiDoc
             ? htmlBookIndexTemplate
-            : htmlBookIndexBodyTemplate
+            : htmlBookIndexBodyTemplate) as unknown as (args: Record<string, unknown>) => string
         this.singleFileHTMLBookTemplate = singleFileHTMLBookTemplate
         this.singleFileHTMLBookCSSTemplate = singleFileHTMLBookCSSTemplate
         this.styleSheets = [{url: staticUrl("css/book.css")}]
@@ -197,19 +197,31 @@ export class HTMLBookExporter {
             }
 
             const documentHTMLExporter = new HTMLExporter(
-                doc as any,
-                bibDB as any,
-                imageDB as any,
+                doc,
+                bibDB,
+                imageDB,
                 this.csl,
                 this.updated,
                 [],
                 options,
-                htmlBookChapterTemplate as any
+                htmlBookChapterTemplate as unknown as typeof HTMLExporter.prototype.htmlExportTemplate
             )
 
             await documentHTMLExporter.process()
             const {metaData, converter, textFiles, httpFiles} =
-                documentHTMLExporter.getProcessedFiles() as any
+                documentHTMLExporter.getProcessedFiles() as {
+                    metaData: Record<string, unknown>
+                    converter: {
+                        fnCounter: number
+                        affCounter: number
+                        categoryCounter: Record<string, number>
+                        features: {math: boolean}
+                        citations: {bibCSS: string}
+                        metaData: {toc: Array<Record<string, unknown>>}
+                    }
+                    textFiles: TextFile[]
+                    httpFiles: HttpFile[]
+                }
 
             const contents = textFiles.find(
                 (textFile: TextFile) => textFile.filename === "document.html"
@@ -431,7 +443,7 @@ export class HTMLBookExporter {
 
     async createZip(): Promise<Blob | void> {
         const zipper = new ZipFileCreator(
-            this.textFiles.concat(this.styleSheets as any),
+            this.textFiles.concat(this.styleSheets as TextFile[]),
             this.httpFiles,
             this.includeZips,
             "application/zip",

package/src/exporter/latex/index.ts

@@ -13,6 +13,7 @@ import {ZipFileCreator} from "fwtoolkit/file/zip"
 import {gettext} from "fwtoolkit"
 
 import type {Book, DocumentListEntry} from "../../types.js"
+import type {BibDB, ImageDB} from "@fiduswriter/document"
 import {getMissingChapterData} from "../tools.js"
 import {bookTexTemplate} from "./templates.js"
 
@@ -31,7 +32,7 @@ export class LatexBookExporter {
     book: Book
     user: User
     docList: DocumentListEntry[]
-    updated: any
+    updated: number
     textFiles: TextFile[]
     httpFiles: HttpFile[]
     zipFileName: string
@@ -42,7 +43,7 @@ export class LatexBookExporter {
         book: Book,
         user: User,
         docList: DocumentListEntry[],
-        updated: any
+        updated: number
     ) {
         this.schema = schema
         this.book = book
@@ -81,12 +82,12 @@ export class LatexBookExporter {
                 return
             }
             const converter = new LatexExporterConvert(
-                this as any,
+                this,
                 {db: doc.images || {}},
                 {db: doc.bibliography || {}},
                 doc.settings
             )
-            const chapterContent = removeHidden(doc.content as any)
+            const chapterContent = removeHidden(doc.content)
             const convertedDoc = converter.init(chapterContent)
             this.textFiles.push({
                 filename: `chapter-${index + 1}.tex`,
@@ -96,7 +97,7 @@ export class LatexBookExporter {
                 ...new Set(bibIds.concat(Object.keys(convertedDoc.usedBibDB)))
             ]
             imageIds = [...new Set(imageIds.concat(convertedDoc.imageIds))]
-            Object.assign(features, converter.features as Record<string, boolean>)
+            Object.assign(features, converter.features)
             Object.keys(convertedDoc.usedBibDB).forEach(
                 bibId =>
                     (combinedBibliography[bibId] = doc.bibliography?.[bibId])
@@ -110,12 +111,12 @@ export class LatexBookExporter {
         })
         if (bibIds.length > 0) {
             const bibExport = new BibLatexExporter(
-                combinedBibliography as any,
+                combinedBibliography as unknown as ConstructorParameters<typeof BibLatexExporter>[0],
                 bibIds
             )
             this.textFiles.push({
                 filename: "bibliography.bib",
-                contents: (bibExport as any).output
+                contents: (bibExport as unknown as {output: string}).output
             })
         }
         imageIds.forEach(id => {
@@ -128,9 +129,9 @@ export class LatexBookExporter {
             }
         })
         const bookConverter = new LatexExporterConvert(
-            this as any,
-            {db: combinedImages as any},
-            {db: combinedBibliography as any},
+            this,
+            {db: combinedImages as unknown as ImageDB["db"]},
+            {db: combinedBibliography as unknown as BibDB["db"]},
             {language: this.book.settings.language, bibliography_header: {}}
         )
         bookConverter.features = features
@@ -155,7 +156,7 @@ export class LatexBookExporter {
             this.httpFiles,
             undefined,
             undefined,
-            this.updated
+            new Date(this.updated * 1000)
         )
 
         return zipper.init().then(blob => {

package/src/exporter/native/index.ts

@@ -12,6 +12,7 @@ import {FIDUSBOOK_VERSION} from "../../schema/index.js"
 import type {Book, DocumentListEntry, User} from "../../types.js"
 import {getMissingChapterData} from "../tools.js"
 import type {ProgressCallback} from "@fiduswriter/document/exporter/native/shrink"
+import type {FidusNode} from "@fiduswriter/document"
 
 interface FileInclude {
     url: string
@@ -30,7 +31,7 @@ export class NativeBookExporter {
     book: Book
     user: User
     documentList: DocumentListEntry[]
-    updated: any
+    updated: number
 
     progressCallback?: ProgressCallback
 
@@ -39,7 +40,7 @@ export class NativeBookExporter {
         book: Book,
         user: User,
         documentList: DocumentListEntry[],
-        updated: any,
+        updated: number,
         progressCallback?: ProgressCallback
     ) {
         this.schema = schema
@@ -134,7 +135,7 @@ export class NativeBookExporter {
             )
 
             const shrinker = new ShrinkFidus(
-                doc as any,
+                doc as unknown as {content: FidusNode; [key: string]: unknown},
                 {db: doc.images || {}},
                 {db: doc.bibliography || {}},
                 this.progressCallback
@@ -189,7 +190,7 @@ export class NativeBookExporter {
                 httpFiles,
                 [],
                 "application/fidusbook+zip",
-                this.updated
+                new Date(this.updated * 1000)
             )
             return zipper.init().then(blob => this.download(blob))
         })