@fiduswriter/books-document 0.1.1 → 0.1.2

package/src/exporter/print/index.ts

@@ -4,13 +4,13 @@
  * Uses @vivliostyle/print to render the book in the browser.
  */
 
-import type {Schema} from "prosemirror-model"
-import type {CSL, User} from "@fiduswriter/document"
-import {printHTML} from "@vivliostyle/print"
+import type { Schema } from "prosemirror-model"
+import type { CSL, User } from "@fiduswriter/document"
+import { printHTML } from "@vivliostyle/print"
 
-import type {Book, BookStyles, DocumentListEntry} from "../../types.js"
-import {HTMLBookExporter} from "../html/index.js"
-import {chapterTemplate} from "./templates.js"
+import type { Book, BookStyles, DocumentListEntry } from "../../types.js"
+import { HTMLBookExporter } from "../html/index.js"
+import { chapterTemplate } from "./templates.js"
 
 export class PrintBookExporter extends HTMLBookExporter {
     constructor(
@@ -37,13 +37,10 @@ export class PrintBookExporter extends HTMLBookExporter {
         let contents = bookStyle.contents
         bookStyle.bookstylefile_set.forEach(
             ([url, filename]: [string, string]) =>
-                (contents = contents.replace(
-                    new RegExp(filename, "g"),
-                    url
-                ))
+                (contents = contents.replace(new RegExp(filename, "g"), url))
         )
 
-        this.styleSheets.push({contents})
+        this.styleSheets.push({ contents })
         return true
     }
 
@@ -54,7 +51,7 @@ export class PrintBookExporter extends HTMLBookExporter {
         if (!htmlDoc) {
             return
         }
-        const config: any = {title: this.book.title}
+        const config: any = { title: this.book.title }
 
         if (navigator.userAgent.includes("Gecko/")) {
             config.printCallback = (iframeWin: Window) => {
@@ -70,8 +67,7 @@ export class PrintBookExporter extends HTMLBookExporter {
                 document.body.appendChild(backgroundStyle)
                 window.print()
                 document.body = oldBody
-                delete document.body.parentElement!.dataset
-                    .vivliostylePaginated
+                delete document.body.parentElement!.dataset.vivliostylePaginated
             }
         }
 
@@ -82,7 +78,7 @@ export class PrintBookExporter extends HTMLBookExporter {
         url?: string
         filename?: string
         contents?: string
-    }): Promise<{url?: string; filename?: string; contents?: string}> {
+    }): Promise<{ url?: string; filename?: string; contents?: string }> {
         if (sheet.url) {
             sheet.filename = sheet.url
             delete sheet.url

package/src/exporter/print/templates.ts

@@ -1,4 +1,4 @@
-import {escapeText} from "fwtoolkit"
+import { escapeText } from "fwtoolkit"
 
 export const chapterTemplate = ({
     part,

package/src/exporter/tools.ts

@@ -7,10 +7,10 @@
  * decrypt end-to-end encrypted chapters.
  */
 
-import type {Schema} from "prosemirror-model"
-import {getSettings} from "@fiduswriter/document/schema/convert"
-import {acceptAllNoInsertions} from "@fiduswriter/document/transform"
-import {addAlert} from "fwtoolkit"
+import type { Schema } from "prosemirror-model"
+import { getSettings } from "@fiduswriter/document/schema/convert"
+import { acceptAllNoInsertions } from "@fiduswriter/document/transform"
+import { addAlert, gettext } from "fwtoolkit"
 
 import type {
     ChapterLoader,
@@ -60,8 +60,11 @@ export async function getMissingChapterData(
         e2ee?: E2EEStrategy
     } = {}
 ): Promise<void> {
-    const {rawContent = false, loader = noopChapterLoader, e2ee = noopE2EEStrategy} =
-        options
+    const {
+        rawContent = false,
+        loader = noopChapterLoader,
+        e2ee = noopE2EEStrategy
+    } = options
 
     const bookDocuments = book.chapters.map(chapter =>
         documentList.find(doc => doc.id === chapter.text)
@@ -131,7 +134,9 @@ async function decryptE2EEChapters(
                     "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)}`)
+                throw new Error(
+                    `No encryption key for document ${String(doc.id)}`
+                )
             }
 
             if (!doc.e2ee_salt) {
@@ -142,7 +147,11 @@ async function decryptE2EEChapters(
             const salt = base64ToUint8Array(doc.e2ee_salt)
             const iterations = doc.e2ee_iterations || 600000
 
-            const key = await e2ee.resolvePasswordToKey(password, salt, iterations)
+            const key = await e2ee.resolvePasswordToKey(
+                password,
+                salt,
+                iterations
+            )
 
             try {
                 const decryptedContent = (await e2ee.decryptObject(
@@ -151,11 +160,18 @@ async function decryptE2EEChapters(
                 )) as Record<string, unknown>
 
                 // Update the plaintext title.
-                const titleNode = (decryptedContent.content as Record<string, unknown>[] | undefined)?.[0]
-                const titleContent = (titleNode?.content as Record<string, unknown>[] | undefined) || []
+                const titleNode = (
+                    decryptedContent.content as
+                        Record<string, unknown>[] | undefined
+                )?.[0]
+                const titleContent =
+                    (titleNode?.content as
+                        Record<string, unknown>[] | undefined) || []
                 let title = ""
                 titleContent.forEach(child => {
-                    const marks = (child.marks as Record<string, unknown>[] | undefined) || []
+                    const marks =
+                        (child.marks as
+                            Record<string, unknown>[] | undefined) || []
                     if (!marks.some(m => (m.type as string) === "deletion")) {
                         title += (child.text as string) || ""
                     }
@@ -163,23 +179,36 @@ async function decryptE2EEChapters(
                 if (title) {
                     doc.title = title.substring(0, 255)
                     if (typeof sessionStorage !== "undefined") {
-                        sessionStorage.setItem(`e2ee_title_${String(doc.id)}`, doc.title)
+                        sessionStorage.setItem(
+                            `e2ee_title_${String(doc.id)}`,
+                            doc.title
+                        )
                     }
                 }
 
                 // 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 Record<string, unknown>
+                                )
+                                .toJSON()
+                        )
                     )
                 }
                 doc.content = acceptAllNoInsertions(
-                    schema.nodeFromJSON(decryptedContent as Record<string, unknown>)
+                    schema.nodeFromJSON(
+                        decryptedContent as Record<string, unknown>
+                    )
                 ).toJSON()
                 doc.settings = getSettings(doc.content)
 
                 // Decrypt encrypted images.
-                const encryptedImageEntries = Object.entries(doc.images || {}).filter(
+                const encryptedImageEntries = Object.entries(
+                    doc.images || {}
+                ).filter(
                     ([, entry]) =>
                         entry.file_type === "application/octet-stream" &&
                         typeof entry.image === "string"

package/src/importer/native/index.ts

@@ -5,15 +5,14 @@
  * chapter and delegates creation of the book record to a `BookImporterBackend`.
  */
 
-import type {NativeImporterBackend} from "@fiduswriter/document"
-import {NativeImporter} from "@fiduswriter/document/importer/native"
-import {addAlert} from "fwtoolkit"
+import type { NativeImporterBackend } from "@fiduswriter/document"
+import { NativeImporter } from "@fiduswriter/document/importer/native"
+import { addAlert, gettext } from "fwtoolkit"
 
-import type {BookImporterBackend, Chapter, User} from "../../types.js"
-import {readFidusBookFile} from "./reader.js"
+import type { BookImporterBackend, Chapter, User } from "../../types.js"
 
-export {FIDUSBOOK_VERSION} from "./reader.js"
-export {readFidusBookFile, FidusBookReader} from "./reader.js"
+export { FIDUSBOOK_VERSION } from "./reader.js"
+export { readFidusBookFile, FidusBookReader } from "./reader.js"
 
 export class NativeBookImporter {
     file: Blob
@@ -69,8 +68,8 @@ export class NativeBookImporter {
     }
 
     async readZip(): Promise<void> {
-        let textFiles: Array<{filename: string; content: string}> = []
-        let binaryFiles: Array<{filename: string; content: Blob}> = []
+        let textFiles: Array<{ filename: string; content: string }> = []
+        let binaryFiles: Array<{ filename: string; content: Blob }> = []
 
         try {
             const JSZip = (await import("jszip")).default
@@ -103,7 +102,7 @@ export class NativeBookImporter {
                         }
                     })
             )
-        } catch (error) {
+        } catch (_error) {
             this.statusText = gettext(
                 "The uploaded file does not appear to be a Fidusbook file."
             )
@@ -114,18 +113,15 @@ export class NativeBookImporter {
     }
 
     async processFidusbookFile(
-        textFiles: Array<{filename: string; content: string}>,
-        binaryFiles: Array<{filename: string; content: Blob}>
+        textFiles: Array<{ filename: string; content: string }>,
+        binaryFiles: Array<{ filename: string; content: Blob }>
     ): Promise<void> {
         const versionEntry = textFiles.find(
             f => f.filename === "filetype-version"
         )
         const filetypeVersion = Number.parseFloat(versionEntry?.content || "")
 
-        if (
-            filetypeVersion < 1.0 ||
-            filetypeVersion > 1.0
-        ) {
+        if (filetypeVersion < 1.0 || filetypeVersion > 1.0) {
             this.statusText =
                 gettext(
                     "The Fidusbook file version is not supported by this server: "
@@ -148,9 +144,13 @@ export class NativeBookImporter {
             textFiles.find(f => f.filename === "book.json")?.content || "{}"
         ) as Record<string, any>
 
-        const sortedChapters = [...(bookData.chapters as Array<{chapter_index: number; number: number; part?: string}>)].sort(
-            (a, b) => a.chapter_index - b.chapter_index
-        )
+        const sortedChapters = [
+            ...(bookData.chapters as Array<{
+                chapter_index: number
+                number: number
+                part?: string
+            }>)
+        ].sort((a, b) => a.chapter_index - b.chapter_index)
 
         const importedDocIds: Record<number, number> = {}
 
@@ -177,7 +177,10 @@ export class NativeBookImporter {
             }
 
             const docJson = JSON.parse(docFile.content) as Record<string, any>
-            const imagesJson = JSON.parse(imagesFile.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 chapterPrefix = `chapters/${ci}/images/`
@@ -194,7 +197,7 @@ export class NativeBookImporter {
             const importer = new NativeImporter(
                 docJson,
                 bibJson,
-                {db: imagesJson},
+                { db: imagesJson },
                 chapterOtherFiles,
                 this.user,
                 this.nativeBackend,
@@ -205,7 +208,7 @@ export class NativeBookImporter {
 
             let doc
             try {
-                ;({doc} = await importer.init())
+                ;({ doc } = await importer.init())
             } catch (error) {
                 addAlert(
                     "error",
@@ -225,7 +228,11 @@ export class NativeBookImporter {
             part: chapter.part || ""
         }))
 
-        const book = await this.bookBackend.createBook(bookData as any, chapters, false)
+        const book = await this.bookBackend.createBook(
+            bookData as any,
+            chapters,
+            false
+        )
         this.bookId = book.id || null
         this.ok = true
         this.statusText = `"${bookData.title}" ${gettext("successfully imported.")}`

package/src/importer/native/reader.ts

@@ -6,7 +6,7 @@
  * exporters.  No server interaction.
  */
 
-import type {DocumentListEntry} from "../../types.js"
+import type { DocumentListEntry } from "../../types.js"
 
 export const FIDUSBOOK_VERSION = "1.0"
 export const MIN_FIDUSBOOK_VERSION = 1.0
@@ -58,7 +58,7 @@ export async function readFidusBookFile(
                 const content = await zipfs.files[filename].async(
                     isText ? "string" : "blob"
                 )
-                const entry = {filename, content}
+                const entry = { filename, content }
                 if (isText) {
                     textFiles.push(entry as ArchiveFile)
                 } else {
@@ -93,9 +93,9 @@ export async function readFidusBookFile(
         textFiles.find(f => f.filename === "book.json")?.content as string
     ) as Record<string, unknown>
 
-    const sortedChapters = [...(bookData.chapters as Array<{chapter_index: number}>)].sort(
-        (a, b) => a.chapter_index - b.chapter_index
-    )
+    const sortedChapters = [
+        ...(bookData.chapters as Array<{ chapter_index: number }>)
+    ].sort((a, b) => a.chapter_index - b.chapter_index)
 
     const documentList: DocumentListEntry[] = []
 
@@ -116,9 +116,18 @@ export async function readFidusBookFile(
             throw new Error(`Missing chapter data for index ${ci}`)
         }
 
-        const docJson = JSON.parse(docFile.content as string) as Record<string, unknown>
-        const imagesJson = JSON.parse(imagesFile.content as string) as Record<string, {image: string; file?: Blob}>
-        const bibJson = JSON.parse(bibFile.content as string) as Record<string, unknown>
+        const docJson = JSON.parse(docFile.content as string) as Record<
+            string,
+            unknown
+        >
+        const imagesJson = JSON.parse(imagesFile.content as string) as Record<
+            string,
+            { image: string; file?: Blob }
+        >
+        const bibJson = JSON.parse(bibFile.content as string) as Record<
+            string,
+            unknown
+        >
 
         const chapterPrefix = `chapters/${ci}/images/`
         const chapterImages: Record<string, Blob> = {}
@@ -155,7 +164,7 @@ export async function readFidusBookFile(
         } as DocumentListEntry)
     }
 
-    return {book: bookData, documentList}
+    return { book: bookData, documentList }
 }
 
 export class FidusBookReader {

package/src/index.ts

@@ -1,4 +1,4 @@
-export {FIDUSBOOK_VERSION} from "./schema/index.js"
+export { FIDUSBOOK_VERSION } from "./schema/index.js"
 export type {
     Book,
     BookBaseMetadata,

package/src/modules.d.ts

@@ -1,5 +1,5 @@
 declare module "pretty" {
-    function pretty(html: string, options?: {ocd?: boolean}): string
+    function pretty(html: string, options?: { ocd?: boolean }): string
     export default pretty
 }
 

package/src/types.ts

@@ -2,7 +2,7 @@
  * Core types for the @fiduswriter/books-document package.
  */
 
-import type {Schema} from "prosemirror-model"
+import type { Schema } from "prosemirror-model"
 import type {
     BibDB,
     CSL,
@@ -12,7 +12,7 @@ import type {
     User
 } from "@fiduswriter/document"
 
-export type {CSL, User} from "@fiduswriter/document"
+export type { CSL, User } from "@fiduswriter/document"
 
 /** A single chapter entry inside a book. */
 export interface Chapter {

package/src/global.d.ts

@@ -1,2 +0,0 @@
-declare function gettext(text: string): string
-declare function interpolate(fmt: string, ...args: unknown[]): string