@fiduswriter/books-document 0.1.8 → 0.1.11

package/locale/ru/messages.json

@@ -0,0 +1,49 @@
+{
+    "": "ru",
+    "A personal passphrase is required to work with books that contain encrypted chapters. Please set up or unlock your personal passphrase in your profile settings.": "",
+    "Assembling BITS book...": "",
+    "Assembling Epub book...": "",
+    "Assembling HTML book...": "",
+    "BITS book export complete.": "",
+    "BITS book export has been initiated.": "",
+    "Book cannot be exported due to lack of chapters.": "",
+    "Cannot produce book as you lack access rights to its chapters.": "",
+    "Chapter data loaded.": "",
+    "Could not decrypt chapter:": "",
+    "Could not import chapter ": "",
+    "DOCX book export complete.": "",
+    "DOCX book export has been initiated.": "",
+    "Epub book export complete.": "",
+    "Epub book export has been initiated.": "",
+    "Exporting book chapters...": "",
+    "Exporting chapter %s of %s...": "",
+    "Fidusbook export complete.": "",
+    "Fidusbook export failed.": "",
+    "Fidusbook export has been initiated.": "",
+    "Fidusbook file is missing data for chapter ": "",
+    "Finalizing BITS book...": "",
+    "Finalizing DOCX book...": "",
+    "Finalizing Epub book...": "",
+    "Finalizing HTML book...": "",
+    "Finalizing LaTeX book...": "",
+    "Finalizing ODT book...": "",
+    "HTML book export complete.": "",
+    "HTML book export has been initiated.": "",
+    "LaTeX book export complete.": "",
+    "LaTeX book export has been initiated.": "",
+    "Loading chapter data...": "",
+    "No encryption key found for chapter:": "",
+    "ODT book export complete.": "",
+    "ODT book export has been initiated.": "",
+    "Preparing BITS book...": "",
+    "Preparing DOCX book...": "",
+    "Preparing Epub book...": "",
+    "Preparing LaTeX book...": "",
+    "Preparing ODT book...": "",
+    "successfully imported.": "успешно импортирован.",
+    "The document may have been re-encrypted with a different password.": "",
+    "The Fidusbook file version is not supported by this server: ": "",
+    "The key may not have been shared with you.": "",
+    "The uploaded file does not appear to be a Fidusbook file.": "",
+    "Untitled": "Без названия"
+}

package/locale/sv/messages.json

@@ -0,0 +1,49 @@
+{
+    "": "sv",
+    "A personal passphrase is required to work with books that contain encrypted chapters. Please set up or unlock your personal passphrase in your profile settings.": "",
+    "Assembling BITS book...": "",
+    "Assembling Epub book...": "",
+    "Assembling HTML book...": "",
+    "BITS book export complete.": "",
+    "BITS book export has been initiated.": "",
+    "Book cannot be exported due to lack of chapters.": "",
+    "Cannot produce book as you lack access rights to its chapters.": "",
+    "Chapter data loaded.": "",
+    "Could not decrypt chapter:": "",
+    "Could not import chapter ": "",
+    "DOCX book export complete.": "",
+    "DOCX book export has been initiated.": "",
+    "Epub book export complete.": "",
+    "Epub book export has been initiated.": "",
+    "Exporting book chapters...": "",
+    "Exporting chapter %s of %s...": "",
+    "Fidusbook export complete.": "",
+    "Fidusbook export failed.": "",
+    "Fidusbook export has been initiated.": "",
+    "Fidusbook file is missing data for chapter ": "",
+    "Finalizing BITS book...": "",
+    "Finalizing DOCX book...": "",
+    "Finalizing Epub book...": "",
+    "Finalizing HTML book...": "",
+    "Finalizing LaTeX book...": "",
+    "Finalizing ODT book...": "",
+    "HTML book export complete.": "",
+    "HTML book export has been initiated.": "",
+    "LaTeX book export complete.": "",
+    "LaTeX book export has been initiated.": "",
+    "Loading chapter data...": "",
+    "No encryption key found for chapter:": "",
+    "ODT book export complete.": "",
+    "ODT book export has been initiated.": "",
+    "Preparing BITS book...": "",
+    "Preparing DOCX book...": "",
+    "Preparing Epub book...": "",
+    "Preparing LaTeX book...": "",
+    "Preparing ODT book...": "",
+    "successfully imported.": "framgångsrikt importerat.",
+    "The document may have been re-encrypted with a different password.": "",
+    "The Fidusbook file version is not supported by this server: ": "",
+    "The key may not have been shared with you.": "",
+    "The uploaded file does not appear to be a Fidusbook file.": "",
+    "Untitled": "Namnlös"
+}

