Merge pull request #373 from dolanmiu/feat/declaritive

Static Packer

demo/1-basic.ts

@@ -24,8 +24,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/10-my-cv.ts

@@ -336,8 +336,6 @@ const documentCreator = new DocumentCreator();
 
 const doc = documentCreator.create([experiences, education, skills, achievements]);
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/11-declaritive-styles-2.ts

@@ -163,8 +163,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/12-scaling-images.ts

@@ -14,8 +14,6 @@ doc.addSection({
     children: [new Paragraph("Hello World"), new Paragraph(image), new Paragraph(image2), new Paragraph(image3), new Paragraph(image4)],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/13-xml-styles.ts

@@ -27,8 +27,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/14-page-numbers.ts

@@ -32,8 +32,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/15-page-break-before.ts

@@ -15,8 +15,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/16-multiple-sections.ts

@@ -107,8 +107,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/17-footnotes.ts

@@ -12,8 +12,6 @@ doc.addSection({
 doc.createFootnote(new Paragraph("Test"));
 doc.createFootnote(new Paragraph("My amazing reference"));
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/18-image-from-buffer.ts

@@ -17,8 +17,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/19-export-to-base64.ts

@@ -23,8 +23,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBase64String(doc).then((str) => {
-
-packer.toBase64String(doc).then((str) => {
     fs.writeFileSync("My Document.docx", str);
 });

demo/2-declaritive-styles.ts

@@ -117,8 +117,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/20-table-cell-borders.ts

@@ -19,8 +19,6 @@ table
     .addStartBorder(BorderStyle.DOT_DOT_DASH, 3, "green")
     .addEndBorder(BorderStyle.DOT_DOT_DASH, 3, "#ff8000");
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/21-bookmarks.ts

@@ -30,8 +30,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/22-right-to-left-text.ts

@@ -39,8 +39,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/23-base64-images.ts

@@ -27,8 +27,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/24-images-to-table-cell.ts

@@ -19,8 +19,6 @@ table.getCell(2, 2).add(new Paragraph("Hello"));
 const image = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
 table.getCell(1, 1).add(new Paragraph(image));
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/26-paragraph-borders.ts

@@ -28,8 +28,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/27-declaritive-styles-3.ts

@@ -37,8 +37,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/28-table-of-contents.ts

@@ -48,12 +48,9 @@ doc.addSection({
             style: "MySpectacularStyle",
             pageBreakBefore: true,
         }),
-
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/29-numbered-lists.ts

@@ -61,8 +61,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/3-numbering-and-bullet-points.ts

@@ -71,8 +71,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/30-template-document.ts

@@ -23,8 +23,7 @@ fs.readFile(filePath, (err, data) => {
             children: [new Paragraph("Hello World")],
         });
 
-        const packer = new Packer();
+        Packer.toBuffer(doc).then((buffer) => {
-        packer.toBuffer(doc).then((buffer) => {
             fs.writeFileSync("My Document.docx", buffer);
         });
     });

demo/31-tables.ts

@@ -27,8 +27,6 @@ doc.addSection({
     children: [table],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/32-merge-table-cells.ts

@@ -108,8 +108,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/33-sequential-captions.ts

@@ -26,8 +26,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/34-floating-tables.ts

@@ -36,8 +36,6 @@ doc.addSection({
     children: [table],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/35-hyperlinks.ts

@@ -12,8 +12,6 @@ doc.addSection({
     children: [paragraph],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/36-image-to-table-cell.ts

@@ -22,8 +22,6 @@ doc.addSection({
     children: [table],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/37-images-to-header-and-footer.ts

@@ -17,8 +17,6 @@ doc.addSection({
     children: [new Paragraph("Hello World")],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/38-text-wrapping.ts

@@ -40,8 +40,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/39-page-numbers.ts

@@ -40,8 +40,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/4-basic-table.ts

@@ -16,8 +16,6 @@ doc.addSection({
     children: [table],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/40-line-numbers.ts

@@ -24,8 +24,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/41-merge-table-cells-2.ts

@@ -49,8 +49,6 @@ doc.addSection({
     children: [table],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/43-images-to-table-cell-2.ts

@@ -17,8 +17,6 @@ doc.addSection({
     children: [table],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/44-multiple-columns.ts

@@ -35,8 +35,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/45-highlighting-text.ts

@@ -30,8 +30,6 @@ doc.addSection({
     children: [],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/46-shading-text.ts

@@ -34,8 +34,6 @@ doc.addSection({
     children: [],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/5-images.ts

@@ -57,8 +57,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/6-page-borders.ts

@@ -35,8 +35,6 @@ doc.addSection({
     ],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/7-landscape.ts

@@ -12,8 +12,6 @@ doc.addSection({
     children: [new Paragraph("Hello World")],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/8-header-footer.ts

@@ -19,8 +19,6 @@ doc.addSection({
     children: [new Paragraph("Hello World")],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/9-images-in-header-and-footer.ts

@@ -30,8 +30,6 @@ doc.addSection({
     children: [new Paragraph("Hello World")],
 });
 
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/browser-demo.html

@@ -32,9 +32,9 @@
                     ],
                 });
 
-                const packer = new Packer();
 
-                packer.toBlob(doc).then((blob) => {
+
+                Packer.toBlob(doc).then((blob) => {
                     console.log(blob);
                     saveAs(blob, "example.docx");
                     console.log("Document created successfully");

docs/README.md

@@ -59,9 +59,7 @@ doc.addSection({
 });
 
 // Used to export the file into a .docx file
-const packer = new Packer();
+Packer.toBuffer(doc).then((buffer) => {
-
-packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });
 

docs/usage/packers.md

@@ -2,9 +2,44 @@
 
 > Packers are the way in which `docx` turns your code into `.docx` format. It is completely decoupled from the `docx.Document`.
 
+Packers in `version 4` and above are now one single `Packer`. It works in both a node and browser environment (Angular etc). Now, the packer returns a `Buffer`, `Blob` or `base64 string`. It is up to you to take that and persist it with node's `fs`, send it down as a downloadable file, or anything else you wish. As of version 4, this library will not have options to export to PDF.
+
+## Version 5
+
+Packers in `version 5` and above are now static methods on `Packer`.
+
+### Export as Buffer
+
+This will return a NodeJS `Buffer`. If this is used in the browser, it will return a `UInt8Array` instead.
+
+```ts
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});
+```
+
+### Export as a `base64` string
+
+```ts
+Packer.toBase64String(doc).then((string) => {
+    console.log(string);
+});
+```
+
+### Export as Blob
+
+This is useful if you want to send it as an downloadable in a browser environment.
+
+```ts
+Packer.toBlob(doc).then((blob) => {
+    // saveAs from FileSaver will download the file
+    saveAs(blob, "example.docx");
+});
+```
+
 ## Version 4
 
-Packers in `version 4` and above are now one single `Packer`. It works in both a node and browser environment (Angular etc). Now, the packer returns a `Buffer`, `Blob` or `base64 string`. It is up to you to take that and persist it with node's `fs`, send it down as a downloadable file, or anything else you wish. As of version 4, this library will not have options to export to PDF.
+The `Packer` in `version 4` requires an instance of `Packer`, so be sure to `new` it.
 
 ### Export as Buffer
 

docs/usage/styling-with-js.md

@@ -107,8 +107,7 @@ There are three parts to using custom styles with `docx`:
 3.  When you generate your document, make sure to pass the `styles` container to the `Packer`:
 
     ```ts
-    const packer = new Packer(doc, myStyles);
+    Packer.pack(myOutStream);
-    packer.pack(myOutStream);
     ```
 
 **Note**: If you are using the `.headingX` or `.title` methods of paragraphs, you must make sure to define `HeadingX` or `Title` styles for these. Otherwise they'll show up unstyled :(. If you are using the `.bullet` or `.setNumbering` methods, you need to define a `ListParagraph` style or the numbers may not show up.

src/export/packer/next-compiler.ts

@@ -30,17 +30,15 @@ interface IXmlifyedFileMapping {
 export class Compiler {
     private readonly formatter: Formatter;
     private readonly imageReplacer: ImageReplacer;
-    private readonly prettifyXml?: boolean;
 
-    constructor(prettifyXml?: boolean) {
+    constructor() {
         this.formatter = new Formatter();
         this.imageReplacer = new ImageReplacer();
-        this.prettifyXml = prettifyXml;
     }
 
-    public compile(file: File): JSZip {
+    public compile(file: File, prettifyXml?: boolean): JSZip {
         const zip = new JSZip();
-        const xmlifiedFileMapping = this.xmlifyFile(file);
+        const xmlifiedFileMapping = this.xmlifyFile(file, prettifyXml);
 
         for (const key in xmlifiedFileMapping) {
             if (!xmlifiedFileMapping[key]) {
@@ -66,14 +64,14 @@ export class Compiler {
         return zip;
     }
 
-    private xmlifyFile(file: File): IXmlifyedFileMapping {
+    private xmlifyFile(file: File, prettify?: boolean): IXmlifyedFileMapping {
         file.verifyUpdateFields();
         const documentRelationshipCount = file.DocumentRelationships.RelationshipCount + 1;
 
         return {
             Relationships: {
                 data: (() => {
-                    const xmlData = xml(this.formatter.format(file.Document), this.prettifyXml);
+                    const xmlData = xml(this.formatter.format(file.Document), prettify);
                     const mediaDatas = this.imageReplacer.getMediaData(xmlData, file.Media);
 
                     mediaDatas.forEach((mediaData, i) => {
@@ -84,13 +82,13 @@ export class Compiler {
                         );
                     });
 
-                    return xml(this.formatter.format(file.DocumentRelationships), this.prettifyXml);
+                    return xml(this.formatter.format(file.DocumentRelationships), prettify);
                 })(),
                 path: "word/_rels/document.xml.rels",
             },
             Document: {
                 data: (() => {
-                    const tempXmlData = xml(this.formatter.format(file.Document), this.prettifyXml);
+                    const tempXmlData = xml(this.formatter.format(file.Document), prettify);
                     const mediaDatas = this.imageReplacer.getMediaData(tempXmlData, file.Media);
                     const xmlData = this.imageReplacer.replace(tempXmlData, mediaDatas, documentRelationshipCount);
 
@@ -99,7 +97,7 @@ export class Compiler {
                 path: "word/document.xml",
             },
             Styles: {
-                data: xml(this.formatter.format(file.Styles), this.prettifyXml),
+                data: xml(this.formatter.format(file.Styles), prettify),
                 path: "word/styles.xml",
             },
             Properties: {
@@ -112,15 +110,15 @@ export class Compiler {
                 path: "docProps/core.xml",
             },
             Numbering: {
-                data: xml(this.formatter.format(file.Numbering), this.prettifyXml),
+                data: xml(this.formatter.format(file.Numbering), prettify),
                 path: "word/numbering.xml",
             },
             FileRelationships: {
-                data: xml(this.formatter.format(file.FileRelationships), this.prettifyXml),
+                data: xml(this.formatter.format(file.FileRelationships), prettify),
                 path: "_rels/.rels",
             },
             HeaderRelationships: file.Headers.map((headerWrapper, index) => {
-                const xmlData = xml(this.formatter.format(headerWrapper.Header), this.prettifyXml);
+                const xmlData = xml(this.formatter.format(headerWrapper.Header), prettify);
                 const mediaDatas = this.imageReplacer.getMediaData(xmlData, file.Media);
 
                 mediaDatas.forEach((mediaData, i) => {
@@ -132,12 +130,12 @@ export class Compiler {
                 });
 
                 return {
-                    data: xml(this.formatter.format(headerWrapper.Relationships), this.prettifyXml),
+                    data: xml(this.formatter.format(headerWrapper.Relationships), prettify),
                     path: `word/_rels/header${index + 1}.xml.rels`,
                 };
             }),
             FooterRelationships: file.Footers.map((footerWrapper, index) => {
-                const xmlData = xml(this.formatter.format(footerWrapper.Footer), this.prettifyXml);
+                const xmlData = xml(this.formatter.format(footerWrapper.Footer), prettify);
                 const mediaDatas = this.imageReplacer.getMediaData(xmlData, file.Media);
 
                 mediaDatas.forEach((mediaData, i) => {
@@ -149,12 +147,12 @@ export class Compiler {
                 });
 
                 return {
-                    data: xml(this.formatter.format(footerWrapper.Relationships), this.prettifyXml),
+                    data: xml(this.formatter.format(footerWrapper.Relationships), prettify),
                     path: `word/_rels/footer${index + 1}.xml.rels`,
                 };
             }),
             Headers: file.Headers.map((headerWrapper, index) => {
-                const tempXmlData = xml(this.formatter.format(headerWrapper.Header), this.prettifyXml);
+                const tempXmlData = xml(this.formatter.format(headerWrapper.Header), prettify);
                 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);
@@ -165,7 +163,7 @@ export class Compiler {
                 };
             }),
             Footers: file.Footers.map((footerWrapper, index) => {
-                const tempXmlData = xml(this.formatter.format(footerWrapper.Footer), this.prettifyXml);
+                const tempXmlData = xml(this.formatter.format(footerWrapper.Footer), prettify);
                 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);
@@ -176,19 +174,19 @@ export class Compiler {
                 };
             }),
             ContentTypes: {
-                data: xml(this.formatter.format(file.ContentTypes), this.prettifyXml),
+                data: xml(this.formatter.format(file.ContentTypes), prettify),
                 path: "[Content_Types].xml",
             },
             AppProperties: {
-                data: xml(this.formatter.format(file.AppProperties), this.prettifyXml),
+                data: xml(this.formatter.format(file.AppProperties), prettify),
                 path: "docProps/app.xml",
             },
             FootNotes: {
-                data: xml(this.formatter.format(file.FootNotes), this.prettifyXml),
+                data: xml(this.formatter.format(file.FootNotes), prettify),
                 path: "word/footnotes.xml",
             },
             Settings: {
-                data: xml(this.formatter.format(file.Settings), this.prettifyXml),
+                data: xml(this.formatter.format(file.Settings), prettify),
                 path: "word/settings.xml",
             },
         };

src/export/packer/packer.spec.ts

@@ -7,7 +7,6 @@ import { File, HeadingLevel, Paragraph } from "file";
 import { Packer } from "./packer";
 
 describe("Packer", () => {
-    let packer: Packer;
     let file: File;
 
     beforeEach(() => {
@@ -34,14 +33,12 @@ describe("Packer", () => {
                 new Paragraph("test text"),
             ],
         });
-
-        packer = new Packer();
     });
 
     describe("#toBuffer()", () => {
         it("should create a standard docx file", async function() {
             this.timeout(99999999);
-            const buffer = await packer.toBuffer(file);
+            const buffer = await Packer.toBuffer(file);
 
             assert.isDefined(buffer);
             assert.isTrue(buffer.byteLength > 0);
@@ -49,19 +46,24 @@ describe("Packer", () => {
 
         it("should handle exception if it throws any", () => {
             // tslint:disable-next-line:no-any
-            const compiler = stub((packer as any).compiler, "compile");
+            const compiler = stub((Packer as any).compiler, "compile");
 
             compiler.throwsException();
-            return packer.toBuffer(file).catch((error) => {
+            return Packer.toBuffer(file).catch((error) => {
                 assert.isDefined(error);
             });
         });
+
+        after(() => {
+            // tslint:disable-next-line:no-any
+            (Packer as any).compiler.compile.restore();
+        });
     });
 
     describe("#toBase64String()", () => {
         it("should create a standard docx file", async function() {
             this.timeout(99999999);
-            const str = await packer.toBase64String(file);
+            const str = await Packer.toBase64String(file);
 
             assert.isDefined(str);
             assert.isTrue(str.length > 0);
@@ -69,12 +71,17 @@ describe("Packer", () => {
 
         it("should handle exception if it throws any", () => {
             // tslint:disable-next-line:no-any
-            const compiler = stub((packer as any).compiler, "compile");
+            const compiler = stub((Packer as any).compiler, "compile");
 
             compiler.throwsException();
-            return packer.toBase64String(file).catch((error) => {
+            return Packer.toBase64String(file).catch((error) => {
                 assert.isDefined(error);
             });
         });
+
+        after(() => {
+            // tslint:disable-next-line:no-any
+            (Packer as any).compiler.compile.restore();
+        });
     });
 });

src/export/packer/packer.ts

@@ -2,14 +2,8 @@ import { File } from "file";
 import { Compiler } from "./next-compiler";
 
 export class Packer {
-    private readonly compiler: Compiler;
+    public static async toBuffer(file: File, prettify?: boolean): Promise<Buffer> {
-
+        const zip = this.compiler.compile(file, prettify);
-    constructor(prettifyXml?: boolean) {
-        this.compiler = new Compiler(prettifyXml);
-    }
-
-    public async toBuffer(file: File): Promise<Buffer> {
-        const zip = this.compiler.compile(file);
         const zipData = (await zip.generateAsync({
             type: "nodebuffer",
             mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
@@ -18,8 +12,8 @@ export class Packer {
         return zipData;
     }
 
-    public async toBase64String(file: File): Promise<string> {
+    public static async toBase64String(file: File, prettify?: boolean): Promise<string> {
-        const zip = this.compiler.compile(file);
+        const zip = this.compiler.compile(file, prettify);
         const zipData = (await zip.generateAsync({
             type: "base64",
             mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
@@ -28,8 +22,8 @@ export class Packer {
         return zipData;
     }
 
-    public async toBlob(file: File): Promise<Blob> {
+    public static async toBlob(file: File, prettify?: boolean): Promise<Blob> {
-        const zip = this.compiler.compile(file);
+        const zip = this.compiler.compile(file, prettify);
         const zipData = (await zip.generateAsync({
             type: "blob",
             mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
@@ -37,4 +31,6 @@ export class Packer {
 
         return zipData;
     }
+
+    private static readonly compiler = new Compiler();
 }