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

package/dist/exporter/docx/comments.js

@@ -0,0 +1,170 @@
+import { escapeText } from "fwtoolkit";
+import { descendantNodes } from "../tools/doc_content.js";
+const DEFAULT_COMMENTS_XML = `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+    <w:comments xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main" xmlns:w10="urn:schemas-microsoft-com:office:word" xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing" xmlns:wps="http://schemas.microsoft.com/office/word/2010/wordprocessingShape" xmlns:wpg="http://schemas.microsoft.com/office/word/2010/wordprocessingGroup" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" xmlns:wp14="http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing" xmlns:w14="http://schemas.microsoft.com/office/word/2010/wordml" xmlns:w15="http://schemas.microsoft.com/office/word/2012/wordml" mc:Ignorable="w14 wp14 w15">
+    </w:comments>`;
+const DEFAULT_COMMENTS_EXTENDED_XML = `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+    <w15:commentsEx xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" xmlns:w15="http://schemas.microsoft.com/office/word/2012/wordml" mc:Ignorable="w15">
+    </w15:commentsEx>`;
+export class DOCXExporterComments {
+    docContent;
+    commentsDB;
+    xml;
+    rels;
+    richtext;
+    usedComments;
+    commentsXML;
+    commentsExtendedXML;
+    commentsFilePath;
+    commentsExtendedFilePath;
+    commentIdCounter;
+    constructor(docContent, commentsDB, xml, rels, richtext) {
+        this.docContent = docContent;
+        this.commentsDB = commentsDB;
+        this.xml = xml;
+        this.rels = rels;
+        this.richtext = richtext;
+        this.usedComments = [];
+        this.commentsXML = null;
+        this.commentsExtendedXML = null;
+        this.commentsFilePath = "word/comments.xml";
+        this.commentsExtendedFilePath = "word/commentsExtended.xml";
+        this.commentIdCounter = -1;
+    }
+    init() {
+        let useExtended = false;
+        descendantNodes(this.docContent).forEach(node => {
+            if (node.marks) {
+                const comments = node.marks.filter(mark => mark.type === "comment");
+                comments.forEach(comment => {
+                    const commentId = String(comment.attrs?.id);
+                    if (commentId &&
+                        !this.usedComments.includes(commentId) &&
+                        this.commentsDB[commentId]) {
+                        this.usedComments.push(commentId);
+                        const commentDBEntry = this.commentsDB[commentId];
+                        if (commentDBEntry.resolved ||
+                            commentDBEntry.answers?.length) {
+                            useExtended = true;
+                        }
+                    }
+                });
+            }
+        });
+        if (!this.usedComments.length) {
+            return Promise.resolve();
+        }
+        this.rels.addCommentsRel();
+        const addCommentXMLs = [
+            this.xml
+                .getXml(this.commentsFilePath, DEFAULT_COMMENTS_XML)
+                .then(commentsXML => {
+                this.commentsXML = commentsXML;
+                return undefined;
+            })
+        ];
+        if (useExtended) {
+            this.rels.addCommentsExtendedRel();
+            addCommentXMLs.push(this.xml
+                .getXml(this.commentsExtendedFilePath, DEFAULT_COMMENTS_EXTENDED_XML)
+                .then(commentsExtendedXML => {
+                this.commentsExtendedXML = commentsExtendedXML;
+                return undefined;
+            }));
+        }
+        return Promise.all(addCommentXMLs).then(() => {
+            if (!this.commentsXML) {
+                return Promise.resolve();
+            }
+            this.commentsXML.queryAll("w:comment").forEach(el => {
+                const id = Number.parseInt(String(el.getAttribute("w:id")));
+                if (id > this.commentIdCounter) {
+                    this.commentIdCounter = id;
+                }
+            });
+            return this.exportComments();
+        });
+    }
+    addComment(id) {
+        const commentId = ++this.commentIdCounter;
+        this.richtext.comments[id] = commentId;
+        const commentDBEntry = this.commentsDB[id];
+        if (!this.commentsXML || !commentDBEntry) {
+            return;
+        }
+        const comments = this.commentsXML.query("w:comments");
+        if (!comments) {
+            return;
+        }
+        let string = `<w:comment w:id="${commentId}" w:author="${escapeText(commentDBEntry.username)}" w:date="${new Date(commentDBEntry.date).toISOString().split(".")[0]}Z" w:initials="${escapeText(commentDBEntry.username
+            .split(" ")
+            .map(n => n[0])
+            .join("")
+            .toUpperCase())}">`;
+        let parentParagraphId = "";
+        string += commentDBEntry.comment
+            .map((node, index) => {
+            const options = { section: "CommentText" };
+            if ((commentDBEntry.resolved ||
+                commentDBEntry.answers?.length) &&
+                index === commentDBEntry.comment.length - 1) {
+                // If comment has been resolved or there are answers, we need to add an id to the last paragraph
+                // of the comment and add an entry into commentsExtended.xml.
+                parentParagraphId = (++this.richtext.paragraphIdCounter)
+                    .toString(16)
+                    .padStart(8, "0");
+                options.paragraphId = parentParagraphId;
+                const extendedString = `<w15:commentEx w15:paraId="${parentParagraphId}" w15:done="${commentDBEntry.resolved ? "1" : "0"}"/>`;
+                if (this.commentsExtendedXML) {
+                    const extendedComments = this.commentsExtendedXML.query("w15:commentsEx");
+                    extendedComments?.appendXML(extendedString);
+                }
+            }
+            if (!index) {
+                options.commentReference = true;
+            }
+            return this.richtext.transformRichtext(node, options);
+        })
+            .join("");
+        string += "</w:comment>";
+        commentDBEntry.answers?.forEach(answer => {
+            const answerId = ++this.commentIdCounter;
+            string += `<w:comment w:id="${answerId}" w:author="${escapeText(answer.username)}" w:date="${new Date(answer.date).toISOString().split(".")[0]}Z" w:initials="${escapeText(answer.username
+                .split(" ")
+                .map(n => n[0])
+                .join("")
+                .toUpperCase())}">`;
+            string += answer.answer
+                .map((node, index) => {
+                const options = { section: "CommentText" };
+                if (index === answer.answer.length - 1) {
+                    // We need to add an id to the last paragraph of the comment and add an entry
+                    // into commentsExtended.xml pointing to the last paragraph of the parent comment.
+                    const paragraphId = (++this.richtext.paragraphIdCounter)
+                        .toString(16)
+                        .padStart(8, "0");
+                    options.paragraphId = paragraphId;
+                    const extendedString = `<w15:commentEx w15:paraId="${paragraphId}" w15:done="${commentDBEntry.resolved ? "1" : "0"}" w15:paraIdParent="${parentParagraphId}"/>`;
+                    if (this.commentsExtendedXML) {
+                        const extendedComments = this.commentsExtendedXML.query("w15:commentsEx");
+                        extendedComments?.appendXML(extendedString);
+                    }
+                }
+                if (!index) {
+                    options.commentReference = true;
+                }
+                return this.richtext.transformRichtext(node, options);
+            })
+                .join("");
+            string += "</w:comment>";
+        });
+        comments.appendXML(string);
+    }
+    exportComments() {
+        this.usedComments.forEach(comment => {
+            this.addComment(comment);
+        });
+        return Promise.resolve();
+    }
+}
+//# sourceMappingURL=comments.js.map

