@fiduswriter/books-document 0.1.2 → 0.1.4

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, gettext } from "fwtoolkit"
+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 {
     ChapterLoader,
@@ -60,11 +60,8 @@ 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)
@@ -134,9 +131,7 @@ 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) {
@@ -147,11 +142,7 @@ 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(
@@ -160,18 +151,11 @@ 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) || ""
                     }
@@ -179,36 +163,23 @@ 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/global.d.ts

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

package/src/importer/native/index.ts

@@ -5,14 +5,28 @@
  * 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, gettext } from "fwtoolkit"
+import type {E2EEOptions, NativeImporterBackend} from "@fiduswriter/document"
+import {NativeImporter} from "@fiduswriter/document/importer/native"
+import {addAlert} from "fwtoolkit"
 
-import type { BookImporterBackend, Chapter, User } from "../../types.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 interface E2EEOptionsResult {
+    options: E2EEOptions
+    password: string
+}
+
+export interface NativeBookImporterOptions {
+    path?: string
+    getE2EEOptions?: () => Promise<E2EEOptionsResult | null>
+    onChapterImported?: (
+        doc: Record<string, unknown>,
+        password: string
+    ) => Promise<void>
+}
 
 export class NativeBookImporter {
     file: Blob
@@ -20,6 +34,11 @@ export class NativeBookImporter {
     path: string
     nativeBackend: NativeImporterBackend
     bookBackend: BookImporterBackend
+    getE2EEOptions?: () => Promise<E2EEOptionsResult | null>
+    onChapterImported?: (
+        doc: Record<string, unknown>,
+        password: string
+    ) => Promise<void>
 
     ok: boolean
     statusText: string
@@ -30,13 +49,16 @@ export class NativeBookImporter {
         user: User,
         nativeBackend: NativeImporterBackend,
         bookBackend: BookImporterBackend,
-        path = "/"
+        options: string | NativeBookImporterOptions = "/"
     ) {
+        const opts = typeof options === "string" ? {path: options} : options
         this.file = file
         this.user = user
-        this.path = path.endsWith("/") ? path : path + "/"
+        this.path = opts.path?.endsWith("/") ? opts.path : `${opts.path || "/"}/`
         this.nativeBackend = nativeBackend
         this.bookBackend = bookBackend
+        this.getE2EEOptions = opts.getE2EEOptions
+        this.onChapterImported = opts.onChapterImported
 
         this.ok = false
         this.statusText = ""
@@ -68,8 +90,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
@@ -113,15 +135,18 @@ 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: "
@@ -144,13 +169,9 @@ 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,10 +198,7 @@ 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,21 +212,27 @@ export class NativeBookImporter {
             const safeBookTitle = (bookData.title as string) || "Untitled"
             const chapterPath = `${this.path}${safeBookTitle}/${(docJson.title as string) || "Untitled"}`
 
+            let e2eeResult: E2EEOptionsResult | null = null
+            if (this.getE2EEOptions) {
+                e2eeResult = await this.getE2EEOptions()
+            }
+
             const importer = new NativeImporter(
                 docJson,
                 bibJson,
-                { db: imagesJson },
+                {db: imagesJson},
                 chapterOtherFiles,
                 this.user,
                 this.nativeBackend,
                 {
-                    requestedPath: chapterPath
+                    requestedPath: chapterPath,
+                    e2eeOptions: e2eeResult?.options ?? null
                 }
             )
 
             let doc
             try {
-                ;({ doc } = await importer.init())
+                ;({doc} = await importer.init())
             } catch (error) {
                 addAlert(
                     "error",
@@ -220,6 +244,10 @@ export class NativeBookImporter {
             }
 
             importedDocIds[ci] = doc.id as number
+
+            if (e2eeResult && this.onChapterImported) {
+                await this.onChapterImported(doc, e2eeResult.password)
+            }
         }
 
         const chapters: Chapter[] = sortedChapters.map(chapter => ({
@@ -228,11 +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 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,18 +116,9 @@ 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> = {}
@@ -164,7 +155,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 {