@fiduswriter/document 0.1.0-alpha.2 → 0.1.0-alpha.4

package/README.md

@@ -7,7 +7,22 @@ This package contains the Fidus Writer document schema, importers and exporters.
 ```javascript
 import {docSchema, FW_DOCUMENT_VERSION} from "@fiduswriter/document/schema"
 import {DocxConvert} from "@fiduswriter/document/importer/docx/convert.js"
-import {ExportFidusFile} from "@fiduswriter/document/exporter/native/file.js"
+import {DOCXExporter} from "@fiduswriter/document/exporter/docx/index.js"
+```
+
+## TypeScript
+
+The package is being migrated to TypeScript. New source files are written in
+`.ts`, compiled to `dist/` on build, and published with matching `.d.ts`
+declarations. The public import paths remain unchanged.
+
+## Development
+
+```bash
+npm install
+npm run build      # compile TypeScript to dist/
+npm run typecheck  # run tsc --noEmit
+npm test           # run the Jest test suite
 ```
 
 ## Dependencies
@@ -18,3 +33,9 @@ import {ExportFidusFile} from "@fiduswriter/document/exporter/native/file.js"
 
 A JSON serialization of the schema is exported as `schema.json` and regenerated
 by the `prepare` / `prepublishOnly` scripts.
+
+## Tests
+
+The test suite includes round-trip tests that import real DOCX files, run them
+through the exporters, and validate that the generated output files contain the
+required ZIP entries and well-formed XML.

package/dist/bibliography/common.d.ts

@@ -0,0 +1,92 @@
+export namespace text {
+    let group: string;
+}
+export namespace literal {
+    let content: string;
+    let marks: string;
+    let parseDOM: {
+        tag: string;
+    }[];
+    function toDOM(): (string | number | {
+        class: string;
+    })[];
+}
+export namespace variable {
+    export let inline: boolean;
+    let group_1: string;
+    export { group_1 as group };
+    export namespace attrs {
+        namespace variable {
+            let _default: string;
+            export { _default as default };
+        }
+    }
+    let parseDOM_1: {
+        tag: string;
+        getAttrs(dom: any): {
+            variable: any;
+        };
+    }[];
+    export { parseDOM_1 as parseDOM };
+    export function toDOM(node: any): any[];
+}
+export namespace sup {
+    let parseDOM_2: ({
+        tag: string;
+        style?: undefined;
+        getAttrs?: undefined;
+    } | {
+        style: string;
+        getAttrs: (value: any) => false | null;
+        tag?: undefined;
+    })[];
+    export { parseDOM_2 as parseDOM };
+    export function toDOM(): string[];
+}
+export namespace sub {
+    let parseDOM_3: ({
+        tag: string;
+        style?: undefined;
+        getAttrs?: undefined;
+    } | {
+        style: string;
+        getAttrs: (value: any) => false | null;
+        tag?: undefined;
+    })[];
+    export { parseDOM_3 as parseDOM };
+    export function toDOM(): string[];
+}
+export namespace smallcaps {
+    let parseDOM_4: ({
+        tag: string;
+        style?: undefined;
+        getAttrs?: undefined;
+    } | {
+        style: string;
+        getAttrs: (value: any) => false | null;
+        tag?: undefined;
+    })[];
+    export { parseDOM_4 as parseDOM };
+    export function toDOM(): (string | {
+        class: string;
+    })[];
+}
+export namespace url {
+    let parseDOM_5: {
+        tag: string;
+    }[];
+    export { parseDOM_5 as parseDOM };
+    export function toDOM(): (string | {
+        class: string;
+    })[];
+}
+export namespace enquote {
+    let parseDOM_6: {
+        tag: string;
+    }[];
+    export { parseDOM_6 as parseDOM };
+    export function toDOM(): (string | {
+        class: string;
+    })[];
+}
+//# sourceMappingURL=common.d.ts.map

package/dist/bibliography/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/bibliography/common.js"],"names":[],"mappings":";;;;;;;;;IAQI;;SAQC;;;;;;;;;;;;;;;;;;;IAmBD,wCAMC;;;;;;;;;;;;;IAQD,kCAEC;;;;;;;;;;;;;IAQD,kCAEC;;;;;;;;;;;;;IAWD;;SAEC;;;;;;;IAOD;;SAEC;;;;;;;IAKD;;SAEC"}

package/dist/bibliography/common.js

@@ -0,0 +1,85 @@
+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" }];
+    }
+};
+//# sourceMappingURL=common.js.map