package/dist/exporter/docx/comments.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"comments.js","sourceRoot":"","sources":["../../../src/exporter/docx/comments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,UAAU,EAAC,MAAM,WAAW,CAAA;AAGpC,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAA;AAKvD,MAAM,oBAAoB,GAAG;;kBAEX,CAAA;AAElB,MAAM,6BAA6B,GAAG;;sBAEhB,CAAA;AAEtB,MAAM,OAAO,oBAAoB;IAC7B,UAAU,CAAW;IACrB,UAAU,CAA6B;IACvC,GAAG,CAAQ;IACX,IAAI,CAAkB;IACtB,QAAQ,CAAK;IAEb,YAAY,CAAU;IACtB,WAAW,CAAmB;IAC9B,mBAAmB,CAAmB;IACtC,gBAAgB,CAAQ;IACxB,wBAAwB,CAAQ;IAChC,gBAAgB,CAAQ;IAExB,YACI,UAAqB,EACrB,UAAuC,EACvC,GAAW,EACX,IAAsB,EACtB,QAAa;QAEb,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QAExB,IAAI,CAAC,YAAY,GAAG,EAAE,CAAA;QACtB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAA;QACvB,IAAI,CAAC,mBAAmB,GAAG,IAAI,CAAA;QAC/B,IAAI,CAAC,gBAAgB,GAAG,mBAAmB,CAAA;QAC3C,IAAI,CAAC,wBAAwB,GAAG,2BAA2B,CAAA;QAC3D,IAAI,CAAC,gBAAgB,GAAG,CAAC,CAAC,CAAA;IAC9B,CAAC;IAED,IAAI;QACA,IAAI,WAAW,GAAG,KAAK,CAAA;QACvB,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YAC5C,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACb,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAC9B,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,SAAS,CAClC,CAAA;gBACD,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;oBACvB,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAA;oBAC3C,IACI,SAAS;wBACT,CAAC,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,SAAS,CAAC;wBACtC,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,EAC5B,CAAC;wBACC,IAAI,CAAC,YAAY,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;wBACjC,MAAM,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC,CAAA;wBACjD,IACI,cAAc,CAAC,QAAQ;4BACvB,cAAc,CAAC,OAAO,EAAE,MAAM,EAChC,CAAC;4BACC,WAAW,GAAG,IAAI,CAAA;wBACtB,CAAC;oBACL,CAAC;gBACL,CAAC,CAAC,CAAA;YACN,CAAC;QACL,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;YAC5B,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;QAC5B,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAA;QAC1B,MAAM,cAAc,GAAyB;YACzC,IAAI,CAAC,GAAG;iBACH,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE,oBAAoB,CAAC;iBACnD,IAAI,CAAC,WAAW,CAAC,EAAE;gBAChB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;gBAC9B,OAAO,SAAS,CAAA;YACpB,CAAC,CAAC;SACT,CAAA;QACD,IAAI,WAAW,EAAE,CAAC;YACd,IAAI,CAAC,IAAI,CAAC,sBAAsB,EAAE,CAAA;YAClC,cAAc,CAAC,IAAI,CACf,IAAI,CAAC,GAAG;iBACH,MAAM,CACH,IAAI,CAAC,wBAAwB,EAC7B,6BAA6B,CAChC;iBACA,IAAI,CAAC,mBAAmB,CAAC,EAAE;gBACxB,IAAI,CAAC,mBAAmB,GAAG,mBAAmB,CAAA;gBAC9C,OAAO,SAAS,CAAA;YACpB,CAAC,CAAC,CACT,CAAA;QACL,CAAC;QACD,OAAO,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;YACzC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;gBACpB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;YAC5B,CAAC;YACD,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;gBAChD,MAAM,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,CAAC,YAAY,CAAC,MAAM,CAAC,CAAC,CAAC,CAAA;gBAC3D,IAAI,EAAE,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAC;oBAC7B,IAAI,CAAC,gBAAgB,GAAG,EAAE,CAAA;gBAC9B,CAAC;YACL,CAAC,CAAC,CAAA;YACF,OAAO,IAAI,CAAC,cAAc,EAAE,CAAA;QAChC,CAAC,CAAC,CAAA;IACN,CAAC;IAED,UAAU,CAAC,EAAU;QACjB,MAAM,SAAS,GAAG,EAAE,IAAI,CAAC,gBAAgB,CAAA;QACzC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,GAAG,SAAS,CAAA;QACtC,MAAM,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,CAAA;QAC1C,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,cAAc,EAAE,CAAC;YACvC,OAAM;QACV,CAAC;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;QACrD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,OAAM;QACV,CAAC;QACD,IAAI,MAAM,GAAG,oBAAoB,SAAS,eAAe,UAAU,CAAC,cAAc,CAAC,QAAQ,CAAC,aAAa,IAAI,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,kBAAkB,UAAU,CAC1L,cAAc,CAAC,QAAQ;aAClB,KAAK,CAAC,GAAG,CAAC;aACV,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aACd,IAAI,CAAC,EAAE,CAAC;aACR,WAAW,EAAE,CACrB,IAAI,CAAA;QACL,IAAI,iBAAiB,GAAG,EAAE,CAAA;QAC1B,MAAM,IAAI,cAAc,CAAC,OAAO;aAC3B,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;YACjB,MAAM,OAAO,GAA4B,EAAC,OAAO,EAAE,aAAa,EAAC,CAAA;YACjE,IACI,CAAC,cAAc,CAAC,QAAQ;gBACpB,cAAc,CAAC,OAAO,EAAE,MAAM,CAAC;gBACnC,KAAK,KAAK,cAAc,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAC7C,CAAC;gBACC,gGAAgG;gBAChG,6DAA6D;gBAC7D,iBAAiB,GAAG,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC;qBACnD,QAAQ,CAAC,EAAE,CAAC;qBACZ,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;gBACrB,OAAO,CAAC,WAAW,GAAG,iBAAiB,CAAA;gBACvC,MAAM,cAAc,GAAG,8BAA8B,iBAAiB,eAAe,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,KAAK,CAAA;gBAC7H,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;oBAC3B,MAAM,gBAAgB,GAClB,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAA;oBACpD,gBAAgB,EAAE,SAAS,CAAC,cAAc,CAAC,CAAA;gBAC/C,CAAC;YACL,CAAC;YACD,IAAI,CAAC,KAAK,EAAE,CAAC;gBACT,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAA;YACnC,CAAC;YACD,OAAO,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QACzD,CAAC,CAAC;aACD,IAAI,CAAC,EAAE,CAAC,CAAA;QACb,MAAM,IAAI,cAAc,CAAA;QACxB,cAAc,CAAC,OAAO,EAAE,OAAO,CAAC,MAAM,CAAC,EAAE;YACrC,MAAM,QAAQ,GAAG,EAAE,IAAI,CAAC,gBAAgB,CAAA;YACxC,MAAM,IAAI,oBAAoB,QAAQ,eAAe,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,aAAa,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,kBAAkB,UAAU,CACtK,MAAM,CAAC,QAAQ;iBACV,KAAK,CAAC,GAAG,CAAC;iBACV,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;iBACd,IAAI,CAAC,EAAE,CAAC;iBACR,WAAW,EAAE,CACrB,IAAI,CAAA;YACL,MAAM,IAAI,MAAM,CAAC,MAAM;iBAClB,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;gBACjB,MAAM,OAAO,GAA4B,EAAC,OAAO,EAAE,aAAa,EAAC,CAAA;gBACjE,IAAI,KAAK,KAAK,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBACrC,6EAA6E;oBAC7E,kFAAkF;oBAClF,MAAM,WAAW,GAAG,CAAC,EAAE,IAAI,CAAC,QAAQ,CAAC,kBAAkB,CAAC;yBACnD,QAAQ,CAAC,EAAE,CAAC;yBACZ,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAA;oBACrB,OAAO,CAAC,WAAW,GAAG,WAAW,CAAA;oBACjC,MAAM,cAAc,GAAG,8BAA8B,WAAW,eAAe,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,uBAAuB,iBAAiB,KAAK,CAAA;oBAC/J,IAAI,IAAI,CAAC,mBAAmB,EAAE,CAAC;wBAC3B,MAAM,gBAAgB,GAClB,IAAI,CAAC,mBAAmB,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAA;wBACpD,gBAAgB,EAAE,SAAS,CAAC,cAAc,CAAC,CAAA;oBAC/C,CAAC;gBACL,CAAC;gBACD,IAAI,CAAC,KAAK,EAAE,CAAC;oBACT,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAA;gBACnC,CAAC;gBACD,OAAO,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,EAAE,OAAO,CAAC,CAAA;YACzD,CAAC,CAAC;iBACD,IAAI,CAAC,EAAE,CAAC,CAAA;YACb,MAAM,IAAI,cAAc,CAAA;QAC5B,CAAC,CAAC,CAAA;QACF,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;IAC9B,CAAC;IAED,cAAc;QACV,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;YAChC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,CAAA;QAC5B,CAAC,CAAC,CAAA;QACF,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;IAC5B,CAAC;CACJ"}

