@fiduswriter/books-document 0.1.1

package/package.json

@@ -0,0 +1,101 @@
+{
+  "name": "@fiduswriter/books-document",
+  "version": "0.1.1",
+  "description": "Fidus Writer book importers and exporters",
+  "repository": {
+    "type": "git",
+    "url": "ssh://git@codeberg.org/fiduswriter/fiduswriter-books-document.git"
+  },
+  "license": "AGPL-3.0",
+  "author": "Johannes Wilm",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./schema": {
+      "types": "./dist/schema/index.d.ts",
+      "default": "./dist/schema/index.js"
+    },
+    "./importer/native": {
+      "types": "./dist/importer/native/index.d.ts",
+      "default": "./dist/importer/native/index.js"
+    },
+    "./exporter/native": {
+      "types": "./dist/exporter/native/index.d.ts",
+      "default": "./dist/exporter/native/index.js"
+    },
+    "./exporter/html": {
+      "types": "./dist/exporter/html/index.d.ts",
+      "default": "./dist/exporter/html/index.js"
+    },
+    "./exporter/epub": {
+      "types": "./dist/exporter/epub/index.d.ts",
+      "default": "./dist/exporter/epub/index.js"
+    },
+    "./exporter/latex": {
+      "types": "./dist/exporter/latex/index.d.ts",
+      "default": "./dist/exporter/latex/index.js"
+    },
+    "./exporter/docx": {
+      "types": "./dist/exporter/docx/index.d.ts",
+      "default": "./dist/exporter/docx/index.js"
+    },
+    "./exporter/odt": {
+      "types": "./dist/exporter/odt/index.d.ts",
+      "default": "./dist/exporter/odt/index.js"
+    },
+    "./exporter/print": {
+      "types": "./dist/exporter/print/index.d.ts",
+      "default": "./dist/exporter/print/index.js"
+    },
+    "./exporter/bits": {
+      "types": "./dist/exporter/bits/index.d.ts",
+      "default": "./dist/exporter/bits/index.js"
+    },
+    "./exporter/tools": {
+      "types": "./dist/exporter/tools.d.ts",
+      "default": "./dist/exporter/tools.js"
+    },
+    "./i18n": {
+      "types": "./dist/i18n.d.ts",
+      "default": "./dist/i18n.js"
+    }
+  },
+  "directories": {
+    "test": "test"
+  },
+  "files": [
+    "dist/",
+    "src/",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "prepare": "npm run build",
+    "prepublishOnly": "npm run build",
+    "typecheck": "tsc --noEmit",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --config jest.config.js"
+  },
+  "dependencies": {
+    "@fiduswriter/document": "^0.2.0",
+    "@vivliostyle/print": "^2.42.0",
+    "biblatex-csl-converter": "^3.0.0",
+    "downloadjs": "^1.4.7",
+    "fast-deep-equal": "^3.1.3",
+    "fwtoolkit": "^0.1.3",
+    "jszip": "^3.10.1",
+    "pretty": "^2.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^26.0.1",
+    "jest": "^30.4.2",
+    "ts-jest": "^29.1.2",
+    "ts-jest-resolver": "^2.0.1",
+    "typescript": "^6.0.3"
+  }
+}

package/src/exporter/bits/index.ts

