@fiduswriter/document 0.1.0-alpha.1

package/jest.config.js

@@ -0,0 +1,23 @@
+export default {
+    rootDir: ".",
+    testEnvironment: "node",
+    transform: {},
+    moduleDirectories: ["node_modules"],
+    moduleNameMapper: {
+        "^downloadjs$": "<rootDir>/test/exporter/mocks/downloadjs.js",
+        "^mathlive$": "<rootDir>/test/exporter/mocks/mathlive.js",
+        "^mathml2omml$": "<rootDir>/test/exporter/mocks/mathml2omml.js",
+        "^@vivliostyle/print$": "<rootDir>/test/exporter/mocks/vivliostyle.js",
+        "^pretty$": "<rootDir>/test/exporter/mocks/pretty.js",
+        "^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",
+        "^@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"
+    },
+    testMatch: ["<rootDir>/test/**/*.test.js"],
+    setupFiles: ["<rootDir>/test/setup.js"],
+    moduleFileExtensions: ["js", "mjs", "json"]
+}

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@fiduswriter/document",
+  "version": "0.1.0-alpha.1",
+  "description": "Fidus Writer document schema, importers and exporters",
+  "repository": {
+    "type": "git",
+    "url": "ssh://git@codeberg.org/fiduswriter/fiduswriter-document.git"
+  },
+  "license": "AGPL-3.0",
+  "author": "Johannes Wilm",
+  "type": "module",
+  "exports": {
+    ".": "./src/index.js",
+    "./schema": "./src/schema/index.js",
+    "./schema/*": "./src/schema/*",
+    "./importer/*": "./src/importer/*",
+    "./exporter/*": "./src/exporter/*",
+    "./citations/*": "./src/citations/*",
+    "./bibliography/*": "./src/bibliography/*",
+    "./common": "./src/common/index.js",
+    "./common/*": "./src/common/*"
+  },
+  "main": "jest.config.js",
+  "directories": {
+    "test": "test"
+  },
+  "files": [
+    "src/",
+    "scripts/",
+    "schema.json",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build-schema": "node scripts/export-schema.js",
+    "prepare": "node scripts/export-schema.js",
+    "prepublishOnly": "node scripts/export-schema.js",
+    "test": "node --experimental-vm-modules node_modules/jest/bin/jest.js --config jest.config.js"
+  },
+  "dependencies": {
+    "biblatex-csl-converter": "^3.0.0",
+    "downloadjs": "^1.4.7",
+    "fast-deep-equal": "^3.1.3",
+    "fast-xml-parser": "^4.5.0",
+    "jszip": "^3.10.1",
+    "mathlive": "^0.104.0",
+    "mathml-to-latex": "^1.4.3",
+    "mathml2omml": "^0.5.0",
+    "orderedmap": "^2.1.1",
+    "pretty": "^2.0.0",
+    "prosemirror-model": "^1.25.0",
+    "prosemirror-schema-basic": "^1.2.4",
+    "prosemirror-tables": "^1.6.4",
+    "@vivliostyle/print": "^2.42.0"
+  },
+  "devDependencies": {
+    "jest": "^29.7.0"
+  }
+}

package/schema.json