package/dist/exporter/docx/footnotes.d.ts

@@ -0,0 +1,47 @@
+import type { BibDB, CSL, DocSettings, ExportDoc, FidusNode, ImageDB } from "../../types.js";
+import type { XmlZip } from "../tools/xml_zip.js";
+import type { XMLElement } from "../tools/xml.js";
+import { DOCXExporterCitations } from "./citations.js";
+import { DOCXExporterImages } from "./images.js";
+import { DOCXExporterLists } from "./lists.js";
+import { DOCXExporterRels } from "./rels.js";
+export declare class DOCXExporterFootnotes {
+    doc: ExportDoc;
+    docContent: FidusNode;
+    settings: DocSettings;
+    imageDB: ImageDB;
+    bibDB: BibDB;
+    xml: XmlZip;
+    citations: DOCXExporterCitations;
+    csl: CSL;
+    lists: DOCXExporterLists;
+    math: any;
+    tables: any;
+    rels: DOCXExporterRels;
+    pmBib: FidusNode | false;
+    fnPmJSON: FidusNode | false;
+    images: DOCXExporterImages | null;
+    augmentedCitations: DOCXExporterCitations | null;
+    footnotes: FidusNode[][];
+    fnXML: string | null;
+    fnRels: DOCXExporterRels | null;
+    ctXML: XMLElement | null;
+    styleXML: XMLElement | null;
+    settingsXML: XMLElement | null;
+    filePath: string;
+    ctFilePath: string;
+    settingsFilePath: string;
+    styleFilePath: string;
+    richtext: any;
+    constructor(doc: ExportDoc, docContent: FidusNode, settings: DocSettings, imageDB: ImageDB, bibDB: BibDB, xml: XmlZip, citations: DOCXExporterCitations, csl: CSL, lists: DOCXExporterLists, math: any, tables: any, rels: DOCXExporterRels);
+    init(): Promise<void> | Promise<undefined>;
+    initCt(): Promise<void>;
+    addRelsToCt(): void;
+    addStyles(): Promise<void>;
+    addStyle(styleName: string, xml: string): void;
+    findFootnotes(): void;
+    convertFootnotes(): void;
+    createXml(): Promise<void>;
+    setSettings(): Promise<void>;
+}
+//# sourceMappingURL=footnotes.d.ts.map