package/locale/tr/messages.json

@@ -0,0 +1,49 @@
+{
+    "": "tr",
+    "A personal passphrase is required to work with books that contain encrypted chapters. Please set up or unlock your personal passphrase in your profile settings.": "",
+    "Assembling BITS book...": "",
+    "Assembling Epub book...": "",
+    "Assembling HTML book...": "",
+    "BITS book export complete.": "",
+    "BITS book export has been initiated.": "",
+    "Book cannot be exported due to lack of chapters.": "",
+    "Cannot produce book as you lack access rights to its chapters.": "",
+    "Chapter data loaded.": "",
+    "Could not decrypt chapter:": "",
+    "Could not import chapter ": "",
+    "DOCX book export complete.": "",
+    "DOCX book export has been initiated.": "",
+    "Epub book export complete.": "",
+    "Epub book export has been initiated.": "",
+    "Exporting book chapters...": "",
+    "Exporting chapter %s of %s...": "",
+    "Fidusbook export complete.": "",
+    "Fidusbook export failed.": "",
+    "Fidusbook export has been initiated.": "",
+    "Fidusbook file is missing data for chapter ": "",
+    "Finalizing BITS book...": "",
+    "Finalizing DOCX book...": "",
+    "Finalizing Epub book...": "",
+    "Finalizing HTML book...": "",
+    "Finalizing LaTeX book...": "",
+    "Finalizing ODT book...": "",
+    "HTML book export complete.": "",
+    "HTML book export has been initiated.": "",
+    "LaTeX book export complete.": "",
+    "LaTeX book export has been initiated.": "",
+    "Loading chapter data...": "",
+    "No encryption key found for chapter:": "",
+    "ODT book export complete.": "",
+    "ODT book export has been initiated.": "",
+    "Preparing BITS book...": "",
+    "Preparing DOCX book...": "",
+    "Preparing Epub book...": "",
+    "Preparing LaTeX book...": "",
+    "Preparing ODT book...": "",
+    "successfully imported.": "başarıyla içe aktarıldı.",
+    "The document may have been re-encrypted with a different password.": "",
+    "The Fidusbook file version is not supported by this server: ": "",
+    "The key may not have been shared with you.": "",
+    "The uploaded file does not appear to be a Fidusbook file.": "",
+    "Untitled": "İsimsiz"
+}

package/locale/zh_Hans/messages.json