@@ -0,0 +1 @@
+{"nodes":{"doc":{"content":"title part*","selectable":false,"allowGapCursor":false,"attrs":{"documentstyle":{"default":""},"tracked":{"default":false},"citationstyle":{"default":"apa"},"citationstyles":{"default":["american-anthropological-association","apa","chicago-author-date","chicago-note-bibliography","harvard-cite-them-right","modern-language-association","nature","oxford-university-press-humsoc"]},"language":{"default":"en-US"},"languages":{"default":["af-ZA","sq-AL","ar","ast","be","br","bg","ca","ca-ES-Valencia","zh-CN","da","nl","en-AU","en-CA","en-NZ","en-ZA","en-GB","en-US","eo","fr","gl","de-DE","de-AU","de-CH","el","he","is","it","ja","km","lt","ml","nb-NO","nn-NO","fa","pl","pt-BR","pt-PT","ro","ru","tr","sr-SP-Cy","sr-SP-Lt","sk","sl","es","sv","ta","tl","uk"]},"papersize":{"default":"A4"},"papersizes":{"default":["A4","US Letter"]},"footnote_marks":{"default":["strong","em","link"]},"footnote_elements":{"default":["paragraph","heading1","heading2","heading3","heading4","heading5","heading6","figure","ordered_list","bullet_list","horizontal_rule","equation","citation","cross_reference","blockquote","table"]},"bibliography_header":{"default":{}},"template":{"default":""},"import_id":{"default":""},"copyright":{"default":{"holder":false,"year":false,"freeToRead":true,"licenses":[]}},"code_categories":{"default":{"listing":{"counter":0,"enabled":true},"example":{"counter":0,"enabled":true},"snippet":{"counter":0,"enabled":false},"tutorial":{"counter":0,"enabled":false},"exercise":{"counter":0,"enabled":false},"exercise_solution":{"counter":0,"enabled":false}}},"code_languages":{"default":["javascript","python","java","cpp","c","csharp","php","ruby","go","rust","swift","kotlin","typescript","html","css","sql","bash","shell","r","matlab","scala","perl","lua","haskell","xml","json","yaml","markdown"]},"id_types":{"default":[]}},"parseDOM":[{"tag":"div.doc"}]},"richtext_part":{"content":"block+","group":"part","marks":"annotation track","isolating":true,"attrs":{"title":{"default":""},"id":{"default":""},"locking":{"default":false},"language":{"default":false},"optional":{"default":false},"hidden":{"default":false},"help":{"default":false},"initial":{"default":false},"deleted":{"default":false},"elements":{"default":["paragraph","heading1","heading2","heading3","heading4","heading5","heading6","code_block","figure","ordered_list","bullet_list","horizontal_rule","equation","citation","cross_reference","blockquote","footnote","table"]},"marks":{"default":["strong","em","link","anchor","sup","sub","code"]},"metadata":{"default":false}},"parseDOM":[{"tag":"div.doc-richtext"}]},"heading_part":{"content":"heading","group":"part","marks":"annotation track","isolating":true,"attrs":{"title":{"default":""},"id":{"default":""},"locking":{"default":false},"language":{"default":false},"optional":{"default":false},"hidden":{"default":false},"help":{"default":false},"initial":{"default":false},"deleted":{"default":false},"elements":{"default":["heading1"]},"marks":{"default":["strong","em","link","anchor","sup","sub","code"]},"metadata":{"default":false}},"parseDOM":[{"tag":"div.doc-heading"}]},"contributors_part":{"content":"contributor*","group":"part","marks":"annotation track","isolating":true,"attrs":{"title":{"default":""},"id":{"default":""},"locking":{"default":false},"language":{"default":false},"optional":{"default":false},"hidden":{"default":false},"help":{"default":false},"initial":{"default":false},"deleted":{"default":false},"item_title":{"default":"Contributor"},"metadata":{"default":false}},"parseDOM":[{"tag":"div.doc-contributors"}]},"tags_part":{"content":"tag*","group":"part","marks":"annotation track","isolating":true,"attrs":{"title":{"default":""},"id":{"default":""},"locking":{"default":false},"language":{"default":false},"optional":{"default":false},"hidden":{"default":false},"help":{"default":false},"initial":{"default":false},"deleted":{"default":false},"item_title":{"default":"Tag"},"metadata":{"default":false}},"parseDOM":[{"tag":"div.doc-tags"}]},"table_part":{"content":"table","group":"part","marks":"annotation track","isolating":true,"attrs":{"title":{"default":""},"id":{"default":""},"locking":{"default":false},"language":{"default":false},"optional":{"default":false},"hidden":{"default":false},"help":{"default":false},"initial":{"default":false},"deleted":{"default":false},"elements":{"default":["paragraph","heading1","heading2","heading3","heading4","heading5","heading6","code_block","figure","ordered_list","bullet_list","horizontal_rule","equation","citation","blockquote","footnote"]},"marks":{"default":["strong","em","link","anchor","sup","sub","code"]}},"parseDOM":[{"tag":"div.doc-table"}]},"table_of_contents":{"group":"part","marks":"annotation track","defining":true,"parseDOM":[{"tag":"div.table-of-contents"}],"attrs":{"title":{"default":"Table of Contents"},"id":{"default":"toc"},"optional":{"default":false},"hidden":{"default":false}}},"separator_part":{"marks":"annotation track","group":"part","defining":true,"attrs":{"id":{"default":"separator"}},"parseDOM":[{"tag":"hr.doc-separator_part"}]},"title":{"content":"text*","marks":"annotation track","group":"fixedpart","defining":true,"isolating":true,"attrs":{"id":{"default":"title"}},"parseDOM":[{"tag":"div.doc-title"}]},"contributor":{"inline":true,"draggable":true,"attrs":{"firstname":{"default":false},"lastname":{"default":false},"email":{"default":false},"institution":{"default":false},"id_type":{"default":false},"id_value":{"default":false}},"parseDOM":[{"tag":"span.contributor"}]},"tag":{"inline":true,"draggable":true,"attrs":{"tag":{"default":""}},"parseDOM":[{"tag":"span.tag"}]},"paragraph":{"group":"block","content":"inline*","attrs":{"track":{"default":[]}},"parseDOM":[{"tag":"p"}]},"blockquote":{"content":"block+","group":"block","attrs":{"track":{"default":[]}},"marks":"annotation","defining":true,"parseDOM":[{"tag":"blockquote"}]},"horizontal_rule":{"group":"block","attrs":{"track":{"default":[]}},"parseDOM":[{"tag":"hr"}]},"figure":{"inline":false,"allowGapCursor":false,"selectable":true,"group":"block","attrs":{"category":{"default":"none"},"caption":{"default":false},"id":{"default":false},"track":{"default":[]},"aligned":{"default":"center"},"width":{"default":"100"}},"content":"figure_caption image|figure_caption figure_equation|image figure_caption|figure_equation figure_caption","parseDOM":[{"tag":"figure"}]},"image":{"selectable":false,"draggable":false,"attrs":{"image":{"default":false}},"parseDOM":[{"tag":"img"}]},"figure_equation":{"selectable":false,"draggable":false,"attrs":{"equation":{"default":false}},"parseDOM":[{"tag":"div.figure-equation[data-equation]"}]},"figure_caption":{"isolating":true,"defining":true,"content":"inline*","parseDOM":[{"tag":"figcaption span.text"}]},"heading1":{"group":"block heading","content":"inline*","marks":"_","defining":true,"attrs":{"id":{"default":false},"track":{"default":[]}},"parseDOM":[{"tag":"h1"}]},"heading2":{"group":"block heading","content":"inline*","marks":"_","defining":true,"attrs":{"id":{"default":false},"track":{"default":[]}},"parseDOM":[{"tag":"h2"}]},"heading3":{"group":"block heading","content":"inline*","marks":"_","defining":true,"attrs":{"id":{"default":false},"track":{"default":[]}},"parseDOM":[{"tag":"h3"}]},"heading4":{"group":"block heading","content":"inline*","marks":"_","defining":true,"attrs":{"id":{"default":false},"track":{"default":[]}},"parseDOM":[{"tag":"h4"}]},"heading5":{"group":"block heading","content":"inline*","marks":"_","defining":true,"attrs":{"id":{"default":false},"track":{"default":[]}},"parseDOM":[{"tag":"h5"}]},"heading6":{"group":"block heading","content":"inline*","marks":"_","defining":true,"attrs":{"id":{"default":false},"track":{"default":[]}},"parseDOM":[{"tag":"h6"}]},"code_block":{"content":"text*","marks":"_","group":"block","code":true,"defining":true,"attrs":{"track":{"default":[]},"language":{"default":""},"category":{"default":""},"title":{"default":""},"id":{"default":""}},"parseDOM":[{"tag":"pre","preserveWhitespace":"full"}]},"text":{"group":"inline"},"hard_break":{"inline":true,"group":"inline","selectable":false,"parseDOM":[{"tag":"br"}]},"citation":{"inline":true,"group":"inline","attrs":{"format":{"default":"autocite"},"references":{"default":[]}},"parseDOM":[{"tag":"span.citation"}]},"equation":{"inline":true,"group":"inline","attrs":{"equation":{"default":""}},"parseDOM":[{"tag":"span.equation"}]},"cross_reference":{"inline":true,"group":"inline","attrs":{"id":{"default":false},"title":{"default":null}},"parseDOM":[{"tag":"span.cross-reference[data-id][data-title]"}]},"footnote":{"inline":true,"group":"inline","attrs":{"footnote":{"default":[{"type":"paragraph"}]}},"parseDOM":[{"tag":"span.footnote-marker[data-footnote]"}]},"ordered_list":{"group":"block","content":"list_item+","attrs":{"id":{"default":false},"order":{"default":1},"track":{"default":[]}},"parseDOM":[{"tag":"ol"}]},"bullet_list":{"group":"block","content":"list_item+","attrs":{"id":{"default":false},"track":{"default":[]}},"parseDOM":[{"tag":"ul"}]},"list_item":{"content":"block+","marks":"annotation","attrs":{"track":{"default":[]}},"parseDOM":[{"tag":"li"}],"defining":true},"table":{"inline":false,"group":"block","tableRole":"table","attrs":{"id":{"default":false},"track":{"default":[]},"width":{"default":"100"},"aligned":{"default":"center"},"layout":{"default":"fixed"},"category":{"default":"none"},"caption":{"default":false}},"content":"table_caption table_body","parseDOM":[{"tag":"table"}]},"table_caption":{"content":"inline*","parseDOM":[{"tag":"caption span.text"}]},"table_body":{"content":"table_row+","tableRole":"table","isolating":true,"parseDOM":[{"tag":"tbody"}]},"table_row":{"content":"(table_cell | table_header)+","tableRole":"row","parseDOM":[{"tag":"tr"}]},"table_cell":{"marks":"annotation","content":"block+","attrs":{"colspan":{"default":1,"validate":"number"},"rowspan":{"default":1,"validate":"number"},"colwidth":{"default":null}},"tableRole":"cell","isolating":true,"parseDOM":[{"tag":"td"}]},"table_header":{"marks":"annotation","content":"block+","attrs":{"colspan":{"default":1,"validate":"number"},"rowspan":{"default":1,"validate":"number"},"colwidth":{"default":null}},"tableRole":"header_cell","isolating":true,"parseDOM":[{"tag":"th"}]}},"marks":{"em":{"parseDOM":[{"tag":"i"},{"tag":"em"},{"style":"font-style=italic"},{"style":"font-style=normal"}]},"strong":{"parseDOM":[{"tag":"strong"},{"tag":"b"},{"style":"font-weight=400"},{"style":"font-weight"}]},"link":{"attrs":{"href":{},"title":{"default":""}},"inclusive":false,"parseDOM":[{"tag":"a[href]"}]},"underline":{"parseDOM":[{"tag":"span.underline"}]},"sup":{"parseDOM":[{"tag":"sup"}],"excludes":"sub"},"sub":{"parseDOM":[{"tag":"sub"}],"excludes":"sup"},"code":{"parseDOM":[{"tag":"code"}],"excludes":"strong em underline link sup sub"},"comment":{"attrs":{"id":{"default":false}},"inclusive":false,"excludes":"","group":"annotation","parseDOM":[{"tag":"span.comment[data-id]"}]},"annotation_tag":{"attrs":{"type":{"default":""},"key":{"default":""},"value":{"default":""}},"inclusive":false,"excludes":"","group":"annotation","parseDOM":[{"tag":"span.annotation-tag[data-type]"}]},"anchor":{"attrs":{"id":{"default":false}},"inclusive":false,"group":"annotation","parseDOM":[{"tag":"span.anchor[data-id]"}]},"deletion":{"attrs":{"user":{"default":0},"username":{"default":""},"date":{"default":0}},"inclusive":false,"group":"track","parseDOM":[{"tag":"span.deletion"}]},"insertion":{"attrs":{"user":{"default":0},"username":{"default":""},"date":{"default":0},"approved":{"default":true}},"inclusive":false,"group":"track","parseDOM":[{"tag":"span.insertion"},{"tag":"span.approved-insertion"}]},"format_change":{"attrs":{"user":{"default":0},"username":{"default":""},"date":{"default":0},"before":{"default":[]},"after":{"default":[]}},"inclusive":false,"group":"track","parseDOM":[{"tag":"span.format-change"}]}}}

