@fiduswriter/books-document 0.1.2 → 0.1.4

package/src/exporter/bits/index.ts

@@ -2,17 +2,17 @@
  * BITS (Book Interchange Tag Suite) book exporter.
  */
 
-import type { Schema } from "prosemirror-model"
+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, gettext } from "fwtoolkit"
+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"
+import type {Book, CSL, DocumentListEntry, User} from "../../types.js"
+import {getMissingChapterData} from "../tools.js"
+import {bitsTemplate} from "./templates.js"
 
 interface TextFile {
     filename: string
@@ -73,39 +73,37 @@ export class BITSBookExporter {
     export(): Promise<Blob> {
         this.book.chapters.sort((a, b) => (a.number > b.number ? 1 : -1))
 
-        const imageDict: Record<string, { image: string; title?: string }> = {}
+        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: "" })
+                    return Promise.resolve({front: "", body: "", back: ""})
                 }
                 const converter = new JATSExporterConverter(
                     this.type,
                     doc,
                     this.csl,
-                    { db: doc.images || {} },
-                    { db: doc.bibliography || {} }
+                    {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 }
-                    })
+                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 }>
+        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] || "",
@@ -118,9 +116,7 @@ export class BITSBookExporter {
         this.textFiles = [
             {
                 filename: "manuscript.xml",
-                contents: pretty(bitsTemplate(this.book, chapters), {
-                    ocd: true
-                })
+                contents: pretty(bitsTemplate(this.book, chapters), {ocd: true})
             },
             {
                 filename: "manifest.xml",
@@ -130,7 +126,7 @@ export class BITSBookExporter {
                         type: this.type,
                         images
                     }),
-                    { ocd: true }
+                    {ocd: true}
                 )
             }
         ]

package/src/exporter/bits/templates.ts

@@ -1,13 +1,13 @@
-import { escapeText } from "fwtoolkit"
+import {escapeText} from "fwtoolkit"
 
-import type { Book, BitsTemplateParams } from "../../types.js"
+import type {Book, BitsTemplateParams} from "../../types.js"
 