@@ -0,0 +1,163 @@
+/**
+ * BITS (Book Interchange Tag Suite) book exporter.
+ */
+
+import type {Schema} from "prosemirror-model"
+import pretty from "pretty"
+import {JATSExporterConverter} from "@fiduswriter/document/exporter/jats/convert"
+import {darManifest} from "@fiduswriter/document/exporter/jats/templates"
+import {createSlug} from "@fiduswriter/document/exporter/tools/file"
+import {ZipFileCreator} from "@fiduswriter/document/exporter/tools/zip"
+import {addAlert} from "fwtoolkit"
+
+import type {Book, CSL, DocumentListEntry, User} from "../../types.js"
+import {getMissingChapterData} from "../tools.js"
+import {bitsTemplate} from "./templates.js"
+
+interface TextFile {
+    filename: string
+    contents: string
+}
+
+interface HttpFile {
+    filename: string
+    url: string
+    title?: string
+}
+
+export class BITSBookExporter {
+    schema: Schema
+    csl: CSL
+    book: Book
+    user: User
+    docList: DocumentListEntry[]
+    updated: any
+    type: string
+    textFiles: TextFile[]
+    httpFiles: HttpFile[]
+    zipFileName: string
+
+    constructor(
+        schema: Schema,
+        csl: CSL,
+        book: Book,
+        user: User,
+        docList: DocumentListEntry[],
+        updated: any
+    ) {
+        this.schema = schema
+        this.csl = csl
+        this.book = book
+        this.user = user
+        this.docList = docList
+        this.updated = updated
+        this.type = "book"
+        this.textFiles = []
+        this.httpFiles = []
+        this.zipFileName = ""
+    }
+
+    init(): Promise<Blob> | false {
+        if (this.book.chapters.length === 0) {
+            addAlert(
+                "error",
+                gettext("Book cannot be exported due to lack of chapters.")
+            )
+            return false
+        }
+        return getMissingChapterData(this.book, this.docList, this.schema).then(
+            () => this.export()
+        )
+    }
+
+    export(): Promise<Blob> {
+        this.book.chapters.sort((a, b) => (a.number > b.number ? 1 : -1))
+
+        const imageDict: Record<string, {image: string; title?: string}> = {}
+        return Promise.all(
+            this.book.chapters.map(chapter => {
+                const doc = this.docList.find(d => d.id === chapter.text)
+                if (!doc) {
+                    return Promise.resolve({front: "", body: "", back: ""})
+                }
+                const converter = new JATSExporterConverter(
+                    this.type,
+                    doc,
+                    this.csl,
+                    {db: doc.images || {}},
+                    {db: doc.bibliography || {}}
+                )
+                return converter.init().then(({front, body, back, imageIds}) => {
+                    imageIds.forEach(
+                        (imageId: string | number) =>
+                            (imageDict[imageId] = doc.images?.[imageId] as {
+                                image: string
+                                title?: string
+                            })
+                    )
+                    return {front, body, back}
+                })
+            })
+        ).then(chapters => this.createFiles(chapters, imageDict))
+    }
+
+    createFiles(
+        chapters: Array<{front: string; body: string; back: string}>,
+        imageDict: Record<string, {image: string; title?: string}>
+    ): Promise<Blob> {
+        const images = Object.values(imageDict).map(image => ({
+            filename: image.image.split("/").pop()?.split("?")[0] || "",
+            url: image.image.split("?")[0],
+            title: image.title || ""
+        }))
+
+        this.zipFileName = `${createSlug(this.book.title)}.bits.zip`
+
+        this.textFiles = [
+            {
+                filename: "manuscript.xml",
+                contents: pretty(bitsTemplate(this.book, chapters), {ocd: true})
+            },
+            {
+                filename: "manifest.xml",
+                contents: pretty(
+                    darManifest({
+                        title: this.book.title,
+                        type: this.type,
+                        images
+                    }),
+                    {ocd: true}
+                )
+            }
+        ]
+
+        images.forEach(image => {
+            this.httpFiles.push({
+                filename: image.filename,
+                url: image.url,
+                title: image.title
+            })
+        })
+
+        return this.createZip()
+    }
+
+    createZip(): Promise<Blob> {
+        const zipper = new ZipFileCreator(
+            this.textFiles,
+            this.httpFiles,
+            undefined,
+            undefined,
+            this.updated
+        )
+        return zipper.init().then(blob => this.download(blob))
+    }
+
+    download(blob: Blob): Blob {
+        return blob
+    }
+
+    get defaultFilename(): string {
+        return this.zipFileName
+    }
+}

package/src/exporter/bits/templates.ts