package/dist/bibliography/common.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../src/bibliography/common.js"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,IAAI,GAAG;IAChB,KAAK,EAAE,QAAQ;CAClB,CAAA;AAED,MAAM,CAAC,MAAM,OAAO,GAAG;IACnB,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,GAAG;IACV,QAAQ,EAAE,CAAC,EAAC,GAAG,EAAE,aAAa,EAAC,CAAC;IAChC,KAAK;QACD,OAAO;YACH,KAAK;YACL;gBACI,KAAK,EAAE,SAAS;aACnB;YACD,CAAC;SACJ,CAAA;IACL,CAAC;CACJ,CAAA;AAED,MAAM,CAAC,MAAM,QAAQ,GAAG;IACpB,MAAM,EAAE,IAAI;IACZ,KAAK,EAAE,QAAQ;IACf,KAAK,EAAE;QACH,QAAQ,EAAE,EAAC,OAAO,EAAE,EAAE,EAAC;KAC1B;IACD,QAAQ,EAAE;QACN;YACI,GAAG,EAAE,qBAAqB;YAC1B,QAAQ,CAAC,GAAG;gBACR,OAAO;oBACH,QAAQ,EAAE,GAAG,CAAC,YAAY,CAAC,eAAe,CAAC;iBAC9C,CAAA;YACL,CAAC;SACJ;KACJ;IACD,KAAK,CAAC,IAAI;QACN,OAAO;YACH,MAAM;YACN,EAAC,eAAe,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAC;YACtC,IAAI,CAAC,KAAK,CAAC,QAAQ;SACtB,CAAA;IACL,CAAC;CACJ,CAAA;AAED,MAAM,CAAC,MAAM,GAAG,GAAG;IACf,QAAQ,EAAE;QACN,EAAC,GAAG,EAAE,KAAK,EAAC;QACZ,EAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,IAAI,OAAO,IAAI,IAAI,EAAC;KACzE;IACD,KAAK;QACD,OAAO,CAAC,KAAK,CAAC,CAAA;IAClB,CAAC;CACJ,CAAA;AAED,MAAM,CAAC,MAAM,GAAG,GAAG;IACf,QAAQ,EAAE;QACN,EAAC,GAAG,EAAE,KAAK,EAAC;QACZ,EAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,IAAI,KAAK,IAAI,IAAI,EAAC;KACvE;IACD,KAAK;QACD,OAAO,CAAC,KAAK,CAAC,CAAA;IAClB,CAAC;CACJ,CAAA;AAED,MAAM,CAAC,MAAM,SAAS,GAAG;IACrB,QAAQ,EAAE;QACN,EAAC,GAAG,EAAE,gBAAgB,EAAC;QACvB;YACI,KAAK,EAAE,cAAc;YACrB,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC,KAAK,IAAI,YAAY,IAAI,IAAI;SACnD;KACJ;IACD,KAAK;QACD,OAAO,CAAC,MAAM,EAAE,EAAC,KAAK,EAAE,WAAW,EAAC,CAAC,CAAA;IACzC,CAAC;CACJ,CAAA;AAED,uBAAuB;AAEvB,MAAM,CAAC,MAAM,GAAG,GAAG;IACf,QAAQ,EAAE,CAAC,EAAC,GAAG,EAAE,UAAU,EAAC,CAAC;IAC7B,KAAK;QACD,OAAO,CAAC,MAAM,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,CAAC,CAAA;IACnC,CAAC;CACJ,CAAA;AAED,MAAM,CAAC,MAAM,OAAO,GAAG;IACnB,QAAQ,EAAE,CAAC,EAAC,GAAG,EAAE,cAAc,EAAC,CAAC;IACjC,KAAK;QACD,OAAO,CAAC,MAAM,EAAE,EAAC,KAAK,EAAE,SAAS,EAAC,CAAC,CAAA;IACvC,CAAC;CACJ,CAAA"}

package/dist/bibliography/csl_bib.d.ts

@@ -0,0 +1,3 @@
+export const cslBibSchema: Schema<"doc" | "text" | "cslbib" | "cslentry" | "cslinline" | "cslblock" | "cslleftmargin" | "cslrightinline" | "cslindent", "em" | "strong" | "sub" | "sup" | "smallcaps">;
+import { Schema } from "prosemirror-model";
+//# sourceMappingURL=csl_bib.d.ts.map

package/dist/bibliography/csl_bib.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"csl_bib.d.ts","sourceRoot":"","sources":["../../src/bibliography/csl_bib.js"],"names":[],"mappings":"AAuHA,uMAmBE;uBA1ImB,mBAAmB"}