package/dist/exporter/docx/footnotes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"footnotes.d.ts","sourceRoot":"","sources":["../../../src/exporter/docx/footnotes.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAC,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAC,MAAM,gBAAgB,CAAA;AAC1F,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,qBAAqB,CAAA;AAC/C,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,iBAAiB,CAAA;AAC/C,OAAO,EAAC,qBAAqB,EAAC,MAAM,gBAAgB,CAAA;AACpD,OAAO,EAAC,kBAAkB,EAAC,MAAM,aAAa,CAAA;AAC9C,OAAO,EAAC,iBAAiB,EAAC,MAAM,YAAY,CAAA;AAC5C,OAAO,EAAC,gBAAgB,EAAC,MAAM,WAAW,CAAA;AAiD1C,qBAAa,qBAAqB;IAC9B,GAAG,EAAE,SAAS,CAAA;IACd,UAAU,EAAE,SAAS,CAAA;IACrB,QAAQ,EAAE,WAAW,CAAA;IACrB,OAAO,EAAE,OAAO,CAAA;IAChB,KAAK,EAAE,KAAK,CAAA;IACZ,GAAG,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,qBAAqB,CAAA;IAChC,GAAG,EAAE,GAAG,CAAA;IACR,KAAK,EAAE,iBAAiB,CAAA;IACxB,IAAI,EAAE,GAAG,CAAA;IACT,MAAM,EAAE,GAAG,CAAA;IACX,IAAI,EAAE,gBAAgB,CAAA;IAEtB,KAAK,EAAE,SAAS,GAAG,KAAK,CAAA;IACxB,QAAQ,EAAE,SAAS,GAAG,KAAK,CAAA;IAC3B,MAAM,EAAE,kBAAkB,GAAG,IAAI,CAAA;IACjC,kBAAkB,EAAE,qBAAqB,GAAG,IAAI,CAAA;IAChD,SAAS,EAAE,SAAS,EAAE,EAAE,CAAA;IACxB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,MAAM,EAAE,gBAAgB,GAAG,IAAI,CAAA;IAC/B,KAAK,EAAE,UAAU,GAAG,IAAI,CAAA;IACxB,QAAQ,EAAE,UAAU,GAAG,IAAI,CAAA;IAC3B,WAAW,EAAE,UAAU,GAAG,IAAI,CAAA;IAC9B,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,MAAM,CAAA;IAClB,gBAAgB,EAAE,MAAM,CAAA;IACxB,aAAa,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,GAAG,CAAA;gBAGT,GAAG,EAAE,SAAS,EACd,UAAU,EAAE,SAAS,EACrB,QAAQ,EAAE,WAAW,EACrB,OAAO,EAAE,OAAO,EAChB,KAAK,EAAE,KAAK,EACZ,GAAG,EAAE,MAAM,EACX,SAAS,EAAE,qBAAqB,EAChC,GAAG,EAAE,GAAG,EACR,KAAK,EAAE,iBAAiB,EACxB,IAAI,EAAE,GAAG,EACT,MAAM,EAAE,GAAG,EACX,IAAI,EAAE,gBAAgB;IA+B1B,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,OAAO,CAAC,SAAS,CAAC;IAsD1C,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAQvB,WAAW,IAAI,IAAI;IAenB,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAS1B,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,IAAI;IAO9C,aAAa,IAAI,IAAI;IAQrB,gBAAgB,IAAI,IAAI;IAcxB,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC;IAuB1B,WAAW,IAAI,OAAO,CAAC,IAAI,CAAC;CAW/B"}

package/dist/exporter/docx/footnotes.js

@@ -0,0 +1,216 @@
+import { descendantNodes } from "../tools/doc_content.js";
+import { DOCXExporterCitations } from "./citations.js";
+import { DOCXExporterImages } from "./images.js";
+import { DOCXExporterLists } from "./lists.js";
+import { DOCXExporterRels } from "./rels.js";
+import { DOCXExporterRichtext } from "./richtext.js";
+const DEFAULT_XML = `<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+    <w:footnotes xmlns:o="urn:schemas-microsoft-com:office:office" xmlns:r="http://schemas.openxmlformats.org/officeDocument/2006/relationships" xmlns:v="urn:schemas-microsoft-com:vml" xmlns:w="http://schemas.openxmlformats.org/wordprocessingml/2006/main" xmlns:w10="urn:schemas-microsoft-com:office:word" xmlns:wp="http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing" xmlns:wps="http://schemas.microsoft.com/office/word/2010/wordprocessingShape" xmlns:wpg="http://schemas.microsoft.com/office/word/2010/wordprocessingGroup" xmlns:mc="http://schemas.openxmlformats.org/markup-compatibility/2006" xmlns:wp14="http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing" xmlns:w14="http://schemas.microsoft.com/office/word/2010/wordml" mc:Ignorable="w14 wp14">
+        <w:footnote w:id="0" w:type="separator">
+            <w:p>
+                <w:r>
+                    <w:separator />
+                </w:r>
+            </w:p>
+        </w:footnote>
+        <w:footnote w:id="1" w:type="continuationSeparator">
+            <w:p>
+                <w:r>
+                    <w:continuationSeparator />
+                </w:r>
+            </w:p>
+        </w:footnote>
+    </w:footnotes>`;
+const DEFAULT_SETTINGS_XML = `<w:footnotePr>
+        <w:numFmt w:val="decimal"/>
+        <w:footnote w:id="0"/>
+        <w:footnote w:id="1"/>
+    </w:footnotePr>`;
+const DEFAULT_STYLE_FOOTNOTE = `<w:style w:type="paragraph" w:styleId="Footnote">
+        <w:name w:val="Footnote Text" />
+        <w:basedOn w:val="Normal" />
+        <w:pPr>
+            <w:suppressLineNumbers />
+            <w:ind w:left="339" w:hanging="339" />
+        </w:pPr>
+        <w:rPr>
+            <w:sz w:val="20" />
+            <w:szCs w:val="20" />
+        </w:rPr>
+    </w:style>`;
+const DEFAULT_STYLE_FOOTNOTE_ANCHOR = `
+    <w:style w:type="character" w:styleId="FootnoteAnchor">
+        <w:name w:val="Footnote Anchor" />
+        <w:rPr>
+            <w:vertAlign w:val="superscript" />
+        </w:rPr>
+    </w:style>
+    `;
+export class DOCXExporterFootnotes {
+    doc;
+    docContent;
+    settings;
+    imageDB;
+    bibDB;
+    xml;
+    citations;
+    csl;
+    lists;
+    math;
+    tables;
+    rels;
+    pmBib;
+    fnPmJSON;
+    images;
+    augmentedCitations;
+    footnotes;
+    fnXML;
+    fnRels;
+    ctXML;
+    styleXML;
+    settingsXML;
+    filePath;
+    ctFilePath;
+    settingsFilePath;
+    styleFilePath;
+    richtext;
+    constructor(doc, docContent, settings, imageDB, bibDB, xml, citations, csl, lists, math, tables, rels) {
+        this.doc = doc;
+        this.docContent = docContent;
+        this.settings = settings;
+        this.imageDB = imageDB;
+        this.bibDB = bibDB;
+        this.xml = xml;
+        this.citations = citations;
+        this.csl = csl;
+        this.lists = lists;
+        this.math = math;
+        this.tables = tables;
+        this.rels = rels;
+        this.pmBib = false;
+        this.fnPmJSON = false;
+        this.images = null;
+        this.augmentedCitations = null;
+        this.footnotes = []; // footnotes
+        this.fnXML = null;
+        this.fnRels = null;
+        this.ctXML = null;
+        this.styleXML = null;
+        this.settingsXML = null;
+        this.filePath = "word/footnotes.xml";
+        this.ctFilePath = "[Content_Types].xml";
+        this.settingsFilePath = "word/settings.xml";
+        this.styleFilePath = "word/styles.xml";
+    }
+    init() {
+        this.findFootnotes();
+        if (this.footnotes.length ||
+            (this.citations.citFm &&
+                this.citations.citFm.citationType === "note" &&
+                this.citations.citInfos.length)) {
+            this.convertFootnotes();
+            this.fnRels = new DOCXExporterRels(this.xml, "footnotes");
+            // Include the citinfos from the main body document so that they will be
+            // used for calculating the bibliography as well
+            this.augmentedCitations = new DOCXExporterCitations(this.fnPmJSON, this.settings, this.bibDB, this.csl, this.xml, this.citations.citInfos);
+            this.images = new DOCXExporterImages(this.fnPmJSON, this.imageDB, this.xml, this.fnRels);
+            this.lists = new DOCXExporterLists(this.fnPmJSON, this.xml, this.fnRels);
+            return this.augmentedCitations
+                .init()
+                .then(() => {
+                // Replace the main bibliography with the new one that
+                // includes both citations in main document
+                // and in the footnotes.
+                this.pmBib = this.augmentedCitations.pmBib;
+                return this.fnRels.init();
+            })
+                .then(() => this.images.init())
+                .then(() => this.lists.init())
+                .then(() => this.initCt())
+                .then(() => this.setSettings())
+                .then(() => this.addStyles())
+                .then(() => this.createXml());
+        }
+        else {
+            // No footnotes were found.
+            return Promise.resolve();
+        }
+    }
+    initCt() {
+        return this.xml.getXml(this.ctFilePath).then(ctXML => {
+            this.ctXML = ctXML;
+            this.addRelsToCt();
+            return Promise.resolve();
+        });
+    }
+    addRelsToCt() {
+        if (!this.ctXML) {
+            return;
+        }
+        const override = this.ctXML.query("Override", {
+            PartName: `/${this.filePath}`
+        });
+        if (!override) {
+            const types = this.ctXML.query("Types");
+            types?.appendXML(`<Override PartName="/${this.filePath}" ContentType="application/vnd.openxmlformats-officedocument.wordprocessingml.footnotes+xml"/>`);
+        }
+    }
+    addStyles() {
+        return this.xml.getXml(this.styleFilePath).then(styleXML => {
+            this.styleXML = styleXML;
+            this.addStyle("Footnote", DEFAULT_STYLE_FOOTNOTE);
+            this.addStyle("FootnoteAnchor", DEFAULT_STYLE_FOOTNOTE_ANCHOR);
+            return Promise.resolve();
+        });
+    }
+    addStyle(styleName, xml) {
+        if (!this.styleXML.query("w:style", { "w:styleId": styleName })) {
+            const stylesEl = this.styleXML.query("w:styles");
+            stylesEl?.appendXML(xml);
+        }
+    }
+    findFootnotes() {
+        descendantNodes(this.docContent).forEach(node => {
+            if (node.type === "footnote") {
+                this.footnotes.push(node.attrs?.footnote);
+            }
+        });
+    }
+    convertFootnotes() {
+        const fnContent = [];
+        this.footnotes.forEach(footnote => {
+            fnContent.push({
+                type: "footnotecontainer",
+                content: footnote
+            });
+        });
+        this.fnPmJSON = {
+            type: "doc",
+            content: fnContent
+        };
+    }
+    createXml() {
+        this.richtext = new DOCXExporterRichtext(this.doc, this.lists, this, this.settings, this.math, this.tables, this.fnRels, this.augmentedCitations, this.images);
+        this.fnXML = this.richtext.transformRichtext(this.fnPmJSON);
+        // TODO: add max dimensions
+        this.rels.addFootnoteRel();
+        return this.xml.getXml(this.filePath, DEFAULT_XML).then(xml => {
+            const footnotesEl = xml.query("w:footnotes");
+            footnotesEl?.appendXML(this.fnXML);
+            // Note: original code reassigned this.xml to the XMLElement here;
+            // that is not needed and conflicts with the XmlZip type.
+        });
+    }
+    setSettings() {
+        return this.xml.getXml(this.settingsFilePath).then(settingsXML => {
+            const footnotePr = settingsXML.query("w:footnotePr");
+            if (!footnotePr) {
+                const settingsEl = settingsXML.query("w:settings");
+                settingsEl?.appendXML(DEFAULT_SETTINGS_XML);
+            }
+            this.settingsXML = settingsXML;
+            return Promise.resolve();
+        });
+    }
+}
+//# sourceMappingURL=footnotes.js.map