package/scripts/export-schema.js

@@ -0,0 +1,16 @@
+// Generate a JSON serialization of the Fidus Writer document schema.
+// This script is run by the package's prepare/prepublishOnly scripts.
+import {writeFileSync} from "node:fs"
+import {dirname, join} from "node:path"
+import {fileURLToPath} from "node:url"
+
+import {SchemaExport} from "../src/schema/export.js"
+
+const __dirname = dirname(fileURLToPath(import.meta.url))
+const outPath = join(__dirname, "..", "schema.json")
+
+const exporter = new SchemaExport()
+const json = exporter.init()
+
+writeFileSync(outPath, json)
+console.log(`Wrote schema.json (${json.length} bytes)`)

package/src/bibliography/common.js

@@ -0,0 +1,92 @@
+export const text = {
+    group: "inline"
+}
+
+export const literal = {
+    content: "inline*",
+    marks: "_",
+    parseDOM: [{tag: "div.literal"}],
+    toDOM() {
+        return [
+            "div",
+            {
+                class: "literal"
+            },
+            0
+        ]
+    }
+}
+
+export const variable = {
+    inline: true,
+    group: "inline",
+    attrs: {
+        variable: {default: ""}
+    },
+    parseDOM: [
+        {
+            tag: "span[data-variable]",
+            getAttrs(dom) {
+                return {
+                    variable: dom.getAttribute("data-variable")
+                }
+            }
+        }
+    ],
+    toDOM(node) {
+        return [
+            "span",
+            {"data-variable": node.attrs.variable},
+            node.attrs.variable
+        ]
+    }
+}
+
+export const sup = {
+    parseDOM: [
+        {tag: "sup"},
+        {style: "vertical-align", getAttrs: value => value == "super" && null}
+    ],
+    toDOM() {
+        return ["sup"]
+    }
+}
+
+export const sub = {
+    parseDOM: [
+        {tag: "sub"},
+        {style: "vertical-align", getAttrs: value => value == "sub" && null}
+    ],
+    toDOM() {
+        return ["sub"]
+    }
+}
+
+export const smallcaps = {
+    parseDOM: [
+        {tag: "span.smallcaps"},
+        {
+            style: "font-variant",
+            getAttrs: value => value == "small-caps" && null
+        }
+    ],
+    toDOM() {
+        return ["span", {class: "smallcaps"}]
+    }
+}
+
+//Currently unsupported
+
+export const url = {
+    parseDOM: [{tag: "span.url"}],
+    toDOM() {
+        return ["span", {class: "url"}]
+    }
+}
+
+export const enquote = {
+    parseDOM: [{tag: "span.enquote"}],
+    toDOM() {
+        return ["span", {class: "enquote"}]
+    }
+}