package/dist/bibliography/csl_bib.js

@@ -0,0 +1,131 @@
+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
+    }
+});
+//# sourceMappingURL=csl_bib.js.map

package/dist/bibliography/csl_bib.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"csl_bib.js","sourceRoot":"","sources":["../../src/bibliography/csl_bib.js"],"names":[],"mappings":"AAAA,OAAO,EAAC,MAAM,EAAC,MAAM,mBAAmB,CAAA;AACxC,OAAO,EAAC,KAAK,EAAC,MAAM,0BAA0B,CAAA;AAC9C,OAAO,EAAC,SAAS,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAC,MAAM,aAAa,CAAA;AAErD,MAAM,GAAG,GAAG,EAAC,OAAO,EAAE,QAAQ,EAAC,CAAA;AAE/B,MAAM,MAAM,GAAG;IACX,OAAO,EAAE,WAAW;IACpB,QAAQ,EAAE,CAAC,EAAC,GAAG,EAAE,kBAAkB,EAAC,CAAC;IACrC,KAAK,CAAC,KAAK;QACP,OAAO;YACH,KAAK;YACL;gBACI,KAAK,EAAE,cAAc;aACxB;YACD,CAAC;SACJ,CAAA;IACL,CAAC;CACJ,CAAA;AAED,MAAM,QAAQ,GAAG;IACb,OAAO,EAAE,QAAQ;IACjB,QAAQ,EAAE,CAAC,EAAC,GAAG,EAAE,eAAe,EAAC,CAAC;IAClC,KAAK,CAAC,KAAK;QACP,OAAO;YACH,KAAK;YACL;gBACI,KAAK,EAAE,WAAW;aACrB;YACD,CAAC;SACJ,CAAA;IACL,CAAC;CACJ,CAAA;AAED,gFAAgF;AAChF,iFAAiF;AACjF,+EAA+E;AAC/E,8BAA8B;AAC9B,MAAM,SAAS,GAAG;IACd,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,OAAO;IAChB,KAAK,EAAE,GAAG;IACV,QAAQ,EAAE,CAAC,EAAC,GAAG,EAAE,gBAAgB,EAAC,CAAC;IACnC,KAAK,CAAC,KAAK;QACP,OAAO;YACH,KAAK;YACL;gBACI,KAAK,EAAE,YAAY;aACtB;YACD,CAAC;SACJ,CAAA;IACL,CAAC;CACJ,CAAA;AAED,MAAM,QAAQ,GAAG;IACb,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,OAAO;IAChB,KAAK,EAAE,GAAG;IACV,QAAQ,EAAE,CAAC,EAAC,GAAG,EAAE,eAAe,EAAC,CAAC;IAClC,KAAK,CAAC,KAAK;QACP,OAAO;YACH,KAAK;YACL;gBACI,KAAK,EAAE,WAAW;aACrB;YACD,CAAC;SACJ,CAAA;IACL,CAAC;CACJ,CAAA;AAED,MAAM,aAAa,GAAG;IAClB,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,OAAO;IAChB,KAAK,EAAE,GAAG;IACV,QAAQ,EAAE,CAAC,EAAC,GAAG,EAAE,qBAAqB,EAAC,CAAC;IACxC,KAAK,CAAC,KAAK;QACP,OAAO;YACH,KAAK;YACL;gBACI,KAAK,EAAE,iBAAiB;aAC3B;YACD,CAAC;SACJ,CAAA;IACL,CAAC;CACJ,CAAA;AAED,MAAM,cAAc,GAAG;IACnB,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,OAAO;IAChB,KAAK,EAAE,GAAG;IACV,QAAQ,EAAE,CAAC,EAAC,GAAG,EAAE,sBAAsB,EAAC,CAAC;IACzC,KAAK,CAAC,KAAK;QACP,OAAO;YACH,KAAK;YACL;gBACI,KAAK,EAAE,kBAAkB;aAC5B;YACD,CAAC;SACJ,CAAA;IACL,CAAC;CACJ,CAAA;AAED,MAAM,SAAS,GAAG;IACd,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,OAAO;IAChB,KAAK,EAAE,GAAG;IACV,QAAQ,EAAE,CAAC,EAAC,GAAG,EAAE,gBAAgB,EAAC,CAAC;IACnC,KAAK,CAAC,KAAK;QACP,OAAO;YACH,KAAK;YACL;gBACI,KAAK,EAAE,YAAY;aACtB;YACD,CAAC;SACJ,CAAA;IACL,CAAC;CACJ,CAAA;AAED,4DAA4D;AAC5D,MAAM,CAAC,MAAM,YAAY,GAAG,IAAI,MAAM,CAAC;IACnC,KAAK,EAAE;QACH,GAAG;QACH,MAAM;QACN,QAAQ;QACR,SAAS;QACT,QAAQ;QACR,aAAa;QACb,cAAc;QACd,SAAS;QACT,IAAI;KACP;IACD,KAAK,EAAE;QACH,EAAE,EAAE,KAAK,CAAC,EAAE;QACZ,MAAM,EAAE,KAAK,CAAC,MAAM;QACpB,SAAS;QACT,GAAG;QACH,GAAG;KACN;CACJ,CAAC,CAAA"}