-const bookPartTemplate = ({ front, body, back }: BitsTemplateParams) =>
+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 }>
+    chapters: Array<{front: string; body: string; back: string}>
 ) => {
     const updated = new Date((book.updated || 0) * 1000)
     return `<?xml version="1.0" encoding="UTF-8"?>

package/src/exporter/docx/index.ts

@@ -2,31 +2,31 @@
  * DOCX book exporter.
  */
 
-import type { Schema } from "prosemirror-model"
-import type { CSL, User } from "@fiduswriter/document"
+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, gettext } 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"
+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
@@ -70,9 +70,12 @@ export class DOCXBookExporter {
             )
             return false
         }
-        return getMissingChapterData(this.book, this.docList, this.schema, {
-            rawContent: true
-        }).then(() => this.export())
+        return getMissingChapterData(
+            this.book,
+            this.docList,
+            this.schema,
+            {rawContent: true}
+        ).then(() => this.export())
     }
 
     export(): Promise<Blob> {
@@ -95,9 +98,7 @@ export class DOCXBookExporter {
             .then(() => math.init())
             .then(() => render.init())
             .then(() => rels.init())
-            .then(() =>
-                this.exportChapters(xml as any, render, rels, math, tables)
-            )
+            .then(() => this.exportChapters(xml as any, render, rels, math, tables))
             .then(() => xml.prepareBlob())
             .then(blob => this.download(blob))
     }
@@ -124,7 +125,7 @@ export class DOCXBookExporter {
 
                     const images = new DOCXExporterImages(
                         docContent as any,
-                        { db: doc.images || {} },
+                        {db: doc.images || {}},
                         xml,
                         rels
                     )
@@ -132,7 +133,7 @@ export class DOCXBookExporter {
                     const citations = new DOCXExporterCitations(
                         docContent,
                         doc.settings,
-                        { db: doc.bibliography || {} },
+                        {db: doc.bibliography || {}},
                         this.csl,
                         xml
                     )
@@ -141,8 +142,8 @@ export class DOCXBookExporter {
                         doc as any,
                         docContent,
                         doc.settings,
-                        { db: doc.images || {} },
-                        { db: doc.bibliography || {} },
+                        {db: doc.images || {}},
+                        {db: doc.bibliography || {}},
                         xml,
                         citations,
                         this.csl,
@@ -213,7 +214,7 @@ export class DOCXBookExporter {
 
     getBaseMetadata(): Record<string, unknown> {
         const authors = this.book.metadata.author?.length
-            ? [{ institution: this.book.metadata.author }]
+            ? [{institution: this.book.metadata.author}]
             : []
         const keywords = this.book.metadata.keywords?.length
             ? this.book.metadata.keywords

package/src/exporter/docx/render.ts

@@ -1,4 +1,4 @@
-import { DOCXExporterRender } from "@fiduswriter/document/exporter/docx/render"
+import {DOCXExporterRender} from "@fiduswriter/document/exporter/docx/render"
 
 export class DOCXBookExporterRender extends DOCXExporterRender {
     preamble: any
@@ -47,8 +47,7 @@ export class DOCXBookExporterRender extends DOCXExporterRender {
     }
 
     render(...args: any[]): void {
-        const [docContent, pmBib, settings, richtext, citations, chapterIndex] =
-            args
+        const [docContent, pmBib, settings, richtext, citations, chapterIndex] = args
         this.text = this.bodyTemplate.cloneNode(true)
         const bodyBookmark = (this.text as any).query("w:bookmarkStart", {
             "w:name": "body"
@@ -76,19 +75,19 @@ export class DOCXBookExporterRender extends DOCXExporterRender {
         series_position
     }: Record<string, unknown>): void {
         const tags = [
-            { title: "book.title", content: title },
-            { title: "book.subtitle", content: subtitle },
-            { title: "book.version", content: version },
-            { title: "book.publisher", content: publisher },
-            { title: "book.copyright", content: copyright },
-            { title: "book.author", content: author },
-            { title: "book.keywords", content: keywords },
-            { title: "book.language", content: language },
-            { title: "book.description", content: description },
-            { title: "book.isbn", content: isbn },
-            { title: "book.publication_date", content: publication_date },
-            { title: "book.series_title", content: series_title },
-            { title: "book.series_position", content: series_position }
+            {title: "book.title", content: title},
+            {title: "book.subtitle", content: subtitle},
+            {title: "book.version", content: version},
+            {title: "book.publisher", content: publisher},
+            {title: "book.copyright", content: copyright},
+            {title: "book.author", content: author},
+            {title: "book.keywords", content: keywords},
+            {title: "book.language", content: language},
+            {title: "book.description", content: description},
+            {title: "book.isbn", content: isbn},
+            {title: "book.publication_date", content: publication_date},
+            {title: "book.series_title", content: series_title},
+            {title: "book.series_position", content: series_position}
         ]
         const usedTags: any[] = []
         const ambles = [this.preamble, this.postamble]
@@ -99,7 +98,7 @@ export class DOCXBookExporterRender extends DOCXExporterRender {
                 tags.forEach(tag => {
                     const tagString = tag.title
                     if (text.includes(`{${tagString}}`)) {
-                        usedTags.push(Object.assign({ block }, tag))
+                        usedTags.push(Object.assign({block}, tag))
                     }
                 })
             })

package/src/exporter/epub/index.ts

@@ -2,23 +2,17 @@
  * EPUB book exporter.
  */
 
-import type { Schema } from "prosemirror-model"
-import { HTMLExporterConvert } from "@fiduswriter/document/exporter/html/convert"
-import { htmlExportTemplate } from "@fiduswriter/document/exporter/html/templates"
-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 { addAlert, get, gettext, staticUrl } from "fwtoolkit"
+import type {Schema} from "prosemirror-model"
+import {HTMLExporterConvert} from "@fiduswriter/document/exporter/html/convert"
+import {htmlExportTemplate} from "@fiduswriter/document/exporter/html/templates"
+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 {addAlert, get, staticUrl} from "fwtoolkit"
 import pretty from "pretty"
 
-import type {
-    Book,
-    BookStyles,
-    CSL,
-    DocumentListEntry,
-    User
-} from "../../types.js"
-import { getMissingChapterData } from "../tools.js"
+import type {Book, BookStyles, CSL, DocumentListEntry, User} from "../../types.js"
+import {getMissingChapterData} from "../tools.js"
 import {
     containerTemplate,
     epubBookCopyrightTemplate,
@@ -110,7 +104,7 @@ export class EpubBookExporter {
         this.images = []
         this.fontFiles = []
         this.httpFiles = []
-        this.styleSheets = [{ url: staticUrl("css/book.css") }]
+        this.styleSheets = [{url: staticUrl("css/book.css")}]
         this.chapters = []
         this.contentItems = []
         this.includeZips = []
@@ -148,10 +142,7 @@ export class EpubBookExporter {
             )
         })
 
-        this.styleSheets.push({
-            contents,
-            filename: `css/${bookStyle.slug}.css`
-        })
+        this.styleSheets.push({contents, filename: `css/${bookStyle.slug}.css`})
         this.fontFiles = this.fontFiles.concat(
             bookStyle.bookstylefile_set.map(([url, filename]) => ({
                 filename: `css/media/${filename}`,
@@ -171,9 +162,7 @@ export class EpubBookExporter {
             if (coverImage?.image) {
                 this.images.push({
                     url: coverImage.image.split("?")[0],
-                    filename:
-                        coverImage.image.split("/").pop()?.split("?")[0] ||
-                        "cover",
+                    filename: coverImage.image.split("/").pop()?.split("?")[0] || "cover",
                     coverImage: true
                 })
 
@@ -212,17 +201,15 @@ export class EpubBookExporter {
                             return false
                         }
 
-                        const docContent = removeHidden(
-                            doc.content as any
-                        ) as any
+                        const docContent = removeHidden(doc.content as any) as any
 
                         const converter = new HTMLExporterConvert(
                             doc.title,
                             doc.settings,
                             docContent,
                             htmlExportTemplate,
-                            { db: doc.images || {} },
-                            { db: doc.bibliography || {} },
+                            {db: doc.images || {}},
+                            {db: doc.bibliography || {}},
                             this.csl,
                             this.styleSheets,
                             {
@@ -233,7 +220,7 @@ export class EpubBookExporter {
                                 idPrefix: `c-${chapter.number}-`
                             }
                         )
-                        const { html, imageIds, metaData, extraStyleSheets } =
+                        const {html, imageIds, metaData, extraStyleSheets} =
                             await converter.init()
 
                         if (!html) {
@@ -242,10 +229,7 @@ export class EpubBookExporter {
 
                         imageIds.forEach((id: string | number) => {
                             const image = doc.images?.[id]
-                            if (
-                                image?.image &&
-                                typeof image.image === "string"
-                            ) {
+                            if (image?.image && typeof image.image === "string") {
                                 this.images.push({
                                     filename: `images/${image.image.split("/").pop()}`,
                                     url: image.image
@@ -254,8 +238,8 @@ export class EpubBookExporter {
                         })
 
                         await Promise.all(
-                            extraStyleSheets.map(async (sheet: StyleSheet) =>
-                                this.loadStyle(sheet)
+                            extraStyleSheets.map(
+                                async (sheet: StyleSheet) => this.loadStyle(sheet)
                             )
                         )
 
@@ -302,9 +286,7 @@ export class EpubBookExporter {
                     })
                 }
                 items = items.concat(
-                    (
-                        chapter.metaData.toc as Array<Record<string, unknown>>
-                    ).map(item => ({
+                    (chapter.metaData.toc as Array<Record<string, unknown>>).map(item => ({
                         ...item,
                         docNum: chapter.number,
                         link: `document-${chapter.number}.xhtml#c-${chapter.number}-${item.id}`
@@ -412,15 +394,13 @@ export class EpubBookExporter {
             ) {
                 return file
             }
-            return Object.assign({}, file, {
-                filename: `EPUB/${file.filename}`
-            })
+            return Object.assign({}, file, {filename: `EPUB/${file.filename}`})
         })
         this.fontFiles = this.fontFiles.map(file =>
-            Object.assign({}, file, { filename: `EPUB/${file.filename}` })
+            Object.assign({}, file, {filename: `EPUB/${file.filename}`})
         )
         this.includeZips = this.includeZips.map(file =>
-            Object.assign({}, file, { directory: `EPUB/${file.directory}` })
+            Object.assign({}, file, {directory: `EPUB/${file.directory}`})
         )
     }
 