package/dist/exporter/docx/footnotes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"footnotes.js","sourceRoot":"","sources":["../../../src/exporter/docx/footnotes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAA;AAIvD,OAAO,EAAC,qBAAqB,EAAC,MAAM,gBAAgB,CAAA;AACpD,OAAO,EAAC,kBAAkB,EAAC,MAAM,aAAa,CAAA;AAC9C,OAAO,EAAC,iBAAiB,EAAC,MAAM,YAAY,CAAA;AAC5C,OAAO,EAAC,gBAAgB,EAAC,MAAM,WAAW,CAAA;AAC1C,OAAO,EAAC,oBAAoB,EAAC,MAAM,eAAe,CAAA;AAElD,MAAM,WAAW,GAAG;;;;;;;;;;;;;;;;mBAgBD,CAAA;AAEnB,MAAM,oBAAoB,GAAG;;;;oBAIT,CAAA;AAEpB,MAAM,sBAAsB,GAAG;;;;;;;;;;;eAWhB,CAAA;AAEf,MAAM,6BAA6B,GAAG;;;;;;;KAOjC,CAAA;AAEL,MAAM,OAAO,qBAAqB;IAC9B,GAAG,CAAW;IACd,UAAU,CAAW;IACrB,QAAQ,CAAa;IACrB,OAAO,CAAS;IAChB,KAAK,CAAO;IACZ,GAAG,CAAQ;IACX,SAAS,CAAuB;IAChC,GAAG,CAAK;IACR,KAAK,CAAmB;IACxB,IAAI,CAAK;IACT,MAAM,CAAK;IACX,IAAI,CAAkB;IAEtB,KAAK,CAAmB;IACxB,QAAQ,CAAmB;IAC3B,MAAM,CAA2B;IACjC,kBAAkB,CAA8B;IAChD,SAAS,CAAe;IACxB,KAAK,CAAe;IACpB,MAAM,CAAyB;IAC/B,KAAK,CAAmB;IACxB,QAAQ,CAAmB;IAC3B,WAAW,CAAmB;IAC9B,QAAQ,CAAQ;IAChB,UAAU,CAAQ;IAClB,gBAAgB,CAAQ;IACxB,aAAa,CAAQ;IACrB,QAAQ,CAAK;IAEb,YACI,GAAc,EACd,UAAqB,EACrB,QAAqB,EACrB,OAAgB,EAChB,KAAY,EACZ,GAAW,EACX,SAAgC,EAChC,GAAQ,EACR,KAAwB,EACxB,IAAS,EACT,MAAW,EACX,IAAsB;QAEtB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;QACxB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,SAAS,GAAG,SAAS,CAAA;QAC1B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAChB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;QACpB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAEhB,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;QAClB,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAA;QACrB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAA;QAClB,IAAI,CAAC,kBAAkB,GAAG,IAAI,CAAA;QAC9B,IAAI,CAAC,SAAS,GAAG,EAAE,CAAA,CAAC,YAAY;QAChC,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACjB,IAAI,CAAC,MAAM,GAAG,IAAI,CAAA;QAClB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;QACjB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAA;QACpB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAA;QACvB,IAAI,CAAC,QAAQ,GAAG,oBAAoB,CAAA;QACpC,IAAI,CAAC,UAAU,GAAG,qBAAqB,CAAA;QACvC,IAAI,CAAC,gBAAgB,GAAG,mBAAmB,CAAA;QAC3C,IAAI,CAAC,aAAa,GAAG,iBAAiB,CAAA;IAC1C,CAAC;IAED,IAAI;QACA,IAAI,CAAC,aAAa,EAAE,CAAA;QACpB,IACI,IAAI,CAAC,SAAS,CAAC,MAAM;YACrB,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK;gBACjB,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,YAAY,KAAK,MAAM;gBAC5C,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EACrC,CAAC;YACC,IAAI,CAAC,gBAAgB,EAAE,CAAA;YACvB,IAAI,CAAC,MAAM,GAAG,IAAI,gBAAgB,CAAC,IAAI,CAAC,GAAG,EAAE,WAAW,CAAC,CAAA;YACzD,wEAAwE;YACxE,gDAAgD;YAChD,IAAI,CAAC,kBAAkB,GAAG,IAAI,qBAAqB,CAC/C,IAAI,CAAC,QAAqB,EAC1B,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,KAAK,EACV,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,SAAS,CAAC,QAAQ,CAC1B,CAAA;YAED,IAAI,CAAC,MAAM,GAAG,IAAI,kBAAkB,CAChC,IAAI,CAAC,QAAqB,EAC1B,IAAI,CAAC,OAAO,EACZ,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,MAAM,CACd,CAAA;YACD,IAAI,CAAC,KAAK,GAAG,IAAI,iBAAiB,CAC9B,IAAI,CAAC,QAAqB,EAC1B,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,MAAM,CACd,CAAA;YAED,OAAO,IAAI,CAAC,kBAAkB;iBACzB,IAAI,EAAE;iBACN,IAAI,CAAC,GAAG,EAAE;gBACP,sDAAsD;gBACtD,2CAA2C;gBAC3C,wBAAwB;gBACxB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,kBAAmB,CAAC,KAAK,CAAA;gBAC3C,OAAO,IAAI,CAAC,MAAO,CAAC,IAAI,EAAE,CAAA;YAC9B,CAAC,CAAC;iBACD,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAO,CAAC,IAAI,EAAE,CAAC;iBAC/B,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;iBAC7B,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;iBACzB,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;iBAC9B,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;iBAC5B,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,CAAA;QACrC,CAAC;aAAM,CAAC;YACJ,2BAA2B;YAC3B,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;QAC5B,CAAC;IACL,CAAC;IAED,MAAM;QACF,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YACjD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;YAClB,IAAI,CAAC,WAAW,EAAE,CAAA;YAClB,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;QAC5B,CAAC,CAAC,CAAA;IACN,CAAC;IAED,WAAW;QACP,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YACd,OAAM;QACV,CAAC;QACD,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,UAAU,EAAE;YAC1C,QAAQ,EAAE,IAAI,IAAI,CAAC,QAAQ,EAAE;SAChC,CAAC,CAAA;QACF,IAAI,CAAC,QAAQ,EAAE,CAAC;YACZ,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;YACvC,KAAK,EAAE,SAAS,CACZ,wBAAwB,IAAI,CAAC,QAAQ,gGAAgG,CACxI,CAAA;QACL,CAAC;IACL,CAAC;IAED,SAAS;QACL,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE;YACvD,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAA;YACxB,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,sBAAsB,CAAC,CAAA;YACjD,IAAI,CAAC,QAAQ,CAAC,gBAAgB,EAAE,6BAA6B,CAAC,CAAA;YAC9D,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;QAC5B,CAAC,CAAC,CAAA;IACN,CAAC;IAED,QAAQ,CAAC,SAAiB,EAAE,GAAW;QACnC,IAAI,CAAC,IAAI,CAAC,QAAS,CAAC,KAAK,CAAC,SAAS,EAAE,EAAC,WAAW,EAAE,SAAS,EAAC,CAAC,EAAE,CAAC;YAC7D,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAS,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;YACjD,QAAQ,EAAE,SAAS,CAAC,GAAG,CAAC,CAAA;QAC5B,CAAC;IACL,CAAC;IAED,aAAa;QACT,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YAC5C,IAAI,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;gBAC3B,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,QAAuB,CAAC,CAAA;YAC5D,CAAC;QACL,CAAC,CAAC,CAAA;IACN,CAAC;IAED,gBAAgB;QACZ,MAAM,SAAS,GAAgB,EAAE,CAAA;QACjC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;YAC9B,SAAS,CAAC,IAAI,CAAC;gBACX,IAAI,EAAE,mBAAmB;gBACzB,OAAO,EAAE,QAAQ;aACpB,CAAC,CAAA;QACN,CAAC,CAAC,CAAA;QACF,IAAI,CAAC,QAAQ,GAAG;YACZ,IAAI,EAAE,KAAK;YACX,OAAO,EAAE,SAAS;SACrB,CAAA;IACL,CAAC;IAED,SAAS;QACL,IAAI,CAAC,QAAQ,GAAG,IAAI,oBAAoB,CACpC,IAAI,CAAC,GAAG,EACR,IAAI,CAAC,KAAK,EACV,IAAI,EACJ,IAAI,CAAC,QAAQ,EACb,IAAI,CAAC,IAAI,EACT,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,MAAM,EACX,IAAI,CAAC,kBAAkB,EACvB,IAAI,CAAC,MAAM,CACd,CAAA;QACD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC3D,2BAA2B;QAC3B,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE,CAAA;QAC1B,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;YAC1D,MAAM,WAAW,GAAG,GAAG,CAAC,KAAK,CAAC,aAAa,CAAC,CAAA;YAC5C,WAAW,EAAE,SAAS,CAAC,IAAI,CAAC,KAAe,CAAC,CAAA;YAC5C,kEAAkE;YAClE,yDAAyD;QAC7D,CAAC,CAAC,CAAA;IACN,CAAC;IAED,WAAW;QACP,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;YAC7D,MAAM,UAAU,GAAG,WAAW,CAAC,KAAK,CAAC,cAAc,CAAC,CAAA;YACpD,IAAI,CAAC,UAAU,EAAE,CAAC;gBACd,MAAM,UAAU,GAAG,WAAW,CAAC,KAAK,CAAC,YAAY,CAAC,CAAA;gBAClD,UAAU,EAAE,SAAS,CAAC,oBAAoB,CAAC,CAAA;YAC/C,CAAC;YACD,IAAI,CAAC,WAAW,GAAG,WAAW,CAAA;YAC9B,OAAO,OAAO,CAAC,OAAO,EAAE,CAAA;QAC5B,CAAC,CAAC,CAAA;IACN,CAAC;CACJ"}

