@fiduswriter/document 0.1.0-alpha.1 → 0.1.0-alpha.3

package/README.md

@@ -10,6 +10,10 @@ import {DocxConvert} from "@fiduswriter/document/importer/docx/convert.js"
 import {ExportFidusFile} from "@fiduswriter/document/exporter/native/file.js"
 ```
 
+## Dependencies
+
+- `fwtoolkit` — shared utilities (text helpers, network helpers, etc.)
+
 ## Schema JSON
 
 A JSON serialization of the schema is exported as `schema.json` and regenerated

package/jest.config.js

@@ -12,7 +12,8 @@ export default {
         "^biblatex-csl-converter$": "<rootDir>/test/exporter/mocks/biblatex-csl-converter.js",
         "^jszip$": "<rootDir>/test/importer/mocks/jszip.js",
         "^mathml-to-latex$": "<rootDir>/test/importer/mocks/mathml-to-latex.js",
-        "^@fiduswriter/document/common$": "<rootDir>/test/exporter/mocks/common.js",
+        "^fwtoolkit$": "<rootDir>/test/exporter/mocks/common.js",
+        "^fwtoolkit/.*": "<rootDir>/test/exporter/mocks/common.js",
         "^@fiduswriter/document/citations/format$": "<rootDir>/test/exporter/mocks/citations-format.js",
         "^@fiduswriter/document/bibliography/csl_bib$": "<rootDir>/test/exporter/mocks/csl-bib-schema.js",
         "^@fiduswriter/document/mathlive/opf_includes$": "<rootDir>/test/exporter/mocks/empty-module.js"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fiduswriter/document",
-  "version": "0.1.0-alpha.1",
+  "version": "0.1.0-alpha.3",
   "description": "Fidus Writer document schema, importers and exporters",
   "repository": {
     "type": "git",
@@ -16,9 +16,7 @@
     "./importer/*": "./src/importer/*",
     "./exporter/*": "./src/exporter/*",
     "./citations/*": "./src/citations/*",
-    "./bibliography/*": "./src/bibliography/*",
-    "./common": "./src/common/index.js",
-    "./common/*": "./src/common/*"
+    "./bibliography/*": "./src/bibliography/*"
   },
   "main": "jest.config.js",
   "directories": {
@@ -38,6 +36,7 @@
     "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --config jest.config.js"
   },
   "dependencies": {
+    "fwtoolkit": "^0.1.1",
     "biblatex-csl-converter": "^3.0.0",
     "downloadjs": "^1.4.7",
     "fast-deep-equal": "^3.1.3",

package/src/citations/format.js

@@ -1,4 +1,4 @@
-import {escapeText} from "../common/index.js"
+import {escapeText} from "fwtoolkit"
 import {citeprocSys} from "./citeproc_sys.js"
 /*
  * Use CSL and bibDB to format all citations for the given prosemirror json citation nodes

package/src/exporter/docx/comments.js

@@ -1,4 +1,4 @@
-import {escapeText} from "../../common/index.js"
+import {escapeText} from "fwtoolkit"
 import {descendantNodes} from "../tools/doc_content.js"
 
 const DEFAULT_COMMENTS_XML = `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

package/src/exporter/docx/images.js

@@ -1,4 +1,4 @@
-import {get} from "../../common/index.js"
+import {get} from "fwtoolkit"
 import {descendantNodes} from "../tools/doc_content.js"
 import {svg2png} from "../tools/svg.js"
 

package/src/exporter/docx/index.js

@@ -1,6 +1,6 @@
 import download from "downloadjs"
 
-import {shortFileTitle} from "../../common/index.js"
+import {shortFileTitle} from "fwtoolkit"
 import {fixTables, removeHidden, textContent} from "../tools/doc_content.js"
 import {createSlug} from "../tools/file.js"
 import {XmlZip} from "../tools/xml_zip.js"

package/src/exporter/docx/metadata.js