@@ -0,0 +1,107 @@
+import {escapeText} from "fwtoolkit"
+
+import type {Book, BitsTemplateParams} from "../../types.js"
+
+const bookPartTemplate = ({front, body, back}: BitsTemplateParams) =>
+    `<book-part book-part-type="chapter" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ali="http://www.niso.org/schemas/ali/1.0/" xmlns:mml="http://www.w3.org/1998/Math/MathML">${front}${body}${back}</book-part>`
+
+export const bitsTemplate = (
+    book: Book,
+    chapters: Array<{front: string; body: string; back: string}>
+) => {
+    const updated = new Date((book.updated || 0) * 1000)
+    return `<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE book PUBLIC "-//NLM//DTD BITS Book Interchange DTD v2.1 20220202//EN" "https://jats.nlm.nih.gov/extensions/bits/2.1/BITS-book2-1.dtd">
+<book dtd-version="2.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:ali="http://www.niso.org/schemas/ali/1.0/">
+    <processing-meta tagset-family="bits" table-model="xhtml" math-representation="tex mathml"></processing-meta>
+    <book-meta>
+        <book-title-group>
+            <book-title>${escapeText(book.title)}</book-title>
+            ${book.metadata.subtitle?.length ? `<subtitle>${escapeText(book.metadata.subtitle)}</subtitle>` : ""}
+        </book-title-group>
+        ${
+            book.metadata.version?.length
+                ? `<content-version>${escapeText(book.metadata.version)}</content-version>`
+                : ""
+        }
+        <content-language>${book.settings.language.split("-")[0]}</content-language>
+        ${
+            book.metadata.description?.length
+                ? `<abstract>
+    <p>${escapeText(book.metadata.description)}</p>
+</abstract>`
+                : ""
+        }
+        ${
+            book.metadata.author?.length
+                ? `<contrib-group>
+            <contrib contrib-type="author">
+                <name>
+                    <surname>${escapeText(book.metadata.author.split(" ").slice(1).join(" "))}</surname>
+                    <given-names>${escapeText(book.metadata.author.split(" ").pop() || "")}</given-names>
+                </name>
+            </contrib>
+            </contrib-group>`
+                : ""
+        }
+        <pub-date>
+            <year>${updated.getFullYear()}</year>
+            <month>${updated.getMonth() + 1}</month>
+            <day>${updated.getDate()}</day>
+        </pub-date>
+        ${
+            book.metadata.publication_date?.length
+                ? `<pub-date date-type="pub" publication-format="electronic">
+    <string-date>${escapeText(book.metadata.publication_date)}</string-date>
+</pub-date>`
+                : ""
+        }
+        ${
+            book.metadata.isbn?.length
+                ? `<isbn>${escapeText(book.metadata.isbn)}</isbn>`
+                : ""
+        }
+        ${
+            book.metadata.publisher?.length
+                ? `<publisher>
+                <publisher-name>${escapeText(book.metadata.publisher)}</publisher-name>
+            </publisher>`
+                : ""
+        }
+        ${
+            book.metadata.series_title?.length
+                ? `<series>
+    <series-title>${escapeText(book.metadata.series_title)}</series-title>
+    ${
+        book.metadata.series_position?.length
+            ? `<series-text>${escapeText(book.metadata.series_position)}</series-text>`
+            : ""
+    }
+</series>`
+                : ""
+        }
+        ${
+            book.metadata.copyright?.length
+                ? `<permissions>
+                <copyright-holder>
+                <name>${escapeText(book.metadata.copyright)}</name>
+                </copyright-holder>
+            </permissions>`
+                : ""
+        }
+        ${
+            book.metadata.keywords?.length
+                ? `<kwd-group>${book.metadata.keywords
+                      .split(",")
+                      .map(
+                          keyword => `<kwd>${escapeText(keyword.trim())}</kwd>`
+                      )
+                      .join("")}</kwd-group>`
+                : ""
+        }
+    </book-meta>
+    <book-body>
+        ${chapters.map(chapter => bookPartTemplate(chapter)).join("\n")}
+    </book-body>
+</book>`
+}

package/src/exporter/docx/index.ts

