@fiduswriter/books-document 0.1.3 → 0.1.5

package/src/exporter/html/index.ts

@@ -4,11 +4,12 @@
 
 import type {Schema} from "prosemirror-model"
 import type {CSL, User} from "@fiduswriter/document"
+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"
 import {ZipFileCreator} from "@fiduswriter/document/exporter/tools/zip"
 import {LANGUAGES} from "@fiduswriter/document/schema/const"
-import {addAlert, get, staticUrl} from "fwtoolkit"
+import {gettext, get, staticUrl} from "fwtoolkit"
 import pretty from "pretty"
 
 import type {Book, BookStyle, BookStyles, DocumentListEntry} from "../../types.js"
@@ -74,6 +75,7 @@ export class HTMLBookExporter {
     singleFileHTMLBookTemplate: (...args: any[]) => string
     singleFileHTMLBookCSSTemplate: (...args: any[]) => string
     styleSheets: StyleSheet[]
+    progressCallback?: ProgressCallback
 
     constructor(
         schema: Schema,
@@ -112,16 +114,21 @@ export class HTMLBookExporter {
         this.styleSheets = [{url: staticUrl("css/book.css")}]
     }
 
-    async init(): Promise<Blob | false | void> {
+    async init(progressCallback?: ProgressCallback): Promise<Blob | false | void> {
+        this.progressCallback = progressCallback
+        this.progressCallback?.(
+            gettext("HTML book export has been initiated."),
+            0
+        )
         if (this.book.chapters.length === 0) {
-            addAlert(
-                "error",
+            throw new Error(
                 gettext("Book cannot be exported due to lack of chapters.")
             )
-            return false
         }
 
-        await getMissingChapterData(this.book, this.docList, this.schema)
+        await getMissingChapterData(this.book, this.docList, this.schema, {
+            progressCallback: this.progressCallback
+        })
 
         this.addBookStyle()
 
@@ -147,6 +154,7 @@ export class HTMLBookExporter {
     }
 
     async exportChapters(): Promise<Blob | void> {
+        this.progressCallback?.(gettext("Exporting book chapters..."), 20)
         let footnoteCounter = 0,
             affiliationCounter = 0,
             figureCounter = 0,
@@ -154,9 +162,11 @@ export class HTMLBookExporter {
             photoCounter = 0,
             tableCounter = 0
 
-        for (const chapterInfo of this.book.chapters.sort(
+        const sortedChapters = this.book.chapters.sort(
             (a, b) => a.number - b.number
-        )) {
+        )
+
+        for (const chapterInfo of sortedChapters) {
             const chapterNumber = chapterInfo.number
             const chapterPart = chapterInfo.part || ""
             const doc = this.docList.find(d => d.id === chapterInfo.text)
@@ -254,10 +264,12 @@ export class HTMLBookExporter {
             })
         }
 
+        this.progressCallback?.(gettext("Assembling HTML book..."), 80)
         return this.exportBook()
     }
 
     async exportBook(): Promise<Blob | void> {
+        this.progressCallback?.(gettext("Finalizing HTML book..."), 90)
         if (this.math) {
             this.includeZips.push({
                 directory: "css",
@@ -426,6 +438,7 @@ export class HTMLBookExporter {
             new Date(this.updated * 1000)
         )
         const blob = await zipper.init()
+        this.progressCallback?.(gettext("HTML book export complete."), 100)
         return this.download(blob)
     }
 

package/src/exporter/latex/index.ts

@@ -4,11 +4,13 @@
 
 import type {Schema} from "prosemirror-model"
 import type {User} from "@fiduswriter/document"
+import type {ProgressCallback} from "@fiduswriter/document/exporter/tools/progress"
 import {BibLatexExporter} from "biblatex-csl-converter"
 import {LatexExporterConvert} from "@fiduswriter/document/exporter/latex/convert"
 import {removeHidden} from "@fiduswriter/document/exporter/tools/doc_content"
 import {createSlug} from "@fiduswriter/document/exporter/tools/file"
 import {ZipFileCreator} from "@fiduswriter/document/exporter/tools/zip"
+import {gettext} from "fwtoolkit"
 
 import type {Book, DocumentListEntry} from "../../types.js"
 import {getMissingChapterData} from "../tools.js"
@@ -33,6 +35,7 @@ export class LatexBookExporter {
     textFiles: TextFile[]
     httpFiles: HttpFile[]
     zipFileName: string
+    progressCallback?: ProgressCallback
 
     constructor(
         schema: Schema,
@@ -53,13 +56,19 @@ export class LatexBookExporter {
         this.zipFileName = ""
     }
 
-    init(): Promise<Blob> {
+    init(progressCallback?: ProgressCallback): Promise<Blob> {
+        this.progressCallback = progressCallback
+        this.progressCallback?.(
+            gettext("LaTeX book export has been initiated."),
+            0
+        )
         return getMissingChapterData(this.book, this.docList, this.schema).then(
             () => this.export()
         )
     }
 
     export(): Promise<Blob> {
+        this.progressCallback?.(gettext("Preparing LaTeX book..."), 10)
         this.zipFileName = `${createSlug(this.book.title)}.latex.zip`
         let bibIds: string[] = []
         let imageIds: string[] = []
@@ -140,6 +149,7 @@ export class LatexBookExporter {
     }
 
     createZip(): Promise<Blob> {
+        this.progressCallback?.(gettext("Finalizing LaTeX book..."), 90)
         const zipper = new ZipFileCreator(
             this.textFiles,
             this.httpFiles,
@@ -148,7 +158,10 @@ export class LatexBookExporter {
             this.updated
         )
 
-        return zipper.init().then(blob => this.download(blob))
+        return zipper.init().then(blob => {
+            this.progressCallback?.(gettext("LaTeX book export complete."), 100)
+            return this.download(blob)
+        })
     }
 
     download(blob: Blob): Blob {

package/src/exporter/native/index.ts

@@ -6,11 +6,12 @@ import type {Schema} from "prosemirror-model"
 import {ShrinkFidus} from "@fiduswriter/document/exporter/native/shrink"
 import {createSlug} from "@fiduswriter/document/exporter/tools/file"
 import {ZipFileCreator} from "@fiduswriter/document/exporter/tools/zip"
-import {addAlert} from "fwtoolkit"
+import {gettext} from "fwtoolkit"
 
 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"
 
 interface FileInclude {
     url: string
@@ -31,40 +32,54 @@ export class NativeBookExporter {
     documentList: DocumentListEntry[]
     updated: any
 
+    progressCallback?: ProgressCallback
+
     constructor(
         schema: Schema,
         book: Book,
         user: User,
         documentList: DocumentListEntry[],
-        updated: any
+        updated: any,
+        progressCallback?: ProgressCallback
     ) {
         this.schema = schema
         this.book = book
         this.user = user
         this.documentList = documentList
         this.updated = updated
+        this.progressCallback = progressCallback
     }
 
-    init(): Promise<Blob> {
+    init(progressCallback?: ProgressCallback): Promise<Blob> {
+        if (progressCallback) {
+            this.progressCallback = progressCallback
+        }
         if (this.book.chapters.length === 0) {
-            addAlert(
-                "error",
-                gettext("Book cannot be exported due to lack of chapters.")
+            this.progressCallback?.(
+                gettext("Book cannot be exported due to lack of chapters."),
+                100
             )
             return Promise.resolve(new Blob([]))
         }
 
-        addAlert(
-            "info",
-            `${this.book.title}: ${gettext("Fidusbook export has been initiated.")}`
+        this.progressCallback?.(
+            `${this.book.title}: ${gettext("Fidusbook export has been initiated.")}`,
+            0
         )
 
         return getMissingChapterData(this.book, this.documentList, this.schema)
             .then(() => this.exportContents())
+            .then(blob => {
+                this.progressCallback?.(
+                    `${this.book.title}: ${gettext("Fidusbook export complete.")}`,
+                    100
+                )
+                return blob
+            })
             .catch(error => {
-                addAlert(
-                    "error",
-                    `${this.book.title}: ${gettext("Fidusbook export failed.")}`
+                this.progressCallback?.(
+                    `${this.book.title}: ${gettext("Fidusbook export failed.")}`,
+                    100
                 )
                 throw error
             })
@@ -113,11 +128,16 @@ export class NativeBookExporter {
                 return processChapter(index + 1)
             }
 
+            this.progressCallback?.(
+                gettext("Exporting chapter %s of %s..."),
+                Math.round((index / sortedChapters.length) * 90)
+            )
+
             const shrinker = new ShrinkFidus(
                 doc as any,
                 {db: doc.images || {}},
                 {db: doc.bibliography || {}},
-                true
+                this.progressCallback
             )
 
             return shrinker

package/src/exporter/odt/index.ts

@@ -4,13 +4,14 @@
 
 import type {Schema} from "prosemirror-model"
 import type {CSL, User} from "@fiduswriter/document"
+import type {ProgressCallback} from "@fiduswriter/document/exporter/tools/progress"
 import {
     fixTables,
     removeHidden
 } from "@fiduswriter/document/exporter/tools/doc_content"
 import {createSlug} from "@fiduswriter/document/exporter/tools/file"
 import {XmlZip} from "@fiduswriter/document/exporter/tools/xml_zip"
-import {addAlert} from "fwtoolkit"
+import {gettext} from "fwtoolkit"
 
 import {ODTExporterCitations} from "@fiduswriter/document/exporter/odt/citations"
 import {ODTExporterImages} from "@fiduswriter/document/exporter/odt/images"
@@ -36,6 +37,7 @@ export class ODTBookExporter {
     textFiles: Array<Record<string, unknown>>
     httpFiles: Array<Record<string, unknown>>
     mimeType: string
+    progressCallback?: ProgressCallback
 
     constructor(
         schema: Schema,
@@ -58,23 +60,27 @@ export class ODTBookExporter {
         this.mimeType = "application/vnd.oasis.opendocument.text"
     }
 
-    init(): Promise<Blob> | false {
+    init(progressCallback?: ProgressCallback): Promise<Blob> | false {
+        this.progressCallback = progressCallback
+        this.progressCallback?.(
+            gettext("ODT book export has been initiated."),
+            0
+        )
         if (this.book.chapters.length === 0) {
-            addAlert(
-                "error",
+            throw new Error(
                 gettext("Book cannot be exported due to lack of chapters.")
             )
-            return false
         }
         return getMissingChapterData(
             this.book,
             this.docList,
             this.schema,
-            {rawContent: true}
+            {rawContent: true, progressCallback: this.progressCallback}
         ).then(() => this.export())
     }
 
     export(): Promise<Blob> {
+        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)
@@ -95,8 +101,17 @@ export class ODTBookExporter {
             .then(() => metadata.init())
             .then(() => math.init())
             .then(() => this.exportChapters(xml as any, render, styles, math, tracks))
-            .then(() => xml.prepareBlob())
-            .then(blob => this.download(blob))
+            .then(() => {
+                this.progressCallback?.(gettext("Finalizing ODT book..."), 90)
+                return xml.prepareBlob()
+            })
+            .then(blob => {
+                this.progressCallback?.(
+                    gettext("ODT book export complete."),
+                    100
+                )
+                return this.download(blob)
+            })
     }
 
     exportChapters(

package/src/exporter/tools.ts

@@ -10,7 +10,8 @@
 import type {Schema} from "prosemirror-model"
 import {getSettings} from "@fiduswriter/document/schema/convert"
 import {acceptAllNoInsertions} from "@fiduswriter/document/transform"
-import {addAlert} from "fwtoolkit"
+import {gettext} from "fwtoolkit"
+import type {ProgressCallback} from "@fiduswriter/document/exporter/tools/progress"
 
 import type {
     ChapterLoader,
@@ -58,30 +59,35 @@ export async function getMissingChapterData(
         rawContent?: boolean
         loader?: ChapterLoader
         e2ee?: E2EEStrategy
+        progressCallback?: ProgressCallback
     } = {}
 ): Promise<void> {
-    const {rawContent = false, loader = noopChapterLoader, e2ee = noopE2EEStrategy} =
-        options
+    const {
+        rawContent = false,
+        loader = noopChapterLoader,
+        e2ee = noopE2EEStrategy,
+        progressCallback
+    } = options
+
+    progressCallback?.(gettext("Loading chapter data..."), 0)
 
     const bookDocuments = book.chapters.map(chapter =>
         documentList.find(doc => doc.id === chapter.text)
     )
 
     if (bookDocuments.some(doc => doc === undefined)) {
-        addAlert(
-            "error",
+        throw new Error(
             gettext(
                 "Cannot produce book as you lack access rights to its chapters."
             )
         )
-        throw new Error(
-            "Cannot produce book as you lack access rights to its chapters."
-        )
     }
 
     const docIds = book.chapters.map(chapter => chapter.text)
     await loader.loadChapters(docIds, documentList, schema, rawContent)
     await decryptE2EEChapters(book, documentList, schema, rawContent, e2ee)
+
+    progressCallback?.(gettext("Chapter data loaded."), 50)
 }
 
 /**
@@ -106,13 +112,11 @@ async function decryptE2EEChapters(
 
     const unlocked = await e2ee.ensurePassphraseUnlocked()
     if (!unlocked) {
-        addAlert(
-            "error",
+        throw new Error(
             gettext(
                 "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."
             )
         )
-        throw new Error("Passphrase required for encrypted chapters")
     }
 
     await Promise.all(
@@ -127,11 +131,9 @@ async function decryptE2EEChapters(
 
             const password = await e2ee.getDocumentPassword(Number(doc.id))
             if (!password) {
-                addAlert(
-                    "error",
+                throw new Error(
                     `${gettext("No encryption key found for chapter:")} ${chapterLabel}. ${gettext("The key may not have been shared with you.")}`
                 )
-                throw new Error(`No encryption key for document ${String(doc.id)}`)
             }
 
             if (!doc.e2ee_salt) {
@@ -213,11 +215,9 @@ async function decryptE2EEChapters(
                 ) {
                     throw err
                 }
-                addAlert(
-                    "error",
+                throw new Error(
                     `${gettext("Could not decrypt chapter:")} ${chapterLabel}. ${gettext("The document may have been re-encrypted with a different password.")}`
                 )
-                throw err
             }
         })
     )