package/src/bibliography/csl_bib.js

@@ -0,0 +1,139 @@
+import {Schema} from "prosemirror-model"
+import {marks} from "prosemirror-schema-basic"
+import {smallcaps, sub, sup, text} from "./common.js"
+
+const doc = {content: "cslbib"}
+
+const cslbib = {
+    content: "cslentry*",
+    parseDOM: [{tag: "div.csl-bib-body"}],
+    toDOM(_node) {
+        return [
+            "div",
+            {
+                class: "csl-bib-body"
+            },
+            0
+        ]
+    }
+}
+
+const cslentry = {
+    content: "block*",
+    parseDOM: [{tag: "div.csl-entry"}],
+    toDOM(_node) {
+        return [
+            "div",
+            {
+                class: "csl-entry"
+            },
+            0
+        ]
+    }
+}
+
+// This block doesn't actually appear in the HTML output, but because the schema
+// system doesn't allow for the mixing of inline and block content, it "imagines"
+// that this block exists. This---rather than other blocks---is chosen, because
+// it's the first in the list.
+const cslinline = {
+    group: "block",
+    content: "text*",
+    marks: "_",
+    parseDOM: [{tag: "div.csl-inline"}],
+    toDOM(_node) {
+        return [
+            "div",
+            {
+                class: "csl-inline"
+            },
+            0
+        ]
+    }
+}
+
+const cslblock = {
+    group: "block",
+    content: "text*",
+    marks: "_",
+    parseDOM: [{tag: "div.csl-block"}],
+    toDOM(_node) {
+        return [
+            "div",
+            {
+                class: "csl-block"
+            },
+            0
+        ]
+    }
+}
+
+const cslleftmargin = {
+    group: "block",
+    content: "text*",
+    marks: "_",
+    parseDOM: [{tag: "div.csl-left-margin"}],
+    toDOM(_node) {
+        return [
+            "div",
+            {
+                class: "csl-left-margin"
+            },
+            0
+        ]
+    }
+}
+
+const cslrightinline = {
+    group: "block",
+    content: "text*",
+    marks: "_",
+    parseDOM: [{tag: "div.csl-right-inline"}],
+    toDOM(_node) {
+        return [
+            "div",
+            {
+                class: "csl-right-inline"
+            },
+            0
+        ]
+    }
+}
+
+const cslindent = {
+    group: "block",
+    content: "text*",
+    marks: "_",
+    parseDOM: [{tag: "div.csl-indent"}],
+    toDOM(_node) {
+        return [
+            "div",
+            {
+                class: "csl-indent"
+            },
+            0
+        ]
+    }
+}
+
+// A schema to express the citeproc HTML bibliography output
+export const cslBibSchema = new Schema({
+    nodes: {
+        doc,
+        cslbib,
+        cslentry,
+        cslinline,
+        cslblock,
+        cslleftmargin,
+        cslrightinline,
+        cslindent,
+        text
+    },
+    marks: {
+        em: marks.em,
+        strong: marks.strong,
+        smallcaps,
+        sup,
+        sub
+    }
+})

