docx 7.8.2 → 8.0.1

package/src/export/packer/next-compiler.spec.ts

@@ -1,180 +0,0 @@
-/* tslint:disable:typedef space-before-function-paren */
-import { expect } from "chai";
-import * as sinon from "sinon";
-
-import { File } from "@file/file";
-import { Footer, Header } from "@file/header";
-import { ImageRun, Paragraph } from "@file/paragraph";
-import * as convenienceFunctions from "@util/convenience-functions";
-
-import { Compiler } from "./next-compiler";
-
-describe("Compiler", () => {
-    let compiler: Compiler;
-
-    beforeEach(() => {
-        compiler = new Compiler();
-    });
-
-    before(() => {
-        sinon.stub(convenienceFunctions, "uniqueId").callsFake(() => "test");
-    });
-
-    after(() => {
-        (convenienceFunctions.uniqueId as sinon.SinonStub).restore();
-    });
-
-    describe("#compile()", () => {
-        it("should pack all the content", function () {
-            this.timeout(99999999);
-            const file = new File({
-                sections: [],
-                comments: {
-                    children: [],
-                },
-            });
-            const zipFile = compiler.compile(file);
-            const fileNames = Object.keys(zipFile.files).map((f) => zipFile.files[f].name);
-
-            expect(fileNames).is.an.instanceof(Array);
-            expect(fileNames).has.length(17);
-            expect(fileNames).to.include("word/document.xml");
-            expect(fileNames).to.include("word/styles.xml");
-            expect(fileNames).to.include("docProps/core.xml");
-            expect(fileNames).to.include("docProps/custom.xml");
-            expect(fileNames).to.include("docProps/app.xml");
-            expect(fileNames).to.include("word/numbering.xml");
-            expect(fileNames).to.include("word/footnotes.xml");
-            expect(fileNames).to.include("word/_rels/footnotes.xml.rels");
-            expect(fileNames).to.include("word/settings.xml");
-            expect(fileNames).to.include("word/comments.xml");
-            expect(fileNames).to.include("word/_rels/document.xml.rels");
-            expect(fileNames).to.include("[Content_Types].xml");
-            expect(fileNames).to.include("_rels/.rels");
-        });
-
-        it("should pack all additional headers and footers", function () {
-            const file = new File({
-                sections: [
-                    {
-                        headers: {
-                            default: new Header({
-                                children: [new Paragraph("test")],
-                            }),
-                        },
-                        footers: {
-                            default: new Footer({
-                                children: [new Paragraph("test")],
-                            }),
-                        },
-                        children: [],
-                    },
-                    {
-                        headers: {
-                            default: new Header({
-                                children: [new Paragraph("test")],
-                            }),
-                        },
-                        footers: {
-                            default: new Footer({
-                                children: [new Paragraph("test")],
-                            }),
-                        },
-                        children: [],
-                    },
-                ],
-            });
-
-            this.timeout(99999999);
-
-            const zipFile = compiler.compile(file);
-            const fileNames = Object.keys(zipFile.files).map((f) => zipFile.files[f].name);
-
-            expect(fileNames).is.an.instanceof(Array);
-            expect(fileNames).has.length(25);
-
-            expect(fileNames).to.include("word/header1.xml");
-            expect(fileNames).to.include("word/_rels/header1.xml.rels");
-            expect(fileNames).to.include("word/header2.xml");
-            expect(fileNames).to.include("word/_rels/header2.xml.rels");
-            expect(fileNames).to.include("word/footer1.xml");
-            expect(fileNames).to.include("word/_rels/footer1.xml.rels");
-            expect(fileNames).to.include("word/footer2.xml");
-            expect(fileNames).to.include("word/_rels/footer2.xml.rels");
-        });
-
-        it("should call the format method X times equalling X files to be formatted", () => {
-            // This test is required because before, there was a case where Document was formatted twice, which was inefficient
-            // This also caused issues such as running prepForXml multiple times as format() was ran multiple times.
-            const paragraph = new Paragraph("");
-            const file = new File({
-                sections: [
-                    {
-                        properties: {},
-                        children: [paragraph],
-                    },
-                ],
-            });
-
-            // tslint:disable-next-line: no-string-literal
-            const spy = sinon.spy(compiler["formatter"], "format");
-
-            compiler.compile(file);
-            expect(spy.callCount).to.equal(13);
-        });
-
-        it("should work with media datas", () => {
-            // This test is required because before, there was a case where Document was formatted twice, which was inefficient
-            // This also caused issues such as running prepForXml multiple times as format() was ran multiple times.
-            const file = new File({
-                sections: [
-                    {
-                        headers: {
-                            default: new Header({
-                                children: [new Paragraph("test")],
-                            }),
-                        },
-                        footers: {
-                            default: new Footer({
-                                children: [new Paragraph("test")],
-                            }),
-                        },
-                        children: [
-                            new Paragraph({
-                                children: [
-                                    new ImageRun({
-                                        data: Buffer.from("", "base64"),
-                                        transformation: {
-                                            width: 100,
-                                            height: 100,
-                                        },
-                                    }),
-                                ],
-                            }),
-                        ],
-                    },
-                ],
-            });
-
-            // tslint:disable-next-line: no-string-literal
-            sinon.stub(compiler["imageReplacer"], "getMediaData").returns([
-                {
-                    stream: Buffer.from(""),
-                    fileName: "test",
-                    transformation: {
-                        pixels: {
-                            x: 100,
-                            y: 100,
-                        },
-                        emus: {
-                            x: 100,
-                            y: 100,
-                        },
-                    },
-                },
-            ]);
-
-            compiler.compile(file);
-        });
-    });
-});

