npm - @fiduswriter/books-document - Versions diffs - 0.1.1 - Mend

@fiduswriter/books-document 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (125) hide show

package/LICENSE +661 -0
package/README.md +24 -0
package/dist/exporter/bits/index.d.ts +42 -0
package/dist/exporter/bits/index.d.ts.map +1 -0
package/dist/exporter/bits/index.js +98 -0
package/dist/exporter/bits/index.js.map +1 -0
package/dist/exporter/bits/templates.d.ts +7 -0
package/dist/exporter/bits/templates.d.ts.map +1 -0
package/dist/exporter/bits/templates.js +78 -0
package/dist/exporter/bits/templates.js.map +1 -0
package/dist/exporter/docx/index.d.ts +27 -0
package/dist/exporter/docx/index.d.ts.map +1 -0
package/dist/exporter/docx/index.js +129 -0
package/dist/exporter/docx/index.js.map +1 -0
package/dist/exporter/docx/render.d.ts +14 -0
package/dist/exporter/docx/render.d.ts.map +1 -0
package/dist/exporter/docx/render.js +116 -0
package/dist/exporter/docx/render.js.map +1 -0
package/dist/exporter/epub/index.d.ts +65 -0
package/dist/exporter/epub/index.d.ts.map +1 -0
package/dist/exporter/epub/index.js +268 -0
package/dist/exporter/epub/index.js.map +1 -0
package/dist/exporter/epub/templates.d.ts +65 -0
package/dist/exporter/epub/templates.d.ts.map +1 -0
package/dist/exporter/epub/templates.js +223 -0
package/dist/exporter/epub/templates.js.map +1 -0
package/dist/exporter/epub/tools.d.ts +5 -0
package/dist/exporter/epub/tools.d.ts.map +1 -0
package/dist/exporter/epub/tools.js +59 -0
package/dist/exporter/epub/tools.js.map +1 -0
package/dist/exporter/html/index.d.ts +67 -0
package/dist/exporter/html/index.d.ts.map +1 -0
package/dist/exporter/html/index.js +300 -0
package/dist/exporter/html/index.js.map +1 -0
package/dist/exporter/html/templates.d.ts +40 -0
package/dist/exporter/html/templates.d.ts.map +1 -0
package/dist/exporter/html/templates.js +226 -0
package/dist/exporter/html/templates.js.map +1 -0
package/dist/exporter/html/tools.d.ts +2 -0
package/dist/exporter/html/tools.d.ts.map +1 -0
package/dist/exporter/html/tools.js +23 -0
package/dist/exporter/html/tools.js.map +1 -0
package/dist/exporter/latex/index.d.ts +32 -0
package/dist/exporter/latex/index.d.ts.map +1 -0
package/dist/exporter/latex/index.js +102 -0
package/dist/exporter/latex/index.js.map +1 -0
package/dist/exporter/latex/templates.d.ts +4 -0
package/dist/exporter/latex/templates.d.ts.map +1 -0
package/dist/exporter/latex/templates.js +26 -0
package/dist/exporter/latex/templates.js.map +1 -0
package/dist/exporter/native/index.d.ts +20 -0
package/dist/exporter/native/index.d.ts.map +1 -0
package/dist/exporter/native/index.js +109 -0
package/dist/exporter/native/index.js.map +1 -0
package/dist/exporter/odt/index.d.ts +27 -0
package/dist/exporter/odt/index.d.ts.map +1 -0
package/dist/exporter/odt/index.js +123 -0
package/dist/exporter/odt/index.js.map +1 -0
package/dist/exporter/odt/render.d.ts +15 -0
package/dist/exporter/odt/render.d.ts.map +1 -0
package/dist/exporter/odt/render.js +119 -0
package/dist/exporter/odt/render.js.map +1 -0
package/dist/exporter/print/index.d.ts +24 -0
package/dist/exporter/print/index.d.ts.map +1 -0
package/dist/exporter/print/index.js +60 -0
package/dist/exporter/print/index.js.map +1 -0
package/dist/exporter/print/templates.d.ts +2 -0
package/dist/exporter/print/templates.d.ts.map +1 -0
package/dist/exporter/print/templates.js +5 -0
package/dist/exporter/print/templates.js.map +1 -0
package/dist/exporter/tools.d.ts +29 -0
package/dist/exporter/tools.d.ts.map +1 -0
package/dist/exporter/tools.js +151 -0
package/dist/exporter/tools.js.map +1 -0
package/dist/i18n.d.ts +7 -0
package/dist/i18n.d.ts.map +1 -0
package/dist/i18n.js +918 -0
package/dist/i18n.js.map +1 -0
package/dist/importer/native/index.d.ts +34 -0
package/dist/importer/native/index.d.ts.map +1 -0
package/dist/importer/native/index.js +152 -0
package/dist/importer/native/index.js.map +1 -0
package/dist/importer/native/reader.d.ts +26 -0
package/dist/importer/native/reader.d.ts.map +1 -0
package/dist/importer/native/reader.js +105 -0
package/dist/importer/native/reader.js.map +1 -0
package/dist/index.d.ts +3 -0
package/dist/index.d.ts.map +1 -0
package/dist/index.js +2 -0
package/dist/index.js.map +1 -0
package/dist/schema/index.d.ts +4 -0
package/dist/schema/index.d.ts.map +1 -0
package/dist/schema/index.js +4 -0
package/dist/schema/index.js.map +1 -0
package/dist/types.d.ts +151 -0
package/dist/types.d.ts.map +1 -0
package/dist/types.js +5 -0
package/dist/types.js.map +1 -0
package/package.json +101 -0
package/src/exporter/bits/index.ts +163 -0
package/src/exporter/bits/templates.ts +107 -0
package/src/exporter/docx/index.ts +239 -0
package/src/exporter/docx/render.ts +142 -0
package/src/exporter/epub/index.ts +426 -0
package/src/exporter/epub/templates.ts +401 -0
package/src/exporter/epub/tools.ts +68 -0
package/src/exporter/html/index.ts +443 -0
package/src/exporter/html/templates.ts +363 -0
package/src/exporter/html/tools.ts +26 -0
package/src/exporter/latex/index.ts +161 -0
package/src/exporter/latex/templates.ts +35 -0
package/src/exporter/native/index.ts +187 -0
package/src/exporter/odt/index.ts +211 -0
package/src/exporter/odt/render.ts +146 -0
package/src/exporter/print/index.ts +92 -0
package/src/exporter/print/templates.ts +8 -0
package/src/exporter/tools.ts +233 -0
package/src/global.d.ts +2 -0
package/src/i18n.ts +936 -0
package/src/importer/native/index.ts +233 -0
package/src/importer/native/reader.ts +165 -0
package/src/index.ts +19 -0
package/src/modules.d.ts +11 -0
package/src/schema/index.ts +4 -0
package/src/types.ts +188 -0

