@fiduswriter/books-document 0.1.7 → 0.1.9

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fiduswriter/books-document",
-    "version": "0.1.7",
+    "version": "0.1.9",
     "description": "Fidus Writer book importers and exporters",
     "repository": {
         "type": "git",
@@ -76,22 +76,23 @@
     ],
     "scripts": {
         "build": "tsc",
-        "prepare": "npm run build",
+        "prepare": "husky",
         "prepublishOnly": "npm run build",
         "typecheck": "tsc --noEmit",
         "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --config jest.config.js",
         "lint": "eslint src test",
         "lint:fix": "eslint src test --fix",
         "format": "prettier --write .",
-        "format:check": "prettier --check ."
+        "format:check": "prettier --check .",
+        "install-hooks": "husky"
     },
     "dependencies": {
         "@fiduswriter/document": "^0.2.20",
         "@vivliostyle/print": "^2.42.0",
-        "bibliojson": "^4.0.0",
+        "bibliojson": "^4.0.4",
         "downloadjs": "^1.4.7",
         "fast-deep-equal": "^3.1.3",
-        "fwtoolkit": "^0.1.9",
+        "fwtoolkit": "^0.2.0",
         "jszip": "^3.10.1",
         "pretty": "^2.0.0"
     },
@@ -106,6 +107,17 @@
         "globals": "^15.15.0",
         "prettier": "^3.8.5",
         "typescript-eslint": "^8.62.0",
-        "prosemirror-model": "^1.25.0"
+        "prosemirror-model": "^1.25.0",
+        "husky": "^9.1.7",
+        "lint-staged": "^17.0.8"
+    },
+    "lint-staged": {
+        "*.{ts,js,mjs,css,md,json,html}": [
+            "prettier --write"
+        ],
+        "*.{ts,js,mjs}": [
+            "eslint --fix",
+            "sh -c 'npm run typecheck'"
+        ]
     }
 }

package/src/exporter/bits/index.ts

@@ -32,7 +32,7 @@ export class BITSBookExporter {
     book: Book
     user: User
     docList: DocumentListEntry[]
-    updated: any
+    updated: number
     type: string
     textFiles: TextFile[]
     httpFiles: HttpFile[]
@@ -45,7 +45,7 @@ export class BITSBookExporter {
         book: Book,
         user: User,
         docList: DocumentListEntry[],
-        updated: any
+        updated: number
     ) {
         this.schema = schema
         this.csl = csl
@@ -156,7 +156,7 @@ export class BITSBookExporter {
             this.httpFiles,
             undefined,
             undefined,
-            this.updated
+            new Date(this.updated * 1000)
         )
         return zipper.init().then(blob => {
             this.progressCallback?.(gettext("BITS book export complete."), 100)

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,25 @@
+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"
+
+interface TagData {
+    title: string
+    content?: string | unknown[]
+    block: XMLElement
+    dimensions?: {width: number; height: number}
+}
 
 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 +31,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,22 +54,35 @@ 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) {
             bodyBookmark.setAttribute("w:name", `chapter ${chapterIndex + 1}`)
         }
-        super.render(docContent, pmBib, settings, richtext, citations)
+        super.render(
+            docContent,
+            pmBib as false | FidusNode,
+            settings,
+            richtext,
+            citations
+        )
         this.bodyParts.push(this.text)
     }
 
@@ -89,31 +116,39 @@ 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?: string | 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
                     if (text.includes(`{${tagString}}`)) {
-                        usedTags.push(Object.assign({block}, tag))
+                        usedTags.push(Object.assign({block}, tag) as TagData)
                     }
                 })
             })
         })
-        usedTags.forEach(tag => this.inlineRender(tag))
+        usedTags.forEach(tag => this.inlineRender(tag as unknown as TagData))
     }
 
     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 +170,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

@@ -4,6 +4,7 @@
 
 import type {Schema} from "prosemirror-model"
 import {HTMLExporterConvert} from "@fiduswriter/document/exporter/html/convert"
+import type {HTMLExportMetadata} from "@fiduswriter/document/exporter/html/convert"
 import {htmlExportTemplate} from "@fiduswriter/document/exporter/html/templates"
 import type {ProgressCallback} from "@fiduswriter/document/exporter/tools/progress"
 import {removeHidden} from "@fiduswriter/document/exporter/tools/doc_content"
@@ -12,7 +13,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,
@@ -64,7 +66,7 @@ interface ChapterOutput {
     part: string
     title: string
     docNum: number
-    metaData: Record<string, unknown>
+    metaData: HTMLExportMetadata
 }
 
 export class EpubBookExporter {
@@ -179,7 +181,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 +211,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,
@@ -246,7 +248,7 @@ export class EpubBookExporter {
                         })
 
                         await Promise.all(
-                            extraStyleSheets.map(
+                            (extraStyleSheets as StyleSheet[]).map(
                                 async (sheet: StyleSheet) => this.loadStyle(sheet)
                             )
                         )
@@ -326,19 +328,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 +351,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 +364,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

@@ -4,6 +4,7 @@
 
 import type {Schema} from "prosemirror-model"
 import type {CSL, User} from "@fiduswriter/document"
+import type {HTMLExportMetadata} from "@fiduswriter/document/exporter/html/convert"
 import type {ProgressCallback} from "@fiduswriter/document/exporter/tools/progress"
 import {HTMLExporter} from "@fiduswriter/document/exporter/html/index"
 import {createSlug} from "@fiduswriter/document/exporter/tools/file"
@@ -33,7 +34,7 @@ interface StyleSheet {
 
 interface TextFile {
     filename: string
-    contents: string
+    contents?: string
 }
 
 interface HttpFile {
@@ -50,7 +51,7 @@ interface ChapterInfo {
     number: number
     part: string
     doc: DocumentListEntry
-    metaData: Record<string, unknown>
+    metaData: HTMLExportMetadata
     toc: Array<Record<string, unknown>>
 }
 
@@ -61,7 +62,7 @@ export class HTMLBookExporter {
     book: Book
     user: User
     docList: DocumentListEntry[]
-    updated: any
+    updated: number
     multiDoc: boolean
     relativeUrls: boolean
     chapters: ChapterInfo[]
@@ -70,10 +71,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 +85,7 @@ export class HTMLBookExporter {
         book: Book,
         user: User,
         docList: DocumentListEntry[],
-        updated: any,
+        updated: number,
         multiDoc = true,
         {relativeUrls = true} = {}
     ) {
@@ -103,12 +104,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 +198,19 @@ export class HTMLBookExporter {
             }
 
             const documentHTMLExporter = new HTMLExporter(
-                doc as any,
-                bibDB as any,
-                imageDB as any,
+                doc,
+                bibDB,
+                imageDB,
                 this.csl,
-                this.updated,
+                new Date(this.updated * 1000),
                 [],
                 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()
 
             const contents = textFiles.find(
                 (textFile: TextFile) => textFile.filename === "document.html"
@@ -431,7 +432,10 @@ 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[]) as Array<{
+                filename: string
+                contents: string
+            }>,
             this.httpFiles,
             this.includeZips,
             "application/zip",