@@ -0,0 +1,49 @@
+{
+    "": "zh_Hans",
+    "A personal passphrase is required to work with books that contain encrypted chapters. Please set up or unlock your personal passphrase in your profile settings.": "",
+    "Assembling BITS book...": "",
+    "Assembling Epub book...": "",
+    "Assembling HTML book...": "",
+    "BITS book export complete.": "",
+    "BITS book export has been initiated.": "",
+    "Book cannot be exported due to lack of chapters.": "",
+    "Cannot produce book as you lack access rights to its chapters.": "",
+    "Chapter data loaded.": "",
+    "Could not decrypt chapter:": "",
+    "Could not import chapter ": "",
+    "DOCX book export complete.": "",
+    "DOCX book export has been initiated.": "",
+    "Epub book export complete.": "",
+    "Epub book export has been initiated.": "",
+    "Exporting book chapters...": "",
+    "Exporting chapter %s of %s...": "",
+    "Fidusbook export complete.": "",
+    "Fidusbook export failed.": "",
+    "Fidusbook export has been initiated.": "",
+    "Fidusbook file is missing data for chapter ": "",
+    "Finalizing BITS book...": "",
+    "Finalizing DOCX book...": "",
+    "Finalizing Epub book...": "",
+    "Finalizing HTML book...": "",
+    "Finalizing LaTeX book...": "",
+    "Finalizing ODT book...": "",
+    "HTML book export complete.": "",
+    "HTML book export has been initiated.": "",
+    "LaTeX book export complete.": "",
+    "LaTeX book export has been initiated.": "",
+    "Loading chapter data...": "",
+    "No encryption key found for chapter:": "",
+    "ODT book export complete.": "",
+    "ODT book export has been initiated.": "",
+    "Preparing BITS book...": "",
+    "Preparing DOCX book...": "",
+    "Preparing Epub book...": "",
+    "Preparing LaTeX book...": "",
+    "Preparing ODT book...": "",
+    "successfully imported.": "成功导入。",
+    "The document may have been re-encrypted with a different password.": "",
+    "The Fidusbook file version is not supported by this server: ": "",
+    "The key may not have been shared with you.": "",
+    "The uploaded file does not appear to be a Fidusbook file.": "",
+    "Untitled": "无题"
+}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fiduswriter/books-document",
-    "version": "0.1.8",
+    "version": "0.1.11",
     "description": "Fidus Writer book importers and exporters",
     "repository": {
         "type": "git",
@@ -72,48 +72,56 @@
         "dist/",
         "src/",
         "README.md",
-        "LICENSE"
+        "LICENSE",
+        "locale/*/messages.json"
     ],
     "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",
+        "compile-i18n": "node scripts/compile-i18n.js",
+        "extract-i18n": "node scripts/extract-i18n.js"
     },
     "dependencies": {
-        "@fiduswriter/document": "^0.2.20",
+        "@fiduswriter/document": "^0.2.32",
         "@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.4",
         "jszip": "^3.10.1",
         "pretty": "^2.0.0"
     },
     "devDependencies": {
+        "@eslint/js": "^10.0.1",
         "@types/node": "^26.0.1",
+        "eslint": "^10.6.0",
+        "gettext-parser": "^9.1.1",
+        "globals": "^15.15.0",
+        "husky": "^9.1.7",
         "jest": "^30.4.2",
+        "lint-staged": "^17.0.8",
+        "prettier": "^3.8.5",
+        "prosemirror-model": "^1.25.0",
         "ts-jest": "^29.1.2",
         "ts-jest-resolver": "^2.0.1",
         "typescript": "^6.0.3",
-        "@eslint/js": "^10.0.1",
-        "eslint": "^10.6.0",
-        "globals": "^15.15.0",
-        "prettier": "^3.8.5",
-        "typescript-eslint": "^8.62.0",
-        "prosemirror-model": "^1.25.0"
+        "typescript-eslint": "^8.62.0"
     },
     "lint-staged": {
         "*.{ts,js,mjs,css,md,json,html}": [
             "prettier --write"
         ],
         "*.{ts,js,mjs}": [
-            "eslint --fix"
+            "eslint --fix",
+            "sh -c 'npm run typecheck'"
         ]
     }
 }

package/src/exporter/docx/render.ts

@@ -5,6 +5,13 @@ 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: XMLElement | null
     bodyTemplate: XMLElement | null
@@ -69,7 +76,13 @@ export class DOCXBookExporterRender extends DOCXExporterRender {
         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)
     }
 