package/src/exporter/html/templates.ts ADDED Viewed

@@ -0,0 +1,363 @@
+import {escapeText, localizeDate} from "fwtoolkit"
+import type {Book} from "../../types.js"
+import {bookTerm} from "../../i18n.js"
+export const htmlBookChapterTemplate = ({body, back}: Record<string, unknown>) =>
+    `${body}${back}`
+interface HtmlBookExportParams {
+    styleSheets: Array<{filename: string}>
+    part?: string
+    currentPart?: string
+    contents: string
+    title: string
+    settings: Record<string, string>
+}
+/** A template for HTML export of a book. */
+export const htmlBookExportTemplate = ({
+    styleSheets,
+    part,
+    currentPart,
+    contents,
+    title,
+    settings
+}: HtmlBookExportParams) =>
+    `<!DOCTYPE html>
+<html lang="${settings.language.split("-")[0]}">
+    <head>
+        <meta charset="UTF-8">
+        <title>${title}</title>
+        ${styleSheets
+            .map(
+                sheet =>
+                    `<link type="text/css" rel="stylesheet" href="${sheet.filename}" />`
+            )
+            .join("")}
+    </head>
+    <body class="user-contents book-chapter${
+        currentPart?.length
+            ? ` ${currentPart.toLowerCase().replace(/[^a-z]/g, "")}`
+            : ""
+    }">
+        ${
+            part?.length
+                ? `<h1 class="part">${escapeText(part)}</h1>`
+                : ""
+        }
+        ${contents}
+    </body>
+</html>`
+/** A template to create the book index item. */
+const htmlBookIndexItemTemplate = ({
+    item,
+    multiDoc
+}: {
+    item: Record<string, unknown>
+    multiDoc: boolean
+}): string =>
+    `<li>
+        <a href="${
+            item.link
+                ? item.link
+                : multiDoc
+                  ? item.docNum
+                      ? `document-${item.docNum}.html#${item.id}`
+                      : `document.html#${item.id}`
+                  : `#${item.id}`
+        }">
+            ${escapeText(item.title as string)}
+        </a>
+        ${
+            (item.subItems as Array<Record<string, unknown>>)?.length
+                ? `<ol>
+                ${(item.subItems as Array<Record<string, unknown>>)
+                    .map(subItem =>
+                        htmlBookIndexItemTemplate({item: subItem, multiDoc})
+                    )
+                    .join("")}
+            </ol>`
+                : ""
+        }
+    </li>`
+interface HtmlBookIndexBodyParams {
+    book: Book
+    contentItems: Array<Record<string, unknown>>
+    language: string
+    creator: string
+    multiDoc: boolean
+}
+/** A template to create the book index. */
+export const htmlBookIndexBodyTemplate = ({
+    book,
+    contentItems,
+    language,
+    creator,
+    multiDoc
+}: HtmlBookIndexBodyParams) =>
+    `<div class="titlepage frontmatter">
+        <h1 class="booktitle">${escapeText(book.title)}</h1>
+        ${
+            book.metadata.subtitle?.length
+                ? `<h2 class="booksubtitle">${escapeText(book.metadata.subtitle)}</h2>`
+                : ""
+        }
+        ${
+            book.metadata.author?.length
+                ? `<h3 class="bookauthor">${bookTerm(
+                      "by",
+                      book.settings.language
+                  )} ${escapeText(book.metadata.author)}</h3>`
+                : ""
+        }
+        ${
+            book.metadata.version?.length
+                ? `<h4 class="bookversion">${escapeText(book.metadata.version)}</h4>`
+                : ""
+        }
+        ${
+            book.metadata.series_title?.length
+                ? `<p class="bookseries">${escapeText(book.metadata.series_title)}${
+                      book.metadata.series_position?.length
+                          ? ` \u2013 ${bookTerm("Series position", book.settings.language)} ${escapeText(book.metadata.series_position)}`
+                          : ""
+                  }</p>`
+                : ""
+        }
+    </div>
+    <div class="copyrightpage frontmatter">
+        ${
+            book.metadata.publisher?.length
+                ? `<p>${bookTerm(
+                      "Published by",
+                      book.settings.language
+                  )}: ${escapeText(book.metadata.publisher)}</p>`
+                : ""
+        }
+        ${
+            book.metadata.isbn?.length
+                ? `<p>${bookTerm("ISBN", book.settings.language)}: ${escapeText(book.metadata.isbn)}</p>`
+                : ""
+        }
+        ${
+            book.metadata.publication_date?.length
+                ? `<p>${bookTerm("Publication date", book.settings.language)}: ${escapeText(book.metadata.publication_date)}</p>`
+                : ""
+        }
+        ${
+            book.metadata.series_title?.length
+                ? `<p>${bookTerm("Series", book.settings.language)}: ${escapeText(book.metadata.series_title)}${
+                      book.metadata.series_position?.length
+                          ? ` (${bookTerm("Series position", book.settings.language)}: ${escapeText(book.metadata.series_position)})`
+                          : ""
+                  }</p>`
+                : ""
+        }
+        ${
+            book.metadata.description?.length
+                ? `<p class="book-description">${escapeText(book.metadata.description).replace(/\n/g, "<br>")}</p>`
+                : ""
+        }
+        <p>${bookTerm("Last updated", book.settings.language)}: ${localizeDate(
+            (book.updated || 0) * 1000,
+            "sortable-date"
+        )}</p>
+        <p>${bookTerm("Created", book.settings.language)}: ${localizeDate(
+            (book.added || 0) * 1000,
+            "sortable-date"
+        )}</p>
+        <p>${bookTerm("Language", book.settings.language)}: ${language}</p>
+        <p>${bookTerm("Created by", book.settings.language)}: ${escapeText(
+            creator
+        )}</p>
+    </div>
+    <div class="tocpage frontmatter">
+        <nav role="doc-toc"><ol>
+            ${contentItems
+                .map(item => htmlBookIndexItemTemplate({item, multiDoc}))
+                .join("")}
+        </ol></nav>
+    </div>`
+interface HtmlBookIndexParams {
+    book: Book
+    contentItems: Array<Record<string, unknown>>
+    language: string
+    creator: string
+    styleSheets: Array<{filename: string}>
+    multiDoc: boolean
+}
+/** A template to create the book index. */
+export const htmlBookIndexTemplate = ({
+    book,
+    contentItems,
+    language,
+    creator,
+    styleSheets,
+    multiDoc
+}: HtmlBookIndexParams) =>
+    `<!DOCTYPE html>
+<html lang="${book.settings.language.split("-")[0]}">
+    <head>
+        <meta charset="utf-8"></meta>
+        ${
+            book.metadata.description
+                ? `<meta name="description" content="${escapeText(book.metadata.description.replace(/\n/g, " "))}">`
+                : ""
+        }
+        <title>${escapeText(book.title)}</title>
+        <link type="text/css" rel="stylesheet" href="css/book.css" />
+        ${styleSheets
+            .map(
+                sheet =>
+                    `<link type="text/css" rel="stylesheet" href="${sheet.filename}" />`
+            )
+            .join("")}
+    </head>
+    <body class="user-contents book-index">
+        ${htmlBookIndexBodyTemplate({
+            book,
+            contentItems,
+            language,
+            creator,
+            multiDoc
+        })}
+    </body>
+</html>`
+export const singleFileHTMLBookChapterTemplate = ({
+    part,
+    contents
+}: Record<string, unknown>) => `
+    ${part && (part as string).length ? `<h1 class="part">${escapeText(part as string)}</h1>` : ""}
+    ${contents}`
+export const singleFileHTMLBookTemplate = ({
+    css,
+    html,
+    title,
+    styleSheets,
+    settings
+}: Record<string, unknown>) => `<!DOCTYPE html>
+<html lang="${(settings as Record<string, string>).language.split("-")[0]}">
+    <head>
+        <meta charset="UTF-8">
+        <title>${title}</title>
+        <style>
+            ${css}
+        </style>
+        ${(styleSheets as Array<{filename?: string; contents?: string}>)
+            .map(sheet =>
+                sheet.filename
+                    ? `<link type="text/css" rel="stylesheet" href="${sheet.filename}" />`
+                    : sheet.contents
+                      ? `<style>${sheet.contents}</style>`
+                      : ""
+            )
+            .join("")}
+    </head>
+    <body>
+        <div class="user-contents" id="flow">
+            ${html}
+        </div>
+    </body>
+</html>`
+const CSS_PAPER_SIZES: Record<string, string> = {
+    folio: "12in 15in",
+    quarto: "9.5in 12in",
+    octavo: "6in 9in",
+    a5: "A5",
+    a4: "A4"
+}
+export const singleFileHTMLBookCSSTemplate = ({
+    papersize
+}: Record<string, unknown>) =>
+    `a.fn {
+      -adapt-template: url(data:application/xml,${encodeURI(
+          '<html xmlns="http://www.w3.org/1999/xhtml" xmlns:s="http://www.pyroxy.com/ns/shadow"><head><style>.footnote-content{float:footnote}</style></head><body><s:template id="footnote"><s:content/><s:include class="footnote-content"/></s:template></body></html>#footnote'
+      )});
+      text-decoration: none;
+      color: inherit;
+      vertical-align: baseline;
+      font-size: 70%;
+      position: relative;
+      top: -0.3em;
+  }
+  body {
+      background-color: white;
+  }
+  section[role=doc-footnote] .footnote-counter:after {
+      content: ". ";
+  }
+  section.fnlist {
+      display: none;
+  }
+  section:footnote-content {
+      display: block;
+      font-style:normal;
+      font-weight:normal;
+      text-decoration:none;
+  }
+  .table-of-contents a {
+      display: inline-flex;
+      width: 100%;
+      text-decoration: none;
+      color: currentColor;
+      break-inside: avoid;
+      align-items: baseline;
+  }
+  .table-of-contents a::before {
+      margin-left: 1px;
+      margin-right: 1px;
+      border-bottom: solid 1px lightgray;
+      content: "";
+      order: 1;
+      flex: auto;
+  }
+  .table-of-contents a::after {
+      text-align: right;
+      content: target-counter(attr(href, url), page);
+      align-self: flex-end;
+      flex: none;
+      order: 2;
+  }
+  @page {
+      size: ${CSS_PAPER_SIZES[papersize as string]};
+      @top-center {
+          content: env(doc-title);
+      }
+      @bottom-center {
+          content: counter(page);
+      }
+  }
+  @page :first {
+		          @bottom-center { content: normal; }
+		          @top-center { content: normal; }
+  }
+  figure img {
+      max-width: 100%;
+  }
+  .doc-title {
+      page-break-before: right;
+      counter-reset: cat-figure cat-equation cat-photo cat-table;
+  }
+  h1.part {
+      page-break-before: right;
+  }
+  .copyrightpage {
+      page-break-before: left;
+  }
+  .tocpage {
+      page-break-before: right;
+  }
+  .booktitle {
+      text-align: center;
+  }`

package/src/exporter/html/tools.ts ADDED Viewed

@@ -0,0 +1,26 @@
+export function orderLinks(
+    contentItems: Array<Record<string, unknown>>
+): Array<Record<string, unknown>> {
+    for (let i = 0; i < contentItems.length; i++) {
+        contentItems[i].subItems = []
+        if (i > 0) {
+            for (let j = i - 1; j > -1; j--) {
+                if ((contentItems[j].level as number) < (contentItems[i].level as number)) {
+                    ;(contentItems[j].subItems as Array<Record<string, unknown>>).push(
+                        contentItems[i]
+                    )
+                    contentItems[i].delete = true
+                    break
+                }
+            }
+        }
+    }
+    for (let i = contentItems.length; i > -1; i--) {
+        if (contentItems[i]?.delete) {
+            delete contentItems[i].delete
+            contentItems.splice(i, 1)
+        }
+    }
+    return contentItems
+}

package/src/exporter/latex/index.ts ADDED Viewed

@@ -0,0 +1,161 @@
+/**
+ * LaTeX book exporter.
+ */
+import type {Schema} from "prosemirror-model"
+import type {User} from "@fiduswriter/document"
+import {BibLatexExporter} from "biblatex-csl-converter"
+import {LatexExporterConvert} from "@fiduswriter/document/exporter/latex/convert"
+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 type {Book, DocumentListEntry} from "../../types.js"
+import {getMissingChapterData} from "../tools.js"
+import {bookTexTemplate} from "./templates.js"
+interface TextFile {
+    filename: string
+    contents: string
+}
+interface HttpFile {
+    url: string
+    filename: string
+}
+export class LatexBookExporter {
+    schema: Schema
+    book: Book
+    user: User
+    docList: DocumentListEntry[]
+    updated: any
+    textFiles: TextFile[]
+    httpFiles: HttpFile[]
+    zipFileName: string
+    constructor(
+        schema: Schema,
+        book: Book,
+        user: User,
+        docList: DocumentListEntry[],
+        updated: any
+    ) {
+        this.schema = schema
+        this.book = book
+        this.book.chapters.sort((a, b) => (a.number > b.number ? 1 : -1))
+        this.user = user
+        this.docList = docList
+        this.updated = updated
+        this.textFiles = []
+        this.httpFiles = []
+        this.zipFileName = ""
+    }
+    init(): Promise<Blob> {
+        return getMissingChapterData(this.book, this.docList, this.schema).then(
+            () => this.export()
+        )
+    }
+    export(): Promise<Blob> {
+        this.zipFileName = `${createSlug(this.book.title)}.latex.zip`
+        let bibIds: string[] = []
+        let imageIds: string[] = []
+        const features: Record<string, boolean> = {}
+        const combinedBibliography: Record<string, unknown> = {}
+        const combinedImages: Record<string, {image: string}> = {}
+        this.book.chapters.forEach((chapter, index) => {
+            const doc = this.docList.find(d => d.id === chapter.text)
+            if (!doc) {
+                return
+            }
+            const converter = new LatexExporterConvert(
+                this as any,
+                {db: doc.images || {}},
+                {db: doc.bibliography || {}},
+                doc.settings
+            )
+            const chapterContent = removeHidden(doc.content as any)
+            const convertedDoc = converter.init(chapterContent)
+            this.textFiles.push({
+                filename: `chapter-${index + 1}.tex`,
+                contents: convertedDoc.latex
+            })
+            bibIds = [
+                ...new Set(bibIds.concat(Object.keys(convertedDoc.usedBibDB)))
+            ]
+            imageIds = [...new Set(imageIds.concat(convertedDoc.imageIds))]
+            Object.assign(features, converter.features as Record<string, boolean>)
+            Object.keys(convertedDoc.usedBibDB).forEach(
+                bibId =>
+                    (combinedBibliography[bibId] = doc.bibliography?.[bibId])
+            )
+            convertedDoc.imageIds.forEach(
+                (imageId: string) =>
+                    (combinedImages[imageId] = doc.images?.[imageId] as {
+                        image: string
+                    })
+            )
+        })
+        if (bibIds.length > 0) {
+            const bibExport = new BibLatexExporter(
+                combinedBibliography as any,
+                bibIds
+            )
+            this.textFiles.push({
+                filename: "bibliography.bib",
+                contents: (bibExport as any).output
+            })
+        }
+        imageIds.forEach(id => {
+            const image = combinedImages[id]
+            if (image?.image) {
+                this.httpFiles.push({
+                    filename: image.image.split("/").pop() || id,
+                    url: image.image
+                })
+            }
+        })
+        const bookConverter = new LatexExporterConvert(
+            this as any,
+            {db: combinedImages as any},
+            {db: combinedBibliography as any},
+            {language: this.book.settings.language, bibliography_header: {}}
+        )
+        bookConverter.features = features
+        const preamble = bookConverter.assemblePreamble()
+        const epilogue = bookConverter.assembleEpilogue()
+        this.textFiles.push({
+            filename: "book.tex",
+            contents: bookTexTemplate({
+                book: this.book,
+                preamble,
+                epilogue
+            })
+        })
+        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/latex/templates.ts ADDED Viewed

@@ -0,0 +1,35 @@
+import type {BookTexTemplateParams} from "../../types.js"
+/** A template to create the latex book.tex file. */
+export const bookTexTemplate = ({preamble, book, epilogue}: BookTexTemplateParams) =>
+    `\\documentclass[11pt]{book}
+${preamble}
+\\usepackage{docmute}
+\\title{${book.title}}
+\\author{${book.metadata.author}}
+${
+    book.metadata.publication_date?.length || book.metadata.version?.length
+        ? `\\date{${book.metadata.publication_date || book.metadata.version}}`
+        : ""
+}
+\\begin{document}
+\\maketitle
+${
+    book.metadata.description?.length
+        ? `\\chapter*{Abstract}
+${book.metadata.description}
+`
+        : ""
+}
+\\def\\title#1{\\chapter{#1}}
+\\tableofcontents
+${book.chapters
+    .map(
+        chapter =>
+            `${chapter.part && chapter.part.length ? `\n\\part{${chapter.part}}` : ""}
+        \\input{chapter-${chapter.number}}
+        `
+    )
+    .join("")}
+${epilogue}
+\\end{document}`