package/src/export/packer/next-compiler.ts

@@ -1,426 +0,0 @@
-import * as JSZip from "jszip";
-import * as xml from "xml";
-
-import { File } from "@file/file";
-
-import { Formatter } from "../formatter";
-import { ImageReplacer } from "./image-replacer";
-import { NumberingReplacer } from "./numbering-replacer";
-import { PrettifyType } from "./packer";
-
-interface IXmlifyedFile {
-    readonly data: string;
-    readonly path: string;
-}
-
-interface IXmlifyedFileMapping {
-    readonly Document: IXmlifyedFile;
-    readonly Styles: IXmlifyedFile;
-    readonly Properties: IXmlifyedFile;
-    readonly Numbering: IXmlifyedFile;
-    readonly Relationships: IXmlifyedFile;
-    readonly FileRelationships: IXmlifyedFile;
-    readonly Headers: readonly IXmlifyedFile[];
-    readonly Footers: readonly IXmlifyedFile[];
-    readonly HeaderRelationships: readonly IXmlifyedFile[];
-    readonly FooterRelationships: readonly IXmlifyedFile[];
-    readonly ContentTypes: IXmlifyedFile;
-    readonly CustomProperties: IXmlifyedFile;
-    readonly AppProperties: IXmlifyedFile;
-    readonly FootNotes: IXmlifyedFile;
-    readonly FootNotesRelationships: IXmlifyedFile;
-    readonly Settings: IXmlifyedFile;
-    readonly Comments?: IXmlifyedFile;
-}
-
-export class Compiler {
-    private readonly formatter: Formatter;
-    private readonly imageReplacer: ImageReplacer;
-    private readonly numberingReplacer: NumberingReplacer;
-
-    public constructor() {
-        this.formatter = new Formatter();
-        this.imageReplacer = new ImageReplacer();
-        this.numberingReplacer = new NumberingReplacer();
-    }
-
-    public compile(file: File, prettifyXml?: boolean | PrettifyType): JSZip {
-        const zip = new JSZip();
-        const xmlifiedFileMapping = this.xmlifyFile(file, prettifyXml);
-        const map = new Map<string, IXmlifyedFile | readonly IXmlifyedFile[]>(Object.entries(xmlifiedFileMapping));
-
-        for (const [, obj] of map) {
-            if (Array.isArray(obj)) {
-                for (const subFile of obj as readonly IXmlifyedFile[]) {
-                    zip.file(subFile.path, subFile.data);
-                }
-            } else {
-                zip.file((obj as IXmlifyedFile).path, (obj as IXmlifyedFile).data);
-            }
-        }
-
-        for (const data of file.Media.Array) {
-            const mediaData = data.stream;
-            zip.file(`word/media/${data.fileName}`, mediaData);
-        }
-
-        return zip;
-    }
-
-    private xmlifyFile(file: File, prettify?: boolean | PrettifyType): IXmlifyedFileMapping {
-        const documentRelationshipCount = file.Document.Relationships.RelationshipCount + 1;
-
-        const documentXmlData = xml(
-            this.formatter.format(file.Document.View, {
-                viewWrapper: file.Document,
-                file,
-            }),
-            {
-                indent: prettify,
-                declaration: {
-                    standalone: "yes",
-                    encoding: "UTF-8",
-                },
-            },
-        );
-        const documentMediaDatas = this.imageReplacer.getMediaData(documentXmlData, file.Media);
-
-        return {
-            Relationships: {
-                data: (() => {
-                    documentMediaDatas.forEach((mediaData, i) => {
-                        file.Document.Relationships.createRelationship(
-                            documentRelationshipCount + i,
-                            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image",
-                            `media/${mediaData.fileName}`,
-                        );
-                    });
-
-                    return xml(
-                        this.formatter.format(file.Document.Relationships, {
-                            viewWrapper: file.Document,
-                            file,
-                        }),
-                        {
-                            indent: prettify,
-                            declaration: {
-                                encoding: "UTF-8",
-                            },
-                        },
-                    );
-                })(),
-                path: "word/_rels/document.xml.rels",
-            },
-            Document: {
-                data: (() => {
-                    const xmlData = this.imageReplacer.replace(documentXmlData, documentMediaDatas, documentRelationshipCount);
-                    const referenedXmlData = this.numberingReplacer.replace(xmlData, file.Numbering.ConcreteNumbering);
-                    return referenedXmlData;
-                })(),
-                path: "word/document.xml",
-            },
-            Styles: {
-                data: (() => {
-                    const xmlStyles = xml(
-                        this.formatter.format(file.Styles, {
-                            viewWrapper: file.Document,
-                            file,
-                        }),
-                        {
-                            indent: prettify,
-                            declaration: {
-                                standalone: "yes",
-                                encoding: "UTF-8",
-                            },
-                        },
-                    );
-                    const referencedXmlStyles = this.numberingReplacer.replace(xmlStyles, file.Numbering.ConcreteNumbering);
-                    return referencedXmlStyles;
-                })(),
-                path: "word/styles.xml",
-            },
-            Properties: {
-                data: xml(
-                    this.formatter.format(file.CoreProperties, {
-                        viewWrapper: file.Document,
-                        file,
-                    }),
-                    {
-                        indent: prettify,
-                        declaration: {
-                            standalone: "yes",
-                            encoding: "UTF-8",
-                        },
-                    },
-                ),
-                path: "docProps/core.xml",
-            },
-            Numbering: {
-                data: xml(
-                    this.formatter.format(file.Numbering, {
-                        viewWrapper: file.Document,
-                        file,
-                    }),
-                    {
-                        indent: prettify,
-                        declaration: {
-                            standalone: "yes",
-                            encoding: "UTF-8",
-                        },
-                    },
-                ),
-                path: "word/numbering.xml",
-            },
-            FileRelationships: {
-                data: xml(
-                    this.formatter.format(file.FileRelationships, {
-                        viewWrapper: file.Document,
-                        file,
-                    }),
-                    {
-                        indent: prettify,
-                        declaration: {
-                            encoding: "UTF-8",
-                        },
-                    },
-                ),
-                path: "_rels/.rels",
-            },
-            HeaderRelationships: file.Headers.map((headerWrapper, index) => {
-                const xmlData = xml(
-                    this.formatter.format(headerWrapper.View, {
-                        viewWrapper: headerWrapper,
-                        file,
-                    }),
-                    {
-                        indent: prettify,
-                        declaration: {
-                            encoding: "UTF-8",
-                        },
-                    },
-                );
-                const mediaDatas = this.imageReplacer.getMediaData(xmlData, file.Media);
-
-                mediaDatas.forEach((mediaData, i) => {
-                    headerWrapper.Relationships.createRelationship(
-                        i,
-                        "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image",
-                        `media/${mediaData.fileName}`,
-                    );
-                });
-
-                return {
-                    data: xml(
-                        this.formatter.format(headerWrapper.Relationships, {
-                            viewWrapper: headerWrapper,
-                            file,
-                        }),
-                        {
-                            indent: prettify,
-                            declaration: {
-                                encoding: "UTF-8",
-                            },
-                        },
-                    ),
-                    path: `word/_rels/header${index + 1}.xml.rels`,
-                };
-            }),
-            FooterRelationships: file.Footers.map((footerWrapper, index) => {
-                const xmlData = xml(
-                    this.formatter.format(footerWrapper.View, {
-                        viewWrapper: footerWrapper,
-                        file,
-                    }),
-                    {
-                        indent: prettify,
-                        declaration: {
-                            encoding: "UTF-8",
-                        },
-                    },
-                );
-                const mediaDatas = this.imageReplacer.getMediaData(xmlData, file.Media);
-
-                mediaDatas.forEach((mediaData, i) => {
-                    footerWrapper.Relationships.createRelationship(
-                        i,
-                        "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image",
-                        `media/${mediaData.fileName}`,
-                    );
-                });
-
-                return {
-                    data: xml(
-                        this.formatter.format(footerWrapper.Relationships, {
-                            viewWrapper: footerWrapper,
-                            file,
-                        }),
-                        {
-                            indent: prettify,
-                            declaration: {
-                                encoding: "UTF-8",
-                            },
-                        },
-                    ),
-                    path: `word/_rels/footer${index + 1}.xml.rels`,
-                };
-            }),
-            Headers: file.Headers.map((headerWrapper, index) => {
-                const tempXmlData = xml(
-                    this.formatter.format(headerWrapper.View, {
-                        viewWrapper: headerWrapper,
-                        file,
-                    }),
-                    {
-                        indent: prettify,
-                        declaration: {
-                            encoding: "UTF-8",
-                        },
-                    },
-                );
-                const mediaDatas = this.imageReplacer.getMediaData(tempXmlData, file.Media);
-                // TODO: 0 needs to be changed when headers get relationships of their own
-                const xmlData = this.imageReplacer.replace(tempXmlData, mediaDatas, 0);
-
-                const referenedXmlData = this.numberingReplacer.replace(xmlData, file.Numbering.ConcreteNumbering);
-
-                return {
-                    data: referenedXmlData,
-                    path: `word/header${index + 1}.xml`,
-                };
-            }),
-            Footers: file.Footers.map((footerWrapper, index) => {
-                const tempXmlData = xml(
-                    this.formatter.format(footerWrapper.View, {
-                        viewWrapper: footerWrapper,
-                        file,
-                    }),
-                    {
-                        indent: prettify,
-                        declaration: {
-                            encoding: "UTF-8",
-                        },
-                    },
-                );
-                const mediaDatas = this.imageReplacer.getMediaData(tempXmlData, file.Media);
-                // TODO: 0 needs to be changed when headers get relationships of their own
-                const xmlData = this.imageReplacer.replace(tempXmlData, mediaDatas, 0);
-
-                const referenedXmlData = this.numberingReplacer.replace(xmlData, file.Numbering.ConcreteNumbering);
-
-                return {
-                    data: referenedXmlData,
-                    path: `word/footer${index + 1}.xml`,
-                };
-            }),
-            ContentTypes: {
-                data: xml(
-                    this.formatter.format(file.ContentTypes, {
-                        viewWrapper: file.Document,
-                        file,
-                    }),
-                    {
-                        indent: prettify,
-                        declaration: {
-                            encoding: "UTF-8",
-                        },
-                    },
-                ),
-                path: "[Content_Types].xml",
-            },
-            CustomProperties: {
-                data: xml(
-                    this.formatter.format(file.CustomProperties, {
-                        viewWrapper: file.Document,
-                        file,
-                    }),
-                    {
-                        indent: prettify,
-                        declaration: {
-                            standalone: "yes",
-                            encoding: "UTF-8",
-                        },
-                    },
-                ),
-                path: "docProps/custom.xml",
-            },
-            AppProperties: {
-                data: xml(
-                    this.formatter.format(file.AppProperties, {
-                        viewWrapper: file.Document,
-                        file,
-                    }),
-                    {
-                        indent: prettify,
-                        declaration: {
-                            standalone: "yes",
-                            encoding: "UTF-8",
-                        },
-                    },
-                ),
-                path: "docProps/app.xml",
-            },
-            FootNotes: {
-                data: xml(
-                    this.formatter.format(file.FootNotes.View, {
-                        viewWrapper: file.FootNotes,
-                        file: file,
-                    }),
-                    {
-                        indent: prettify,
-                        declaration: {
-                            encoding: "UTF-8",
-                        },
-                    },
-                ),
-                path: "word/footnotes.xml",
-            },
-            FootNotesRelationships: {
-                data: xml(
-                    this.formatter.format(file.FootNotes.Relationships, {
-                        viewWrapper: file.FootNotes,
-                        file: file,
-                    }),
-                    {
-                        indent: prettify,
-                        declaration: {
-                            encoding: "UTF-8",
-                        },
-                    },
-                ),
-                path: "word/_rels/footnotes.xml.rels",
-            },
-            Settings: {
-                data: xml(
-                    this.formatter.format(file.Settings, {
-                        viewWrapper: file.Document,
-                        file,
-                    }),
-                    {
-                        indent: prettify,
-                        declaration: {
-                            standalone: "yes",
-                            encoding: "UTF-8",
-                        },
-                    },
-                ),
-                path: "word/settings.xml",
-            },
-            Comments: {
-                data: xml(
-                    this.formatter.format(file.Comments, {
-                        viewWrapper: file.Document,
-                        file,
-                    }),
-                    {
-                        indent: prettify,
-                        declaration: {
-                            standalone: "yes",
-                            encoding: "UTF-8",
-                        },
-                    },
-                ),
-                path: "word/comments.xml",
-            },
-        };
-    }
-}

package/src/export/packer/numbering-replacer.ts

@@ -1,16 +0,0 @@
-import { ConcreteNumbering } from "@file/numbering";
-
-export class NumberingReplacer {
-    public replace(xmlData: string, concreteNumberings: readonly ConcreteNumbering[]): string {
-        let currentXmlData = xmlData;
-
-        for (const concreteNumbering of concreteNumberings) {
-            currentXmlData = currentXmlData.replace(
-                new RegExp(`{${concreteNumbering.reference}-${concreteNumbering.instance}}`, "g"),
-                concreteNumbering.numId.toString(),
-            );
-        }
-
-        return currentXmlData;
-    }
-}