package/dist/exporter/docx/images.d.ts

@@ -0,0 +1,25 @@
+import type { FidusNode, ImageDB } from "../../types.js";
+import type { XMLElement } from "../tools/xml.js";
+import type { XmlZip } from "../tools/xml_zip.js";
+import type { DOCXExporterRels } from "./rels.js";
+interface ImageInfo {
+    id: number;
+    width: number;
+    height: number;
+    title?: string;
+}
+export declare class DOCXExporterImages {
+    docContent: FidusNode;
+    imageDB: ImageDB;
+    xml: XmlZip;
+    rels: DOCXExporterRels;
+    images: Record<string, ImageInfo>;
+    ctXML: XMLElement | null;
+    constructor(docContent: FidusNode, imageDB: ImageDB, xml: XmlZip, rels: DOCXExporterRels);
+    init(): Promise<void>;
+    addImage(imgFileName: string, image: Blob): number;
+    addContentType(fileEnding: string): void;
+    exportImages(): Promise<void>;
+}
+export {};
+//# sourceMappingURL=images.d.ts.map

package/dist/exporter/docx/images.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"images.d.ts","sourceRoot":"","sources":["../../../src/exporter/docx/images.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAC,SAAS,EAAE,OAAO,EAAC,MAAM,gBAAgB,CAAA;AAGtD,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,iBAAiB,CAAA;AAC/C,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,qBAAqB,CAAA;AAC/C,OAAO,KAAK,EAAC,gBAAgB,EAAC,MAAM,WAAW,CAAA;AAE/C,UAAU,SAAS;IACf,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,KAAK,CAAC,EAAE,MAAM,CAAA;CACjB;AAED,qBAAa,kBAAkB;IAC3B,UAAU,EAAE,SAAS,CAAA;IACrB,OAAO,EAAE,OAAO,CAAA;IAChB,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,gBAAgB,CAAA;IAEtB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAA;IACjC,KAAK,EAAE,UAAU,GAAG,IAAI,CAAA;gBAEZ,UAAU,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB;IAUxF,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAQrB,QAAQ,CAAC,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,GAAG,MAAM;IAQlD,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,IAAI;IAkBxC,YAAY,IAAI,OAAO,CAAC,IAAI,CAAC;CA0DhC"}