@@ -105,7 +118,7 @@ export class DOCXBookExporterRender extends DOCXExporterRender {
         ]
         const usedTags: Array<{
             title: string
-            content?: unknown
+            content?: string | unknown[]
             block: XMLElement
         }> = []
         const ambles = [this.preamble, this.postamble].filter(
@@ -118,12 +131,12 @@ export class DOCXBookExporterRender extends DOCXExporterRender {
                 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 {

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"
@@ -65,7 +66,7 @@ interface ChapterOutput {
     part: string
     title: string
     docNum: number
-    metaData: Record<string, unknown>
+    metaData: HTMLExportMetadata
 }
 
 export class EpubBookExporter {
@@ -247,7 +248,7 @@ export class EpubBookExporter {
                         })
 
                         await Promise.all(
-                            extraStyleSheets.map(
+                            (extraStyleSheets as StyleSheet[]).map(
                                 async (sheet: StyleSheet) => this.loadStyle(sheet)
                             )
                         )

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>>
 }
 
@@ -201,7 +202,7 @@ export class HTMLBookExporter {
                 bibDB,
                 imageDB,
                 this.csl,
-                this.updated,
+                new Date(this.updated * 1000),
                 [],
                 options,
                 htmlBookChapterTemplate as unknown as typeof HTMLExporter.prototype.htmlExportTemplate
@@ -209,19 +210,7 @@ export class HTMLBookExporter {
 
             await documentHTMLExporter.process()
             const {metaData, converter, textFiles, httpFiles} =
-                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[]
-                }
+                documentHTMLExporter.getProcessedFiles()
 
             const contents = textFiles.find(
                 (textFile: TextFile) => textFile.filename === "document.html"
@@ -443,7 +432,10 @@ export class HTMLBookExporter {
 
     async createZip(): Promise<Blob | void> {
         const zipper = new ZipFileCreator(
-            this.textFiles.concat(this.styleSheets as TextFile[]),
+            this.textFiles.concat(this.styleSheets as TextFile[]) as Array<{
+                filename: string
+                contents: string
+            }>,
             this.httpFiles,
             this.includeZips,
             "application/zip",

package/src/exporter/latex/index.ts

@@ -13,7 +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 type {BibDB, ExportDoc, FidusNode, ImageDB} from "@fiduswriter/document"
 import {getMissingChapterData} from "../tools.js"
 import {bookTexTemplate} from "./templates.js"
 
@@ -29,6 +29,7 @@ interface HttpFile {
 
 export class LatexBookExporter {
     schema: Schema
+    doc!: ExportDoc
     book: Book
     user: User
     docList: DocumentListEntry[]
@@ -81,13 +82,14 @@ export class LatexBookExporter {
             if (!doc) {
                 return
             }
+            this.doc = doc
             const converter = new LatexExporterConvert(
                 this,
                 {db: doc.images || {}},
                 {db: doc.bibliography || {}},
                 doc.settings
             )
-            const chapterContent = removeHidden(doc.content)
+            const chapterContent = removeHidden(doc.content) as FidusNode
             const convertedDoc = converter.init(chapterContent)
             this.textFiles.push({
                 filename: `chapter-${index + 1}.tex`,
@@ -132,7 +134,10 @@ export class LatexBookExporter {
             this,
             {db: combinedImages as unknown as ImageDB["db"]},
             {db: combinedBibliography as unknown as BibDB["db"]},
-            {language: this.book.settings.language, bibliography_header: {}}
+            {
+                language: this.book.settings.language,
+                bibliography_header: {} as FidusNode
+            }
         )
         bookConverter.features = features
         const preamble = bookConverter.assemblePreamble()

package/src/exporter/odt/render.ts

@@ -6,6 +6,12 @@ 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"
 
+interface Tag {
+    title: string
+    content?: unknown[]
+    block: XMLElement
+}
+
 export class ODTBookExporterRender extends ODTExporterRender {
     styles: ODTExporterStyles
     preamble: XMLElement | null
@@ -85,7 +91,13 @@ export class ODTBookExporterRender extends ODTExporterRender {
                 `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)
     }
 
@@ -121,7 +133,7 @@ export class ODTBookExporterRender extends ODTExporterRender {
         ]
         const usedTags: Array<{
             title: string
-            content?: unknown
+            content?: unknown[]
             block: XMLElement
         }> = []
         const ambles = [this.preamble, this.postamble].filter(
@@ -137,12 +149,12 @@ export class ODTBookExporterRender extends ODTExporterRender {
                 tags.forEach(tag => {
                     const tagString = tag.title
                     if (text.includes(`{${tagString}}`)) {
-                        usedTags.push(Object.assign({block}, tag))
+                        usedTags.push(Object.assign({block}, tag) as Tag)
                     }
                 })
             })
         })
-        usedTags.forEach(tag => this.inlineRender(tag))
+        usedTags.forEach(tag => this.inlineRender(tag as unknown as Tag))
     }
 
     assemble(): void {