@fiduswriter/books-document 0.1.7 → 0.1.8

package/src/exporter/odt/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,
@@ -33,7 +33,7 @@ export class ODTBookExporter {
     user: User
     docList: DocumentListEntry[]
     templateUrl: string
-    updated: any
+    updated: number
     textFiles: Array<Record<string, unknown>>
     httpFiles: Array<Record<string, unknown>>
     mimeType: string
@@ -45,7 +45,7 @@ export class ODTBookExporter {
         book: Book,
         user: User,
         docList: DocumentListEntry[],
-        updated: any
+        updated: number
     ) {
         this.schema = schema
         this.csl = csl
@@ -83,14 +83,15 @@ export class ODTBookExporter {
         this.progressCallback?.(gettext("Preparing ODT book..."), 10)
         this.book.chapters.sort((a, b) => (a.number > b.number ? 1 : -1))
         const xml = new XmlZip(this.templateUrl, this.mimeType)
-        const styles = new ODTExporterStyles(xml as any)
-        const math = new ODTExporterMath(xml as any)
-        const tracks = new ODTExporterTracks(xml as any)
-        const render = new ODTBookExporterRender(xml as any, styles)
+        const styles = new ODTExporterStyles(xml)
+        const math = new ODTExporterMath(xml)
+        const tracks = new ODTExporterTracks(xml)
+        const render = new ODTBookExporterRender(xml, styles)
         const metadata = new ODTExporterMetadata(
-            xml as any,
+            xml,
             styles,
-            this.getBaseMetadata() as any
+            this.getBaseMetadata(),
+            this.csl
         )
 
         return xml
@@ -100,7 +101,7 @@ export class ODTBookExporter {
             .then(() => render.init())
             .then(() => metadata.init())
             .then(() => math.init())
-            .then(() => this.exportChapters(xml as any, render, styles, math, tracks))
+            .then(() => this.exportChapters(xml, render, styles, math, tracks))
             .then(() => {
                 this.progressCallback?.(gettext("Finalizing ODT book..."), 90)
                 return xml.prepareBlob()
@@ -115,11 +116,11 @@ export class ODTBookExporter {
     }
 
     exportChapters(
-        xml: any,
+        xml: XmlZip,
         render: ODTBookExporterRender,
-        styles: any,
-        math: any,
-        tracks: any
+        styles: ODTExporterStyles,
+        math: ODTExporterMath,
+        tracks: ODTExporterTracks
     ): Promise<void> {
         return this.book.chapters
             .map((chapter, chapterIndex) => {
@@ -129,10 +130,12 @@ export class ODTBookExporter {
                         return Promise.resolve()
                     }
                     const docContent = fixTables(
-                        removeHidden(doc.rawContent as any) as any
-                    ) as any
+                        removeHidden(
+                            doc.rawContent as unknown as FidusNode
+                        ) as FidusNode
+                    )
                     const citations = new ODTExporterCitations(
-                        docContent as any,
+                        docContent,
                         doc.settings,
                         styles,
                         {db: doc.bibliography || {}},
@@ -169,7 +172,7 @@ export class ODTBookExporter {
                         .then(() => {
                             const pmBib = footnotes.pmBib || citations.pmBib
                             render.render(
-                                docContent as any,
+                                docContent,
                                 pmBib,
                                 doc.settings,
                                 richtext,
@@ -199,7 +202,7 @@ export class ODTBookExporter {
             .then(() => render.assemble())
     }
 
-    getBaseMetadata(): Record<string, unknown> {
+    getBaseMetadata(): ExportMetadata {
         const authors = this.book.metadata.author?.length
             ? [{institution: this.book.metadata.author}]
             : []
@@ -210,6 +213,7 @@ export class ODTBookExporter {
             : []
         return {
             authors,
+            contributors: [],
             keywords,
             title: this.book.title,
             language: this.book.settings.language

package/src/exporter/odt/render.ts

@@ -1,14 +1,20 @@
+import type {DocSettings, FidusNode} from "@fiduswriter/document"
+import {XMLElement} from "@fiduswriter/document/exporter/tools/xml"
+import type {XmlZip} from "@fiduswriter/document/exporter/tools/xml_zip"
+import {ODTExporterCitations} from "@fiduswriter/document/exporter/odt/citations"
 import {ODTExporterRender} from "@fiduswriter/document/exporter/odt/render"
+import {ODTExporterRichtext} from "@fiduswriter/document/exporter/odt/richtext"
+import type {ODTExporterStyles} from "@fiduswriter/document/exporter/odt/styles"
 
 export class ODTBookExporterRender extends ODTExporterRender {
-    styles: any
-    preamble: any
-    bodyTemplate: any
-    postamble: any
-    bodyParts: any[]
-    fileXml: any
+    styles: ODTExporterStyles
+    preamble: XMLElement | null
+    bodyTemplate: XMLElement | null
+    postamble: XMLElement | null
+    bodyParts: XMLElement[]
+    fileXml: XMLElement | null
 
-    constructor(xml: any, styles: any) {
+    constructor(xml: XmlZip, styles: ODTExporterStyles) {
         super(xml)
 
         this.styles = styles
@@ -22,16 +28,18 @@ export class ODTBookExporterRender extends ODTExporterRender {
     }
 
     init(): Promise<void> {
-        return this.xml.getXml(this.filePath).then((xml: any) => {
+        return this.xml.getXml(this.filePath).then(xml => {
             this.fileXml = xml
-            const text = xml.query("office:text")
+            const text = xml.query("office:text") as XMLElement
             this.preamble = text.cloneNode(false)
             this.bodyTemplate = text.cloneNode(false)
             this.postamble = text.cloneNode(false)
-            let currentSection: any
-            const textChildren = Array.from(text.children)
-            textChildren.forEach((node: any) => {
-                if (["text:p", "text:h"].includes(node.tagName)) {
+            let currentSection: XMLElement | null = null
+            const textChildren = Array.from(text.children).filter(
+                (node): node is XMLElement => node instanceof XMLElement
+            )
+            textChildren.forEach(node => {
+                if (node.tagName && ["text:p", "text:h"].includes(node.tagName)) {
                     const bookmark = node.query("text:bookmark")
                     if (bookmark) {
                         const sectionName = String(
@@ -58,10 +66,17 @@ export class ODTBookExporterRender extends ODTExporterRender {
         })
     }
 
-    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("text:bookmark", {
+    render(
+        docContent: FidusNode,
+        pmBib: unknown,
+        settings: DocSettings,
+        richtext: ODTExporterRichtext,
+        citations: ODTExporterCitations,
+        chapterIndex = 0
+    ): void {
+        this.text = this.bodyTemplate!.cloneNode(true)
+        const textEl = this.text as XMLElement
+        const bodyBookmark = textEl.query("text:bookmark", {
             "text:name": "body"
         })
         if (bodyBookmark) {
@@ -104,12 +119,18 @@ export class ODTBookExporterRender extends ODTExporterRender {
             {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(["text:p", "text:h"])
-            blocks.forEach((block: any) => {
-                if (block.parentElement.nodeName === "text:deletion") {
+            blocks.forEach(block => {
+                if (block.parentElement?.tagName === "text:deletion") {
                     return
                 }
                 const text = block.textContent
@@ -126,21 +147,23 @@ export class ODTBookExporterRender extends ODTExporterRender {
 
     assemble(): void {
         this.styles.addPageBreakStyle()
-        const text = this.fileXml.query("office:text")
-        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("office:text") 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) {
                 text.appendXML('<text:p text:style-name="PageBreak"/>')
             }
         })
-        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/print/index.ts

@@ -54,7 +54,9 @@ export class PrintBookExporter extends HTMLBookExporter {
         if (!htmlDoc) {
             return
         }
-        const config: any = {title: this.book.title}
+        const config: {title: string; printCallback?: (iframeWin: Window) => void} = {
+            title: this.book.title
+        }
 
         if (navigator.userAgent.includes("Gecko/")) {
             config.printCallback = (iframeWin: Window) => {

package/src/exporter/tools.ts

@@ -7,11 +7,12 @@
  * decrypt end-to-end encrypted chapters.
  */
 
-import type {Schema} from "prosemirror-model"
+import type {Node, Schema} from "prosemirror-model"
 import {getSettings} from "@fiduswriter/document/schema/convert"
 import {acceptAllNoInsertions} from "@fiduswriter/document/transform"
 import {gettext} from "fwtoolkit"
 import type {ProgressCallback} from "@fiduswriter/document/exporter/tools/progress"
+import type {FidusDoc} from "@fiduswriter/document"
 
 import type {
     ChapterLoader,
@@ -172,13 +173,13 @@ async function decryptE2EEChapters(
                 // Parse ProseMirror content.
                 if (rawContent) {
                     doc.rawContent = JSON.parse(
-                        JSON.stringify(schema.nodeFromJSON(decryptedContent as Record<string, unknown>).toJSON())
+                        JSON.stringify(schema.nodeFromJSON(decryptedContent as unknown as Record<string, unknown>).toJSON())
                     )
                 }
                 doc.content = acceptAllNoInsertions(
-                    schema.nodeFromJSON(decryptedContent as Record<string, unknown>)
+                    schema.nodeFromJSON(decryptedContent as unknown as Record<string, unknown>) as Node
                 ).toJSON()
-                doc.settings = getSettings(doc.content)
+                doc.settings = getSettings(doc.content as unknown as FidusDoc)
 
                 // Decrypt encrypted images.
                 const encryptedImageEntries = Object.entries(doc.images || {}).filter(

package/src/importer/native/index.ts

@@ -167,7 +167,7 @@ export class NativeBookImporter {
 
         const bookData = JSON.parse(
             textFiles.find(f => f.filename === "book.json")?.content || "{}"
-        ) as Record<string, any>
+        ) as Record<string, unknown>
 
         const sortedChapters = [...(bookData.chapters as Array<{chapter_index: number; number: number; part?: string}>)].sort(
             (a, b) => a.chapter_index - b.chapter_index
@@ -197,9 +197,9 @@ export class NativeBookImporter {
                 throw new Error(`Missing chapter data for index ${ci}`)
             }
 
-            const docJson = JSON.parse(docFile.content) as Record<string, any>
-            const imagesJson = JSON.parse(imagesFile.content) as Record<string, any>
-            const bibJson = JSON.parse(bibFile.content) as Record<string, any>
+            const docJson = JSON.parse(docFile.content) as Record<string, unknown>
+            const imagesJson = JSON.parse(imagesFile.content) as Record<string, unknown>
+            const bibJson = JSON.parse(bibFile.content) as Record<string, unknown>
 
             const chapterPrefix = `chapters/${ci}/images/`
             const chapterOtherFiles = binaryFiles
@@ -220,7 +220,7 @@ export class NativeBookImporter {
             const importer = new NativeImporter(
                 docJson,
                 bibJson,
-                {db: imagesJson},
+                {db: imagesJson as unknown as import("@fiduswriter/document").ImageDB["db"]},
                 chapterOtherFiles,
                 this.user,
                 this.nativeBackend,
@@ -256,7 +256,7 @@ export class NativeBookImporter {
             part: chapter.part || ""
         }))
 
-        const book = await this.bookBackend.createBook(bookData as any, chapters, false)
+        const book = await this.bookBackend.createBook(bookData, chapters, false)
         this.bookId = book.id || null
         this.ok = true
         this.statusText = `"${bookData.title}" ${gettext("successfully imported.")}`