package/dist/exporter/docx/images.js

@@ -0,0 +1,101 @@
+import { get } from "fwtoolkit";
+import { descendantNodes } from "../tools/doc_content.js";
+import { svg2png } from "../tools/svg.js";
+export class DOCXExporterImages {
+    docContent;
+    imageDB;
+    xml;
+    rels;
+    images;
+    ctXML;
+    constructor(docContent, imageDB, xml, rels) {
+        this.docContent = docContent;
+        this.imageDB = imageDB;
+        this.xml = xml;
+        this.rels = rels;
+        this.images = {};
+        this.ctXML = null;
+    }
+    init() {
+        return this.xml.getXml("[Content_Types].xml").then(ctXML => {
+            this.ctXML = ctXML;
+            return this.exportImages();
+        });
+    }
+    // add an image to the list of files
+    addImage(imgFileName, image) {
+        const rId = this.rels.addImageRel(imgFileName);
+        this.addContentType(imgFileName.split(".").pop() || "");
+        this.xml.addExtraFile(`word/media/${imgFileName}`, image);
+        return rId;
+    }
+    // add a global contenttype declaration for an image type (if needed)
+    addContentType(fileEnding) {
+        if (!this.ctXML) {
+            return;
+        }
+        const types = this.ctXML.query("Types");
+        if (!types) {
+            return;
+        }
+        const contentDec = types.query("Default", { Extension: fileEnding });
+        if (!contentDec) {
+            const string = `<Default ContentType="image/${fileEnding}" Extension="${fileEnding}"/>`;
+            types.appendXML(string);
+        }
+    }
+    // Find all images used in file and add these to the export zip.
+    // TODO: This will likely fail on image types docx doesn't support such as SVG.
+    // Try out and fix.
+    exportImages() {
+        const usedImgs = [];
+        descendantNodes(this.docContent).forEach(node => {
+            if (node.type === "image" && node.attrs?.image !== false) {
+                const imageId = node.attrs?.image;
+                if (imageId !== undefined && !usedImgs.includes(imageId)) {
+                    usedImgs.push(imageId);
+                }
+            }
+        });
+        return new Promise(resolveExportImages => {
+            const p = [];
+            usedImgs.forEach(image => {
+                const imgDBEntry = this.imageDB.db[String(image)];
+                if (!imgDBEntry || !imgDBEntry.image) {
+                    return;
+                }
+                p.push(get(imgDBEntry.image)
+                    .then(response => response.blob())
+                    .then(async (blob) => {
+                    if (blob.type === "image/svg+xml") {
+                        // DOCX doesn't support SVG. Convert to PNG.
+                        const { blob: pngBlob, width, height } = await svg2png(blob);
+                        const wImgId = this.addImage(imgDBEntry.image
+                            .split("/")
+                            .pop()
+                            .replace(/.svg$/g, ".png"), pngBlob);
+                        this.images[String(image)] = {
+                            id: wImgId,
+                            width,
+                            height,
+                            title: imgDBEntry.title
+                        };
+                    }
+                    else {
+                        const wImgId = this.addImage(imgDBEntry.image.split("/").pop(), blob);
+                        this.images[String(image)] = {
+                            id: wImgId,
+                            width: imgDBEntry.width,
+                            height: imgDBEntry.height,
+                            title: imgDBEntry.title
+                        };
+                    }
+                }));
+            });
+            Promise.all(p).then(() => {
+                resolveExportImages();
+            });
+        });
+    }
+}
+//# sourceMappingURL=images.js.map

