@fiduswriter/document 0.1.0-alpha.4 → 0.1.0-alpha.5

package/src/exporter/latex/{index.js → index.ts}

@@ -2,19 +2,34 @@ import {BibLatexExporter} from "biblatex-csl-converter"
 import download from "downloadjs"
 
 import {shortFileTitle} from "fwtoolkit"
+import type {BibDB, ExportDoc, FidusNode, ImageDB} from "../../types.js"
 import {fixTables, removeHidden} from "../tools/doc_content.js"
 import {createSlug} from "../tools/file.js"
 import {ZipFileCreator} from "../tools/zip.js"
 import {LatexExporterConvert} from "./convert.js"
 import {readMe} from "./readme.js"
+
 /*
  Exporter to LaTeX
 */
 
 export class LatexExporter {
-    constructor(doc, bibDB, imageDB, updated) {
+    doc: ExportDoc
+    docTitle: string
+    bibDB: BibDB
+    imageDB: ImageDB
+    updated: any
+
+    docContent: any
+    zipFileName: string | false
+    textFiles: Array<{filename: string; contents: string}>
+    httpFiles: Array<{filename: string; url: string}>
+
+    conversion: any
+
+    constructor(doc: ExportDoc, bibDB: BibDB, imageDB: ImageDB, updated: any) {
         this.doc = doc
-        this.docTitle = shortFileTitle(this.doc.title, this.doc.path)
+        this.docTitle = shortFileTitle(this.doc.title, this.doc.path || "")
         this.bibDB = bibDB
         this.imageDB = imageDB
         this.updated = updated
@@ -25,16 +40,16 @@ export class LatexExporter {
         this.httpFiles = []
     }
 
-    init() {
+    init(): Promise<void> {
         this.zipFileName = `${createSlug(this.docTitle)}.latex.zip`
-        this.docContent = fixTables(removeHidden(this.doc.content))
-        this.converter = new LatexExporterConvert(
+        this.docContent = fixTables(removeHidden(this.doc.content) as FidusNode)
+        const converter = new LatexExporterConvert(
             this,
             this.imageDB,
             this.bibDB,
             this.doc.settings
         )
-        this.conversion = this.converter.init(this.docContent)
+        this.conversion = converter.init(this.docContent)
         if (Object.keys(this.conversion.usedBibDB).length > 0) {
             const bibExport = new BibLatexExporter(this.conversion.usedBibDB)
             this.textFiles.push({
@@ -47,16 +62,16 @@ export class LatexExporter {
             contents: this.conversion.latex
         })
         this.textFiles.push({filename: "README.txt", contents: readMe})
-        this.conversion.imageIds.forEach(id => {
+        this.conversion.imageIds.forEach((id: string) => {
             this.httpFiles.push({
-                filename: this.imageDB.db[id].image.split("/").pop(),
-                url: this.imageDB.db[id].image
+                filename: this.imageDB.db[id].image!.toString().split("/").pop()!,
+                url: this.imageDB.db[id].image as string
             })
         })
         return this.createZip()
     }
 
-    createZip() {
+    createZip(): Promise<void> {
         const zipper = new ZipFileCreator(
             this.textFiles,
             this.httpFiles,
@@ -68,7 +83,7 @@ export class LatexExporter {
         return zipper.init().then(blob => this.download(blob))
     }
 
-    download(blob) {
-        return download(blob, this.zipFileName, "application/zip")
+    download(blob: Blob): void {
+        return download(blob, this.zipFileName as string, "application/zip")
     }
 }

package/src/exporter/latex/{readme.js → readme.ts}

@@ -1,4 +1,4 @@
-export const readMe = `We strongly recommend using LuaTeX instead of PDFTeX or XeLaTeX for document
+export const readMe = `We strongly recommend using LuaTeX instead of PDFTeX or XeTeX for document
 compilation.
 
 In order to compile the LaTeX file, you need to use at least TeXLive 2016. If
@@ -18,5 +18,5 @@ If there are citations, continue with these commands:
 > biber document
 > lualatex document
 
-Look at the output messages to determine whether you need to run laluatex again.
+Look at the output messages to determine whether you need to run lualatex again.
 `

package/src/exporter/native/copy.ts

@@ -0,0 +1,231 @@
+import {gettext, longFilePath} from "fwtoolkit"
+
+import {ShrinkFidus} from "./shrink.js"
+
+import type {
+    BibDB,
+    E2EEOptions,
+    FidusNode,
+    ImageDB,
+    ImportDocument,
+    SaveCopyE2EE,
+    User
+} from "../../types.js"
+
+interface SaveCopyOptions {
+    importId?: string | number | null
+    e2eeOptions?: E2EEOptions | null
+    e2ee?: SaveCopyE2EE
+    importDocument: ImportDocument
+}
+
+export class SaveCopy {
+    doc: Record<string, unknown>
+    bibDB: BibDB
+    imageDB: ImageDB
+    newUser: User
+    importId: string | number | null
+    e2eeOptions: E2EEOptions | null
+    e2ee?: SaveCopyE2EE
+    importDocument: ImportDocument
+
+    constructor(
+        doc: Record<string, unknown>,
+        bibDB: BibDB,
+        imageDB: ImageDB,
+        newUser: User,
+        options: SaveCopyOptions
+    ) {
+        this.doc = doc
+        this.bibDB = bibDB
+        this.imageDB = imageDB
+        this.newUser = newUser
+        this.importId = options.importId ?? null
+        this.e2eeOptions = options.e2eeOptions ?? null
+        this.e2ee = options.e2ee
+        this.importDocument = options.importDocument
+    }
+
+    private _requestedPath(): string {
+        return longFilePath(
+            (this.doc.title as string) || "copy",
+            (this.doc.path as string) || "",
+            `${gettext("Copy of")} `
+        )
+    }
+
+    init(): Promise<{doc: Record<string, unknown>; docInfo: Record<string, unknown>}> {
+        let shrinkerPromise: Promise<{
+            doc: Record<string, unknown>
+            shrunkImageDB: Record<string, Record<string, unknown>>
+            shrunkBibDB: Record<string, Record<string, unknown>>
+            httpIncludes: Array<{url: string; filename: string}>
+        }>
+        if (this.doc.e2ee) {
+            shrinkerPromise = this._decryptDocument().then(decryptedDoc => {
+                const shrinker = new ShrinkFidus(
+                    decryptedDoc as any,
+                    this.imageDB,
+                    this.bibDB
+                )
+                return shrinker.init()
+            })
+        } else {
+            const shrinker = new ShrinkFidus(this.doc as any, this.imageDB, this.bibDB)
+            shrinkerPromise = shrinker.init()
+        }
+        return shrinkerPromise
+            .then(({doc, shrunkImageDB, shrunkBibDB, httpIncludes}) => {
+                let targetE2EEPromise: Promise<{
+                    doc: Record<string, unknown>
+                    e2eeOptions: E2EEOptions | null
+                }>
+                if (this.e2eeOptions?.targetE2EE) {
+                    targetE2EEPromise = this._setupTargetE2EE(doc, shrunkImageDB)
+                } else {
+                    targetE2EEPromise = Promise.resolve({
+                        doc,
+                        e2eeOptions: null
+                    })
+                }
+                return targetE2EEPromise.then(
+                    ({doc: encryptedDoc, e2eeOptions}) => {
+                        const importerE2EEOptions = e2eeOptions || {}
+                        if (this.e2eeOptions?.sourceKey) {
+                            ;(importerE2EEOptions as E2EEOptions).sourceKey =
+                                this.e2eeOptions.sourceKey
+                        }
+                        return this.importDocument(
+                            encryptedDoc,
+                            {db: shrunkBibDB as any},
+                            {db: shrunkImageDB as any},
+                            httpIncludes,
+                            {
+                                user: this.newUser,
+                                importId: this.importId,
+                                requestedPath: this._requestedPath(),
+                                e2eeOptions: importerE2EEOptions
+                            }
+                        )
+                    }
+                )
+            })
+    }
+
+    async _decryptDocument(): Promise<Record<string, unknown>> {
+        const key = this.e2eeOptions?.sourceKey
+        if (!key) {
+            throw new Error("Missing source E2EE key for decryption")
+        }
+        if (!this.e2ee) {
+            throw new Error("Missing E2EE helper")
+        }
+        const decryptedDoc = Object.assign({}, this.doc)
+        if (typeof decryptedDoc.content === "string") {
+            decryptedDoc.content = (await this.e2ee.decryptObject(
+                decryptedDoc.content,
+                key
+            )) as FidusNode
+        }
+        if (typeof decryptedDoc.comments === "string") {
+            decryptedDoc.comments = await this.e2ee.decryptObject(
+                decryptedDoc.comments,
+                key
+            )
+        }
+        if (typeof decryptedDoc.bibliography === "string") {
+            decryptedDoc.bibliography = await this.e2ee.decryptObject(
+                decryptedDoc.bibliography,
+                key
+            )
+        }
+        if (this.bibDB && typeof this.bibDB.db === "string") {
+            this.bibDB.db = decryptedDoc.bibliography as any
+        }
+        if (this.imageDB && this.imageDB.db) {
+            await Promise.all(
+                Object.values(this.imageDB.db).map(async imageEntry => {
+                    const copyright = imageEntry.copyright as
+                        | string
+                        | Record<string, unknown>
+                        | undefined
+                    if (
+                        typeof copyright === "string" &&
+                        copyright.length > 0
+                    ) {
+                        try {
+                            imageEntry.copyright =
+                                (await this.e2ee!.decryptObject(
+                                    copyright,
+                                    key
+                                )) as Record<string, any>
+                        } catch (_e) {
+                            // If decryption fails, leave as-is
+                        }
+                    }
+                })
+            )
+        }
+        return decryptedDoc
+    }
+
+    async _setupTargetE2EE(
+        doc: Record<string, unknown>,
+        shrunkImageDB: Record<string, Record<string, unknown>>
+    ): Promise<{doc: Record<string, unknown>; e2eeOptions: E2EEOptions}> {
+        const password = (this.e2eeOptions as E2EEOptions & {targetPassword?: string})
+            .targetPassword
+        if (!password) {
+            throw new Error("Missing target E2EE password")
+        }
+        if (!this.e2ee) {
+            throw new Error("Missing E2EE helper")
+        }
+        const salt = this.e2ee.generateSalt()
+        const saltBase64 = btoa(String.fromCharCode(...salt))
+        const iterations = 600000
+        const key = await this.e2ee.deriveKey(password, salt, iterations)
+
+        const plainDoc = Object.assign({}, doc)
+
+        if (shrunkImageDB) {
+            await Promise.all(
+                Object.values(shrunkImageDB).map(async imageEntry => {
+                    if (imageEntry.file) {
+                        try {
+                            const encryptedFile = await this.e2ee!.encryptImage(
+                                imageEntry.file as Blob,
+                                key
+                            )
+                            imageEntry.file = encryptedFile
+                            imageEntry.original_file_type = imageEntry.file_type
+                            imageEntry.file_type = "application/octet-stream"
+                        } catch (_e) {
+                            // If encryption fails, keep original file
+                        }
+                    }
+                    if (imageEntry.copyright) {
+                        try {
+                            imageEntry.copyright = await this.e2ee!.encryptObject(
+                                imageEntry.copyright,
+                                key
+                            )
+                        } catch (_e) {
+                            // If encryption fails, keep original
+                        }
+                    }
+                })
+            )
+        }
+
+        return {
+            doc: plainDoc,
+            e2eeOptions: {
+                enabled: true,
+                key,
+                salt: saltBase64,
+                iterations
+            }
+        }
+    }
+}

package/src/exporter/native/file.ts

@@ -0,0 +1,65 @@
+import download from "downloadjs"
+import {shortFileTitle} from "fwtoolkit"
+
+import {ShrinkFidus} from "./shrink.js"
+import {createSlug} from "../tools/file.js"
+import {ZipFidus} from "./zip.js"
+
+import type {BibDB, ExportDoc, ImageDB, TemplateFiles} from "../../types.js"
+
+export class ExportFidusFile {
+    doc: ExportDoc
+    bibDB: BibDB
+    imageDB: ImageDB
+    includeTemplate: boolean
+    token: string | boolean
+    getTemplateFiles?: (
+        docId: string | number,
+        token: string | boolean
+    ) => Promise<TemplateFiles>
+
+    constructor(
+        doc: ExportDoc,
+        bibDB: BibDB,
+        imageDB: ImageDB,
+        includeTemplate = true,
+        token: string | boolean = false,
+        getTemplateFiles?: (
+            docId: string | number,
+            token: string | boolean
+        ) => Promise<TemplateFiles>
+    ) {
+        this.doc = doc
+        this.bibDB = bibDB
+        this.imageDB = imageDB
+        this.includeTemplate = includeTemplate
+        this.token = token
+        this.getTemplateFiles = getTemplateFiles
+        return this.init() as unknown as ExportFidusFile
+    }
+
+    init(): Promise<Blob> {
+        const shrinker = new ShrinkFidus(this.doc as any, this.imageDB, this.bibDB)
+        return shrinker
+            .init()
+            .then(({doc, shrunkImageDB, shrunkBibDB, httpIncludes}) => {
+                const zipper = new ZipFidus(
+                    this.doc.id,
+                    doc,
+                    shrunkImageDB,
+                    shrunkBibDB,
+                    httpIncludes,
+                    this.includeTemplate,
+                    this.token,
+                    this.getTemplateFiles
+                )
+                return zipper.init()
+            })
+            .then(blob => {
+                const title: string = shortFileTitle(this.doc.title, this.doc.path || "") || "untitled"
+                const filename = `${createSlug(title)}.fidus`
+                download(blob, filename, "application/fidus+zip")
+                return blob
+            })
+    }
+}

package/src/exporter/native/index.ts

@@ -0,0 +1,4 @@
+export {ExportFidusFile} from "./file.js"
+export {SaveRevision} from "./revision.js"
+export {SaveCopy} from "./copy.js"
+export {ZipFidus} from "./zip.js"

package/src/exporter/native/revision.ts

@@ -0,0 +1,76 @@
+import {ShrinkFidus} from "./shrink.js"
+import {ZipFidus} from "./zip.js"
+
+import type {
+    BibDB,
+    ExportDoc,
+    ImageDB,
+    TemplateFiles,
+    UploadRevision
+} from "../../types.js"
+
+export class SaveRevision {
+    doc: ExportDoc
+    imageDB: ImageDB
+    bibDB: BibDB
+    note: string
+    uploadRevision: UploadRevision
+    token: string | boolean
+    getTemplateFiles?: (
+        docId: string | number,
+        token: string | boolean
+    ) => Promise<TemplateFiles>
+    onError?: (error: unknown) => void
+
+    constructor(
+        doc: ExportDoc,
+        imageDB: ImageDB,
+        bibDB: BibDB,
+        note: string,
+        uploadRevision: UploadRevision,
+        options: {
+            token?: string | boolean
+            getTemplateFiles?: (
+                docId: string | number,
+                token: string | boolean
+            ) => Promise<TemplateFiles>
+            onError?: (error: unknown) => void
+        } = {}
+    ) {
+        this.doc = doc
+        this.imageDB = imageDB
+        this.bibDB = bibDB
+        this.note = note
+        this.uploadRevision = uploadRevision
+        this.token = options.token ?? false
+        this.getTemplateFiles = options.getTemplateFiles
+        this.onError = options.onError
+    }
+
+    init(): Promise<unknown> {
+        const shrinker = new ShrinkFidus(this.doc as any, this.imageDB, this.bibDB)
+
+        return shrinker
+            .init()
+            .then(({doc, shrunkImageDB, shrunkBibDB, httpIncludes}) => {
+                const zipper = new ZipFidus(
+                    this.doc.id,
+                    doc,
+                    shrunkImageDB,
+                    shrunkBibDB,
+                    httpIncludes,
+                    true,
+                    this.token,
+                    this.getTemplateFiles
+                )
+                return zipper.init()
+            })
+            .then(blob => this.uploadRevision(blob, this.doc as any))
+            .catch(error => {
+                if (this.onError) {
+                    this.onError(error)
+                }
+                throw error
+            })
+    }
+}

package/src/exporter/native/{shrink.js → shrink.ts}

@@ -1,18 +1,40 @@
-import {addAlert} from "fwtoolkit"
+import {addAlert, gettext} from "fwtoolkit"
+
 import {docSchema} from "../../schema/document/index.js"
 import {toMiniJSON} from "../../schema/mini_json.js"
+import type {BibDB, FidusNode, ImageDB} from "../../types.js"
+
+interface ShrinkDoc {
+    content: FidusNode
+    [key: string]: unknown
+}
+
+interface ShrinkResult {
+    doc: Record<string, unknown>
+    shrunkImageDB: Record<string, Record<string, unknown>>
+    shrunkBibDB: Record<string, Record<string, unknown>>
+    httpIncludes: Array<{url: string; filename: string}>
+}
+
 // Generate a copy of the fidus doc, imageDB and bibDB with all clutter removed.
 export class ShrinkFidus {
+    doc: ShrinkDoc
+    imageDB: ImageDB
+    bibDB: BibDB
+    silent: boolean
+    imageList: (number | string)[]
+    citeList: (number | string)[]
+
     /**
-     * @param {Object}  doc      - Full document object.
-     * @param {Object}  imageDB  - Image database, e.g. {db: {...}}.
-     * @param {Object}  bibDB    - Bibliography database, e.g. {db: {...}}.
-     * @param {boolean} [silent=false] - When true, suppresses the
+     * @param doc      - Full document object.
+     * @param imageDB  - Image database wrapper, e.g. {db: {...}}.
+     * @param bibDB    - Bibliography database wrapper, e.g. {db: {...}}.
+     * @param silent   - When true, suppresses the
      *   "File export has been initiated" info alert.  Pass true when
      *   shrinking multiple documents in a loop (e.g. one per book chapter)
      *   and the caller already shows its own progress notification.
      */
-    constructor(doc, imageDB, bibDB, silent = false) {
+    constructor(doc: ShrinkDoc, imageDB: ImageDB, bibDB: BibDB, silent = false) {
         this.doc = doc
         this.imageDB = imageDB
         this.bibDB = bibDB
@@ -21,9 +43,9 @@ export class ShrinkFidus {
         this.citeList = []
     }
 
-    init() {
-        const shrunkImageDB = {},
-            httpIncludes = []
+    init(): Promise<ShrinkResult> {
+        const shrunkImageDB: Record<string, Record<string, unknown>> = {},
+            httpIncludes: Array<{url: string; filename: string}> = []
 
         if (!this.silent) {
             addAlert("info", gettext("File export has been initiated."))
@@ -34,22 +56,27 @@ export class ShrinkFidus {
         this.imageList = [...new Set(this.imageList)] // unique values
 
         this.imageList.forEach(itemId => {
-            shrunkImageDB[itemId] = Object.assign({}, this.imageDB.db[itemId])
+            const key = String(itemId)
+            shrunkImageDB[key] = Object.assign(
+                {},
+                this.imageDB.db[key]
+            ) as Record<string, unknown>
             // Remove parts that are connected to a particular user/server
-            delete shrunkImageDB[itemId].cats
-            delete shrunkImageDB[itemId].thumbnail
-            delete shrunkImageDB[itemId].pk
-            delete shrunkImageDB[itemId].added
-            const imageUrl = shrunkImageDB[itemId].image
-            let filename
+            delete shrunkImageDB[key].cats
+            delete shrunkImageDB[key].thumbnail
+            delete shrunkImageDB[key].pk
+            delete shrunkImageDB[key].added
+            const imageUrl = shrunkImageDB[key].image as string
+            let filename: string
             if (imageUrl.startsWith("blob:")) {
                 // Blob URL produced by decrypting an E2EE image client-side.
                 // The URL itself carries no useful file extension, so derive
                 // one from the image entry's MIME type instead.  Without this
                 // the server rejects the upload because get_encrypted_file_path
                 // requires a recognised extension.
-                const mime = shrunkImageDB[itemId].file_type || "image/png"
-                const mimeExtMap = {
+                const mime =
+                    (shrunkImageDB[key].file_type as string) || "image/png"
+                const mimeExtMap: Record<string, string> = {
                     "image/png": "png",
                     "image/jpeg": "jpg",
                     "image/jpg": "jpg",
@@ -59,11 +86,11 @@ export class ShrinkFidus {
                     "image/avif": "avif"
                 }
                 const ext = mimeExtMap[mime] || "png"
-                filename = `images/${itemId}.${ext}`
+                filename = `images/${key}.${ext}`
             } else {
                 filename = `images/${imageUrl.split("/").pop()}`
             }
-            shrunkImageDB[itemId].image = filename
+            shrunkImageDB[key].image = filename
             httpIncludes.push({
                 url: imageUrl,
                 filename
@@ -72,12 +99,16 @@ export class ShrinkFidus {
 
         this.citeList = [...new Set(this.citeList)] // unique values
 
-        const shrunkBibDB = {}
+        const shrunkBibDB: Record<string, Record<string, unknown>> = {}
         this.citeList.forEach(itemId => {
-            shrunkBibDB[itemId] = Object.assign({}, this.bibDB.db[itemId])
+            const key = String(itemId)
+            shrunkBibDB[key] = Object.assign(
+                {},
+                this.bibDB.db[key]
+            ) as Record<string, unknown>
             // Remove the cats, as it is only a list of IDs for one
             // particular user/server.
-            delete shrunkBibDB[itemId].cats
+            delete shrunkBibDB[key].cats
         })
 
         const docCopy = Object.assign({}, this.doc)
@@ -93,7 +124,9 @@ export class ShrinkFidus {
         delete docCopy.updated
         delete docCopy.revisions
 
-        docCopy.content = toMiniJSON(docSchema.nodeFromJSON(docCopy.content))
+        docCopy.content = toMiniJSON(
+            docSchema.nodeFromJSON(docCopy.content as unknown as Record<string, unknown>)
+        ) as unknown as FidusNode
 
         return new Promise(resolve =>
             resolve({
@@ -105,21 +138,23 @@ export class ShrinkFidus {
         )
     }
 
-    walkTree(node) {
+    walkTree(node: FidusNode): void {
         switch (node.type) {
             case "citation":
                 this.citeList = this.citeList.concat(
-                    node.attrs.references.map(ref => ref.id)
+                    (node.attrs?.references as Array<{id: number | string}>).map(
+                        ref => ref.id
+                    )
                 )
                 break
             case "image":
-                if (node.attrs.image !== false) {
-                    this.imageList.push(node.attrs.image)
+                if (node.attrs && node.attrs.image !== false) {
+                    this.imageList.push(node.attrs.image as number | string)
                 }
                 break
             case "footnote":
                 if (node.attrs?.footnote) {
-                    node.attrs.footnote.forEach(childNode =>
+                    ;(node.attrs.footnote as FidusNode[]).forEach(childNode =>
                         this.walkTree(childNode)
                     )
                 }