@@ -0,0 +1,239 @@
+/**
+ * DOCX book exporter.
+ */
+
+import type {Schema} from "prosemirror-model"
+import type {CSL, User} from "@fiduswriter/document"
+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 {DOCXExporterCitations} from "@fiduswriter/document/exporter/docx/citations"
+import {DOCXExporterComments} from "@fiduswriter/document/exporter/docx/comments"
+import {DOCXExporterFootnotes} from "@fiduswriter/document/exporter/docx/footnotes"
+import {DOCXExporterImages} from "@fiduswriter/document/exporter/docx/images"
+import {DOCXExporterLists} from "@fiduswriter/document/exporter/docx/lists"
+import {DOCXExporterMath} from "@fiduswriter/document/exporter/docx/math"
+import {DOCXExporterMetadata} from "@fiduswriter/document/exporter/docx/metadata"
+import {DOCXExporterRels} from "@fiduswriter/document/exporter/docx/rels"
+import {DOCXExporterRichtext} from "@fiduswriter/document/exporter/docx/richtext"
+import {DOCXExporterTables} from "@fiduswriter/document/exporter/docx/tables"
+import {moveFootnoteComments} from "@fiduswriter/document/exporter/docx/tools"
+
+import type {Book, DocumentListEntry} from "../../types.js"
+import {getMissingChapterData} from "../tools.js"
+import {DOCXBookExporterRender} from "./render.js"
+
+export class DOCXBookExporter {
+    schema: Schema
+    csl: CSL
+    book: Book
+    user: User
+    docList: DocumentListEntry[]
+    templateUrl: string
+    updated: any
+    textFiles: Array<Record<string, unknown>>
+    httpFiles: Array<Record<string, unknown>>
+    mimeType: string
+
+    constructor(
+        schema: Schema,
+        csl: CSL,
+        book: Book,
+        user: User,
+        docList: DocumentListEntry[],
+        updated: any
+    ) {
+        this.schema = schema
+        this.csl = csl
+        this.book = book
+        this.user = user
+        this.docList = docList
+        this.templateUrl = book.docx_template || ""
+        this.updated = updated
+        this.textFiles = []
+        this.httpFiles = []
+
+        this.mimeType =
+            "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
+    }
+
+    init(): Promise<Blob> | false {
+        if (this.book.chapters.length === 0) {
+            addAlert(
+                "error",
+                gettext("Book cannot be exported due to lack of chapters.")
+            )
+            return false
+        }
+        return getMissingChapterData(
+            this.book,
+            this.docList,
+            this.schema,
+            {rawContent: true}
+        ).then(() => this.export())
+    }
+
+    export(): Promise<Blob> {
+        this.book.chapters.sort((a, b) => (a.number > b.number ? 1 : -1))
+        const xml = new XmlZip(this.templateUrl, this.mimeType)
+
+        const tables = new DOCXExporterTables(xml as any)
+        const math = new DOCXExporterMath(xml as any)
+        const render = new DOCXBookExporterRender(xml as any)
+        const rels = new DOCXExporterRels(xml as any, "document")
+        const metadata = new DOCXExporterMetadata(
+            xml as any,
+            this.getBaseMetadata() as any
+        )
+
+        return xml
+            .init()
+            .then(() => metadata.init())
+            .then(() => tables.init())
+            .then(() => math.init())
+            .then(() => render.init())
+            .then(() => rels.init())
+            .then(() => this.exportChapters(xml as any, render, rels, math, tables))
+            .then(() => xml.prepareBlob())
+            .then(blob => this.download(blob))
+    }
+
+    exportChapters(
+        xml: any,
+        render: DOCXBookExporterRender,
+        rels: any,
+        math: any,
+        tables: any
+    ): Promise<void> {
+        return this.book.chapters
+            .map((chapter, chapterIndex) => {
+                return (): Promise<void> => {
+                    const doc = this.docList.find(d => d.id === chapter.text)
+                    if (!doc) {
+                        return Promise.resolve()
+                    }
+                    const docContent = moveFootnoteComments(
+                        fixTables(
+                            removeHidden(doc.rawContent as any) as any
+                        ) as any
+                    ) as any
+
+                    const images = new DOCXExporterImages(
+                        docContent as any,
+                        {db: doc.images || {}},
+                        xml,
+                        rels
+                    )
+                    const lists = new DOCXExporterLists(docContent, xml, rels)
+                    const citations = new DOCXExporterCitations(
+                        docContent,
+                        doc.settings,
+                        {db: doc.bibliography || {}},
+                        this.csl,
+                        xml
+                    )
+
+                    const footnotes = new DOCXExporterFootnotes(
+                        doc as any,
+                        docContent,
+                        doc.settings,
+                        {db: doc.images || {}},
+                        {db: doc.bibliography || {}},
+                        xml,
+                        citations,
+                        this.csl,
+                        lists,
+                        math,
+                        tables,
+                        rels
+                    )
+
+                    const richtext = new DOCXExporterRichtext(
+                        doc as any,
+                        doc.settings,
+                        lists,
+                        footnotes,
+                        math,
+                        tables,
+                        rels,
+                        citations,
+                        images
+                    )
+
+                    const comments = new DOCXExporterComments(
+                        docContent,
+                        doc.comments || {},
+                        xml,
+                        rels,
+                        richtext
+                    )
+
+                    return citations
+                        .init()
+                        .then(() => images.init())
+                        .then(() => comments.init())
+                        .then(() => lists.init())
+                        .then(() => footnotes.init())
+                        .then(() => {
+                            const pmBib = footnotes.pmBib || citations.pmBib
+                            render.render(
+                                docContent as any,
+                                pmBib,
+                                doc.settings,
+                                richtext,
+                                citations,
+                                chapterIndex
+                            )
+                            return Promise.resolve()
+                        })
+                }
+            })
+            .reduce(
+                (promiseChain, currentChapter) =>
+                    promiseChain.then(() => currentChapter()),
+                Promise.resolve()
+            )
+            .then(() =>
+                render.renderAmbles(
+                    Object.assign(
+                        {
+                            title: this.book.title,
+                            language: this.book.settings.language
+                        },
+                        this.book.metadata
+                    )
+                )
+            )
+            .then(() => render.assemble())
+    }
+
+    getBaseMetadata(): Record<string, unknown> {
+        const authors = this.book.metadata.author?.length
+            ? [{institution: this.book.metadata.author}]
+            : []
+        const keywords = this.book.metadata.keywords?.length
+            ? this.book.metadata.keywords
+                  .split(",")
+                  .map(keyword => keyword.trim())
+            : []
+        return {
+            authors,
+            keywords,
+            title: this.book.title,
+            language: this.book.settings.language
+        }
+    }
+
+    download(blob: Blob): Blob {
+        return blob
+    }
+
+    get defaultFilename(): string {
+        return `${createSlug(this.book.title)}.docx`
+    }
+}