package/src/citations/citeproc_sys.js

@@ -0,0 +1,42 @@
+/* Connects Fidus Writer citation system with citeproc */
+import {CSLExporter} from "biblatex-csl-converter"
+
+export class citeprocSys {
+    constructor(bibDB) {
+        this.bibDB = bibDB
+        this.abbreviations = {
+            default: {}
+        }
+        this.abbrevsname = "default"
+        // We cache values retrieved once.
+        this.items = {}
+        this.missingItems = []
+    }
+
+    retrieveItem(id) {
+        if (!this.items[id]) {
+            if (this.bibDB.db[id]) {
+                const cslGetter = new CSLExporter(this.bibDB.db, [id])
+                const cslOutput = cslGetter.parse()
+                Object.assign(this.items, cslOutput)
+            } else {
+                this.missingItems.push(id)
+                this.items[id] = {author: [{literal: ""}], type: "article", id}
+            }
+        }
+        return this.items[id]
+    }
+
+    getAbbreviation(_dummy, obj, _jurisdiction, vartype, key) {
+        try {
+            if (this.abbreviations[this.abbrevsname][vartype][key]) {
+                obj["default"][vartype][key] =
+                    this.abbreviations[this.abbrevsname][vartype][key]
+            } else {
+                obj["default"][vartype][key] = ""
+            }
+        } catch (_error) {
+            // There is breakage here that needs investigating.
+        }
+    }
+}

