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/epub/templates.ts ADDED Viewed

@@ -0,0 +1,401 @@
+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"
+export const containerTemplate = () => `<?xml version="1.0" encoding="UTF-8"?>
+<container xmlns="urn:oasis:names:tc:opendocument:xmlns:container" version="1.0">
+    <rootfiles>
+        <rootfile full-path="EPUB/document.opf" media-type="application/oebps-package+xml"/>
+    </rootfiles>
+</container>`
+interface CoverImage {
+    image: string
+}
+export const epubBookCoverTemplate = ({
+    book,
+    coverImage,
+    shortLang
+}: {
+    book: Book
+    coverImage: CoverImage
+    shortLang: string
+}) =>
+    `<?xml version="1.0" encoding="UTF-8"?>
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="${shortLang}" lang="${shortLang}">
+    <head>
+        <title>${escapeText(book.title)}</title>
+        <meta charset="utf-8"/>
+    </head>
+    <body class="epub cover">
+        <div id="cover">
+            <img src="${coverImage.image.split("/").pop()?.split("?")[0]}"
+                alt="${bookTerm("Cover image", book.settings.language)}"
+                title="${bookTerm("Cover image", book.settings.language)}"/>
+        </div>
+    </body>
+</html>`
+export const epubBookTitlepageTemplate = ({
+    book,
+    shortLang
+}: {
+    book: Book
+    shortLang: string
+}) =>
+    `<?xml version="1.0" encoding="UTF-8"?>
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="${shortLang}" lang="${shortLang}">
+    <head>
+        <title>${escapeText(book.title)}</title>
+        <meta charset="utf-8"/>
+    </head>
+    <body class="epub titlepage">
+        <div id="title" epub:type="frontmatter titlepage">
+            <h1 class="booktitle">${escapeText(book.title)}</h1>
+            ${
+                book.metadata.subtitle
+                    ? `<h2 class="booksubtitle">${escapeText(book.metadata.subtitle)}</h2>`
+                    : ""
+            }
+            ${
+                book.metadata.author
+                    ? `<h3 class="bookauthor">${bookTerm("by", book.settings.language)} ${escapeText(book.metadata.author)}</h3>`
+                    : ""
+            }
+            ${
+                book.metadata.version
+                    ? `<h4 class="bookversion">${escapeText(book.metadata.version)}</h4>`
+                    : ""
+            }
+            ${
+                book.metadata.series_title
+                    ? `<p class="bookseries">${escapeText(book.metadata.series_title)}${
+                          book.metadata.series_position
+                              ? ` \u2013 ${bookTerm("Series position", book.settings.language)} ${escapeText(book.metadata.series_position)}`
+                              : ""
+                      }</p>`
+                    : ""
+            }
+        </div>
+    </body>
+</html>`
+export const epubBookCopyrightTemplate = ({
+    book,
+    language,
+    shortLang,
+    creator
+}: {
+    book: Book
+    language: string
+    shortLang: string
+    creator: string
+}) =>
+    `<?xml version="1.0" encoding="UTF-8"?>
+<html xmlns="http://www.w3.org/1999/xhtml" xmlns:epub="http://www.idpf.org/2007/ops" xml:lang="${shortLang}" lang="${shortLang}">
+    <head>
+        <title>${escapeText(book.title)}</title>
+        <meta charset="utf-8"/>
+    </head>
+    <body class="epub copyrightpage">
+        <section epub:type="frontmatter copyright-page">
+            <div id="copyright">
+                <p>${escapeText(book.title)}${
+                    book.metadata.author
+                        ? ` ${bookTerm("by", book.settings.language)} ${escapeText(book.metadata.author)}`
+                        : ""
+                }</p>
+                ${
+                    book.metadata.copyright
+                        ? `<p>${escapeText(book.metadata.copyright)}</p>`
+                        : ""
+                }
+                <p>${bookTerm("Title", book.settings.language)}: ${escapeText(book.title)}</p>
+                ${
+                    book.metadata.author
+                        ? `<p>${bookTerm("Author", book.settings.language)}: ${escapeText(book.metadata.author)}</p>`
+                        : ""
+                }
+                ${
+                    book.metadata.publisher
+                        ? `<p>${bookTerm("Published by", book.settings.language)}: ${escapeText(book.metadata.publisher)}</p>`
+                        : ""
+                }
+                ${
+                    book.metadata.isbn
+                        ? `<p>${bookTerm("ISBN", book.settings.language)}: ${escapeText(book.metadata.isbn)}</p>`
+                        : ""
+                }
+                ${
+                    book.metadata.publication_date
+                        ? `<p>${bookTerm("Publication date", book.settings.language)}: ${escapeText(book.metadata.publication_date)}</p>`
+                        : ""
+                }
+                ${
+                    book.metadata.series_title
+                        ? `<p>${bookTerm("Series", book.settings.language)}: ${escapeText(book.metadata.series_title)}${
+                              book.metadata.series_position
+                                  ? ` (${bookTerm("Series position", book.settings.language)}: ${escapeText(book.metadata.series_position)})`
+                                  : ""
+                          }</p>`
+                        : ""
+                }
+                ${
+                    book.metadata.description
+                        ? `<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)}: ${
+                    LANGUAGES.find(lang => lang[0] === language)?.[1]
+                }</p>
+                <p>${bookTerm("Created by", book.settings.language)}: ${escapeText(creator)}</p>
+            </div>
+        </section>
+    </body>
+</html>`
+export const epubBookOpfTemplate = ({
+    book,
+    language,
+    idType,
+    date,
+    modified,
+    styleSheets,
+    math,
+    images,
+    fontFiles,
+    chapters,
+    user
+}: {
+    book: Book
+    language: string
+    idType: string
+    date: string
+    modified: 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}>
+    user: Record<string, string>
+}) => `<?xml version="1.0" encoding="UTF-8"?>
+<package xmlns="http://www.idpf.org/2007/opf" version="3.0"
+    unique-identifier="${idType}" xml:lang="${language}"
+    prefix="cc: http://creativecommons.org/ns#">
+    <metadata xmlns:dc="http://purl.org/dc/elements/1.1/">
+        <dc:identifier id="${idType}">${book.id}</dc:identifier>
+        <dc:title>${escapeText(book.title)}</dc:title>
+        <dc:creator>${
+            book.metadata.author?.length
+                ? escapeText(book.metadata.author)
+                : escapeText(user.name)
+        }</dc:creator>
+        <dc:language>${language}</dc:language>
+        <meta property="dcterms:modified">${modified}</meta>
+        <dc:date>${book.metadata.publication_date || date}</dc:date>
+        ${
+            book.metadata.copyright
+                ? `<dc:rights>${escapeText(book.metadata.copyright)}</dc:rights>`
+                : ""
+        }
+        ${
+            book.metadata.publisher
+                ? `<dc:publisher>${escapeText(book.metadata.publisher)}</dc:publisher>`
+                : ""
+        }
+        ${
+            book.metadata.description
+                ? `<dc:description>${escapeText(book.metadata.description)}</dc:description>`
+                : ""
+        }
+        ${
+            book.metadata.isbn
+                ? `<dc:identifier id="isbn">${escapeText(book.metadata.isbn)}</dc:identifier>`
+                : ""
+        }
+        ${
+            book.metadata.series_title
+                ? `<meta property="belongs-to-collection" id="series01">${escapeText(book.metadata.series_title)}</meta>
+        <meta refines="#series01" property="collection-type">series</meta>
+        ${
+            book.metadata.series_position
+                ? `<meta refines="#series01" property="group-position">${escapeText(book.metadata.series_position)}</meta>`
+                : ""
+        }`
+                : ""
+        }
+        ${
+            book.metadata.keywords
+                ? book.metadata.keywords
+                      .split(",")
+                      .map(
+                          keyword =>
+                              `<dc:subject>${escapeText(keyword.trim())}</dc:subject>`
+                      )
+                      .join("")
+                : ""
+        }
+    </metadata>
+    <manifest>
+        ${
+            book.cover_image
+                ? '<item id="cover" href="cover.xhtml" media-type="application/xhtml+xml"/>'
+                : ""
+        }
+        <item id="titlepage" href="titlepage.xhtml" media-type="application/xhtml+xml"/>
+        ${chapters
+            .map(
+                chapter =>
+                    `<item id="t${chapter.number}" href="document-${chapter.number}.xhtml"
+                    media-type="application/xhtml+xml" />`
+            )
+            .join("")}
+        <item id="nav" href="document-nav.xhtml" properties="nav"
+            media-type="application/xhtml+xml" />
+        <item id="copyright" href="copyright.xhtml" media-type="application/xhtml+xml"/>
+        ${images
+            .map(
+                (image, index) =>
+                    `<item ${
+                        image.coverImage
+                            ? 'id="cover-image" properties="cover-image"'
+                            : `id="img${index}"`
+                    } href="${image.filename}" media-type="${image.mimeType}"/>`
+            )
+            .join("")}
+        ${fontFiles
+            .map(
+                (font, index) =>
+                    `<item id="font${index}" href="${font.filename}"
+                    media-type="${font.mimeType}" />`
+            )
+            .join("")}
+        ${styleSheets
+            .map(
+                (sheet, index) =>
+                    `<item id="css${index}" href="${sheet.filename}"
+                    media-type="text/css" />`
+            )
+            .join("")}
+        ${math ? mathliveOpfIncludes : ""}
+        <item id="ncx" href="document.ncx" media-type="application/x-dtbncx+xml" />
+    </manifest>
+    <spine toc="ncx">
+        ${book.cover_image ? '<itemref idref="cover" linear="no"/>' : ""}
+        <itemref idref="titlepage" linear="yes"/>
+        ${chapters
+            .map(chapter => `<itemref idref="t${chapter.number}" linear="yes" />`)
+            .join("")}
+        <itemref idref="copyright" linear="yes"/>
+        <itemref idref="nav" linear="no"/>
+    </spine>
+</package>`
+interface TocItem {
+    link: string
+    title: string
+    children?: TocItem[]
+}
+export const navTemplate = ({
+    shortLang,
+    toc,
+    styleSheets
+}: {
+    shortLang: string
+    toc: TocItem[]
+    styleSheets: Array<{filename: string}>
+}) =>
+    `<?xml version="1.0" encoding="UTF-8"?>
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="${shortLang}"
+    lang="${shortLang}" xmlns:epub="http://www.idpf.org/2007/ops">
+    <head>
+        <meta charset="utf-8"/>
+        <title>Navigation</title>
+        ${styleSheets
+            .map(
+                sheet =>
+                    `<link rel="stylesheet" type="text/css" href="${sheet.filename}" />`
+            )
+            .join("")}
+    </head>
+    <body class="epub navigation">
+        <nav epub:type="toc" id="toc">
+            <ol>
+                ${renderTocItems(toc)}
+            </ol>
+        </nav>
+    </body>
+</html>`
+const renderTocItems = (items: TocItem[]): string =>
+    items
+        .map(
+            item => `
+    <li>
+        <a href="${item.link}">${escapeText(item.title)}</a>
+        ${
+            item.children?.length
+                ? `<ol>${renderTocItems(item.children)}</ol>`
+                : ""
+        }
+    </li>
+`
+        )
+        .join("")
+export const ncxTemplate = ({
+    shortLang,
+    idType,
+    id,
+    title,
+    toc
+}: {
+    shortLang: string
+    idType: string
+    id: number | undefined
+    title: string
+    toc: TocItem[]
+}) =>
+    `<?xml version="1.0" encoding="UTF-8"?>
+<ncx xmlns="http://www.daisy.org/z3986/2005/ncx/" version="2005-1" xml:lang="${shortLang}">
+    <head>
+        <meta name="dtb:${idType}" content="${id}"/\u003e
+    </head>
+    <docTitle>
+        <text>${escapeText(title)}</text>
+    </docTitle>
+    <navMap>
+        ${renderNcxItems(toc)}
+    </navMap>
+</ncx>`
+const renderNcxItems = (
+    items: TocItem[],
+    counter: {count: number} = {count: 1}
+): string =>
+    items
+        .map(
+            item => `
+    <navPoint id="np-${counter.count++}" playOrder="${counter.count}">
+        <navLabel>
+            <text>${escapeText(item.title)}</text>
+        </navLabel>
+        <content src="${item.link}"/\u003e
+        ${item.children?.length ? renderNcxItems(item.children, counter) : ""}
+    </navPoint>
+`
+        )
+        .join("")

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

@@ -0,0 +1,68 @@
+export function getTimestamp(date: Date): string {
+    return date.toISOString().replace(/\.\d{3}/, "")
+}
+export function getFontMimeType(filename: string): string | null {
+    const fontMimeTypes: Record<string, string> = {
+        ttf: "font/ttf",
+        otf: "font/otf",
+        woff: "font/woff",
+        woff2: "font/woff2"
+    }
+    const ext = filename.split(".").pop()?.toLowerCase()
+    return ext ? fontMimeTypes[ext] || null : null
+}
+export function getImageMimeType(filename: string): string | null {
+    const imageMimeTypes: Record<string, string> = {
+        jpg: "image/jpeg",
+        jpeg: "image/jpeg",
+        png: "image/png",
+        gif: "image/gif",
+        svg: "image/svg+xml"
+    }
+    const ext = filename.split(".").pop()?.toLowerCase()
+    return ext ? imageMimeTypes[ext] || null : null
+}
+export function buildHierarchy(
+    flatItems: Array<Record<string, unknown>>
+): Array<Record<string, unknown>> {
+    const root: Array<Record<string, unknown>> = []
+    const idMap: Record<string | number, Record<string, unknown>> = {}
+    flatItems.forEach(item => {
+        idMap[item.id as string | number] = {
+            ...item,
+            children: []
+        }
+    })
+    flatItems.forEach(item => {
+        const node = idMap[item.id as string | number]
+        if (item.level === -1 || item.level === 0) {
+            root.push(node)
+        } else {
+            let parentLevel = (item.level as number) - 1
+            let parent: Record<string, unknown> | undefined
+            while (parentLevel >= 0 && !parent) {
+                parent = flatItems.find(
+                    p =>
+                        p.level === parentLevel &&
+                        p.docNum === item.docNum &&
+                        (p.id as number) < (item.id as number)
+                )
+                parentLevel--
+            }
+            if (parent) {
+                ;(idMap[parent.id as string | number].children as Array<
+                    Record<string, unknown>
+                >).push(node)
+            } else {
+                root.push(node)
+            }
+        }
+    })
+    return root
+}