package/dist/citations/citeproc_sys.d.ts

@@ -0,0 +1,13 @@
+export class citeprocSys {
+    constructor(bibDB: any);
+    bibDB: any;
+    abbreviations: {
+        default: {};
+    };
+    abbrevsname: string;
+    items: {};
+    missingItems: any[];
+    retrieveItem(id: any): any;
+    getAbbreviation(_dummy: any, obj: any, _jurisdiction: any, vartype: any, key: any): void;
+}
+//# sourceMappingURL=citeproc_sys.d.ts.map

package/dist/citations/citeproc_sys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"citeproc_sys.d.ts","sourceRoot":"","sources":["../../src/citations/citeproc_sys.js"],"names":[],"mappings":"AAGA;IACI,wBASC;IARG,WAAkB;IAClB;;MAEC;IACD,oBAA4B;IAE5B,UAAe;IACf,oBAAsB;IAG1B,2BAYC;IAED,yFAWC;CACJ"}

package/dist/citations/citeproc_sys.js

@@ -0,0 +1,43 @@
+/* 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.
+        }
+    }
+}
+//# sourceMappingURL=citeproc_sys.js.map

package/dist/citations/citeproc_sys.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"citeproc_sys.js","sourceRoot":"","sources":["../../src/citations/citeproc_sys.js"],"names":[],"mappings":"AAAA,yDAAyD;AACzD,OAAO,EAAC,WAAW,EAAC,MAAM,wBAAwB,CAAA;AAElD,MAAM,OAAO,WAAW;IACpB,YAAY,KAAK;QACb,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,aAAa,GAAG;YACjB,OAAO,EAAE,EAAE;SACd,CAAA;QACD,IAAI,CAAC,WAAW,GAAG,SAAS,CAAA;QAC5B,kCAAkC;QAClC,IAAI,CAAC,KAAK,GAAG,EAAE,CAAA;QACf,IAAI,CAAC,YAAY,GAAG,EAAE,CAAA;IAC1B,CAAC;IAED,YAAY,CAAC,EAAE;QACX,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC;YAClB,IAAI,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC;gBACpB,MAAM,SAAS,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC,CAAA;gBACtD,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,EAAE,CAAA;gBACnC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,CAAA;YACxC,CAAC;iBAAM,CAAC;gBACJ,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;gBAC1B,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,EAAC,MAAM,EAAE,CAAC,EAAC,OAAO,EAAE,EAAE,EAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAC,CAAA;YACnE,CAAC;QACL,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;IACzB,CAAC;IAED,eAAe,CAAC,MAAM,EAAE,GAAG,EAAE,aAAa,EAAE,OAAO,EAAE,GAAG;QACpD,IAAI,CAAC;YACD,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC;gBACrD,GAAG,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC;oBACxB,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAA;YAC1D,CAAC;iBAAM,CAAC;gBACJ,GAAG,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAA;YACrC,CAAC;QACL,CAAC;QAAC,OAAO,MAAM,EAAE,CAAC;YACd,mDAAmD;QACvD,CAAC;IACL,CAAC;CACJ"}

package/dist/citations/format.d.ts

@@ -0,0 +1,23 @@
+export class FormatCitations {
+    constructor(csl: any, allCitationInfos: any, citationStyle: any, bibliographyHeader: any, bibDB: any, synchronous?: boolean, lang?: string);
+    csl: any;
+    allCitationInfos: any;
+    citationStyle: any;
+    bibliographyHeader: any;
+    bibDB: any;
+    synchronous: boolean;
+    lang: string;
+    init(): any;
+    bibliography: any;
+    citations: any[] | undefined;
+    bibFormats: any[] | undefined;
+    citationTexts: any[] | undefined;
+    citationType: any;
+    formatAllCitations(): void;
+    get bibHTML(): string;
+    get bibCSS(): string;
+    reloadCitations(missingItems: any): any;
+    getFormattedCitations(): any;
+    process(citeprocInstance: any): void;
+}
+//# sourceMappingURL=format.d.ts.map

package/dist/citations/format.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.d.ts","sourceRoot":"","sources":["../../src/citations/format.js"],"names":[],"mappings":"AAMA;IACI,4IAgBC;IAPG,SAAc;IACd,sBAAwC;IACxC,mBAAkC;IAClC,wBAA4C;IAC5C,WAAkB;IAClB,qBAA8B;IAC9B,aAAgB;IAGpB,YAQC;IAPG,kBAAyB;IACzB,6BAAmB;IACnB,8BAAoB;IACpB,iCAAuB;IACvB,kBAAsB;IAK1B,2BAUC;IAED,sBAOC;IAGD,qBA6BC;IAED,wCAcC;IAED,6BA2BC;IAED,qCA2DC;CACJ"}

package/dist/citations/format.js

@@ -0,0 +1,161 @@
+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
+ */
+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();
+    }
+}
+//# sourceMappingURL=format.js.map