package/src/exporter/epub/templates.ts

@@ -1,9 +1,9 @@
-import { LANGUAGES } from "@fiduswriter/document/schema/const"
-import { escapeText, localizeDate } from "fwtoolkit"
-import { mathliveOpfIncludes } from "@fiduswriter/document/mathlive/opf_includes"
+import {LANGUAGES} from "@fiduswriter/document/schema/const"
+import {escapeText, localizeDate} from "fwtoolkit"
+import {mathliveOpfIncludes} from "@fiduswriter/document/mathlive/opf_includes"
 
-import type { Book } from "../../types.js"
-import { bookTerm } from "../../i18n.js"
+import type {Book} from "../../types.js"
+import {bookTerm} from "../../i18n.js"
 
 export const containerTemplate = () => `<?xml version="1.0" encoding="UTF-8"?>
 <container xmlns="urn:oasis:names:tc:opendocument:xmlns:container" version="1.0">
@@ -184,11 +184,11 @@ export const epubBookOpfTemplate = ({
     idType: string
     date: string
     modified: string
-    styleSheets: Array<{ filename: string }>
+    styleSheets: Array<{filename: string}>
     math: boolean
-    images: Array<{ coverImage?: boolean; filename: string; mimeType?: string }>
-    fontFiles: Array<{ filename: string; mimeType?: string }>
-    chapters: Array<{ number: number }>
+    images: Array<{coverImage?: boolean; filename: string; mimeType?: string}>
+    fontFiles: Array<{filename: string; mimeType?: string}>
+    chapters: Array<{number: number}>
     user: Record<string, string>
 }) => `<?xml version="1.0" encoding="UTF-8"?>
 <package xmlns="http://www.idpf.org/2007/opf" version="3.0"