package/dist/exporter/docx/images.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"images.js","sourceRoot":"","sources":["../../../src/exporter/docx/images.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,GAAG,EAAC,MAAM,WAAW,CAAA;AAG7B,OAAO,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAA;AACvD,OAAO,EAAC,OAAO,EAAC,MAAM,iBAAiB,CAAA;AAYvC,MAAM,OAAO,kBAAkB;IAC3B,UAAU,CAAW;IACrB,OAAO,CAAS;IAChB,GAAG,CAAQ;IACX,IAAI,CAAkB;IAEtB,MAAM,CAA2B;IACjC,KAAK,CAAmB;IAExB,YAAY,UAAqB,EAAE,OAAgB,EAAE,GAAW,EAAE,IAAsB;QACpF,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;QACtB,IAAI,CAAC,GAAG,GAAG,GAAG,CAAA;QACd,IAAI,CAAC,IAAI,GAAG,IAAI,CAAA;QAEhB,IAAI,CAAC,MAAM,GAAG,EAAE,CAAA;QAChB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAA;IACrB,CAAC;IAED,IAAI;QACA,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;YACvD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAA;YAClB,OAAO,IAAI,CAAC,YAAY,EAAE,CAAA;QAC9B,CAAC,CAAC,CAAA;IACN,CAAC;IAED,oCAAoC;IACpC,QAAQ,CAAC,WAAmB,EAAE,KAAW;QACrC,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAA;QAC9C,IAAI,CAAC,cAAc,CAAC,WAAW,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,CAAC,CAAA;QACvD,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,cAAc,WAAW,EAAE,EAAE,KAAK,CAAC,CAAA;QACzD,OAAO,GAAG,CAAA;IACd,CAAC;IAED,qEAAqE;IACrE,cAAc,CAAC,UAAkB;QAC7B,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;YACd,OAAM;QACV,CAAC;QACD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QACvC,IAAI,CAAC,KAAK,EAAE,CAAC;YACT,OAAM;QACV,CAAC;QACD,MAAM,UAAU,GAAG,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE,EAAC,SAAS,EAAE,UAAU,EAAC,CAAC,CAAA;QAClE,IAAI,CAAC,UAAU,EAAE,CAAC;YACd,MAAM,MAAM,GAAG,+BAA+B,UAAU,gBAAgB,UAAU,KAAK,CAAA;YACvF,KAAK,CAAC,SAAS,CAAC,MAAM,CAAC,CAAA;QAC3B,CAAC;IACL,CAAC;IAED,gEAAgE;IAChE,+EAA+E;IAC/E,mBAAmB;IACnB,YAAY;QACR,MAAM,QAAQ,GAAwB,EAAE,CAAA;QACxC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YAC5C,IAAI,IAAI,CAAC,IAAI,KAAK,OAAO,IAAI,IAAI,CAAC,KAAK,EAAE,KAAK,KAAK,KAAK,EAAE,CAAC;gBACvD,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,EAAE,KAAoC,CAAA;gBAChE,IAAI,OAAO,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;oBACvD,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;gBAC1B,CAAC;YACL,CAAC;QACL,CAAC,CAAC,CAAA;QACF,OAAO,IAAI,OAAO,CAAC,mBAAmB,CAAC,EAAE;YACrC,MAAM,CAAC,GAAyB,EAAE,CAAA;YAClC,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE;gBACrB,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAA;gBACjD,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;oBACnC,OAAM;gBACV,CAAC;gBACD,CAAC,CAAC,IAAI,CACF,GAAG,CAAC,UAAU,CAAC,KAAe,CAAC;qBAC1B,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC;qBACjC,IAAI,CAAC,KAAK,EAAC,IAAI,EAAC,EAAE;oBACf,IAAI,IAAI,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;wBAChC,4CAA4C;wBAC5C,MAAM,EAAC,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAC,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;wBAC1D,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CACvB,UAAU,CAAC,KAAgB;6BACvB,KAAK,CAAC,GAAG,CAAC;6BACV,GAAG,EAAG;6BACN,OAAO,CAAC,QAAQ,EAAE,MAAM,CAAC,EAC9B,OAAO,CACV,CAAA;wBACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG;4BACzB,EAAE,EAAE,MAAM;4BACV,KAAK;4BACL,MAAM;4BACN,KAAK,EAAE,UAAU,CAAC,KAA2B;yBAChD,CAAA;oBACL,CAAC;yBAAM,CAAC;wBACJ,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CACvB,UAAU,CAAC,KAAgB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,EAAG,EAC9C,IAAI,CACP,CAAA;wBACD,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,GAAG;4BACzB,EAAE,EAAE,MAAM;4BACV,KAAK,EAAE,UAAU,CAAC,KAAe;4BACjC,MAAM,EAAE,UAAU,CAAC,MAAgB;4BACnC,KAAK,EAAE,UAAU,CAAC,KAA2B;yBAChD,CAAA;oBACL,CAAC;gBACL,CAAC,CAAC,CACT,CAAA;YACL,CAAC,CAAC,CAAA;YAEF,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE;gBACrB,mBAAmB,EAAE,CAAA;YACzB,CAAC,CAAC,CAAA;QACN,CAAC,CAAC,CAAA;IACN,CAAC;CACJ"}

package/dist/exporter/docx/index.d.ts

@@ -0,0 +1,16 @@
+import type { BibDB, CSL, ExportDoc, ImageDB } from "../../types.js";
+export declare class DOCXExporter {
+    doc: ExportDoc;
+    templateUrl: string;
+    bibDB: BibDB;
+    imageDB: ImageDB;
+    csl: CSL;
+    docTitle: string;
+    mimeType: string;
+    docContent: any;
+    constructor(doc: ExportDoc, templateUrl: string, bibDB: BibDB, imageDB: ImageDB, csl: CSL);
+    init(): Promise<void>;
+    download(blob: Blob): void;
+    getBaseMetadata(): any;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/exporter/docx/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/exporter/docx/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,KAAK,EAAE,GAAG,EAAE,SAAS,EAAa,OAAO,EAAC,MAAM,gBAAgB,CAAA;AA6B7E,qBAAa,YAAY;IACrB,GAAG,EAAE,SAAS,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,KAAK,CAAA;IACZ,OAAO,EAAE,OAAO,CAAA;IAChB,GAAG,EAAE,GAAG,CAAA;IAER,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,GAAG,CAAA;gBAGX,GAAG,EAAE,SAAS,EACd,WAAW,EAAE,MAAM,EACnB,KAAK,EAAE,KAAK,EACZ,OAAO,EAAE,OAAO,EAChB,GAAG,EAAE,GAAG;IAgBZ,IAAI,IAAI,OAAO,CAAC,IAAI,CAAC;IAyFrB,QAAQ,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI;IAQ1B,eAAe,IAAI,GAAG;CA8CzB"}