package/dist/citations/format.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"format.js","sourceRoot":"","sources":["../../src/citations/format.js"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,WAAW,CAAA;AACpC,OAAO,EAAC,WAAW,EAAC,MAAM,mBAAmB,CAAA;AAC7C;;GAEG;AAEH,MAAM,OAAO,eAAe;IACxB,YACI,GAAG,EACH,gBAAgB,EAChB,aAAa,EACb,kBAAkB,EAClB,KAAK,EACL,WAAW,GAAG,KAAK,EACnB,IAAI,GAAG,OAAO;QAEd,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAA;QACxC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAA;QAClC,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAA;QAC5C,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;QAC9B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;IACpB,CAAC;IAED,IAAI;QACA,IAAI,CAAC,YAAY,GAAG,KAAK,CAAA;QACzB,IAAI,CAAC,SAAS,GAAG,EAAE,CAAA;QACnB,IAAI,CAAC,UAAU,GAAG,EAAE,CAAA;QACpB,IAAI,CAAC,aAAa,GAAG,EAAE,CAAA;QACvB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAA;QACtB,IAAI,CAAC,kBAAkB,EAAE,CAAA;QACzB,OAAO,IAAI,CAAC,qBAAqB,EAAE,CAAA;IACvC,CAAC;IAED,kBAAkB;QACd,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;YAClC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;YAClC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;gBAChB,aAAa,EAAE,KAAK,CAAC,UAAU;gBAC/B,UAAU,EAAE;oBACR,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,MAAM;iBACpC;aACJ,CAAC,CAAA;QACN,CAAC,CAAC,CAAA;IACN,CAAC;IAED,IAAI,OAAO;QACP,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;YAC/D,OAAO,EAAE,CAAA;QACb,CAAC;QACD,MAAM,GAAG,GAAG,IAAI,CAAC,YAAY,EACzB,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,QAAQ,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;QAC/D,OAAO,uCAAuC,UAAU,CAAC,IAAI,CAAC,kBAAkB,CAAC,QAAQ,OAAO,EAAE,CAAA;IACtG,CAAC;IAED,MAAM;IACN,IAAI,MAAM;QACN,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;YAC/D,OAAO,EAAE,CAAA;QACb,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;QACpC,IAAI,GAAG,GAAG,IAAI,CAAA;QACd,GAAG,IAAI,+BAA+B,OAAO,CAAC,YAAY,GAAG,CAAC,QAAQ,CAAA;QACtE,GAAG,IAAI,+BAA+B,OAAO,CAAC,WAAW,MAAM,CAAA;QAC/D,IAAI,OAAO,CAAC,aAAa,EAAE,CAAC;YACxB,GAAG,IAAI;;;;wBAIK,CAAA;QAChB,CAAC;aAAM,IAAI,OAAO,CAAC,oBAAoB,CAAC,KAAK,QAAQ,EAAE,CAAC;YACpD,GAAG,IAAI;;wCAEqB,OAAO,CAAC,SAAS;iCACxB,OAAO,CAAC,SAAS;;iBAEjC,CAAA;QACT,CAAC;aAAM,IAAI,OAAO,CAAC,oBAAoB,CAAC,KAAK,OAAO,EAAE,CAAC;YACnD,GAAG,IAAI;;iCAEc,OAAO,CAAC,SAAS;;iBAEjC,CAAA;QACT,CAAC;QACD,OAAO,GAAG,CAAA;IACd,CAAC;IAED,eAAe,CAAC,YAAY;QACxB,oDAAoD;QACpD,gFAAgF;QAChF,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC;YACpB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;QAC5B,CAAC;QAED,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,GAAG,EAAE;YAChC,IAAI,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;gBAChE,OAAO,IAAI,CAAC,IAAI,EAAE,CAAA;YACtB,CAAC;iBAAM,CAAC;gBACJ,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;YAC5B,CAAC;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,qBAAqB;QACjB,MAAM,iBAAiB,GAAG,IAAI,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACrD,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;YACnB,MAAM,gBAAgB,GAAG,IAAI,CAAC,GAAG,CAAC,aAAa,CAC3C,iBAAiB,EACjB,IAAI,CAAC,aAAa,EAClB,IAAI,CAAC,IAAI,CACZ,CAAA;YACD,IAAI,CAAC,gBAAgB,EAAE,CAAC;gBACpB,OAAO,KAAK,CAAA;YAChB,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAA;YAC9B,OAAO,IAAI,CAAA;QACf,CAAC;aAAM,CAAC;YACJ,OAAO,IAAI,CAAC,GAAG;iBACV,SAAS,CAAC,iBAAiB,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,IAAI,CAAC;iBAC3D,IAAI,CAAC,gBAAgB,CAAC,EAAE;gBACrB,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAA;gBAC9B,IAAI,iBAAiB,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC5C,OAAO,IAAI,CAAC,eAAe,CACvB,iBAAiB,CAAC,YAAY,CACjC,CAAA;gBACL,CAAC;qBAAM,CAAC;oBACJ,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;gBAC5B,CAAC;YACL,CAAC,CAAC,CAAA;QACV,CAAC;IACL,CAAC;IAED,OAAO,CAAC,gBAAgB;QACpB,MAAM,MAAM,GAAG,EAAE,CAAA;QACjB,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CACzB,GAAG,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAClE,CAAA;QACD,gBAAgB,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;QAEpC,MAAM,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,KAAK,SAAS,CAAA;QACxE,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAA;QACjC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,EAAE,EAAE,CAAC;YAC3B,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAC9B,aAAa,GAAG,gBAAgB,CAAC,qBAAqB,CAClD,QAAQ,EACR,IAAI,CACP,CAAA;YACL,IAAI,MAAM,IAAI,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC7C,MAAM,KAAK,GAAG,QAAQ,CAAC,aAAa,CAAA;gBACpC,IAAI,WAAW,GAAG,EAAE,CAAA;gBAEpB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;oBACpC,MAAM,cAAc,GAAG;wBACnB;4BACI,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;4BACf,aAAa,EAAE,CAAC;yBACnB;qBACJ,CAAA;oBAED,MAAM,cAAc,GAAG;wBACnB;4BACI,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE;4BACf,iBAAiB,EAAE,CAAC;yBACvB;qBACJ,CAAA;oBAED,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;wBACnB,cAAc,CAAC,CAAC,CAAC,CAAC,OAAO,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAA;oBAChD,CAAC;oBAED,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;wBAClB,cAAc,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAA;oBAC9C,CAAC;oBAED,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;wBACR,WAAW;4BACP,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,gBAAgB;gCAC9C,IAAI,CAAA;oBACZ,CAAC;oBACD,WAAW,IAAI,GAAG,gBAAgB,CAAC,mBAAmB,CAAC,cAAc,CAAC,IAAI,gBAAgB,CAAC,mBAAmB,CAAC,cAAc,CAAC,EAAE,CAAA;gBACpI,CAAC;gBACD,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,YAAY,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;oBACxD,WAAW,CAAA;YACnB,CAAC;YACD,aAAa,CAAC,OAAO,CACjB,CAAC,CAAC,KAAK,EAAE,YAAY,CAAC,EAAE,EAAE,CACtB,CAAC,IAAI,CAAC,aAAa,CAAC,KAAK,CAAC,GAAG,YAAY,CAAC,CACjD,CAAA;QACL,CAAC;QACD,IAAI,CAAC,YAAY,GAAG,gBAAgB,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAA;QAC/D,IAAI,CAAC,YAAY,GAAG,gBAAgB,CAAC,gBAAgB,EAAE,CAAA;IAC3D,CAAC;CACJ"}