@@ -296,9 +296,7 @@ export const epubBookOpfTemplate = ({
         ${book.cover_image ? '<itemref idref="cover" linear="no"/>' : ""}
         <itemref idref="titlepage" linear="yes"/>
         ${chapters
-            .map(
-                chapter => `<itemref idref="t${chapter.number}" linear="yes" />`
-            )
+            .map(chapter => `<itemref idref="t${chapter.number}" linear="yes" />`)
             .join("")}
         <itemref idref="copyright" linear="yes"/>
         <itemref idref="nav" linear="no"/>
@@ -318,7 +316,7 @@ export const navTemplate = ({
 }: {
     shortLang: string
     toc: TocItem[]
-    styleSheets: Array<{ filename: string }>
+    styleSheets: Array<{filename: string}>
 }) =>
     `<?xml version="1.0" encoding="UTF-8"?>
 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="${shortLang}"
@@ -386,7 +384,7 @@ export const ncxTemplate = ({
 
 const renderNcxItems = (
     items: TocItem[],
-    counter: { count: number } = { count: 1 }
+    counter: {count: number} = {count: 1}
 ): string =>
     items
         .map(

package/src/exporter/epub/tools.ts

@@ -55,11 +55,9 @@ export function buildHierarchy(
                 parentLevel--
             }
             if (parent) {
-                ;(
-                    idMap[parent.id as string | number].children as Array<
-                        Record<string, unknown>
-                    >
-                ).push(node)
+                ;(idMap[parent.id as string | number].children as Array<
+                    Record<string, unknown>
+                >).push(node)
             } else {
                 root.push(node)
             }