package/src/citations/format.js

@@ -0,0 +1,194 @@
+import {escapeText} from "../common/index.js"
+import {citeprocSys} from "./citeproc_sys.js"
+/*
+ * Use CSL and bibDB to format all citations for the given prosemirror json citation nodes
+ */
+
+export class FormatCitations {
+    constructor(
+        csl,
+        allCitationInfos,
+        citationStyle,
+        bibliographyHeader,
+        bibDB,
+        synchronous = false,
+        lang = "en-US"
+    ) {
+        this.csl = csl
+        this.allCitationInfos = allCitationInfos
+        this.citationStyle = citationStyle
+        this.bibliographyHeader = bibliographyHeader
+        this.bibDB = bibDB
+        this.synchronous = synchronous
+        this.lang = lang
+    }
+
+    init() {
+        this.bibliography = false
+        this.citations = []
+        this.bibFormats = []
+        this.citationTexts = []
+        this.citationType = ""
+        this.formatAllCitations()
+        return this.getFormattedCitations()
+    }
+
+    formatAllCitations() {
+        this.allCitationInfos.forEach(cInfo => {
+            this.bibFormats.push(cInfo.format)
+            this.citations.push({
+                citationItems: cInfo.references,
+                properties: {
+                    noteIndex: this.bibFormats.length
+                }
+            })
+        })
+    }
+
+    get bibHTML() {
+        if (!this.bibliography || !this.bibliography[0].entry_ids.length) {
+            return ""
+        }
+        const bib = this.bibliography,
+            bibHTML = bib[0].bibstart + bib[1].join("") + bib[0].bibend
+        return `<h1 class="doc-bibliography-header">${escapeText(this.bibliographyHeader)}</h1>${bibHTML}`
+    }
+
+    // CSS
+    get bibCSS() {
+        if (!this.bibliography || !this.bibliography[0].entry_ids.length) {
+            return ""
+        }
+        const bibInfo = this.bibliography[0]
+        let css = "\n"
+        css += `.csl-entry {padding-bottom: ${bibInfo.entryspacing + 1}em;}\n`
+        css += `.csl-bib-body {line-height: ${bibInfo.linespacing};}\n`
+        if (bibInfo.hangingindent) {
+            css += `
+                    .csl-entry {
+                        text-indent: -0.5in;
+                        padding-left: 0.5in;
+                    }\n`
+        } else if (bibInfo["second-field-align"] === "margin") {
+            css += `
+                    .csl-left-margin {
+                        text-indent: -${bibInfo.maxoffset}ch;
+                        width: ${bibInfo.maxoffset}ch;
+                    }
+                `
+        } else if (bibInfo["second-field-align"] === "flush") {
+            css += `
+                    .csl-left-margin {
+                        width: ${bibInfo.maxoffset}ch;
+                    }
+                `
+        }
+        return css
+    }
+
+    reloadCitations(missingItems) {
+        // Not all citations could be found in the database.
+        // Reload the database if possible, but don't cycle if no new matches are found.
+        if (!this.bibDB.getDB) {
+            return Promise.resolve()
+        }
+
+        return this.bibDB.getDB().then(() => {
+            if (missingItems.some(item => this.bibDB.db.hasOwnProperty(item))) {
+                return this.init()
+            } else {
+                return Promise.resolve()
+            }
+        })
+    }
+
+    getFormattedCitations() {
+        const citeprocConnector = new citeprocSys(this.bibDB)
+        if (this.synchronous) {
+            const citeprocInstance = this.csl.getEngineSync(
+                citeprocConnector,
+                this.citationStyle,
+                this.lang
+            )
+            if (!citeprocInstance) {
+                return false
+            }
+            this.process(citeprocInstance)
+            return true
+        } else {
+            return this.csl
+                .getEngine(citeprocConnector, this.citationStyle, this.lang)
+                .then(citeprocInstance => {
+                    this.process(citeprocInstance)
+                    if (citeprocConnector.missingItems.length > 0) {
+                        return this.reloadCitations(
+                            citeprocConnector.missingItems
+                        )
+                    } else {
+                        return Promise.resolve()
+                    }
+                })
+        }
+    }
+
+    process(citeprocInstance) {
+        const allIds = []
+        this.citations.forEach(cit =>
+            cit.citationItems.forEach(item => allIds.push(String(item.id)))
+        )
+        citeprocInstance.updateItems(allIds)
+
+        const inText = citeprocInstance.cslXml.dataObj.attrs.class === "in-text"
+        const len = this.citations.length
+        for (let i = 0; i < len; i++) {
+            const citation = this.citations[i],
+                citationTexts = citeprocInstance.appendCitationCluster(
+                    citation,
+                    true
+                )
+            if (inText && "textcite" == this.bibFormats[i]) {
+                const items = citation.citationItems
+                let newCiteText = ""
+
+                for (let j = 0; j < items.length; j++) {
+                    const onlyNameOption = [
+                        {
+                            id: items[j].id,
+                            "author-only": 1
+                        }
+                    ]
+
+                    const onlyDateOption = [
+                        {
+                            id: items[j].id,
+                            "suppress-author": 1
+                        }
+                    ]
+
+                    if (items[j].locator) {
+                        onlyDateOption[0].locator = items[j].locator
+                    }
+
+                    if (items[j].prefix) {
+                        onlyDateOption[0].prefix = items[j].prefix
+                    }
+
+                    if (0 < j) {
+                        newCiteText +=
+                            citeprocInstance.citation.opt.layout_delimiter ||
+                            "; "
+                    }
+                    newCiteText += `${citeprocInstance.makeCitationCluster(onlyNameOption)} ${citeprocInstance.makeCitationCluster(onlyDateOption)}`
+                }
+                citationTexts.find(citationText => citationText[0] === i)[1] =
+                    newCiteText
+            }
+            citationTexts.forEach(
+                ([index, citationText]) =>
+                    (this.citationTexts[index] = citationText)
+            )
+        }
+        this.citationType = citeprocInstance.cslXml.dataObj.attrs.class
+        this.bibliography = citeprocInstance.makeBibliography()
+    }
+}

package/src/common/blob.js

@@ -0,0 +1,10 @@
+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

@@ -0,0 +1,25 @@
+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

@@ -0,0 +1,12 @@
+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 = () => {}