@@ -1,4 +1,4 @@
-import {escapeText} from "../../common/index.js"
+import {escapeText} from "fwtoolkit"
 
 export class DOCXExporterMetadata {
     constructor(xml, metadata, csl = null) {

package/src/exporter/docx/rels.js

@@ -1,5 +1,5 @@
 // manages the .rels files. Need to initialize one for each of document.xml and footnotes.xml
-import {escapeText} from "../../common/index.js"
+import {escapeText} from "fwtoolkit"
 
 const DEFAULT_XML = `<?xml version="1.0" encoding="UTF-8"?>
 <Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships"></Relationships>`

package/src/exporter/docx/render.js

@@ -1,4 +1,4 @@
-import {escapeText} from "../../common/index.js"
+import {escapeText} from "fwtoolkit"
 import {BIBLIOGRAPHY_HEADERS} from "../../schema/i18n.js"
 import {textContent} from "../tools/doc_content.js"
 import {xmlDOM} from "../tools/xml.js"

package/src/exporter/docx/richtext.js

@@ -1,4 +1,4 @@
-import {escapeText} from "../../common/index.js"
+import {escapeText} from "fwtoolkit"
 import {CATS} from "../../schema/i18n.js"
 
 import {xmlDOM} from "../tools/xml.js"

package/src/exporter/epub/templates.js

@@ -1,4 +1,4 @@
-import {escapeText} from "../../common/index.js"
+import {escapeText} from "fwtoolkit"
 import {mathliveOpfIncludes} from "../../mathlive/opf_includes.js"
 
 /** A template for the OPF file of an epub. */

package/src/exporter/html/citations.js

@@ -1,5 +1,5 @@
 import {FormatCitations} from "../../citations/format.js"
-import {escapeText} from "../../common/index.js"
+import {escapeText} from "fwtoolkit"
 import {BIBLIOGRAPHY_HEADERS} from "../../schema/i18n.js"
 
 export class HTMLExporterCitations {

package/src/exporter/html/convert.js

@@ -1,7 +1,7 @@
 import {convertLatexToMathMl} from "mathlive"
 import pretty from "pretty"
 
-import {escapeText} from "../../common/index.js"
+import {escapeText} from "fwtoolkit"
 import {CATS} from "../../schema/i18n.js"
 import {HTMLExporterCitations} from "./citations.js"
 import {displayNumber} from "./tools.js"

package/src/exporter/html/index.js

@@ -1,7 +1,7 @@
 import download from "downloadjs"
 import pretty from "pretty"
 
-import {shortFileTitle} from "../../common/index.js"
+import {shortFileTitle} from "fwtoolkit"
 import {removeHidden} from "../tools/doc_content.js"
 import {createSlug} from "../tools/file.js"
 import {ZipFileCreator} from "../tools/zip.js"

package/src/exporter/html/templates.js

@@ -1,4 +1,4 @@
-import {escapeText} from "../../common/index.js"
+import {escapeText} from "fwtoolkit"
 
 /** A template for HTML export of a document. */
 export const htmlExportTemplate = ({

package/src/exporter/jats/bibliography.js

@@ -1,4 +1,4 @@
-import {escapeText} from "../../common/index.js"
+import {escapeText} from "fwtoolkit"
 import {convertTexts} from "./text.js"
 
 // This list is based on values listed at https://jats.nlm.nih.gov/archiving/tag-library/1.2/attribute/publication-type.html

package/src/exporter/jats/convert.js

@@ -1,6 +1,6 @@
 import {convertLatexToMathMl} from "mathlive"
 
-import {escapeText} from "../../common/index.js"
+import {escapeText} from "fwtoolkit"
 import {CATS} from "../../schema/i18n.js"
 
 import {removeHidden} from "../tools/doc_content.js"

package/src/exporter/jats/index.js

@@ -1,7 +1,7 @@
 import download from "downloadjs"
 import pretty from "pretty"
 
-import {shortFileTitle} from "../../common/index.js"
+import {shortFileTitle} from "fwtoolkit"
 import {createSlug} from "../tools/file.js"
 import {ZipFileCreator} from "../tools/zip.js"
 import {JATSExporterConverter} from "./convert.js"

package/src/exporter/jats/templates.js

@@ -1,4 +1,4 @@
-import {escapeText, noSpaceTmp} from "../../common/index.js"
+import {escapeText, noSpaceTmp} from "fwtoolkit"
 
 export const articleTemplate = ({front, body, back}) =>
     `<?xml version="1.0" encoding="UTF-8"?>

package/src/exporter/jats/text.js

@@ -1,4 +1,4 @@
-import {escapeText} from "../../common/index.js"
+import {escapeText} from "fwtoolkit"
 
 export function convertTexts(nodeList) {
     return nodeList.map(node => convertText(node)).join("")

package/src/exporter/latex/index.js

@@ -1,7 +1,7 @@
 import {BibLatexExporter} from "biblatex-csl-converter"
 import download from "downloadjs"
 
-import {shortFileTitle} from "../../common/index.js"
+import {shortFileTitle} from "fwtoolkit"
 import {fixTables, removeHidden} from "../tools/doc_content.js"
 import {createSlug} from "../tools/file.js"
 import {ZipFileCreator} from "../tools/zip.js"

package/src/exporter/native/shrink.js

@@ -1,4 +1,4 @@
-import {addAlert} from "../../common/index.js"
+import {addAlert} from "fwtoolkit"
 import {docSchema} from "../../schema/document/index.js"
 import {toMiniJSON} from "../../schema/mini_json.js"
 // Generate a copy of the fidus doc, imageDB and bibDB with all clutter removed.

package/src/exporter/odt/images.js

@@ -1,4 +1,4 @@
-import {get} from "../../common/index.js"
+import {get} from "fwtoolkit"
 import {descendantNodes} from "../tools/doc_content.js"
 import {svg2png} from "../tools/svg.js"
 

package/src/exporter/odt/index.js

@@ -1,6 +1,6 @@
 import download from "downloadjs"
 
-import {shortFileTitle} from "../../common/index.js"
+import {shortFileTitle} from "fwtoolkit"
 
 import {fixTables, removeHidden, textContent} from "../tools/doc_content.js"
 import {createSlug} from "../tools/file.js"

package/src/exporter/odt/metadata.js

@@ -1,4 +1,4 @@
-import {escapeText} from "../../common/index.js"
+import {escapeText} from "fwtoolkit"
 
 export class ODTExporterMetadata {
     constructor(xml, styles, metadata, csl = null) {

package/src/exporter/odt/render.js

@@ -1,4 +1,4 @@
-import {escapeText} from "../../common/index.js"
+import {escapeText} from "fwtoolkit"
 import {BIBLIOGRAPHY_HEADERS} from "../../schema/i18n.js"
 import {textContent} from "../tools/doc_content.js"
 import {xmlDOM} from "../tools/xml.js"

package/src/exporter/odt/richtext.js

@@ -1,4 +1,4 @@
-import {escapeText} from "../../common/index.js"
+import {escapeText} from "fwtoolkit"
 import {CATS} from "../../schema/i18n.js"
 import {createZoteroCitation} from "../tools/zotero_csl.js"
 

package/src/exporter/odt/track.js

@@ -1,4 +1,4 @@
-import {escapeText} from "../../common/index.js"
+import {escapeText} from "fwtoolkit"
 
 export class ODTExporterTracks {
     constructor(xml) {

package/src/exporter/pandoc/index.js

@@ -1,7 +1,7 @@
 import {BibLatexExporter} from "biblatex-csl-converter"
 import download from "downloadjs"
 
-import {shortFileTitle} from "../../common/index.js"
+import {shortFileTitle} from "fwtoolkit"
 import {fixTables, removeHidden} from "../tools/doc_content.js"
 import {createSlug} from "../tools/file.js"
 import {ZipFileCreator} from "../tools/zip.js"

package/src/exporter/print/index.js

@@ -1,5 +1,5 @@
 import {printHTML} from "@vivliostyle/print"
-import {addAlert, shortFileTitle} from "../../common/index.js"
+import {addAlert, shortFileTitle} from "fwtoolkit"
 import {PAPER_SIZES} from "../../schema/const.js"
 import {HTMLExporter} from "../html/index.js"
 import {HTMLExporterConvert} from "../html/convert.js"

package/src/exporter/tools/svg.js

@@ -1,4 +1,4 @@
-import {convertDataURIToBlob} from "../../common/index.js"
+import {convertDataURIToBlob} from "fwtoolkit"
 
 export function svg2png(blob) {
     const img = document.createElement("img")

package/src/exporter/tools/xml_zip.js

@@ -1,6 +1,6 @@
 import {xmlDOM} from "./xml.js"
 
-import {get} from "../../common/index.js"
+import {get} from "fwtoolkit"
 // Handle a zip file containing XML files. Make sure files are only opened once,
 // and provide a mechanism to save the file.
 

package/src/exporter/tools/zip.js

@@ -1,4 +1,4 @@
-import {convertDataURIToBlob, get} from "../../common/index.js"
+import {convertDataURIToBlob, get} from "fwtoolkit"
 
 /** Creates a zip file.
  * @function zipFileCreator

package/src/importer/native/get_images.js

@@ -1,4 +1,4 @@
-import {get} from "../../common/index.js"
+import {get} from "fwtoolkit"
 
 export class GetImages {
     constructor(images, entries) {

package/src/schema/document/content.js

@@ -1,4 +1,4 @@
-import {escapeText} from "../../common/index.js"
+import {escapeText} from "fwtoolkit"
 import {parseTracks} from "../common/index.js"
 import {fnNodeToHtml, htmlToFnNode} from "../footnotes_convert.js"
 

package/src/common/blob.js

@@ -1,10 +0,0 @@
-export const convertDataURIToBlob = dataURI => {
-    const byteString = atob(dataURI.split(",")[1])
-    const mimeString = dataURI.split(",")[0].split(":")[1].split(";")[0]
-    const ab = new ArrayBuffer(byteString.length)
-    const ia = new Uint8Array(ab)
-    for (let i = 0; i < byteString.length; i++) {
-        ia[i] = byteString.charCodeAt(i)
-    }
-    return new Blob([ab], {type: mimeString})
-}

package/src/common/file.js

@@ -1,25 +0,0 @@
-import {escapeText} from "./text.js"
-
-export const shortFileTitle = (title, path) => {
-    if (!path.length || path.endsWith("/")) {
-        return escapeText(title || gettext("Untitled"))
-    }
-    return escapeText(path.split("/").pop())
-}
-
-export const longFilePath = (title, path, prefix = "") => {
-    if (!path.length) {
-        path = "/"
-    }
-    if (path.endsWith("/")) {
-        path += title.replace(/\//g, "") || gettext("Untitled")
-    }
-    if (prefix.length) {
-        const pathParts = path.split("/")
-        const fileName = pathParts.pop()
-        pathParts.push(prefix + fileName)
-        path = pathParts.join("/")
-    }
-
-    return path
-}

package/src/common/index.js

@@ -1,12 +0,0 @@
-export {escapeText, unescapeText, noSpaceTmp} from "./text.js"
-export {convertDataURIToBlob} from "./blob.js"
-export {shortFileTitle, longFilePath} from "./file.js"
-export {get, post, postJson} from "./network.js"
-
-export const addAlert = (type, message) => {
-    if (typeof console !== "undefined") {
-        console.log(`[@fiduswriter/document alert][${type}] ${message}`)
-    }
-}
-
-export const deactivateWait = () => {}

package/src/common/network.js

@@ -1,79 +0,0 @@
-const getCookie = name => {
-    if (typeof document === "undefined" || !document.cookie) {
-        return ""
-    }
-    const cookie = document.cookie
-        .split(";")
-        .map(cookie => cookie.trim())
-        .find(cookie => cookie.substring(0, name.length + 1) === `${name}=`)
-    return cookie ? decodeURIComponent(cookie.substring(name.length + 1)) : ""
-}
-
-const handleFetchErrors = response => {
-    if (!response.ok) {
-        throw response
-    }
-    return response
-}
-
-export const get = (url, params = {}) => {
-    const csrfToken = getCookie("csrftoken")
-    const queryString = Object.keys(params)
-        .map(
-            key =>
-                `${encodeURIComponent(key)}=${encodeURIComponent(params[key])}`
-        )
-        .join("&")
-    if (queryString.length) {
-        url = `${url}?${queryString}`
-    }
-    return fetch(url, {
-        method: "GET",
-        headers: {
-            "X-CSRFToken": csrfToken,
-            Accept: "application/json",
-            "X-Requested-With": "XMLHttpRequest"
-        },
-        credentials: "include"
-    }).then(handleFetchErrors)
-}
-
-export const post = (url, object = {}, files = {}) => {
-    const csrfToken = getCookie("csrftoken")
-    const fetchOptions = {
-        method: "POST",
-        headers: {
-            "X-CSRFToken": csrfToken,
-            Accept: "application/json",
-            "X-Requested-With": "XMLHttpRequest"
-        },
-        credentials: "include"
-    }
-
-    if (Object.keys(files).length) {
-        const body = new FormData()
-        body.append("csrfmiddlewaretoken", csrfToken)
-        body.append("json", JSON.stringify(object))
-        Object.keys(files).forEach(key => {
-            const value = files[key]
-            if (typeof value === "object" && value.file && value.filename) {
-                body.append(key, value.file, value.filename)
-            } else if (Array.isArray(value)) {
-                value.forEach(item => body.append(`${key}[]`, item))
-            } else {
-                body.append(key, value)
-            }
-        })
-        fetchOptions.body = body
-    } else {
-        fetchOptions.headers["Content-Type"] = "application/json"
-        fetchOptions.body = JSON.stringify(object)
-    }
-
-    return fetch(url, fetchOptions).then(handleFetchErrors)
-}
-
-export const postJson = (url, object = {}, files = {}) =>
-    post(url, object, files).then(response =>
-        response.json().then(json => ({json, status: response.status}))
-    )

package/src/common/text.js

@@ -1,44 +0,0 @@
-export const escapeText = text => {
-    if (typeof text !== "string") {
-        return String(text)
-    }
-    return text
-        .replace(/&/g, "&")
-        .replace(/</g, "&lt;")
-        .replace(/>/g, "&gt;")
-        .replace(/"/g, "&quot;")
-        .replace(
-            /[^\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]/g,
-            ""
-        ) // invalid in XML chars
-}
-
-export const unescapeText = text =>
-    text
-        .replace(/&lt;/g, "<")
-        .replace(/&gt;/g, ">")
-        .replace(/&quot;/g, '"')
-        .replace(/&amp;/g, "&")
-
-/**
- * Turn string literals into single line, removing spaces at start of line
- */
-export const noSpaceTmp = (strings, ...values) => {
-    const tmpStrings = Array.from(strings)
-
-    let combined = ""
-    while (tmpStrings.length > 0 || values.length > 0) {
-        if (tmpStrings.length > 0) {
-            combined += tmpStrings.shift()
-        }
-        if (values.length > 0) {
-            combined += values.shift()
-        }
-    }
-
-    let out = ""
-    combined.split("\n").forEach(line => {
-        out += line.replace(/^\s*/g, "")
-    })
-    return out
-}