Version bump

Version bump

.gitignore

@@ -58,5 +58,8 @@ yarn.lock
 # Documents
 My Document.docx
 
-# Temporary folder 
+# Temporary folder
-tmp
+tmp
+
+# nyc
+.nyc_output

.nycrc

@@ -0,0 +1,25 @@
+{
+  "check-coverage": true,
+  "lines": 87.54,
+  "functions": 83.61,
+  "branches": 72.57,
+  "statements": 87.32,
+  "include": [
+    "src/**/*.ts"
+  ],
+  "exclude": [
+    "src/**/*.spec.ts"
+  ],
+  "reporter": [
+    "lcov",
+    "text",
+    "json"
+  ],
+  "extension": [
+    ".ts"
+  ],
+  "cache": true,
+  "all": true,
+  "instrument": false,
+  "sourceMap": true
+}

.travis.yml

@@ -3,9 +3,10 @@ node_js:
   - 9
 install:
   - npm install
+  - npm install -g codecov
 script:
   - npm run lint
-  - npm test
+  - npm run test.coverage
   - npm run style
   - npm run build
   - npm run ts-node -- ./demo/demo1.ts
@@ -32,12 +33,23 @@ script:
   - npm run ts-node -- ./demo/demo22.ts
   - npm run ts-node -- ./demo/demo23.ts
   - npm run ts-node -- ./demo/demo24.ts
+#   - npm run ts-node -- ./demo/demo25.ts
+  - npm run ts-node -- ./demo/demo26.ts
+  - npm run ts-node -- ./demo/demo27.ts
+  - npm run ts-node -- ./demo/demo28.ts
+  - npm run ts-node -- ./demo/demo29.ts
+  - npm run ts-node -- ./demo/demo30.ts
+  - npm run ts-node -- ./demo/demo31.ts
+  - npm run ts-node -- ./demo/demo32.ts
+  - npm run ts-node -- ./demo/demo33.ts
+  - npm run ts-node -- ./demo/demo34.ts
 after_failure:
   - "cat /home/travis/builds/dolanmiu/docx/npm-debug.log"
 after_success:
   - npm run typedoc
   - echo "docx.js.org" > docs/.nojekyll
   - echo "docx.js.org" > docs/CNAME
+  - codecov
 deploy:
   provider: pages
   skip-cleanup: true

.vscode/tasks.json

@@ -0,0 +1,24 @@
+{
+    // See https://go.microsoft.com/fwlink/?LinkId=733558
+    // for the documentation about the tasks.json format
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "type": "typescript",
+            "tsconfig": "tsconfig.json",
+            "option": "watch",
+            "problemMatcher": [
+                "$tsc-watch"
+            ]
+        },
+        {
+            "type": "npm",
+            "script": "ts-node",
+            "problemMatcher": [],
+            "group": {
+                "kind": "build",
+                "isDefault": true
+            }
+        }
+    ]
+}

README.md

@@ -15,6 +15,7 @@
 [![Known Vulnerabilities][snky-image]][snky-url]
 [![Chat on Gitter][gitter-image]][gitter-url]
 [![PRs Welcome][pr-image]][pr-url]
+[![codecov][codecov-image]][codecov-url]
 
 <p align="center">
     <img src="https://i.imgur.com/H5FA1Qy.gif" alt="drawing" width="800"/>
@@ -29,6 +30,10 @@ Here are examples of `docx` being used with basic `HTML/JS` in a browser environ
 *   https://codepen.io/anon/pen/dqoVgQ
 *   https://jsfiddle.net/3xhezb5w/2
 
+Here is an example of `docx` working in `Angular`:
+
+*   https://stackblitz.com/edit/angular-afvxtz
+
 ## Node
 
 Press `endpoint` on the `RunKit` website:
@@ -77,3 +82,5 @@ Made with 💖
 [gitter-url]: https://gitter.im/docx-lib/Lobby
 [pr-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
 [pr-url]: http://makeapullrequest.com
+[codecov-image]: https://codecov.io/gh/dolanmiu/docx/branch/master/graph/badge.svg
+[codecov-url]: https://codecov.io/gh/dolanmiu/docx

demo/demo16.ts

@@ -15,8 +15,12 @@ const footer = doc.createFooter();
 footer.createParagraph("Footer on another page");
 
 doc.addSection({
-    headerId: header.Header.ReferenceId,
+    headers: {
-    footerId: footer.Footer.ReferenceId,
+        default: header,
+    },
+    footers: {
+        default: footer,
+    },
     pageNumberStart: 1,
     pageNumberFormatType: PageNumberFormat.DECIMAL,
 });
@@ -24,8 +28,12 @@ doc.addSection({
 doc.createParagraph("hello");
 
 doc.addSection({
-    headerId: header.Header.ReferenceId,
+    headers: {
-    footerId: footer.Footer.ReferenceId,
+        default: header,
+    },
+    footers: {
+        default: footer,
+    },
     pageNumberStart: 1,
     pageNumberFormatType: PageNumberFormat.DECIMAL,
     orientation: PageOrientation.LANDSCAPE,

demo/demo23.ts

@@ -8,11 +8,11 @@ const doc = new Document();
 const paragraph = new Paragraph("Hello World");
 doc.addParagraph(paragraph);
 
-const image = Media.addImage(doc, "./demo/images/image1.jpeg");
+const image = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
-const image2 = Media.addImage(doc, "./demo/images/dog.png");
+const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/dog.png"));
-const image3 = Media.addImage(doc, "./demo/images/cat.jpg");
+const image3 = Media.addImage(doc, fs.readFileSync("./demo/images/cat.jpg"));
-const image4 = Media.addImage(doc, "./demo/images/parrots.bmp");
+const image4 = Media.addImage(doc, fs.readFileSync("./demo/images/parrots.bmp"));
-const image5 = Media.addImage(doc, "./demo/images/pizza.gif");
+const image5 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
 
 const imageBase64Data = `iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAMAAAD04JH5AAACzVBMVEUAAAAAAAAAAAAAAAA/AD8zMzMqKiokJCQfHx8cHBwZGRkuFxcqFSonJyckJCQiIiIfHx8eHh4cHBwoGhomGSYkJCQhISEfHx8eHh4nHR0lHBwkGyQjIyMiIiIgICAfHx8mHh4lHh4kHR0jHCMiGyIhISEgICAfHx8lHx8kHh4jHR0hHCEhISEgICAlHx8kHx8jHh4jHh4iHSIhHCEhISElICAkHx8jHx8jHh4iHh4iHSIhHSElICAkICAjHx8jHx8iHh4iHh4hHiEhHSEkICAjHx8iHx8iHx8hHh4hHiEkHSEjHSAjHx8iHx8iHx8hHh4kHiEkHiEjHSAiHx8hHx8hHh4kHiEjHiAjHSAiHx8iHx8hHx8kHh4jHiEjHiAjHiAiICAiHx8kHx8jHh4jHiEjHiAiHiAiHSAiHx8jHx8jHx8jHiAiHiAiHiAiHSAiHx8jHx8jHx8iHiAiHiAiHiAjHx8jHx8jHx8jHx8iHiAiHiAiHiAjHx8jHx8jHx8iHx8iHSAiHiAjHiAjHx8jHx8hHx8iHx8iHyAiHiAjHiAjHiAjHh4hHx8iHx8iHx8iHyAjHSAjHiAjHiAjHh4hHx8iHx8iHx8jHyAjHiAhHh4iHx8iHx8jHyAjHSAjHSAhHiAhHh4iHx8iHx8jHx8jHyAjHSAjHSAiHh4iHh4jHx8jHx8jHyAjHyAhHSAhHSAiHh4iHh4jHx8jHx8jHyAhHyAhHSAiHSAiHh4jHh4jHx8jHx8jHyAhHyAhHSAiHSAjHR4jHh4jHx8jHx8hHyAhHyAiHSAjHSAjHR4jHh4jHx8hHx8hHyAhHyAiHyAjHSAjHR4jHR4hHh4hHx8hHyAiHyAjHyAjHSAjHR4jHR4hHh4hHx8hHyAjHyAjHyAjHSAjHR4hHR4hHR4hHx8iHyAjHyAjHyAjHSAhHR4hHR4hHR4hHx8jHyAjHyAjHyAjHyC9S2xeAAAA7nRSTlMAAQIDBAUGBwgJCgsMDQ4PEBESExQVFxgZGhscHR4fICEiIyQlJicoKSorLS4vMDEyMzQ1Njc4OTo7PD0+P0BBQkNERUZISUpLTE1OUFFSU1RVVllaW1xdXmBhYmNkZWZnaGprbG1ub3Byc3R1dnd4eXp8fn+AgYKDhIWGiImKi4yNj5CRkpOUlZaXmJmam5ydnp+goaKjpKaoqqusra6vsLGys7S1tri5uru8vb6/wMHCw8TFxsfIycrLzM3Oz9DR0tPU1dbX2Nna29zd3t/g4eLj5OXm5+jp6uvs7e7v8PHy8/T19vf4+fr7/P3+fkZpVQAABcBJREFUGBntwftjlQMcBvDnnLNL22qzJjWlKLHFVogyty3SiFq6EZliqZGyhnSxsLlMRahYoZKRFcul5dKFCatYqWZaNKvWtrPz/A2+7/b27qRzec/lPfvl/XxgMplMJpPJZDKZAtA9HJ3ppnIez0KnSdtC0RCNznHdJrbrh85wdSlVVRaEXuoGamYi5K5430HNiTiEWHKJg05eRWgNfKeV7RxbqUhGKPV/207VupQ8is0IoX5vtFC18SqEHaK4GyHTZ2kzVR8PBTCO4oANIZL4ShNVZcOhKKeYg9DoWdhI1ec3os2VFI0JCIUez5+i6st0qJZRrEAIJCw+QdW223BG/EmKwTBc/IJ/qfp2FDrkUnwFo8U9dZyqnaPhxLqfYjyM1S3vb6p+GGOBszsojoTDSDFz6qj66R4LzvYJxVMwUNRjf1H1ywQr/megg2RzLximy8waqvbda8M5iijegVEiHjlM1W/3h+FcXesphsMY4dMOUnUgOxyuPEzxPQwRNvV3qg5Nj4BreyimwADWe/dRVTMjEm6MoGLzGwtystL6RyOY3qSqdlYU3FpLZw1VW0sK5943MvUCKwJ1noNtjs6Ohge76Zq9ZkfpigU5WWkDYuCfbs1U5HWFR8/Qq4a9W0uK5k4ZmdrTCl8spGIePLPlbqqsc1Afe83O0hULc8alDYiBd7ZyitYMeBfR55rR2fOKP6ioPk2dGvZ+UVI0d8rtqT2tcCexlqK2F3wRn5Q+YVbBqrLKOupkr9lZujAOrmS0UpTb4JeIPkNHZ+cXr6uoPk2vyuBSPhWLEKj45PQJuQWryyqP0Z14uGLdROHIRNBEXDR09EP5r62rOHCazhrD4VKPwxTH+sIA3ZPTJ+YuWV22n+IruHFDC8X2CBjnPoolcGc2FYUwzmsUWXDHsoGKLBhmN0VvuBVfTVE/AAbpaid5CB4MbaLY1QXGuIViLTyZQcVyGGMuxWPwaA0Vk2GI9RRp8Ci2iuLkIBjhT5LNUfAspZFiTwyC72KK7+DNg1SsRvCNp3gZXq2k4iEEXSHFJHgVXUlxejCCbTvFAHiXdIJiXxyCK7KJ5FHoMZGK9xBcwyg2QpdlVMxEUM2iyIMuXXZQNF+HswxMsSAAJRQjoE//eoqDCXBSTO6f1xd+O0iyNRY6jaWi1ALNYCocZROj4JdEikroVkjFk9DcStXxpdfCD2MoXodu4RUU9ptxxmXssOfxnvDVcxRTod9FxyhqLoAqis5aPhwTDp9spRgEH2Q6KLbYoKqlaKTm6Isp0C/sJMnjFvhiERXPQvUNRe9p29lhR04CdBpC8Sl8YiuncIxEuzUUg4Dkgj+paVozygY9plPMh28SaymO9kabAopREGF3vt9MzeFFl8G7lRSZ8FFGK8XX4VA8QjEd7XrM3M0OXz8YCy+qKBLgq3wqnofiTorF0Ax56Rg1J1elW+BBAsVe+My6iYq7IK6keBdOIseV2qn5Pb8f3MqkWAXf9ThM8c8lAOIotuFsF875lRrH5klRcG0+xcPwQ1oLxfeRAP4heQTnGL78X2rqlw2DK59SXAV/zKaiGMAuko5InCt68mcOan5+ohf+z1pP8lQY/GHZQMV4YD3FpXDp4qerqbF/lBWBswyi+AL+ia+maLgcRRQj4IYlY/UpauqKBsPJAxQF8NM1TRQ/RudSPAD34rK3scOuR8/HGcspxsJfOVS8NZbiGXiUtPgINU3v3WFDmx8pEuG3EiqKKVbCC1vm2iZqap5LAtCtleQf8F9sFYWDohzeJczYyQ4V2bEZFGsQgJRGqqqhS2phHTWn9lDkIhBTqWqxQZ+IsRvtdHY9AvI2VX2hW68nfqGmuQsCEl3JdjfCF8OW1bPdtwhQ0gm2mQzfRE3a7KCYj0BNZJs8+Kxf/r6WtTEI2FIqlsMfFgRB5A6KUnSe/vUkX0AnuvUIt8SjM1m6wWQymUwmk8lkMgXRf5vi8rLQxtUhAAAAAElFTkSuQmCC`;
 const image6 = Media.addImage(doc, Buffer.from(imageBase64Data, "base64"), 100, 100);

demo/demo24.ts

@@ -8,7 +8,7 @@ const doc = new Document();
 const table = doc.createTable(4, 4);
 table.getCell(2, 2).addContent(new Paragraph("Hello"));
 
-const image = Media.addImage(doc, "./demo/images/image1.jpeg");
+const image = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
 table.getCell(1, 1).addContent(image.Paragraph);
 
 const packer = new Packer();

demo/demo27.ts

@@ -30,5 +30,4 @@ const packer = new Packer();
 
 packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
-    console.log("Document created successfully at project root!");
 });

demo/demo30.ts

@@ -0,0 +1,29 @@
+import * as fs from "fs";
+import { Document, ImportDotx, Packer, Paragraph } from "../build";
+
+const importDotx = new ImportDotx();
+const filePath = "./demo/dotx/template.dotx";
+
+fs.readFile(filePath, (err, data) => {
+    if (err) {
+        throw new Error(`Failed to read file ${filePath}.`);
+    }
+
+    importDotx.extract(data).then((templateDocument) => {
+        // This any needs fixing
+        const sectionProps = {
+            titlePage: templateDocument.titlePageIsDefined,
+        } as any;
+
+        const doc = new Document(undefined, sectionProps, {
+            template: templateDocument,
+        });
+        const paragraph = new Paragraph("Hello World");
+        doc.addParagraph(paragraph);
+
+        const packer = new Packer();
+        packer.toBuffer(doc).then((buffer) => {
+            fs.writeFileSync("My Document.docx", buffer);
+        });
+    });
+});

demo/demo33.ts

@@ -0,0 +1,22 @@
+// Sequential Captions
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, Paragraph, TextRun } from "../build";
+
+const doc = new Document();
+
+const paragraph = new Paragraph("Hello World 1->").addSequentialIdentifier("Caption").addRun(new TextRun(" text after sequencial caption 2->")).addSequentialIdentifier("Caption");
+const paragraph2 = new Paragraph("Hello World 1->").addSequentialIdentifier("Label").addRun(new TextRun(" text after sequencial caption 2->")).addSequentialIdentifier("Label");
+const paragraph3 = new Paragraph("Hello World 1->").addSequentialIdentifier("Another").addRun(new TextRun(" text after sequencial caption 3->")).addSequentialIdentifier("Label");
+const paragraph4 = new Paragraph("Hello World 2->").addSequentialIdentifier("Another").addRun(new TextRun(" text after sequencial caption 4->")).addSequentialIdentifier("Label");
+
+doc.addParagraph(paragraph);
+doc.addParagraph(paragraph2);
+doc.addParagraph(paragraph3);
+doc.addParagraph(paragraph4);
+
+const packer = new Packer();
+
+packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/demo34.ts

@@ -0,0 +1,32 @@
+// Example of how you would create a table with float positions
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import {
+    Document,
+    Packer,
+    Paragraph,
+    RelativeHorizontalPosition,
+    RelativeVerticalPosition,
+    TableAnchorType,
+    WidthType,
+} from "../build";
+
+const doc = new Document();
+
+const table = doc.createTable(2, 2).float({
+    horizontalAnchor: TableAnchorType.MARGIN,
+    verticalAnchor: TableAnchorType.MARGIN,
+    relativeHorizontalPosition: RelativeHorizontalPosition.RIGHT,
+    relativeVerticalPosition: RelativeVerticalPosition.BOTTOM,
+});
+table.setFixedWidthLayout();
+table.setWidth(WidthType.DXA, 4535);
+
+table.getCell(0, 0).addContent(new Paragraph("Hello"));
+table.getRow(0).mergeCells(0, 1);
+
+const packer = new Packer();
+
+packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/demo38.ts

@@ -0,0 +1,44 @@
+// Example of how to add images to the document - You can use Buffers, UInt8Arrays or Base64 strings
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+// import { Document, Packer, Paragraph } from "../build";
+import { Document, Packer, TextWrappingSide, TextWrappingType } from "../build";
+
+const doc = new Document();
+
+doc.createParagraph(
+    "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque vehicula nec nulla vitae efficitur. Ut interdum mauris eu ipsum rhoncus, nec pharetra velit placerat. Sed vehicula libero ac urna molestie, id pharetra est pellentesque. Praesent iaculis vehicula fringilla. Duis pretium gravida orci eu vestibulum. Mauris tincidunt ipsum dolor, ut ornare dolor pellentesque id. Integer in nulla gravida, lacinia ante non, commodo ex. Vivamus vulputate nisl id lectus finibus vulputate. Ut et nisl mi. Cras fermentum augue arcu, ac accumsan elit euismod id. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed ac posuere nisi. Pellentesque tincidunt vehicula bibendum. Phasellus eleifend viverra nisl.",
+);
+
+doc.createParagraph(
+    "Proin ac purus faucibus, porttitor magna ut, cursus nisl. Vivamus ante purus, porta accumsan nibh eget, eleifend dignissim odio. Integer sed dictum est, aliquam lacinia justo. Donec ultrices auctor venenatis. Etiam interdum et elit nec elementum. Pellentesque nec viverra mauris. Etiam suscipit leo nec velit fringilla mattis. Pellentesque justo lacus, sodales eu condimentum in, dapibus finibus lacus. Morbi vitae nibh sit amet sem molestie feugiat. In non porttitor enim.",
+);
+
+doc.createParagraph(
+    "Ut eget diam cursus quam accumsan interdum at id ante. Ut mollis mollis arcu, eu scelerisque dui tempus in. Quisque aliquam, augue quis ornare aliquam, ex purus ultrices mauris, ut porta dolor dolor nec justo. Nunc a tempus odio, eu viverra arcu. Suspendisse vitae nibh nec mi pharetra tempus. Mauris ut ullamcorper sapien, et sagittis sapien. Vestibulum in urna metus. In scelerisque, massa id bibendum tempus, quam orci rutrum turpis, a feugiat nisi ligula id metus. Praesent id dictum purus. Proin interdum ipsum nulla.",
+);
+
+doc.createImage(fs.readFileSync("./demo/images/pizza.gif"), 200, 200, {
+    floating: {
+        horizontalPosition: {
+            offset: 2014400,
+        },
+        verticalPosition: {
+            offset: 2014400,
+        },
+        wrap: {
+            type: TextWrappingType.SQUARE,
+            side: TextWrappingSide.BOTH_SIDES,
+        },
+        margins: {
+            top: 201440,
+            bottom: 201440,
+        },
+    },
+});
+
+const packer = new Packer();
+
+packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/demo39.ts

@@ -0,0 +1,33 @@
+// Scaling images
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, PageNumberFormat, TextRun } from "../build";
+
+const doc = new Document(
+    {},
+    {
+        pageNumberStart: 1,
+        pageNumberFormatType: PageNumberFormat.DECIMAL,
+    },
+);
+
+doc.Header.createParagraph("Foo Bar corp. ")
+    .addRun(new TextRun("Page Number ").pageNumber())
+    .addRun(new TextRun(" to ").numberOfTotalPages());
+
+doc.Footer.createParagraph("Foo Bar corp. ")
+    .center()
+    .addRun(new TextRun("Page Number: ").pageNumber())
+    .addRun(new TextRun(" to ").numberOfTotalPages());
+
+doc.createParagraph("Hello World 1").pageBreak();
+doc.createParagraph("Hello World 2").pageBreak();
+doc.createParagraph("Hello World 3").pageBreak();
+doc.createParagraph("Hello World 4").pageBreak();
+doc.createParagraph("Hello World 5").pageBreak();
+
+const packer = new Packer();
+
+packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/demo5.ts

@@ -1,7 +1,8 @@
 // Example of how to add images to the document - You can use Buffers, UInt8Arrays or Base64 strings
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Document, Packer, Paragraph } from "../build";
+// import { Document, Packer, Paragraph } from "../build";
+import { Document, HorizontalPositionAlign, HorizontalPositionRelativeFrom, Packer, Paragraph, VerticalPositionAlign, VerticalPositionRelativeFrom} from "../build";
 
 const doc = new Document();
 
@@ -13,6 +14,29 @@ doc.createImage(fs.readFileSync("./demo/images/dog.png").toString("base64"));
 doc.createImage(fs.readFileSync("./demo/images/cat.jpg"));
 doc.createImage(fs.readFileSync("./demo/images/parrots.bmp"));
 doc.createImage(fs.readFileSync("./demo/images/pizza.gif"));
+doc.createImage(fs.readFileSync("./demo/images/pizza.gif"), 200, 200, {
+    floating: {
+        horizontalPosition: {
+            offset: 1014400,
+        },
+        verticalPosition: {
+            offset: 1014400,
+        },
+    },
+});
+
+doc.createImage(fs.readFileSync("./demo/images/cat.jpg"), 200, 200, {
+    floating: {
+        horizontalPosition: {
+            relative: HorizontalPositionRelativeFrom.PAGE,
+            align: HorizontalPositionAlign.RIGHT,
+        },
+        verticalPosition: {
+            relative: VerticalPositionRelativeFrom.PAGE,
+            align: VerticalPositionAlign.BOTTOM,
+        },
+    },
+});
 
 const packer = new Packer();
 

docs/_sidebar.md

@@ -17,6 +17,7 @@
     * [Numbering](usage/numbering.md)
 	* [Tab Stops](usage/tab-stops.md)
     * [Table of Contents](usage/table-of-contents.md)
+    * [Page Numbers](usage/page-numbers.md)
 	* Styling
         * [Styling with JS](usage/styling-with-js.md)
         * [Styling with XML](usage/styling-with-xml.md)

docs/contribution-guidelines.md

@@ -1,7 +1,5 @@
 # Contribution Guidelines
 
-## Writing Code
-
 *   Include documentation reference(s) at the top of each file:
 
     ```js
@@ -12,6 +10,59 @@
 
 *   Follow the `TSLint` rules
 
+## Always think about the user
+
+The number one pillar for contribution is to **ALWAYS** think about how the user will use the library. 
+
+Put yourself in their position, and imagine how they would feel about your feature you wrote.
+
+1. Is it easy to use? 
+2. Has it been documented well?
+3. Is it intuative?
+4. Is it consistent with the rest of the API?
+5. Is it fun to use?
+
+## Good Commit Names
+
+Please write good commit messages when making a commit: https://chris.beams.io/posts/git-commit/
+
+**Do not:**
+```
+c // What?
+rtl // Adding acryonyms without explaining anything else is not helpful
+works! // Glad its working, but the message is not helpful
+demo updated // Getting better, but capitalize the first letter
+Unesesary coment removed // Make sure to use correct spelling
+```
+
+## No leaky components in API interface
+
+This mainly applies to the API the end user will consume.
+
+Try to make method parameters accept primatives, or `json` objects, so that child components are created **inside** the component, rather than being **injected** in.
+
+This is so that:
+
+1. Imports are much cleaner, no need for:
+   ```js
+   import { ChildComponent } from "./my-feature/sub-component/deeper/.../my-deep.component";
+   ```
+   
+2. This is what I consider "leakage". The code is aware of the underlying implementation of the component.
+3. It means the end user does not need to import and create the child component to be injected.
+
+**Do not**
+`TableFloatProperties` is a class. The outside world would have to construct the object, and inject it in
+```js
+    public float(tableFloatProperties: TableFloatProperties): Table
+```
+
+**Do**
+`ITableFloatOptions` is an interface for a JSON of primatives.
+```js
+    public float(tableFloatOptions: ITableFloatOptions): Table
+```
+
 ## Add vs Create
 
 This is just a guideline, and the rules can sometimes be broken.
@@ -39,24 +90,104 @@ Getters and Setters are done with a capital letter like so:
 
 ```js
 public get Level() {
-
+   ...
 }
 ```
 
 There is no performance advantage by doing this. It means we don't need to prefix all private variables with the ugly `_`:
 
-**Do not:** 
+**Do not:**
 
 ```js
 private get _level: string;
 ```
 
-**Do** 
+**Do**
 
 ```js
 private get level: string;
 ```
 
+## Interfaces over type alias
+
+Do not use `type`, but rather use `Interfaces`. `type` cannot be extended, and a class cannot implement it.
+
+> "In general, use what you want ( type alias / interface ) just be consistent"
+> "always use interface for public API's definition when authoring a library or 3rd party ambient type definitions"
+>
+> *   https://medium.com/@martin_hotell/interface-vs-type-alias-in-typescript-2-7-2a8f1777af4c
+
+`Interface` is generally preferred over `type`: https://stackoverflow.com/questions/37233735/typescript-interfaces-vs-types
+
+**Do not:**
+
+```js
+type RelationshipFileInfo = { id: number, target: string };
+```
+
+**Do:**
+
+```js
+interface IRelationshipFileInfo {
+    id: number;
+    target: string;
+}
+```
+
+## String enums vs type
+
+To take full advantage of TypeScript's typing system, its best to use `string enums`:
+
+**Do not:**
+
+```js
+type WeaponType = "bow" | "sword" | "wand";
+```
+
+**Do:**
+
+```js
+enum WeaponType = {
+    BOW = "bow",
+    SWORD = "sword",
+    WAND = "wand",
+}
+```
+
+## Spell correctly, full and in American English
+
+I am not sure where these habits in software development come from, but I do not believe it is beneficial:
+
+**Do not:**
+```js
+readdy // misspelling
+perm // abbreviation
+conf // abbreviation
+cnty // abbreviation
+relationFile // abbreviation
+colour // U.K. English
+```
+
+**Do:**
+```js
+ready
+permission
+config
+country
+relationshipFile
+color
+```
+
+## Keep files small (within reason)
+
+To minimize merge conflicts, reduce complexity, and improve readability, keep the files small.
+
+## Name files and folders with `/foo-bar/kebab-case.ts`
+
+To be consistent and in-line with the project, name files `like-this.ts`.
+
+https://stackoverflow.com/questions/7273316/what-is-the-javascript-filename-naming-convention
+
 ## Testing
 
 Please write a test of every file you make and suffix it with `.spec.ts`.
@@ -78,3 +209,5 @@ describe("ClassName", () => {
     });
 });
 ```
+
+Try not to use the `tests/utility.ts` file as this is being deprecated.

docs/usage/images.md

@@ -1,156 +1,231 @@
 # Images
 
-## Intro
+To create a `floating` image on top of text:
 
-Adding images is very simple
+```ts
-
+doc.createImage(fs.readFileSync("./demo/images/pizza.gif"), 200, 200, {
-Simply call the `createImage` method:
-
-```js
-const image = doc.createImage([BUFFER_OF_YOUR_IMAGE]);
-```
-
-`docx` supports `jpeg`, `jpg`, `bmp`, `gif` and `png`
-
-Check `demo5.js` for an example
-
-## Positioning
-
-Images can be:
-
-*   floating position of images
-*   Wrapped around the text
-*   Inline
-
-By default, picture are exported as `INLINE` elements.
-
-In Word this is found in:
-
-![Word Image Positiong](https://user-images.githubusercontent.com/34742290/41765548-b0946302-7604-11e8-96f9-166a9f0b8f39.png)
-
-### Usage
-
-The `PictureRun` element support various options to define the positioning of the element in the document.
-
-```js
-interface DrawingOptions {
-    position?: PlacementPosition;
-    textWrapping?: TextWrapping;
-    floating?: Floating;
-}
-```
-
-can be passed when creating `PictureRun()` for example:
-
-```js
-const imageData = document.createImage(buffer, 903, 1149);
-
-new docx.PictureRun(imageData, {
-    position: docx.PlacementPosition.FLOATING,
     floating: {
         horizontalPosition: {
-            relative: HorizontalPositionRelativeFrom.PAGE,
+            offset: 1014400,
-            align: HorizontalPositionAlign.LEFT,
         },
         verticalPosition: {
-            relative: VerticalPositionRelativeFrom.PAGE,
+            offset: 1014400,
-            align: VerticalPositionAlign.TOP,
         },
     },
 });
 ```
 
-So, the first thing is to define the placement position: `INLINE` or `FLOATING`. Inline is the default one so there is no need to pass drawing options for inline.
+By default with no arguments, its an `inline` image:
 
-When placement position is FLOATING then we can use two options:
+```ts
-
+doc.createImage(fs.readFileSync("./demo/images/parrots.bmp"));
-### Wrap text
-
-for `drawingOptions.textWrapping` we can define various options. `textWrapping` has the following properties:
-
-```js
-interface TextWrapping {
-    textWrapStyle: TextWrapStyle;
-    wrapTextOption?: WrapTextOption;
-    distanceFromText?: Distance;
-}
-
-enum TextWrapStyle {
-    NONE,
-    SQUARE,
-    TIGHT,
-    TOP_AND_BOTTOM,
-}
-
-enum WrapTextOption {
-    BOTH_SIDES = "bothSides",
-    LEFT = "left",
-    RIGHT = "right",
-    LARGEST = "largest",
-}
 ```
 
-### Floating position
+You can also create images manually and add them later:
 
-When we want to position the image relative or absolute then we need to use option `drawingOptions.floating`:
+```ts
-
+const image = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
-```js
+doc.addImage(image);
-export interface Floating {
-    horizontalPosition: HorizontalPositionOptions;
-    verticalPosition: VerticalPositionOptions;
-    allowOverlap?: boolean;
-    lockAnchor?: boolean;
-    behindDocument?: boolean;
-    layoutInCell?: boolean;
-}
-
-export interface HorizontalPositionOptions {
-    relative: HorizontalPositionRelativeFrom;
-    align?: HorizontalPositionAlign;
-    offset?: number;
-}
-
-export interface VerticalPositionOptions {
-    relative: VerticalPositionRelativeFrom;
-    align?: VerticalPositionAlign;
-    offset?: number;
-}
-
-export enum HorizontalPositionRelativeFrom {
-    CHARACTER = "character",
-    COLUMN = "column",
-    INSIDE_MARGIN = "insideMargin",
-    LEFT_MARGIN = "leftMargin",
-    MARGIN = "margin",
-    OUTSIDE_MARGIN = "outsideMargin",
-    PAGE = "page",
-    RIGHT_MARGIN = "rightMargin",
-}
-
-export enum VerticalPositionRelativeFrom {
-    BOTTOM_MARGIN = "bottomMargin",
-    INSIDE_MARGIN = "insideMargin",
-    LINE = "line",
-    MARGIN = "margin",
-    OUTSIDE_MARGIN = "outsideMargin",
-    PAGE = "page",
-    PARAGRAPH = "paragraph",
-    TOP_MARGIN = "topMargin",
-}
-
-export enum HorizontalPositionAlign {
-    CENTER = "center",
-    INSIDE = "inside",
-    LEFT = "left",
-    OUTSIDE = "outside",
-    RIGHT = "right",
-}
-
-export enum VerticalPositionAlign {
-    BOTTOM = "bottom",
-    CENTER = "center",
-    INSIDE = "inside",
-    OUTSIDE = "outside",
-    TOP = "top",
-}
 ```
+
+## Intro
+
+Adding images can be done in two ways:
+
+1. Call the `createImage` method to add the image directly into the `document`:
+
+    ```js
+    doc.createImage([IMAGE_BUFFER], [WIDTH], [HEIGHT], [POSITION_OPTIONS]);
+    ```
+
+2. Create an `image` first, then add it into the `document`:
+
+    ```ts
+    const image = Media.addImage(doc, [IMAGE_BUFFER]);
+    doc.addImage(image);
+    ```
+
+`docx` supports `jpeg`, `jpg`, `bmp`, `gif` and `png`
+
+## Positioning
+
+> Positioning is the method on how to place the image on the document
+
+![Word Image Positiong](https://user-images.githubusercontent.com/34742290/41765548-b0946302-7604-11e8-96f9-166a9f0b8f39.png)
+
+Three types of image positioning is supported:
+
+-   Floating
+-   Inline
+
+By default, picture are exported as `Inline` elements.
+
+### Usage
+
+Pass `options` into the `[POSITION_OPTIONS]` metioned in the [Intro above](#Intro).
+
+## Floating
+
+To change the position the image to be on top of the text, simply add the `floating` property to the last argument. By default, the offsets are relative to the top left corner of the `page`. Offset units are in [emus](https://startbigthinksmall.wordpress.com/2010/01/04/points-inches-and-emus-measuring-units-in-office-open-xml/):
+
+```ts
+const imageData = document.createImage(buffer, 903, 1149, {
+    floating: {
+        horizontalPosition: {
+            offset: 1014400, // relative: HorizontalPositionRelativeFrom.PAGE by default
+        },
+        verticalPosition: {
+            offset: 1014400, // relative: VerticalPositionRelativeFrom.PAGE by default
+        },
+    },
+});
+```
+
+```ts
+const imageData = document.createImage(buffer, 903, 1149, {
+    floating: {
+        horizontalPosition: {
+            relative: HorizontalPositionRelativeFrom.RIGHT_MARGIN,
+            offset: 1014400,
+        },
+        verticalPosition: {
+            relative: VerticalPositionRelativeFrom.BOTTOM_MARGIN,
+            offset: 1014400,
+        },
+    },
+});
+```
+
+### Options
+
+Full options you can pass into `floating` are:
+
+| Property           | Type                        | Notes    |
+| ------------------ | --------------------------- | -------- |
+| horizontalPosition | `HorizontalPositionOptions` | Required |
+| verticalPosition   | `VerticalPositionOptions`   | Required |
+| allowOverlap       | `boolean`                   | Optional |
+| lockAnchor         | `boolean`                   | Optional |
+| behindDocument     | `boolean`                   | Optional |
+| layoutInCell       | `boolean`                   | Optional |
+
+`HorizontalPositionOptions` are:
+
+| Property | Type                             | Notes                                             | Possible Values                                                                                           |
+| -------- | -------------------------------- | ------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
+| relative | `HorizontalPositionRelativeFrom` | Required                                          | `CHARACTER`, `COLUMN`, `INSIDE_MARGIN`, `LEFT_MARGIN`, `MARGIN`, `OUTSIDE_MARGIN`, `PAGE`, `RIGHT_MARGIN` |
+| align    | `HorizontalPositionAlign`        | You can either have `align` or `offset`, not both | `CENTER`, `INSIDE`, `LEFT`, `OUTSIDE`, `RIGHT`                                                            |
+| offset   | `number`                         | You can either have `align` or `offset`, not both | `0` to `Infinity`                                                                                         |
+
+`VerticalPositionOptions` are:
+
+| Property | Type                           | Notes                                             | Possible Values                                                                                         |
+| -------- | ------------------------------ | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
+| relative | `VerticalPositionRelativeFrom` | Required                                          | `BOTTOM_MARGIN`, `INSIDE_MARGIN`, `LINE`, `MARGIN`, `OUTSIDE_MARGIN`, `PAGE`, `PARAGRAPH`, `TOP_MARGIN` |
+| align    | `VerticalPositionAlign`        | You can either have `align` or `offset`, not both | `BOTTOM`, `CENTER`, `INSIDE`, `OUTSIDE`, `TOP`                                                          |
+| offset   | `number`                       | You can either have `align` or `offset`, not both | `0` to `Infinity`                                                                                       |
+
+## Wrap text
+
+Wrapping only works for floating elements. Text will "wrap" around the floating `image`.
+
+Add `wrap` options inside the `floating` options:
+
+```ts
+wrap: {
+    type: [TextWrappingType],
+    side: [TextWrappingSide],
+},
+```
+
+For example:
+
+```ts
+doc.createImage(fs.readFileSync("./demo/images/pizza.gif"), 200, 200, {
+    floating: {
+        horizontalPosition: {
+            offset: 2014400,
+        },
+        verticalPosition: {
+            offset: 2014400,
+        },
+        wrap: {
+            type: TextWrappingType.SQUARE,
+            side: TextWrappingSide.BOTH_SIDES,
+        },
+    },
+});
+```
+
+Wrap options have the following properties are:
+
+| Property | Type               | Notes    | Possible Values                             |
+| -------- | ------------------ | -------- | ------------------------------------------- |
+| type     | `TextWrappingType` | Optional | `NONE`, `SQUARE`, `TIGHT`, `TOP_AND_BOTTOM` |
+| side     | `TextWrappingSide` | Optional | `BOTH_SIDES`, `LEFT`, `RIGHT`, `LARGEST`    |
+
+## Margins
+
+Margins give some space between the text and the image. Margins [only work for floating elements](http://officeopenxml.com/drwPicInline.php). Additionally, the image must also be in wrap mode (see above).
+
+?> Be sure to also set `wrap` in your options!
+
+To use, add the `margins` options inside the `floating` options:
+
+```ts
+margins: {
+    top: number,
+    bottom: number,
+    left: number,
+    right: number
+},
+```
+
+For example:
+
+```ts
+doc.createImage(fs.readFileSync("./demo/images/pizza.gif"), 200, 200, {
+    floating: {
+        horizontalPosition: {
+            offset: 2014400,
+        },
+        verticalPosition: {
+            offset: 2014400,
+        },
+        wrap: {
+            type: TextWrappingType.SQUARE,
+            side: TextWrappingSide.BOTH_SIDES,
+        },
+        margins: {
+            top: 201440,
+            bottom: 201440,
+        },
+    },
+});
+```
+
+## Examples
+
+### Add image to the document
+
+Importing Images from file system path
+
+[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo5.ts ":include")
+
+_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo5.ts_
+
+### Add images to header and footer
+
+Example showing how to add image to headers and footers
+
+[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo9.ts ":include")
+
+_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo9.ts_
+
+### Floating images
+
+Example showing how to float images on top of text and optimally give a `margin`
+
+[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo38.ts ":include")
+
+_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo38.ts_

docs/usage/numbering.md

@@ -75,7 +75,7 @@ abstractNum.createLevel(0, "upperRoman", "%1", "start").addParagraphProperty(new
 abstractNum.createLevel(1, "decimal", "%2.", "start").addParagraphProperty(new Indent(1440, 980));
 abstractNum.createLevel(2, "lowerLetter", "%3)", "start").addParagraphProperty(new Indent(2160, 1700));
 
-const concrete = numbering.createConcreteNumbering(numberedAbstract);
+const concrete = numbering.createConcreteNumbering(abstractNum);
 ```
 
 You can then apply your concrete style to paragraphs using their

docs/usage/page-numbers.md

@@ -0,0 +1,66 @@
+# Page Numbers
+
+> This feature allows you to set page numbers on each page
+
+?> **Note:** This feature only works on Headers and Footers
+
+```ts
+doc.Header.createParagraph().addRun(new TextRun("Page Number: ").pageNumber()).addRun(new TextRun("to ").numberOfTotalPages());
+```
+
+## Current page number
+
+To get the current page number, call the `.pageNumber()` method on a `TextRun`. Then add the newly created `TextRun` into a paragraph
+
+```ts
+pageNumber();
+```
+
+For example:
+
+```ts
+const currentPageRun = new TextRun("Current Page Number: ").pageNumber();
+paragraph.addRun(currentPageRun);
+```
+
+## Total number of pages
+
+```ts
+numberOfTotalPages();
+```
+
+For example:
+
+```ts
+const lastPage = new TextRun("Total Page Number: ").numberOfTotalPages();
+paragraph.addRun(lastPage);
+```
+
+
+## Both
+
+You can combine the two to get "Page 2 of 10" effect:
+
+```ts
+const currentPageRun = new TextRun("Page ").pageNumber();
+const lastPage = new TextRun("of ").numberOfTotalPages();
+
+paragraph.addRun(currentPageRun);
+paragraph.addRun(lastPage);
+```
+
+Or:
+
+```ts
+doc.Header.createParagraph().addRun(new TextRun("Page ").pageNumber()).addRun(new TextRun("of ").numberOfTotalPages());
+```
+
+## Examples
+
+### Simple Example
+
+Adding page numbers to Header and Footer
+
+[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo39.ts ":include")
+
+_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo39.ts_

package.json

@@ -1,22 +1,22 @@
 {
   "name": "docx",
-  "version": "4.3.0",
+  "version": "4.7.0",
   "description": "Generate .docx documents with JavaScript (formerly Office-Clippy)",
   "main": "build/index.js",
   "scripts": {
     "pretest": "rimraf ./build",
     "test": "mocha-webpack \"src/**/*.ts\"",
-    "test-watch": "mocha-webpack \"src/**/*.ts\" --watch",
+    "test.coverage": "nyc npm test",
+    "test.watch": "npm test -- --watch",
     "prepublishOnly": "npm run build",
     "lint": "tslint --project .",
     "build": "npm run webpack && npm run fix-types",
     "tsc": "rimraf ./build && tsc -p .",
     "webpack": "rimraf ./build && webpack",
-    "build.web": "webpack --config webpack.web.config.js",
     "demo": "npm run build && npm run ts-node ./demo",
     "typedoc": "typedoc src/index.ts",
     "style": "prettier -l \"src/**/*.ts\"",
-    "style.fix": "prettier \"src/**/*.ts\" --write",
+    "style.fix": "npm run style -- --write",
     "fix-types": "node types-absolute-fixer.js",
     "ts-node": "ts-node"
   },
@@ -48,11 +48,11 @@
   "types": "./build/index.d.ts",
   "dependencies": {
     "@types/image-size": "0.0.29",
-    "@types/jszip": "^3.1.3",
+    "@types/jszip": "^3.1.4",
-    "fast-xml-parser": "^3.3.6",
     "image-size": "^0.6.2",
     "jszip": "^3.1.5",
-    "xml": "^1.0.1"
+    "xml": "^1.0.1",
+    "xml-js": "^1.6.8"
   },
   "author": "Dolan Miu",
   "license": "MIT",
@@ -67,9 +67,11 @@
     "awesome-typescript-loader": "^3.4.1",
     "chai": "^3.5.0",
     "glob": "^7.1.2",
+    "istanbul-instrumenter-loader": "^3.0.1",
     "jszip": "^3.1.5",
     "mocha": "^5.2.0",
     "mocha-webpack": "^1.0.1",
+    "nyc": "^13.1.0",
     "pre-commit": "^1.2.2",
     "prettier": "^1.12.1",
     "prompt": "^1.0.0",
@@ -79,6 +81,7 @@
     "sinon": "^5.0.7",
     "ts-node": "^7.0.1",
     "tslint": "^5.11.0",
+    "tslint-immutable": "^4.9.0",
     "typedoc": "^0.11.1",
     "typescript": "2.9.2",
     "webpack": "^3.10.0"

src/export/formatter.ts

@@ -2,6 +2,12 @@ import { BaseXmlComponent, IXmlableObject } from "file/xml-components";
 
 export class Formatter {
     public format(input: BaseXmlComponent): IXmlableObject {
-        return input.prepForXml();
+        const output = input.prepForXml();
+
+        if (output) {
+            return output;
+        } else {
+            throw Error("XMLComponent did not format correctly");
+        }
     }
 }

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

@@ -1,6 +1,8 @@
 /* tslint:disable:typedef space-before-function-paren */
 import { expect } from "chai";
-import { File } from "../../file";
+
+import { File } from "file";
+
 import { Compiler } from "./next-compiler";
 
 describe("Compiler", () => {

src/export/packer/next-compiler.ts

@@ -5,25 +5,25 @@ import { File } from "file";
 import { Formatter } from "../formatter";
 
 interface IXmlifyedFile {
-    data: string;
+    readonly data: string;
-    path: string;
+    readonly path: string;
 }
 
 interface IXmlifyedFileMapping {
-    Document: IXmlifyedFile;
+    readonly Document: IXmlifyedFile;
-    Styles: IXmlifyedFile;
+    readonly Styles: IXmlifyedFile;
-    Properties: IXmlifyedFile;
+    readonly Properties: IXmlifyedFile;
-    Numbering: IXmlifyedFile;
+    readonly Numbering: IXmlifyedFile;
-    Relationships: IXmlifyedFile;
+    readonly Relationships: IXmlifyedFile;
-    FileRelationships: IXmlifyedFile;
+    readonly FileRelationships: IXmlifyedFile;
-    Headers: IXmlifyedFile[];
+    readonly Headers: IXmlifyedFile[];
-    Footers: IXmlifyedFile[];
+    readonly Footers: IXmlifyedFile[];
-    HeaderRelationships: IXmlifyedFile[];
+    readonly HeaderRelationships: IXmlifyedFile[];
-    FooterRelationships: IXmlifyedFile[];
+    readonly FooterRelationships: IXmlifyedFile[];
-    ContentTypes: IXmlifyedFile;
+    readonly ContentTypes: IXmlifyedFile;
-    AppProperties: IXmlifyedFile;
+    readonly AppProperties: IXmlifyedFile;
-    FootNotes: IXmlifyedFile;
+    readonly FootNotes: IXmlifyedFile;
-    Settings: IXmlifyedFile;
+    readonly Settings: IXmlifyedFile;
 }
 
 export class Compiler {
@@ -59,6 +59,18 @@ export class Compiler {
             zip.file(`word/media/${data.fileName}`, mediaData);
         }
 
+        for (const header of file.Headers) {
+            for (const data of header.Media.Array) {
+                zip.file(`word/media/${data.fileName}`, data.stream);
+            }
+        }
+
+        for (const footer of file.Footers) {
+            for (const data of footer.Media.Array) {
+                zip.file(`word/media/${data.fileName}`, data.stream);
+            }
+        }
+
         return zip;
     }
 
@@ -128,4 +140,13 @@ export class Compiler {
             },
         };
     }
+
+    /* By default docx collapse empty tags. <a></a> -> <a/>. this function mimic it
+       so comparing (diff) original docx file and the library output is easier
+       Currently not used, so commenting out */
+    // private collapseEmptyTags(xmlData: string): string {
+    //     const regEx = /<(([^ <>]+)[^<>]*)><\/\2>/g;
+    //     const collapsed = xmlData.replace(regEx, "<$1/>");
+    //     return collapsed;
+    // }
 }

src/export/packer/packer.spec.ts

@@ -2,7 +2,8 @@
 import { assert } from "chai";
 import { stub } from "sinon";
 
-import { File, Paragraph } from "../../file";
+import { File, Paragraph } from "file";
+
 import { Packer } from "./packer";
 
 describe("Packer", () => {

src/export/packer/packer.ts

@@ -10,21 +10,30 @@ export class Packer {
 
     public async toBuffer(file: File): Promise<Buffer> {
         const zip = await this.compiler.compile(file);
-        const zipData = (await zip.generateAsync({ type: "nodebuffer" })) as Buffer;
+        const zipData = (await zip.generateAsync({
+            type: "nodebuffer",
+            mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+        })) as Buffer;
 
         return zipData;
     }
 
     public async toBase64String(file: File): Promise<string> {
         const zip = await this.compiler.compile(file);
-        const zipData = (await zip.generateAsync({ type: "base64" })) as string;
+        const zipData = (await zip.generateAsync({
+            type: "base64",
+            mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+        })) as string;
 
         return zipData;
     }
 
     public async toBlob(file: File): Promise<Blob> {
         const zip = await this.compiler.compile(file);
-        const zipData = (await zip.generateAsync({ type: "blob" })) as Blob;
+        const zipData = (await zip.generateAsync({
+            type: "blob",
+            mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
+        })) as Blob;
 
         return zipData;
     }

src/file/app-properties/app-properties-attributes.ts

@@ -1,12 +1,12 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IAppPropertiesAttributes {
-    xmlns: string;
+    readonly xmlns: string;
-    vt: string;
+    readonly vt: string;
 }
 
 export class AppPropertiesAttributes extends XmlAttributeComponent<IAppPropertiesAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         xmlns: "xmlns",
         vt: "xmlns:vt",
     };

src/file/content-types/content-types-attributes.ts

@@ -1,11 +1,11 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IContentTypeAttributes {
-    xmlns?: string;
+    readonly xmlns?: string;
 }
 
 export class ContentTypeAttributes extends XmlAttributeComponent<IContentTypeAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         xmlns: "xmlns",
     };
 }

src/file/content-types/content-types.spec.ts

@@ -1,7 +1,9 @@
 // tslint:disable:no-string-literal
 
 import { expect } from "chai";
-import { Formatter } from "../../export/formatter";
+
+import { Formatter } from "export/formatter";
+
 import { ContentTypes } from "./content-types";
 
 describe("ContentTypes", () => {

src/file/content-types/default/default-attributes.ts

@@ -1,12 +1,12 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IDefaultAttributes {
-    contentType: string;
+    readonly contentType: string;
-    extension?: string;
+    readonly extension?: string;
 }
 
 export class DefaultAttributes extends XmlAttributeComponent<IDefaultAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         contentType: "ContentType",
         extension: "Extension",
     };

src/file/content-types/override/override-attributes.ts

@@ -1,12 +1,12 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IOverrideAttributes {
-    contentType: string;
+    readonly contentType: string;
-    partName?: string;
+    readonly partName?: string;
 }
 
 export class OverrideAttributes extends XmlAttributeComponent<IOverrideAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         contentType: "ContentType",
         partName: "PartName",
     };

src/file/core-properties/properties.spec.ts

@@ -1,6 +1,7 @@
 import { expect } from "chai";
 
-import { Formatter } from "../../export/formatter";
+import { Formatter } from "export/formatter";
+
 import { CoreProperties } from "./properties";
 
 describe("Properties", () => {

src/file/core-properties/properties.ts

@@ -3,14 +3,14 @@ import { DocumentAttributes } from "../document/document-attributes";
 import { Created, Creator, Description, Keywords, LastModifiedBy, Modified, Revision, Subject, Title } from "./components";
 
 export interface IPropertiesOptions {
-    title?: string;
+    readonly title?: string;
-    subject?: string;
+    readonly subject?: string;
-    creator?: string;
+    readonly creator?: string;
-    keywords?: string;
+    readonly keywords?: string;
-    description?: string;
+    readonly description?: string;
-    lastModifiedBy?: string;
+    readonly lastModifiedBy?: string;
-    revision?: string;
+    readonly revision?: string;
-    externalStyles?: string;
+    readonly externalStyles?: string;
 }
 
 export class CoreProperties extends XmlComponent {

src/file/document/body/body.spec.ts

@@ -1,6 +1,7 @@
 import { expect } from "chai";
 
-import { Formatter } from "../../../export/formatter";
+import { Formatter } from "export/formatter";
+
 import { Body } from "./body";
 
 describe("Body", () => {
@@ -16,11 +17,11 @@ describe("Body", () => {
             expect(formatted)
                 .to.have.property("w:sectPr")
                 .and.to.be.an.instanceof(Array);
-            expect(formatted["w:sectPr"]).to.have.length(7);
+            expect(formatted["w:sectPr"]).to.have.length(5);
         });
     });
 
-    describe("addSection", () => {
+    describe("#addSection", () => {
         it("should add section with options", () => {
             body.addSection({
                 width: 10000,
@@ -38,5 +39,93 @@ describe("Body", () => {
             const newSection = formatted[1]["w:sectPr"];
             expect(newSection[0]).to.deep.equal({ "w:pgSz": [{ _attr: { "w:h": 10000, "w:w": 10000, "w:orient": "portrait" } }] });
         });
+
+        it("should add section with default parameters", () => {
+            body.addSection({
+                width: 10000,
+                height: 10000,
+            });
+
+            const tree = new Formatter().format(body);
+
+            expect(tree).to.deep.equal({
+                "w:body": [
+                    {
+                        "w:p": [
+                            { "w:pPr": [] },
+                            {
+                                "w:pPr": [
+                                    {
+                                        "w:sectPr": [
+                                            { "w:pgSz": [{ _attr: { "w:w": 11906, "w:h": 16838, "w:orient": "portrait" } }] },
+                                            {
+                                                "w:pgMar": [
+                                                    {
+                                                        _attr: {
+                                                            "w:top": 1440,
+                                                            "w:right": 1440,
+                                                            "w:bottom": 1440,
+                                                            "w:left": 1440,
+                                                            "w:header": 708,
+                                                            "w:footer": 708,
+                                                            "w:gutter": 0,
+                                                            "w:mirrorMargins": false,
+                                                        },
+                                                    },
+                                                ],
+                                            },
+                                            { "w:cols": [{ _attr: { "w:space": 708 } }] },
+                                            { "w:docGrid": [{ _attr: { "w:linePitch": 360 } }] },
+                                            { "w:pgNumType": [{ _attr: { "w:fmt": "decimal" } }] },
+                                        ],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                    {
+                        "w:sectPr": [
+                            { "w:pgSz": [{ _attr: { "w:w": 10000, "w:h": 10000, "w:orient": "portrait" } }] },
+                            {
+                                "w:pgMar": [
+                                    {
+                                        _attr: {
+                                            "w:top": 1440,
+                                            "w:right": 1440,
+                                            "w:bottom": 1440,
+                                            "w:left": 1440,
+                                            "w:header": 708,
+                                            "w:footer": 708,
+                                            "w:gutter": 0,
+                                            "w:mirrorMargins": false,
+                                        },
+                                    },
+                                ],
+                            },
+                            { "w:cols": [{ _attr: { "w:space": 708 } }] },
+                            { "w:docGrid": [{ _attr: { "w:linePitch": 360 } }] },
+                            { "w:pgNumType": [{ _attr: { "w:fmt": "decimal" } }] },
+                        ],
+                    },
+                ],
+            });
+        });
+    });
+
+    describe("#getParagraphs", () => {
+        it("should get no paragraphs", () => {
+            const paragraphs = body.getParagraphs();
+
+            expect(paragraphs).to.be.an.instanceof(Array);
+        });
+    });
+
+    describe("#DefaultSection", () => {
+        it("should get section", () => {
+            const section = body.DefaultSection;
+
+            const tree = new Formatter().format(section);
+            expect(tree["w:sectPr"]).to.be.an.instanceof(Array);
+        });
     });
 });

src/file/document/body/body.ts

@@ -35,11 +35,9 @@ export class Body extends XmlComponent {
             this.sections.push(new SectionProperties(params));
         }
     }
-    public prepForXml(): IXmlableObject {
+    public prepForXml(): IXmlableObject | undefined {
         if (this.sections.length === 1) {
             this.root.push(this.sections[0]);
-        } else if (this.sections.length > 1) {
-            throw new Error("Invalid usage of sections. At the end of the body element there must be ONE section.");
         }
 
         return super.prepForXml();

src/file/document/body/section-properties/columns/columns-attributes.ts

@@ -1,11 +1,11 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IColumnsAttributes {
-    space?: number;
+    readonly space?: number;
 }
 
 export class ColumnsAttributes extends XmlAttributeComponent<IColumnsAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         space: "w:space",
     };
 }

src/file/document/body/section-properties/doc-grid/doc-grid-attributes.ts

@@ -1,11 +1,11 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IDocGridAttributesProperties {
-    linePitch?: number;
+    readonly linePitch?: number;
 }
 
 export class DocGridAttributes extends XmlAttributeComponent<IDocGridAttributesProperties> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         linePitch: "w:linePitch",
     };
 }

src/file/document/body/section-properties/footer-reference/footer-reference-attributes.ts

@@ -7,12 +7,12 @@ export enum FooterReferenceType {
 }
 
 export interface IFooterReferenceAttributes {
-    type: string;
+    readonly type: string;
-    id: string;
+    readonly id: string;
 }
 
 export class FooterReferenceAttributes extends XmlAttributeComponent<IFooterReferenceAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         type: "w:type",
         id: "r:id",
     };

src/file/document/body/section-properties/footer-reference/footer-reference.ts

@@ -2,8 +2,8 @@ import { XmlComponent } from "file/xml-components";
 import { FooterReferenceAttributes, FooterReferenceType } from "./footer-reference-attributes";
 
 export interface IFooterOptions {
-    footerType?: FooterReferenceType;
+    readonly footerType?: FooterReferenceType;
-    footerId?: number;
+    readonly footerId?: number;
 }
 
 export class FooterReference extends XmlComponent {

src/file/document/body/section-properties/header-reference/header-reference-attributes.ts

@@ -7,12 +7,12 @@ export enum HeaderReferenceType {
 }
 
 export interface IHeaderReferenceAttributes {
-    type: string;
+    readonly type: string;
-    id: string;
+    readonly id: string;
 }
 
 export class HeaderReferenceAttributes extends XmlAttributeComponent<IHeaderReferenceAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         type: "w:type",
         id: "r:id",
     };

src/file/document/body/section-properties/header-reference/header-reference.ts

@@ -2,8 +2,8 @@ import { XmlComponent } from "file/xml-components";
 import { HeaderReferenceAttributes, HeaderReferenceType } from "./header-reference-attributes";
 
 export interface IHeaderOptions {
-    headerType?: HeaderReferenceType;
+    readonly headerType?: HeaderReferenceType;
-    headerId?: number;
+    readonly headerId?: number;
 }
 
 export class HeaderReference extends XmlComponent {

src/file/document/body/section-properties/page-border/page-borders.spec.ts

@@ -1,16 +1,15 @@
 import { expect } from "chai";
 
-import { Formatter } from "../../../../../export/formatter";
+import { Formatter } from "export/formatter";
-import { BorderStyle } from "../../../../styles";
+import { BorderStyle } from "file/styles";
+
 import { PageBorderDisplay, PageBorders, PageBorderZOrder } from "./page-borders";
 
 describe("PageBorders", () => {
     describe("#constructor()", () => {
         it("should create empty element when no options are passed", () => {
             const properties = new PageBorders();
-            const tree = new Formatter().format(properties);
+            expect(() => new Formatter().format(properties)).to.throw();
-
-            expect(tree).to.equal("");
         });
 
         it("should create page borders with some configuration", () => {

src/file/document/body/section-properties/page-border/page-borders.ts

@@ -1,6 +1,6 @@
 // http://officeopenxml.com/WPsectionBorders.php
+import { BorderStyle } from "file/styles";
 import { IXmlableObject, XmlAttributeComponent, XmlComponent } from "file/xml-components";
-import { BorderStyle } from "../../../../styles";
 
 export enum PageBorderDisplay {
     ALL_PAGES = "allPages",
@@ -19,28 +19,28 @@ export enum PageBorderZOrder {
 }
 
 export interface IPageBorderAttributes {
-    display?: PageBorderDisplay;
+    readonly display?: PageBorderDisplay;
-    offsetFrom?: PageBorderOffsetFrom;
+    readonly offsetFrom?: PageBorderOffsetFrom;
-    zOrder?: PageBorderZOrder;
+    readonly zOrder?: PageBorderZOrder;
 }
 
 export interface IPageBorderConfiguration {
-    style?: BorderStyle;
+    readonly style?: BorderStyle;
-    size?: number;
+    readonly size?: number;
-    color?: string;
+    readonly color?: string;
-    space?: number;
+    readonly space?: number;
 }
 
 export interface IPageBordersOptions {
-    pageBorders?: IPageBorderAttributes;
+    readonly pageBorders?: IPageBorderAttributes;
-    pageBorderTop?: IPageBorderConfiguration;
+    readonly pageBorderTop?: IPageBorderConfiguration;
-    pageBorderRight?: IPageBorderConfiguration;
+    readonly pageBorderRight?: IPageBorderConfiguration;
-    pageBorderBottom?: IPageBorderConfiguration;
+    readonly pageBorderBottom?: IPageBorderConfiguration;
-    pageBorderLeft?: IPageBorderConfiguration;
+    readonly pageBorderLeft?: IPageBorderConfiguration;
 }
 
 class PageBordeAttributes extends XmlAttributeComponent<IPageBorderConfiguration> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         style: "w:val",
         size: "w:size",
         color: "w:color",
@@ -57,7 +57,7 @@ class PageBorder extends XmlComponent {
 }
 
 class PageBordersAttributes extends XmlAttributeComponent<IPageBorderAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         display: "w:display",
         offsetFrom: "w:offsetFrom",
         zOrder: "w:zOrder",
@@ -98,7 +98,9 @@ export class PageBorders extends XmlComponent {
         }
     }
 
-    public prepForXml(): IXmlableObject {
+    public prepForXml(): IXmlableObject | undefined {
-        return this.root.length > 0 ? super.prepForXml() : "";
+        if (this.root.length > 0) {
+            return super.prepForXml();
+        }
     }
 }

src/file/document/body/section-properties/page-margin/page-margin-attributes.ts

@@ -1,18 +1,18 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IPageMarginAttributes {
-    top?: number;
+    readonly top?: number;
-    right?: number;
+    readonly right?: number;
-    bottom?: number;
+    readonly bottom?: number;
-    left?: number;
+    readonly left?: number;
-    header?: number;
+    readonly header?: number;
-    footer?: number;
+    readonly footer?: number;
-    gutter?: number;
+    readonly gutter?: number;
-    mirror?: boolean;
+    readonly mirror?: boolean;
 }
 
 export class PageMarginAttributes extends XmlAttributeComponent<IPageMarginAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         top: "w:top",
         right: "w:right",
         bottom: "w:bottom",

src/file/document/body/section-properties/page-number/page-number.ts

@@ -17,12 +17,12 @@ export enum PageNumberFormat {
 }
 
 export interface IPageNumberTypeAttributes {
-    pageNumberStart?: number;
+    readonly pageNumberStart?: number;
-    pageNumberFormatType?: PageNumberFormat;
+    readonly pageNumberFormatType?: PageNumberFormat;
 }
 
 export class PageNumberTypeAttributes extends XmlAttributeComponent<IPageNumberTypeAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         pageNumberStart: "w:start",
         pageNumberFormatType: "w:fmt",
     };

src/file/document/body/section-properties/page-size/page-size-attributes.ts

@@ -6,13 +6,13 @@ export enum PageOrientation {
 }
 
 export interface IPageSizeAttributes {
-    width?: number;
+    readonly width?: number;
-    height?: number;
+    readonly height?: number;
-    orientation?: PageOrientation;
+    readonly orientation?: PageOrientation;
 }
 
 export class PageSizeAttributes extends XmlAttributeComponent<IPageSizeAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         width: "w:w",
         height: "w:h",
         orientation: "w:orient",

src/file/document/body/section-properties/page-size/page-size.spec.ts

@@ -1,6 +1,7 @@
 import { expect } from "chai";
 
-import { Formatter } from "../../../../../export/formatter";
+import { Formatter } from "export/formatter";
+
 import { PageSize } from "./page-size";
 import { PageOrientation } from "./page-size-attributes";
 

src/file/document/body/section-properties/section-properties.spec.ts

@@ -1,12 +1,19 @@
 import { expect } from "chai";
 
-import { Formatter } from "../../../../export/formatter";
+import { Formatter } from "export/formatter";
-import { FooterReferenceType, PageBorderOffsetFrom, PageNumberFormat } from "./";
+import { FooterWrapper } from "file/footer-wrapper";
+import { HeaderWrapper } from "file/header-wrapper";
+import { Media } from "file/media";
+
+import { PageBorderOffsetFrom } from "./page-border";
+import { PageNumberFormat } from "./page-number";
 import { SectionProperties } from "./section-properties";
 
 describe("SectionProperties", () => {
     describe("#constructor()", () => {
         it("should create section properties with options", () => {
+            const media = new Media();
+
             const properties = new SectionProperties({
                 width: 11906,
                 height: 16838,
@@ -20,9 +27,12 @@ describe("SectionProperties", () => {
                 mirror: false,
                 space: 708,
                 linePitch: 360,
-                headerId: 100,
+                headers: {
-                footerId: 200,
+                    default: new HeaderWrapper(media, 100),
-                footerType: FooterReferenceType.EVEN,
+                },
+                footers: {
+                    even: new FooterWrapper(media, 200),
+                },
                 pageNumberStart: 10,
                 pageNumberFormatType: PageNumberFormat.CARDINAL_TEXT,
             });
@@ -78,9 +88,7 @@ describe("SectionProperties", () => {
             });
             expect(tree["w:sectPr"][2]).to.deep.equal({ "w:cols": [{ _attr: { "w:space": 708 } }] });
             expect(tree["w:sectPr"][3]).to.deep.equal({ "w:docGrid": [{ _attr: { "w:linePitch": 360 } }] });
-            expect(tree["w:sectPr"][4]).to.deep.equal({ "w:headerReference": [{ _attr: { "r:id": "rId0", "w:type": "default" } }] });
+            expect(tree["w:sectPr"][4]).to.deep.equal({ "w:pgNumType": [{ _attr: { "w:fmt": "decimal" } }] });
-            expect(tree["w:sectPr"][5]).to.deep.equal({ "w:footerReference": [{ _attr: { "r:id": "rId0", "w:type": "default" } }] });
-            expect(tree["w:sectPr"][6]).to.deep.equal({ "w:pgNumType": [{ _attr: { "w:fmt": "decimal" } }] });
         });
 
         it("should create section properties with changed options", () => {
@@ -170,7 +178,8 @@ describe("SectionProperties", () => {
             });
             const tree = new Formatter().format(properties);
             expect(Object.keys(tree)).to.deep.equal(["w:sectPr"]);
-            expect(tree["w:sectPr"][7]).to.deep.equal({
+            const pgBorders = tree["w:sectPr"].find((item) => item["w:pgBorders"] !== undefined);
+            expect(pgBorders).to.deep.equal({
                 "w:pgBorders": [{ _attr: { "w:offsetFrom": "page" } }],
             });
         });

src/file/document/body/section-properties/section-properties.ts

@@ -1,115 +1,172 @@
 // http://officeopenxml.com/WPsection.php
+import { FooterWrapper } from "file/footer-wrapper";
+import { HeaderWrapper } from "file/header-wrapper";
 import { XmlComponent } from "file/xml-components";
-import { FooterReferenceType, IPageBordersOptions, IPageNumberTypeAttributes, PageBorders, PageNumberFormat, PageNumberType } from "./";
+
 import { Columns } from "./columns/columns";
 import { IColumnsAttributes } from "./columns/columns-attributes";
 import { DocumentGrid } from "./doc-grid/doc-grid";
 import { IDocGridAttributesProperties } from "./doc-grid/doc-grid-attributes";
-import { FooterReference, IFooterOptions } from "./footer-reference/footer-reference";
+import { FooterReferenceType } from "./footer-reference";
-import { HeaderReference, IHeaderOptions } from "./header-reference/header-reference";
+import { FooterReference } from "./footer-reference/footer-reference";
-import { HeaderReferenceType } from "./header-reference/header-reference-attributes";
+import { HeaderReferenceType } from "./header-reference";
+import { HeaderReference } from "./header-reference/header-reference";
+import { IPageBordersOptions, PageBorders } from "./page-border";
 import { PageMargin } from "./page-margin/page-margin";
 import { IPageMarginAttributes } from "./page-margin/page-margin-attributes";
+import { IPageNumberTypeAttributes, PageNumberFormat, PageNumberType } from "./page-number";
 import { PageSize } from "./page-size/page-size";
 import { IPageSizeAttributes, PageOrientation } from "./page-size/page-size-attributes";
+import { TitlePage } from "./title-page/title-page";
+
+export interface IHeaderFooterGroup<T> {
+    readonly default?: T;
+    readonly first?: T;
+    readonly even?: T;
+}
+
+interface IHeadersOptions {
+    readonly headers?: IHeaderFooterGroup<HeaderWrapper>;
+}
+
+interface IFootersOptions {
+    readonly footers?: IHeaderFooterGroup<FooterWrapper>;
+}
+
+interface ITitlePageOptions {
+    readonly titlePage?: boolean;
+}
 
 export type SectionPropertiesOptions = IPageSizeAttributes &
     IPageMarginAttributes &
     IColumnsAttributes &
     IDocGridAttributesProperties &
-    IHeaderOptions &
+    IHeadersOptions &
-    IFooterOptions &
+    IFootersOptions &
     IPageNumberTypeAttributes &
-    IPageBordersOptions;
+    IPageBordersOptions &
+    ITitlePageOptions;
 
 export class SectionProperties extends XmlComponent {
     private readonly options: SectionPropertiesOptions;
 
-    constructor(options?: SectionPropertiesOptions) {
+    constructor(options: SectionPropertiesOptions = {}) {
         super("w:sectPr");
 
-        const defaultOptions = {
+        const {
-            width: 11906,
+            width = 11906,
-            height: 16838,
+            height = 16838,
-            top: 1440,
+            top = 1440,
-            right: 1440,
+            right = 1440,
-            bottom: 1440,
+            bottom = 1440,
-            left: 1440,
+            left = 1440,
-            header: 708,
+            header = 708,
-            footer: 708,
+            footer = 708,
-            gutter: 0,
+            gutter = 0,
-            mirror: false,
+            mirror = false,
-            space: 708,
+            space = 708,
-            linePitch: 360,
+            linePitch = 360,
-            orientation: PageOrientation.PORTRAIT,
+            orientation = PageOrientation.PORTRAIT,
-            headerType: HeaderReferenceType.DEFAULT,
+            headers,
-            headerId: 0,
+            footers,
-            footerType: FooterReferenceType.DEFAULT,
+            pageNumberFormatType = PageNumberFormat.DECIMAL,
-            footerId: 0,
+            pageNumberStart,
-            pageNumberStart: undefined,
+            pageBorders,
-            pageNumberFormatType: PageNumberFormat.DECIMAL,
+            pageBorderTop,
-            pageBorders: undefined,
+            pageBorderRight,
-            pageBorderTop: undefined,
+            pageBorderBottom,
-            pageBorderRight: undefined,
+            pageBorderLeft,
-            pageBorderBottom: undefined,
+            titlePage = false,
-            pageBorderLeft: undefined,
+        } = options;
-        };
 
-        const mergedOptions = {
+        this.options = options;
-            ...defaultOptions,
+        this.root.push(new PageSize(width, height, orientation));
-            ...options,
+        this.root.push(new PageMargin(top, right, bottom, left, header, footer, gutter, mirror));
-        };
+        this.root.push(new Columns(space));
+        this.root.push(new DocumentGrid(linePitch));
 
-        this.root.push(new PageSize(mergedOptions.width, mergedOptions.height, mergedOptions.orientation));
+        this.addHeaders(headers);
-        this.root.push(
+        this.addFooters(footers);
-            new PageMargin(
-                mergedOptions.top,
-                mergedOptions.right,
-                mergedOptions.bottom,
-                mergedOptions.left,
-                mergedOptions.header,
-                mergedOptions.footer,
-                mergedOptions.gutter,
-                mergedOptions.mirror,
-            ),
-        );
-        this.root.push(new Columns(mergedOptions.space));
-        this.root.push(new DocumentGrid(mergedOptions.linePitch));
 
-        this.root.push(
+        this.root.push(new PageNumberType(pageNumberStart, pageNumberFormatType));
-            new HeaderReference({
-                headerType: mergedOptions.headerType,
-                headerId: mergedOptions.headerId,
-            }),
-        );
-        this.root.push(
-            new FooterReference({
-                footerType: mergedOptions.footerType,
-                footerId: mergedOptions.footerId,
-            }),
-        );
 
-        this.root.push(new PageNumberType(mergedOptions.pageNumberStart, mergedOptions.pageNumberFormatType));
+        if (pageBorders || pageBorderTop || pageBorderRight || pageBorderBottom || pageBorderLeft) {
-
-        if (
-            mergedOptions.pageBorders ||
-            mergedOptions.pageBorderTop ||
-            mergedOptions.pageBorderRight ||
-            mergedOptions.pageBorderBottom ||
-            mergedOptions.pageBorderLeft
-        ) {
             this.root.push(
                 new PageBorders({
-                    pageBorders: mergedOptions.pageBorders,
+                    pageBorders: pageBorders,
-                    pageBorderTop: mergedOptions.pageBorderTop,
+                    pageBorderTop: pageBorderTop,
-                    pageBorderRight: mergedOptions.pageBorderRight,
+                    pageBorderRight: pageBorderRight,
-                    pageBorderBottom: mergedOptions.pageBorderBottom,
+                    pageBorderBottom: pageBorderBottom,
-                    pageBorderLeft: mergedOptions.pageBorderLeft,
+                    pageBorderLeft: pageBorderLeft,
                 }),
             );
         }
 
-        this.options = mergedOptions;
+        if (titlePage) {
+            this.root.push(new TitlePage());
+        }
+    }
+
+    private addHeaders(headers?: IHeaderFooterGroup<HeaderWrapper>): void {
+        if (headers) {
+            if (headers.default) {
+                this.root.push(
+                    new HeaderReference({
+                        headerType: HeaderReferenceType.DEFAULT,
+                        headerId: headers.default.Header.ReferenceId,
+                    }),
+                );
+            }
+
+            if (headers.first) {
+                this.root.push(
+                    new HeaderReference({
+                        headerType: HeaderReferenceType.FIRST,
+                        headerId: headers.first.Header.ReferenceId,
+                    }),
+                );
+            }
+
+            if (headers.even) {
+                this.root.push(
+                    new HeaderReference({
+                        headerType: HeaderReferenceType.EVEN,
+                        headerId: headers.even.Header.ReferenceId,
+                    }),
+                );
+            }
+        }
+    }
+
+    private addFooters(footers?: IHeaderFooterGroup<FooterWrapper>): void {
+        if (footers) {
+            if (footers.default) {
+                this.root.push(
+                    new FooterReference({
+                        footerType: FooterReferenceType.DEFAULT,
+                        footerId: footers.default.Footer.ReferenceId,
+                    }),
+                );
+            }
+
+            if (footers.first) {
+                this.root.push(
+                    new FooterReference({
+                        footerType: FooterReferenceType.FIRST,
+                        footerId: footers.first.Footer.ReferenceId,
+                    }),
+                );
+            }
+
+            if (footers.even) {
+                this.root.push(
+                    new FooterReference({
+                        footerType: FooterReferenceType.EVEN,
+                        footerId: footers.even.Footer.ReferenceId,
+                    }),
+                );
+            }
+        }
     }
 
     public get Options(): SectionPropertiesOptions {

src/file/document/body/section-properties/title-page/title-page-attributes.ts

@@ -1,11 +1,11 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IHeaderReferenceAttributes {
-    value: string;
+    readonly value: string;
 }
 
 export class TitlePageAttributes extends XmlAttributeComponent<IHeaderReferenceAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         value: "w:val",
     };
 }

src/file/document/body/section-properties/title-page/title-page.spec.ts

@@ -1,6 +1,7 @@
 import { expect } from "chai";
 
-import { Formatter } from "../../../../../export/formatter";
+import { Formatter } from "export/formatter";
+
 import { TitlePage } from "./title-page";
 
 describe("PageSize", () => {

src/file/document/document-attributes.ts

@@ -1,33 +1,33 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IDocumentAttributesProperties {
-    wpc?: string;
+    readonly wpc?: string;
-    mc?: string;
+    readonly mc?: string;
-    o?: string;
+    readonly o?: string;
-    r?: string;
+    readonly r?: string;
-    m?: string;
+    readonly m?: string;
-    v?: string;
+    readonly v?: string;
-    wp14?: string;
+    readonly wp14?: string;
-    wp?: string;
+    readonly wp?: string;
-    w10?: string;
+    readonly w10?: string;
-    w?: string;
+    readonly w?: string;
-    w14?: string;
+    readonly w14?: string;
-    w15?: string;
+    readonly w15?: string;
-    wpg?: string;
+    readonly wpg?: string;
-    wpi?: string;
+    readonly wpi?: string;
-    wne?: string;
+    readonly wne?: string;
-    wps?: string;
+    readonly wps?: string;
-    Ignorable?: string;
+    readonly Ignorable?: string;
-    cp?: string;
+    readonly cp?: string;
-    dc?: string;
+    readonly dc?: string;
-    dcterms?: string;
+    readonly dcterms?: string;
-    dcmitype?: string;
+    readonly dcmitype?: string;
-    xsi?: string;
+    readonly xsi?: string;
-    type?: string;
+    readonly type?: string;
 }
 
 export class DocumentAttributes extends XmlAttributeComponent<IDocumentAttributesProperties> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         wpc: "xmlns:wpc",
         mc: "xmlns:mc",
         o: "xmlns:o",

src/file/document/document.spec.ts

@@ -1,6 +1,7 @@
 import { assert, expect } from "chai";
 
-import { Formatter } from "../../export/formatter";
+import { Formatter } from "export/formatter";
+
 import { Paragraph } from "../paragraph";
 import { Table } from "../table";
 import { Document } from "./document";

src/file/drawing/anchor/anchor-attributes.ts

@@ -2,16 +2,16 @@ import { XmlAttributeComponent } from "file/xml-components";
 import { IDistance } from "../drawing";
 
 export interface IAnchorAttributes extends IDistance {
-    allowOverlap?: "0" | "1";
+    readonly allowOverlap?: "0" | "1";
-    behindDoc?: "0" | "1";
+    readonly behindDoc?: "0" | "1";
-    layoutInCell?: "0" | "1";
+    readonly layoutInCell?: "0" | "1";
-    locked?: "0" | "1";
+    readonly locked?: "0" | "1";
-    relativeHeight?: number;
+    readonly relativeHeight?: number;
-    simplePos?: "0" | "1";
+    readonly simplePos?: "0" | "1";
 }
 
 export class AnchorAttributes extends XmlAttributeComponent<IAnchorAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         distT: "distT",
         distB: "distB",
         distL: "distL",

src/file/drawing/anchor/anchor.spec.ts

@@ -1,10 +1,12 @@
 import { assert } from "chai";
 
-import { Utility } from "../../../tests/utility";
+import { Utility } from "tests/utility";
-import { IDrawingOptions, TextWrapStyle } from ".././";
-import { Anchor } from "./";
 
-function createDrawing(drawingOptions: IDrawingOptions): Anchor {
+import { IDrawingOptions } from "../drawing";
+import { TextWrappingType } from "../text-wrap";
+import { Anchor } from "./anchor";
+
+function createAnchor(drawingOptions: IDrawingOptions): Anchor {
     return new Anchor(
         1,
         {
@@ -26,14 +28,32 @@ describe("Anchor", () => {
 
     describe("#constructor()", () => {
         it("should create a Drawing with correct root key", () => {
-            anchor = createDrawing({});
+            anchor = createAnchor({
+                floating: {
+                    verticalPosition: {
+                        offset: 0,
+                    },
+                    horizontalPosition: {
+                        offset: 0,
+                    },
+                },
+            });
             const newJson = Utility.jsonify(anchor);
             assert.equal(newJson.rootKey, "wp:anchor");
             assert.equal(newJson.root.length, 10);
         });
 
         it("should create a Drawing with all default options", () => {
-            anchor = createDrawing({});
+            anchor = createAnchor({
+                floating: {
+                    verticalPosition: {
+                        offset: 0,
+                    },
+                    horizontalPosition: {
+                        offset: 0,
+                    },
+                },
+            });
             const newJson = Utility.jsonify(anchor);
             assert.equal(newJson.root.length, 10);
 
@@ -58,7 +78,7 @@ describe("Anchor", () => {
             const horizontalPosition = newJson.root[2];
             assert.equal(horizontalPosition.rootKey, "wp:positionH");
             assert.include(horizontalPosition.root[0].root, {
-                relativeFrom: "column",
+                relativeFrom: "page",
             });
             assert.equal(horizontalPosition.root[1].rootKey, "wp:posOffset");
             assert.include(horizontalPosition.root[1].root[0], 0);
@@ -67,7 +87,7 @@ describe("Anchor", () => {
             const verticalPosition = newJson.root[3];
             assert.equal(verticalPosition.rootKey, "wp:positionV");
             assert.include(verticalPosition.root[0].root, {
-                relativeFrom: "paragraph",
+                relativeFrom: "page",
             });
             assert.equal(verticalPosition.root[1].rootKey, "wp:posOffset");
             assert.include(verticalPosition.root[1].root[0], 0);
@@ -101,10 +121,18 @@ describe("Anchor", () => {
             assert.equal(graphic.rootKey, "a:graphic");
         });
 
-        it("should create a Drawing with text wrapping", () => {
+        it("should create a Drawing with square text wrapping", () => {
-            anchor = createDrawing({
+            anchor = createAnchor({
-                textWrapping: {
+                floating: {
-                    textWrapStyle: TextWrapStyle.SQUARE,
+                    verticalPosition: {
+                        offset: 0,
+                    },
+                    horizontalPosition: {
+                        offset: 0,
+                    },
+                    wrap: {
+                        type: TextWrappingType.SQUARE,
+                    },
                 },
             });
             const newJson = Utility.jsonify(anchor);
@@ -114,5 +142,68 @@ describe("Anchor", () => {
             const textWrap = newJson.root[6];
             assert.equal(textWrap.rootKey, "wp:wrapSquare");
         });
+
+        it("should create a Drawing with no text wrapping", () => {
+            anchor = createAnchor({
+                floating: {
+                    verticalPosition: {
+                        offset: 0,
+                    },
+                    horizontalPosition: {
+                        offset: 0,
+                    },
+                    wrap: {
+                        type: TextWrappingType.NONE,
+                    },
+                },
+            });
+            const newJson = Utility.jsonify(anchor);
+            assert.equal(newJson.root.length, 10);
+
+            const textWrap = newJson.root[6];
+            assert.equal(textWrap.rootKey, "wp:wrapNone");
+        });
+
+        it("should create a Drawing with tight text wrapping", () => {
+            anchor = createAnchor({
+                floating: {
+                    horizontalPosition: {
+                        offset: 0,
+                    },
+                    verticalPosition: {
+                        offset: 0,
+                    },
+                    wrap: {
+                        type: TextWrappingType.TIGHT,
+                    },
+                },
+            });
+            const newJson = Utility.jsonify(anchor);
+            assert.equal(newJson.root.length, 10);
+
+            const textWrap = newJson.root[6];
+            assert.equal(textWrap.rootKey, "wp:wrapTight");
+        });
+
+        it("should create a Drawing with tight text wrapping", () => {
+            anchor = createAnchor({
+                floating: {
+                    verticalPosition: {
+                        offset: 0,
+                    },
+                    horizontalPosition: {
+                        offset: 0,
+                    },
+                    wrap: {
+                        type: TextWrappingType.TOP_AND_BOTTOM,
+                    },
+                },
+            });
+            const newJson = Utility.jsonify(anchor);
+            assert.equal(newJson.root.length, 10);
+
+            const textWrap = newJson.root[6];
+            assert.equal(textWrap.rootKey, "wp:wrapTopAndBottom");
+        });
     });
 });

src/file/drawing/anchor/anchor.ts

@@ -2,16 +2,9 @@
 import { IMediaDataDimensions } from "file/media";
 import { XmlComponent } from "file/xml-components";
 import { IDrawingOptions } from "../drawing";
-import {
+import { HorizontalPosition, IFloating, SimplePos, VerticalPosition } from "../floating";
-    HorizontalPosition,
-    HorizontalPositionRelativeFrom,
-    IFloating,
-    SimplePos,
-    VerticalPosition,
-    VerticalPositionRelativeFrom,
-} from "../floating";
 import { Graphic } from "../inline/graphic";
-import { TextWrapStyle, WrapNone, WrapSquare, WrapTight, WrapTopAndBottom } from "../text-wrap";
+import { TextWrappingType, WrapNone, WrapSquare, WrapTight, WrapTopAndBottom } from "../text-wrap";
 import { DocProperties } from "./../doc-properties/doc-properties";
 import { EffectExtent } from "./../effect-extent/effect-extent";
 import { Extent } from "./../extent/extent";
@@ -23,14 +16,8 @@ const defaultOptions: IFloating = {
     behindDocument: false,
     lockAnchor: false,
     layoutInCell: true,
-    verticalPosition: {
+    verticalPosition: {},
-        relative: VerticalPositionRelativeFrom.PARAGRAPH,
+    horizontalPosition: {},
-        offset: 0,
-    },
-    horizontalPosition: {
-        relative: HorizontalPositionRelativeFrom.COLUMN,
-        offset: 0,
-    },
 };
 
 export class Anchor extends XmlComponent {
@@ -38,15 +25,22 @@ export class Anchor extends XmlComponent {
         super("wp:anchor");
 
         const floating = {
+            margins: {
+                top: 0,
+                bottom: 0,
+                left: 0,
+                right: 0,
+            },
             ...defaultOptions,
             ...drawingOptions.floating,
         };
+
         this.root.push(
             new AnchorAttributes({
-                distT: 0,
+                distT: floating.margins.top || 0,
-                distB: 0,
+                distB: floating.margins.bottom || 0,
-                distL: 0,
+                distL: floating.margins.left || 0,
-                distR: 0,
+                distR: floating.margins.right || 0,
                 simplePos: "0", // note: word doesn't fully support - so we use 0
                 allowOverlap: floating.allowOverlap === true ? "1" : "0",
                 behindDoc: floating.behindDocument === true ? "1" : "0",
@@ -62,18 +56,18 @@ export class Anchor extends XmlComponent {
         this.root.push(new Extent(dimensions.emus.x, dimensions.emus.y));
         this.root.push(new EffectExtent());
 
-        if (drawingOptions.textWrapping !== undefined) {
+        if (drawingOptions.floating !== undefined && drawingOptions.floating.wrap !== undefined) {
-            switch (drawingOptions.textWrapping.textWrapStyle) {
+            switch (drawingOptions.floating.wrap.type) {
-                case TextWrapStyle.SQUARE:
+                case TextWrappingType.SQUARE:
-                    this.root.push(new WrapSquare(drawingOptions.textWrapping));
+                    this.root.push(new WrapSquare(drawingOptions.floating.wrap, drawingOptions.floating.margins));
                     break;
-                case TextWrapStyle.TIGHT:
+                case TextWrappingType.TIGHT:
-                    this.root.push(new WrapTight(drawingOptions.textWrapping.distanceFromText));
+                    this.root.push(new WrapTight(drawingOptions.floating.margins));
                     break;
-                case TextWrapStyle.TOP_AND_BOTTOM:
+                case TextWrappingType.TOP_AND_BOTTOM:
-                    this.root.push(new WrapTopAndBottom(drawingOptions.textWrapping.distanceFromText));
+                    this.root.push(new WrapTopAndBottom(drawingOptions.floating.margins));
                     break;
-                case TextWrapStyle.NONE:
+                case TextWrappingType.NONE:
                 default:
                     this.root.push(new WrapNone());
             }

src/file/drawing/doc-properties/doc-properties-attributes.ts

@@ -1,13 +1,13 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IDocPropertiesAttributes {
-    id?: number;
+    readonly id?: number;
-    name?: string;
+    readonly name?: string;
-    descr?: string;
+    readonly descr?: string;
 }
 
 export class DocPropertiesAttributes extends XmlAttributeComponent<IDocPropertiesAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         id: "id",
         name: "name",
         descr: "descr",

src/file/drawing/drawing.spec.ts

@@ -1,7 +1,8 @@
 import { assert } from "chai";
 
-import { Utility } from "../../tests/utility";
+import { Utility } from "tests/utility";
-import { Drawing, IDrawingOptions, PlacementPosition } from "./";
+
+import { Drawing, IDrawingOptions } from "./drawing";
 
 const imageBase64Data = `iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAMAAAD04JH5AAACzVBMVEUAAAAAAAAAAAAAAAA/AD8zMzMqKiokJCQfHx8cHBwZGRkuFxcqFSonJyckJCQiIiIfHx8eHh4cHBwoGhomGSYkJCQhISEfHx8eHh4nHR0lHBwkGyQjIyMiIiIgICAfHx8mHh4lHh4kHR0jHCMiGyIhISEgICAfHx8lHx8kHh4jHR0hHCEhISEgICAlHx8kHx8jHh4jHh4iHSIhHCEhISElICAkHx8jHx8jHh4iHh4iHSIhHSElICAkICAjHx8jHx8iHh4iHh4hHiEhHSEkICAjHx8iHx8iHx8hHh4hHiEkHSEjHSAjHx8iHx8iHx8hHh4kHiEkHiEjHSAiHx8hHx8hHh4kHiEjHiAjHSAiHx8iHx8hHx8kHh4jHiEjHiAjHiAiICAiHx8kHx8jHh4jHiEjHiAiHiAiHSAiHx8jHx8jHx8jHiAiHiAiHiAiHSAiHx8jHx8jHx8iHiAiHiAiHiAjHx8jHx8jHx8jHx8iHiAiHiAiHiAjHx8jHx8jHx8iHx8iHSAiHiAjHiAjHx8jHx8hHx8iHx8iHyAiHiAjHiAjHiAjHh4hHx8iHx8iHx8iHyAjHSAjHiAjHiAjHh4hHx8iHx8iHx8jHyAjHiAhHh4iHx8iHx8jHyAjHSAjHSAhHiAhHh4iHx8iHx8jHx8jHyAjHSAjHSAiHh4iHh4jHx8jHx8jHyAjHyAhHSAhHSAiHh4iHh4jHx8jHx8jHyAhHyAhHSAiHSAiHh4jHh4jHx8jHx8jHyAhHyAhHSAiHSAjHR4jHh4jHx8jHx8hHyAhHyAiHSAjHSAjHR4jHh4jHx8hHx8hHyAhHyAiHyAjHSAjHR4jHR4hHh4hHx8hHyAiHyAjHyAjHSAjHR4jHR4hHh4hHx8hHyAjHyAjHyAjHSAjHR4hHR4hHR4hHx8iHyAjHyAjHyAjHSAhHR4hHR4hHR4hHx8jHyAjHyAjHyAjHyC9S2xeAAAA7nRSTlMAAQIDBAUGBwgJCgsMDQ4PEBESExQVFxgZGhscHR4fICEiIyQlJicoKSorLS4vMDEyMzQ1Njc4OTo7PD0+P0BBQkNERUZISUpLTE1OUFFSU1RVVllaW1xdXmBhYmNkZWZnaGprbG1ub3Byc3R1dnd4eXp8fn+AgYKDhIWGiImKi4yNj5CRkpOUlZaXmJmam5ydnp+goaKjpKaoqqusra6vsLGys7S1tri5uru8vb6/wMHCw8TFxsfIycrLzM3Oz9DR0tPU1dbX2Nna29zd3t/g4eLj5OXm5+jp6uvs7e7v8PHy8/T19vf4+fr7/P3+fkZpVQAABcBJREFUGBntwftjlQMcBvDnnLNL22qzJjWlKLHFVogyty3SiFq6EZliqZGyhnSxsLlMRahYoZKRFcul5dKFCatYqWZaNKvWtrPz/A2+7/b27qRzec/lPfvl/XxgMplMJpPJZDKZAtA9HJ3ppnIez0KnSdtC0RCNznHdJrbrh85wdSlVVRaEXuoGamYi5K5430HNiTiEWHKJg05eRWgNfKeV7RxbqUhGKPV/207VupQ8is0IoX5vtFC18SqEHaK4GyHTZ2kzVR8PBTCO4oANIZL4ShNVZcOhKKeYg9DoWdhI1ec3os2VFI0JCIUez5+i6st0qJZRrEAIJCw+QdW223BG/EmKwTBc/IJ/qfp2FDrkUnwFo8U9dZyqnaPhxLqfYjyM1S3vb6p+GGOBszsojoTDSDFz6qj66R4LzvYJxVMwUNRjf1H1ywQr/megg2RzLximy8waqvbda8M5iijegVEiHjlM1W/3h+FcXesphsMY4dMOUnUgOxyuPEzxPQwRNvV3qg5Nj4BreyimwADWe/dRVTMjEm6MoGLzGwtystL6RyOY3qSqdlYU3FpLZw1VW0sK5943MvUCKwJ1noNtjs6Ohge76Zq9ZkfpigU5WWkDYuCfbs1U5HWFR8/Qq4a9W0uK5k4ZmdrTCl8spGIePLPlbqqsc1Afe83O0hULc8alDYiBd7ZyitYMeBfR55rR2fOKP6ioPk2dGvZ+UVI0d8rtqT2tcCexlqK2F3wRn5Q+YVbBqrLKOupkr9lZujAOrmS0UpTb4JeIPkNHZ+cXr6uoPk2vyuBSPhWLEKj45PQJuQWryyqP0Z14uGLdROHIRNBEXDR09EP5r62rOHCazhrD4VKPwxTH+sIA3ZPTJ+YuWV22n+IruHFDC8X2CBjnPoolcGc2FYUwzmsUWXDHsoGKLBhmN0VvuBVfTVE/AAbpaid5CB4MbaLY1QXGuIViLTyZQcVyGGMuxWPwaA0Vk2GI9RRp8Ci2iuLkIBjhT5LNUfAspZFiTwyC72KK7+DNg1SsRvCNp3gZXq2k4iEEXSHFJHgVXUlxejCCbTvFAHiXdIJiXxyCK7KJ5FHoMZGK9xBcwyg2QpdlVMxEUM2iyIMuXXZQNF+HswxMsSAAJRQjoE//eoqDCXBSTO6f1xd+O0iyNRY6jaWi1ALNYCocZROj4JdEikroVkjFk9DcStXxpdfCD2MoXodu4RUU9ptxxmXssOfxnvDVcxRTod9FxyhqLoAqis5aPhwTDp9spRgEH2Q6KLbYoKqlaKTm6Isp0C/sJMnjFvhiERXPQvUNRe9p29lhR04CdBpC8Sl8YiuncIxEuzUUg4Dkgj+paVozygY9plPMh28SaymO9kabAopREGF3vt9MzeFFl8G7lRSZ8FFGK8XX4VA8QjEd7XrM3M0OXz8YCy+qKBLgq3wqnofiTorF0Ax56Rg1J1elW+BBAsVe+My6iYq7IK6keBdOIseV2qn5Pb8f3MqkWAXf9ThM8c8lAOIotuFsF875lRrH5klRcG0+xcPwQ1oLxfeRAP4heQTnGL78X2rqlw2DK59SXAV/zKaiGMAuko5InCt68mcOan5+ohf+z1pP8lQY/GHZQMV4YD3FpXDp4qerqbF/lBWBswyi+AL+ia+maLgcRRQj4IYlY/UpauqKBsPJAxQF8NM1TRQ/RudSPAD34rK3scOuR8/HGcspxsJfOVS8NZbiGXiUtPgINU3v3WFDmx8pEuG3EiqKKVbCC1vm2iZqap5LAtCtleQf8F9sFYWDohzeJczYyQ4V2bEZFGsQgJRGqqqhS2phHTWn9lDkIhBTqWqxQZ+IsRvtdHY9AvI2VX2hW68nfqGmuQsCEl3JdjfCF8OW1bPdtwhQ0gm2mQzfRE3a7KCYj0BNZJs8+Kxf/r6WtTEI2FIqlsMfFgRB5A6KUnSe/vUkX0AnuvUIt8SjM1m6wWQymUwmk8lkMgXRf5vi8rLQxtUhAAAAAElFTkSuQmCC`;
 
@@ -46,7 +47,14 @@ describe("Drawing", () => {
 
         it("should create a drawing with anchor element when there options are passed", () => {
             currentBreak = createDrawing({
-                position: PlacementPosition.FLOATING,
+                floating: {
+                    horizontalPosition: {
+                        offset: 0,
+                    },
+                    verticalPosition: {
+                        offset: 0,
+                    },
+                },
             });
             const newJson = Utility.jsonify(currentBreak);
             assert.equal(newJson.root[0].rootKey, "wp:anchor");

src/file/drawing/drawing.ts

@@ -3,50 +3,33 @@ import { XmlComponent } from "file/xml-components";
 import { Anchor } from "./anchor";
 import { IFloating } from "./floating";
 import { Inline } from "./inline";
-import { ITextWrapping } from "./text-wrap";
-
-export enum PlacementPosition {
-    INLINE,
-    FLOATING,
-}
 
 export interface IDistance {
-    distT?: number;
+    readonly distT?: number;
-    distB?: number;
+    readonly distB?: number;
-    distL?: number;
+    readonly distL?: number;
-    distR?: number;
+    readonly distR?: number;
 }
 
 export interface IDrawingOptions {
-    position?: PlacementPosition;
+    readonly floating?: IFloating;
-    textWrapping?: ITextWrapping;
-    floating?: IFloating;
 }
 
-const defaultDrawingOptions: IDrawingOptions = {
-    position: PlacementPosition.INLINE,
-};
-
 export class Drawing extends XmlComponent {
     private readonly inline: Inline;
 
-    constructor(imageData: IMediaData, drawingOptions?: IDrawingOptions) {
+    constructor(imageData: IMediaData, drawingOptions: IDrawingOptions = {}) {
         super("w:drawing");
 
         if (imageData === undefined) {
             throw new Error("imageData cannot be undefined");
         }
 
-        const mergedOptions = {
+        if (!drawingOptions.floating) {
-            ...defaultDrawingOptions,
-            ...drawingOptions,
-        };
-
-        if (mergedOptions.position === PlacementPosition.INLINE) {
             this.inline = new Inline(imageData.referenceId, imageData.dimensions);
             this.root.push(this.inline);
-        } else if (mergedOptions.position === PlacementPosition.FLOATING) {
+        } else {
-            this.root.push(new Anchor(imageData.referenceId, imageData.dimensions, mergedOptions));
+            this.root.push(new Anchor(imageData.referenceId, imageData.dimensions, drawingOptions));
         }
     }
 

src/file/drawing/effect-extent/effect-extent-attributes.ts

@@ -1,14 +1,14 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IEffectExtentAttributes {
-    b?: number;
+    readonly b?: number;
-    l?: number;
+    readonly l?: number;
-    r?: number;
+    readonly r?: number;
-    t?: number;
+    readonly t?: number;
 }
 
 export class EffectExtentAttributes extends XmlAttributeComponent<IEffectExtentAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         b: "b",
         l: "l",
         r: "r",

src/file/drawing/extent/extent-attributes.ts

@@ -1,12 +1,12 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IExtentAttributes {
-    cx?: number;
+    readonly cx?: number;
-    cy?: number;
+    readonly cy?: number;
 }
 
 export class ExtentAttributes extends XmlAttributeComponent<IExtentAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         cx: "cx",
         cy: "cy",
     };

src/file/drawing/extent/extent.ts

@@ -1,4 +1,5 @@
 import { XmlComponent } from "file/xml-components";
+
 import { ExtentAttributes } from "./extent-attributes";
 
 export class Extent extends XmlComponent {

src/file/drawing/floating/align.spec.ts

@@ -1,8 +1,9 @@
 import { assert } from "chai";
 
-import { VerticalPositionAlign } from ".";
+import { Utility } from "tests/utility";
-import { Utility } from "../../../tests/utility";
+
 import { Align } from "./align";
+import { VerticalPositionAlign } from "./floating-position";
 
 describe("Align", () => {
     describe("#constructor()", () => {

src/file/drawing/floating/floating-position.ts

@@ -1,4 +1,5 @@
 // http://officeopenxml.com/drwPicFloating-position.php
+import { ITextWrapping } from "../text-wrap";
 
 export enum HorizontalPositionRelativeFrom {
     CHARACTER = "character",
@@ -39,22 +40,31 @@ export enum VerticalPositionAlign {
 }
 
 export interface IHorizontalPositionOptions {
-    relative: HorizontalPositionRelativeFrom;
+    readonly relative?: HorizontalPositionRelativeFrom;
-    align?: HorizontalPositionAlign;
+    readonly align?: HorizontalPositionAlign;
-    offset?: number;
+    readonly offset?: number;
 }
 
 export interface IVerticalPositionOptions {
-    relative: VerticalPositionRelativeFrom;
+    readonly relative?: VerticalPositionRelativeFrom;
-    align?: VerticalPositionAlign;
+    readonly align?: VerticalPositionAlign;
-    offset?: number;
+    readonly offset?: number;
+}
+
+export interface IMargins {
+    readonly left?: number;
+    readonly bottom?: number;
+    readonly top?: number;
+    readonly right?: number;
 }
 
 export interface IFloating {
-    horizontalPosition: IHorizontalPositionOptions;
+    readonly horizontalPosition: IHorizontalPositionOptions;
-    verticalPosition: IVerticalPositionOptions;
+    readonly verticalPosition: IVerticalPositionOptions;
-    allowOverlap?: boolean;
+    readonly allowOverlap?: boolean;
-    lockAnchor?: boolean;
+    readonly lockAnchor?: boolean;
-    behindDocument?: boolean;
+    readonly behindDocument?: boolean;
-    layoutInCell?: boolean;
+    readonly layoutInCell?: boolean;
+    readonly margins?: IMargins;
+    readonly wrap?: ITextWrapping;
 }

src/file/drawing/floating/horizontal-position.spec.ts

@@ -1,7 +1,8 @@
 import { assert } from "chai";
 
-import { HorizontalPositionAlign, HorizontalPositionRelativeFrom } from ".";
+import { Utility } from "tests/utility";
-import { Utility } from "../../../tests/utility";
+
+import { HorizontalPositionAlign, HorizontalPositionRelativeFrom } from "./floating-position";
 import { HorizontalPosition } from "./horizontal-position";
 
 describe("HorizontalPosition", () => {

src/file/drawing/floating/horizontal-position.ts

@@ -5,11 +5,11 @@ import { HorizontalPositionRelativeFrom, IHorizontalPositionOptions } from "./fl
 import { PositionOffset } from "./position-offset";
 
 interface IHorizontalPositionAttributes {
-    relativeFrom: HorizontalPositionRelativeFrom;
+    readonly relativeFrom: HorizontalPositionRelativeFrom;
 }
 
 class HorizontalPositionAttributes extends XmlAttributeComponent<IHorizontalPositionAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         relativeFrom: "relativeFrom",
     };
 }
@@ -20,7 +20,7 @@ export class HorizontalPosition extends XmlComponent {
 
         this.root.push(
             new HorizontalPositionAttributes({
-                relativeFrom: horizontalPosition.relative,
+                relativeFrom: horizontalPosition.relative || HorizontalPositionRelativeFrom.PAGE,
             }),
         );
 

src/file/drawing/floating/position-offset.spec.ts

@@ -1,6 +1,7 @@
 import { assert } from "chai";
 
-import { Utility } from "../../../tests/utility";
+import { Utility } from "tests/utility";
+
 import { PositionOffset } from "./position-offset";
 
 describe("PositionOffset", () => {

src/file/drawing/floating/simple-pos.spec.ts

@@ -1,6 +1,7 @@
 import { assert } from "chai";
 
-import { Utility } from "../../../tests/utility";
+import { Utility } from "tests/utility";
+
 import { SimplePos } from "./simple-pos";
 
 describe("SimplePos", () => {

src/file/drawing/floating/simple-pos.ts

@@ -2,12 +2,12 @@
 import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
 
 interface ISimplePosAttributes {
-    x: number;
+    readonly x: number;
-    y: number;
+    readonly y: number;
 }
 
 class SimplePosAttributes extends XmlAttributeComponent<ISimplePosAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         x: "x",
         y: "y",
     };

src/file/drawing/floating/vertical-position.spec.ts

@@ -1,7 +1,8 @@
 import { assert } from "chai";
 
-import { VerticalPositionAlign, VerticalPositionRelativeFrom } from ".";
+import { Utility } from "tests/utility";
-import { Utility } from "../../../tests/utility";
+
+import { VerticalPositionAlign, VerticalPositionRelativeFrom } from "./floating-position";
 import { VerticalPosition } from "./vertical-position";
 
 describe("VerticalPosition", () => {

src/file/drawing/floating/vertical-position.ts

@@ -5,11 +5,11 @@ import { IVerticalPositionOptions, VerticalPositionRelativeFrom } from "./floati
 import { PositionOffset } from "./position-offset";
 
 interface IVerticalPositionAttributes {
-    relativeFrom: VerticalPositionRelativeFrom;
+    readonly relativeFrom: VerticalPositionRelativeFrom;
 }
 
 class VerticalPositionAttributes extends XmlAttributeComponent<IVerticalPositionAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         relativeFrom: "relativeFrom",
     };
 }
@@ -20,7 +20,7 @@ export class VerticalPosition extends XmlComponent {
 
         this.root.push(
             new VerticalPositionAttributes({
-                relativeFrom: verticalPosition.relative,
+                relativeFrom: verticalPosition.relative || VerticalPositionRelativeFrom.PAGE,
             }),
         );
 

src/file/drawing/graphic-frame/graphic-frame-locks/graphic-frame-lock-attributes.ts

@@ -1,12 +1,12 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IGraphicFrameLockAttributes {
-    xmlns?: string;
+    readonly xmlns?: string;
-    noChangeAspect?: number;
+    readonly noChangeAspect?: number;
 }
 
 export class GraphicFrameLockAttributes extends XmlAttributeComponent<IGraphicFrameLockAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         xmlns: "xmlns:a",
         noChangeAspect: "noChangeAspect",
     };

src/file/drawing/inline/graphic/graphic-data/graphic-data-attribute.ts

@@ -1,11 +1,11 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IGraphicDataAttributes {
-    uri?: string;
+    readonly uri?: string;
 }
 
 export class GraphicDataAttributes extends XmlAttributeComponent<IGraphicDataAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         uri: "uri",
     };
 }

src/file/drawing/inline/graphic/graphic-data/pic/blip/blip.ts

@@ -1,12 +1,12 @@
 import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
 
 interface IBlipProperties {
-    embed: string;
+    readonly embed: string;
-    cstate: string;
+    readonly cstate: string;
 }
 
 class BlipAttributes extends XmlAttributeComponent<IBlipProperties> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         embed: "r:embed",
         cstate: "cstate",
     };

src/file/drawing/inline/graphic/graphic-data/pic/non-visual-pic-properties/child-non-visual-pic-properties/pic-locks/pic-locks-attributes.ts

@@ -1,12 +1,12 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IPicLocksAttributes {
-    noChangeAspect?: number;
+    readonly noChangeAspect?: number;
-    noChangeArrowheads?: number;
+    readonly noChangeArrowheads?: number;
 }
 
 export class PicLocksAttributes extends XmlAttributeComponent<IPicLocksAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         noChangeAspect: "noChangeAspect",
         noChangeArrowheads: "noChangeArrowheads",
     };

src/file/drawing/inline/graphic/graphic-data/pic/non-visual-pic-properties/non-visual-properties/non-visual-properties-attributes.ts

@@ -1,13 +1,13 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface INonVisualPropertiesAttributes {
-    id?: number;
+    readonly id?: number;
-    name?: string;
+    readonly name?: string;
-    descr?: string;
+    readonly descr?: string;
 }
 
 export class NonVisualPropertiesAttributes extends XmlAttributeComponent<INonVisualPropertiesAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         id: "id",
         name: "name",
         descr: "desc",

src/file/drawing/inline/graphic/graphic-data/pic/pic-attributes.ts

@@ -1,11 +1,11 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IPicAttributes {
-    xmlns?: string;
+    readonly xmlns?: string;
 }
 
 export class PicAttributes extends XmlAttributeComponent<IPicAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         xmlns: "xmlns:pic",
     };
 }

src/file/drawing/inline/graphic/graphic-data/pic/shape-properties/form/extents/extents-attributes.ts

@@ -1,12 +1,12 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IExtentsAttributes {
-    cx?: number;
+    readonly cx?: number;
-    cy?: number;
+    readonly cy?: number;
 }
 
 export class ExtentsAttributes extends XmlAttributeComponent<IExtentsAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         cx: "cx",
         cy: "cy",
     };

src/file/drawing/inline/graphic/graphic-data/pic/shape-properties/form/offset/off-attributes.ts

@@ -1,12 +1,12 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IOffsetAttributes {
-    x?: number;
+    readonly x?: number;
-    y?: number;
+    readonly y?: number;
 }
 
 export class OffsetAttributes extends XmlAttributeComponent<IOffsetAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         x: "x",
         y: "y",
     };

src/file/drawing/inline/graphic/graphic-data/pic/shape-properties/preset-geometry/preset-geometry-attributes.ts

@@ -1,11 +1,11 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IPresetGeometryAttributes {
-    prst?: string;
+    readonly prst?: string;
 }
 
 export class PresetGeometryAttributes extends XmlAttributeComponent<IPresetGeometryAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         prst: "prst",
     };
 }

src/file/drawing/inline/graphic/graphic-data/pic/shape-properties/shape-properties-attributes.ts

@@ -1,11 +1,11 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IShapePropertiesAttributes {
-    bwMode?: string;
+    readonly bwMode?: string;
 }
 
 export class ShapePropertiesAttributes extends XmlAttributeComponent<IShapePropertiesAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         bwMode: "bwMode",
     };
 }

src/file/drawing/inline/graphic/graphic.ts

@@ -2,11 +2,11 @@ import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
 import { GraphicData } from "./graphic-data";
 
 interface IGraphicProperties {
-    a: string;
+    readonly a: string;
 }
 
 class GraphicAttributes extends XmlAttributeComponent<IGraphicProperties> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         a: "xmlns:a",
     };
 }

src/file/drawing/inline/inline-attributes.ts

@@ -1,11 +1,16 @@
 import { XmlAttributeComponent } from "file/xml-components";
 import { IDistance } from "../drawing";
 
-// tslint:disable-next-line:no-empty-interface
+// distT, distB etc have no effect on inline images, only floating
-export interface IInlineAttributes extends IDistance {}
+export interface IInlineAttributes extends IDistance {
+    readonly distT?: number;
+    readonly distB?: number;
+    readonly distL?: number;
+    readonly distR?: number;
+}
 
 export class InlineAttributes extends XmlAttributeComponent<IInlineAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         distT: "distT",
         distB: "distB",
         distL: "distL",

src/file/drawing/text-wrap/text-wrapping.ts

@@ -1,14 +1,14 @@
 // http://officeopenxml.com/drwPicFloating-textWrap.php
 import { IDistance } from "../drawing";
 
-export enum TextWrapStyle {
+export enum TextWrappingType {
     NONE,
     SQUARE,
     TIGHT,
     TOP_AND_BOTTOM,
 }
 
-export enum WrapTextOption {
+export enum TextWrappingSide {
     BOTH_SIDES = "bothSides",
     LEFT = "left",
     RIGHT = "right",
@@ -16,7 +16,7 @@ export enum WrapTextOption {
 }
 
 export interface ITextWrapping {
-    textWrapStyle: TextWrapStyle;
+    readonly type: TextWrappingType;
-    wrapTextOption?: WrapTextOption;
+    readonly side?: TextWrappingSide;
-    distanceFromText?: IDistance;
+    readonly margins?: IDistance;
 }

src/file/drawing/text-wrap/wrap-square.ts

@@ -1,14 +1,19 @@
 // http://officeopenxml.com/drwPicFloating-textWrap.php
 import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
-import { ITextWrapping, WrapTextOption } from ".";
+import { ITextWrapping, TextWrappingSide } from ".";
 import { IDistance } from "../drawing";
+import { IMargins } from "../floating";
 
 interface IWrapSquareAttributes extends IDistance {
-    wrapText?: WrapTextOption;
+    readonly wrapText?: TextWrappingSide;
+    readonly distT?: number;
+    readonly distB?: number;
+    readonly distL?: number;
+    readonly distR?: number;
 }
 
 class WrapSquareAttributes extends XmlAttributeComponent<IWrapSquareAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         distT: "distT",
         distB: "distB",
         distL: "distL",
@@ -18,13 +23,24 @@ class WrapSquareAttributes extends XmlAttributeComponent<IWrapSquareAttributes>
 }
 
 export class WrapSquare extends XmlComponent {
-    constructor(textWrapping: ITextWrapping) {
+    constructor(
+        textWrapping: ITextWrapping,
+        margins: IMargins = {
+            top: 0,
+            bottom: 0,
+            left: 0,
+            right: 0,
+        },
+    ) {
         super("wp:wrapSquare");
 
         this.root.push(
             new WrapSquareAttributes({
-                wrapText: textWrapping.wrapTextOption || WrapTextOption.BOTH_SIDES,
+                wrapText: textWrapping.side || TextWrappingSide.BOTH_SIDES,
-                ...textWrapping.distanceFromText,
+                distT: margins.top,
+                distB: margins.bottom,
+                distL: margins.left,
+                distR: margins.right,
             }),
         );
     }

src/file/drawing/text-wrap/wrap-tight.ts

@@ -1,32 +1,33 @@
 // http://officeopenxml.com/drwPicFloating-textWrap.php
 import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
-import { IDistance } from "../drawing";
+
+import { IMargins } from "../floating";
 
 interface IWrapTightAttributes {
-    distT?: number;
+    readonly distT?: number;
-    distB?: number;
+    readonly distB?: number;
 }
 
 class WrapTightAttributes extends XmlAttributeComponent<IWrapTightAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         distT: "distT",
         distB: "distB",
     };
 }
 
 export class WrapTight extends XmlComponent {
-    constructor(distanceFromText?: IDistance) {
+    constructor(
+        margins: IMargins = {
+            top: 0,
+            bottom: 0,
+        },
+    ) {
         super("wp:wrapTight");
 
-        distanceFromText = distanceFromText || {
-            distT: 0,
-            distB: 0,
-        };
-
         this.root.push(
             new WrapTightAttributes({
-                distT: distanceFromText.distT,
+                distT: margins.top,
-                distB: distanceFromText.distB,
+                distB: margins.bottom,
             }),
         );
     }

src/file/drawing/text-wrap/wrap-top-and-bottom.ts

@@ -1,32 +1,33 @@
 // http://officeopenxml.com/drwPicFloating-textWrap.php
 import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
-import { IDistance } from "../drawing";
+
+import { IMargins } from "../floating";
 
 interface IWrapTopAndBottomAttributes {
-    distT?: number;
+    readonly distT?: number;
-    distB?: number;
+    readonly distB?: number;
 }
 
 class WrapTopAndBottomAttributes extends XmlAttributeComponent<IWrapTopAndBottomAttributes> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         distT: "distT",
         distB: "distB",
     };
 }
 
 export class WrapTopAndBottom extends XmlComponent {
-    constructor(distanceFromText?: IDistance) {
+    constructor(
+        margins: IMargins = {
+            top: 0,
+            bottom: 0,
+        },
+    ) {
         super("wp:wrapTopAndBottom");
 
-        distanceFromText = distanceFromText || {
-            distT: 0,
-            distB: 0,
-        };
-
         this.root.push(
             new WrapTopAndBottomAttributes({
-                distT: distanceFromText.distT,
+                distT: margins.top,
-                distB: distanceFromText.distB,
+                distB: margins.bottom,
             }),
         );
     }

src/file/file-properties.ts

@@ -0,0 +1,11 @@
+import { IDocumentTemplate } from "../import-dotx";
+
+export interface IFileProperties {
+    readonly template?: IDocumentTemplate;
+}
+
+// Needed because of: https://github.com/s-panferov/awesome-typescript-loader/issues/432
+/**
+ * @ignore
+ */
+export const WORKAROUND = "";

src/file/file.spec.ts

@@ -0,0 +1,58 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { File } from "./file";
+
+describe("File", () => {
+    describe("#constructor", () => {
+        it("should create with correct headers", () => {
+            const doc = new File();
+            const header = doc.createHeader();
+            const footer = doc.createFooter();
+
+            doc.addSection({
+                headers: {
+                    default: header,
+                },
+                footers: {
+                    default: footer,
+                },
+            });
+
+            const tree = new Formatter().format(doc.Document.Body);
+
+            expect(tree["w:body"][1]["w:sectPr"][4]["w:headerReference"][0]._attr["w:type"]).to.equal("default");
+            expect(tree["w:body"][1]["w:sectPr"][5]["w:footerReference"][0]._attr["w:type"]).to.equal("default");
+        });
+
+        it("should create with correct headers", () => {
+            const doc = new File();
+            const header = doc.createHeader();
+            const footer = doc.createFooter();
+
+            doc.addSection({
+                headers: {
+                    default: header,
+                    first: header,
+                    even: header,
+                },
+                footers: {
+                    default: footer,
+                    first: footer,
+                    even: footer,
+                },
+            });
+
+            const tree = new Formatter().format(doc.Document.Body);
+
+            expect(tree["w:body"][1]["w:sectPr"][4]["w:headerReference"][0]._attr["w:type"]).to.equal("default");
+            expect(tree["w:body"][1]["w:sectPr"][5]["w:headerReference"][0]._attr["w:type"]).to.equal("first");
+            expect(tree["w:body"][1]["w:sectPr"][6]["w:headerReference"][0]._attr["w:type"]).to.equal("even");
+
+            expect(tree["w:body"][1]["w:sectPr"][7]["w:footerReference"][0]._attr["w:type"]).to.equal("default");
+            expect(tree["w:body"][1]["w:sectPr"][8]["w:footerReference"][0]._attr["w:type"]).to.equal("first");
+            expect(tree["w:body"][1]["w:sectPr"][9]["w:footerReference"][0]._attr["w:type"]).to.equal("even");
+        });
+    });
+});

src/file/file.ts

@@ -2,10 +2,19 @@ import { AppProperties } from "./app-properties/app-properties";
 import { ContentTypes } from "./content-types/content-types";
 import { CoreProperties, IPropertiesOptions } from "./core-properties";
 import { Document } from "./document";
-import { FooterReferenceType, HeaderReference, HeaderReferenceType, SectionPropertiesOptions } from "./document/body/section-properties";
+import {
-import { FooterWrapper } from "./footer-wrapper";
+    FooterReference,
+    FooterReferenceType,
+    HeaderReference,
+    HeaderReferenceType,
+    IHeaderFooterGroup,
+    SectionPropertiesOptions,
+} from "./document/body/section-properties";
+import { IDrawingOptions } from "./drawing";
+import { IFileProperties } from "./file-properties";
+import { FooterWrapper, IDocumentFooter } from "./footer-wrapper";
 import { FootNotes } from "./footnotes";
-import { HeaderWrapper } from "./header-wrapper";
+import { HeaderWrapper, IDocumentHeader } from "./header-wrapper";
 import { Image, Media } from "./media";
 import { Numbering } from "./numbering";
 import { Bookmark, Hyperlink, Paragraph } from "./paragraph";
@@ -18,33 +27,53 @@ import { Table } from "./table";
 import { TableOfContents } from "./table-of-contents";
 
 export class File {
+    // tslint:disable-next-line:readonly-keyword
+    private currentRelationshipId: number = 1;
+
     private readonly document: Document;
-    private styles: Styles;
+    private readonly headers: IDocumentHeader[] = [];
+    private readonly footers: IDocumentFooter[] = [];
+    private readonly docRelationships: Relationships;
     private readonly coreProperties: CoreProperties;
     private readonly numbering: Numbering;
     private readonly media: Media;
-    private readonly docRelationships: Relationships;
     private readonly fileRelationships: Relationships;
-    private readonly headerWrapper: HeaderWrapper[] = [];
-    private readonly footerWrapper: FooterWrapper[] = [];
     private readonly footNotes: FootNotes;
     private readonly settings: Settings;
-
     private readonly contentTypes: ContentTypes;
     private readonly appProperties: AppProperties;
+    // tslint:disable-next-line:readonly-keyword
+    private styles: Styles;
 
-    private currentRelationshipId: number = 1;
+    constructor(
+        options: IPropertiesOptions = {
+            creator: "Un-named",
+            revision: "1",
+            lastModifiedBy: "Un-named",
+        },
+        sectionPropertiesOptions: SectionPropertiesOptions = {},
+        fileProperties: IFileProperties = {},
+    ) {
+        this.coreProperties = new CoreProperties(options);
+        this.numbering = new Numbering();
+        this.docRelationships = new Relationships();
+        this.media = new Media();
+        this.fileRelationships = new Relationships();
+        this.appProperties = new AppProperties();
+        this.footNotes = new FootNotes();
+        this.contentTypes = new ContentTypes();
 
-    constructor(options?: IPropertiesOptions, sectionPropertiesOptions?: SectionPropertiesOptions) {
+        if (fileProperties.template) {
-        if (!options) {
+            this.currentRelationshipId = fileProperties.template.currentRelationshipId + 1;
-            options = {
-                creator: "Un-named",
-                revision: "1",
-                lastModifiedBy: "Un-named",
-            };
         }
 
-        if (options.externalStyles) {
+        // set up styles
+        if (fileProperties.template && options.externalStyles) {
+            throw Error("can not use both template and external styles");
+        }
+        if (fileProperties.template) {
+            this.styles = fileProperties.template.styles;
+        } else if (options.externalStyles) {
             const stylesFactory = new ExternalStylesFactory();
             this.styles = stylesFactory.newInstance(options.externalStyles);
         } else {
@@ -52,62 +81,31 @@ export class File {
             this.styles = stylesFactory.newInstance();
         }
 
-        this.coreProperties = new CoreProperties(options);
+        this.addDefaultRelationships();
-        this.numbering = new Numbering();
-        this.docRelationships = new Relationships();
-        this.docRelationships.createRelationship(
-            this.currentRelationshipId++,
-            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles",
-            "styles.xml",
-        );
-        this.docRelationships.createRelationship(
-            this.currentRelationshipId++,
-            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering",
-            "numbering.xml",
-        );
-        this.contentTypes = new ContentTypes();
 
-        this.docRelationships.createRelationship(
+        if (fileProperties.template && fileProperties.template.headers) {
-            this.currentRelationshipId++,
+            for (const templateHeader of fileProperties.template.headers) {
-            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footnotes",
+                this.addHeaderToDocument(templateHeader.header, templateHeader.type);
-            "footnotes.xml",
+            }
-        );
-        this.media = new Media();
-
-        const header = this.createHeader();
-        const footer = this.createFooter();
-
-        this.fileRelationships = new Relationships();
-        this.fileRelationships.createRelationship(
-            1,
-            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument",
-            "word/document.xml",
-        );
-        this.fileRelationships.createRelationship(
-            2,
-            "http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties",
-            "docProps/core.xml",
-        );
-        this.fileRelationships.createRelationship(
-            3,
-            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties",
-            "docProps/app.xml",
-        );
-        this.appProperties = new AppProperties();
-
-        this.footNotes = new FootNotes();
-        if (!sectionPropertiesOptions) {
-            sectionPropertiesOptions = {
-                footerType: FooterReferenceType.DEFAULT,
-                headerType: HeaderReferenceType.DEFAULT,
-                headerId: header.Header.ReferenceId,
-                footerId: footer.Footer.ReferenceId,
-            };
         } else {
-            sectionPropertiesOptions.headerId = header.Header.ReferenceId;
+            this.createHeader();
-            sectionPropertiesOptions.footerId = footer.Footer.ReferenceId;
         }
-        this.document = new Document(sectionPropertiesOptions);
+
+        if (fileProperties.template && fileProperties.template.footers) {
+            for (const templateFooter of fileProperties.template.footers) {
+                this.addFooterToDocument(templateFooter.footer, templateFooter.type);
+            }
+        } else {
+            this.createFooter();
+        }
+
+        const newSectionPropertiesOptions = {
+            ...sectionPropertiesOptions,
+            headers: this.groupHeaders(this.headers, sectionPropertiesOptions.headers),
+            footers: this.groupFooters(this.footers, sectionPropertiesOptions.footers),
+        };
+
+        this.document = new Document(newSectionPropertiesOptions);
         this.settings = new Settings();
     }
 
@@ -115,8 +113,9 @@ export class File {
         this.document.addTableOfContents(toc);
     }
 
-    public addParagraph(paragraph: Paragraph): void {
+    public addParagraph(paragraph: Paragraph): File {
         this.document.addParagraph(paragraph);
+        return this;
     }
 
     public createParagraph(text?: string): Paragraph {
@@ -136,16 +135,21 @@ export class File {
         return this;
     }
 
-    public createImage(buffer: Buffer | string | Uint8Array | ArrayBuffer, width?: number, height?: number): Image {
+    public createImage(
-        const image = Media.addImage(this, buffer, width, height);
+        buffer: Buffer | string | Uint8Array | ArrayBuffer,
+        width?: number,
+        height?: number,
+        drawingOptions?: IDrawingOptions,
+    ): Image {
+        const image = Media.addImage(this, buffer, width, height, drawingOptions);
         this.document.addParagraph(image.Paragraph);
 
         return image;
     }
 
     public createHyperlink(link: string, text?: string): Hyperlink {
-        text = text === undefined ? link : text;
+        const newText = text === undefined ? link : text;
-        const hyperlink = new Hyperlink(text, this.docRelationships.RelationshipCount);
+        const hyperlink = new Hyperlink(newText, this.docRelationships.RelationshipCount);
         this.docRelationships.createRelationship(
             hyperlink.linkId,
             "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink",
@@ -156,16 +160,16 @@ export class File {
     }
 
     public createInternalHyperLink(anchor: string, text?: string): Hyperlink {
-        text = text === undefined ? anchor : text;
+        const newText = text === undefined ? anchor : text;
-        const hyperlink = new Hyperlink(text, this.docRelationships.RelationshipCount, anchor);
+        const hyperlink = new Hyperlink(newText, this.docRelationships.RelationshipCount, anchor);
         // NOTE: unlike File#createHyperlink(), since the link is to an internal bookmark
         // we don't need to create a new relationship.
         return hyperlink;
     }
 
     public createBookmark(name: string, text?: string): Bookmark {
-        text = text === undefined ? name : text;
+        const newText = text === undefined ? name : text;
-        const bookmark = new Bookmark(name, text, this.docRelationships.RelationshipCount);
+        const bookmark = new Bookmark(name, newText, this.docRelationships.RelationshipCount);
         return bookmark;
     }
 
@@ -179,25 +183,13 @@ export class File {
 
     public createHeader(): HeaderWrapper {
         const header = new HeaderWrapper(this.media, this.currentRelationshipId++);
-        this.headerWrapper.push(header);
+        this.addHeaderToDocument(header);
-        this.docRelationships.createRelationship(
-            header.Header.ReferenceId,
-            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/header",
-            `header${this.headerWrapper.length}.xml`,
-        );
-        this.contentTypes.addHeader(this.headerWrapper.length);
         return header;
     }
 
     public createFooter(): FooterWrapper {
         const footer = new FooterWrapper(this.media, this.currentRelationshipId++);
-        this.footerWrapper.push(footer);
+        this.addFooterToDocument(footer);
-        this.docRelationships.createRelationship(
-            footer.Footer.ReferenceId,
-            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer",
-            `footer${this.footerWrapper.length}.xml`,
-        );
-        this.contentTypes.addFooter(this.footerWrapper.length);
         return footer;
     }
 
@@ -214,6 +206,191 @@ export class File {
         return headerWrapper;
     }
 
+    public createEvenPageHeader(): HeaderWrapper {
+        const headerWrapper = this.createHeader();
+
+        this.document.Body.DefaultSection.addChildElement(
+            new HeaderReference({
+                headerType: HeaderReferenceType.EVEN,
+                headerId: headerWrapper.Header.ReferenceId,
+            }),
+        );
+
+        return headerWrapper;
+    }
+
+    public createFirstPageFooter(): FooterWrapper {
+        const footerWrapper = this.createFooter();
+
+        this.document.Body.DefaultSection.addChildElement(
+            new FooterReference({
+                footerType: FooterReferenceType.FIRST,
+                footerId: footerWrapper.Footer.ReferenceId,
+            }),
+        );
+
+        return footerWrapper;
+    }
+
+    public createEvenPageFooter(): FooterWrapper {
+        const footerWrapper = this.createFooter();
+
+        this.document.Body.DefaultSection.addChildElement(
+            new FooterReference({
+                footerType: FooterReferenceType.EVEN,
+                footerId: footerWrapper.Footer.ReferenceId,
+            }),
+        );
+
+        return footerWrapper;
+    }
+
+    public getFooterByReferenceNumber(refId: number): FooterWrapper {
+        const entry = this.footers.map((item) => item.footer).find((h) => h.Footer.ReferenceId === refId);
+        if (entry) {
+            return entry;
+        }
+        throw new Error(`There is no footer with given reference id ${refId}`);
+    }
+
+    public getHeaderByReferenceNumber(refId: number): HeaderWrapper {
+        const entry = this.headers.map((item) => item.header).find((h) => h.Header.ReferenceId === refId);
+        if (entry) {
+            return entry;
+        }
+        throw new Error(`There is no header with given reference id ${refId}`);
+    }
+
+    public verifyUpdateFields(): void {
+        if (this.document.getTablesOfContents().length) {
+            this.settings.addUpdateFields();
+        }
+    }
+
+    private addHeaderToDocument(header: HeaderWrapper, type: HeaderReferenceType = HeaderReferenceType.DEFAULT): void {
+        this.headers.push({ header, type });
+        this.docRelationships.createRelationship(
+            header.Header.ReferenceId,
+            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/header",
+            `header${this.headers.length}.xml`,
+        );
+        this.contentTypes.addHeader(this.headers.length);
+    }
+
+    private addFooterToDocument(footer: FooterWrapper, type: FooterReferenceType = FooterReferenceType.DEFAULT): void {
+        this.footers.push({ footer, type });
+        this.docRelationships.createRelationship(
+            footer.Footer.ReferenceId,
+            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer",
+            `footer${this.footers.length}.xml`,
+        );
+        this.contentTypes.addFooter(this.footers.length);
+    }
+
+    private addDefaultRelationships(): void {
+        this.fileRelationships.createRelationship(
+            1,
+            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument",
+            "word/document.xml",
+        );
+        this.fileRelationships.createRelationship(
+            2,
+            "http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties",
+            "docProps/core.xml",
+        );
+        this.fileRelationships.createRelationship(
+            3,
+            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties",
+            "docProps/app.xml",
+        );
+
+        this.docRelationships.createRelationship(
+            this.currentRelationshipId++,
+            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles",
+            "styles.xml",
+        );
+        this.docRelationships.createRelationship(
+            this.currentRelationshipId++,
+            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering",
+            "numbering.xml",
+        );
+        this.docRelationships.createRelationship(
+            this.currentRelationshipId++,
+            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footnotes",
+            "footnotes.xml",
+        );
+    }
+
+    private groupHeaders(headers: IDocumentHeader[], group: IHeaderFooterGroup<HeaderWrapper> = {}): IHeaderFooterGroup<HeaderWrapper> {
+        let newGroup = group;
+
+        for (const header of headers) {
+            switch (header.type) {
+                case HeaderReferenceType.DEFAULT:
+                    newGroup = {
+                        ...newGroup,
+                        default: header.header,
+                    };
+                    break;
+                case HeaderReferenceType.FIRST:
+                    newGroup = {
+                        ...newGroup,
+                        first: header.header,
+                    };
+                    break;
+                case HeaderReferenceType.EVEN:
+                    newGroup = {
+                        ...newGroup,
+                        even: header.header,
+                    };
+                    break;
+                default:
+                    newGroup = {
+                        ...newGroup,
+                        default: header.header,
+                    };
+                    break;
+            }
+        }
+
+        return newGroup;
+    }
+
+    private groupFooters(footers: IDocumentFooter[], group: IHeaderFooterGroup<FooterWrapper> = {}): IHeaderFooterGroup<FooterWrapper> {
+        let newGroup = group;
+
+        for (const footer of footers) {
+            switch (footer.type) {
+                case FooterReferenceType.DEFAULT:
+                    newGroup = {
+                        ...newGroup,
+                        default: footer.footer,
+                    };
+                    break;
+                case FooterReferenceType.FIRST:
+                    newGroup = {
+                        ...newGroup,
+                        first: footer.footer,
+                    };
+                    break;
+                case FooterReferenceType.EVEN:
+                    newGroup = {
+                        ...newGroup,
+                        even: footer.footer,
+                    };
+                    break;
+                default:
+                    newGroup = {
+                        ...newGroup,
+                        default: footer.footer,
+                    };
+                    break;
+            }
+        }
+
+        return newGroup;
+    }
+
     public get Document(): Document {
         return this.document;
     }
@@ -247,35 +424,19 @@ export class File {
     }
 
     public get Header(): HeaderWrapper {
-        return this.headerWrapper[0];
+        return this.headers[0].header;
     }
 
     public get Headers(): HeaderWrapper[] {
-        return this.headerWrapper;
+        return this.headers.map((item) => item.header);
-    }
-
-    public HeaderByRefNumber(refId: number): HeaderWrapper {
-        const entry = this.headerWrapper.find((h) => h.Header.ReferenceId === refId);
-        if (entry) {
-            return entry;
-        }
-        throw new Error(`There is no header with given reference id ${refId}`);
     }
 
     public get Footer(): FooterWrapper {
-        return this.footerWrapper[0];
+        return this.footers[0].footer;
     }
 
     public get Footers(): FooterWrapper[] {
-        return this.footerWrapper;
+        return this.footers.map((item) => item.footer);
-    }
-
-    public FooterByRefNumber(refId: number): FooterWrapper {
-        const entry = this.footerWrapper.find((h) => h.Footer.ReferenceId === refId);
-        if (entry) {
-            return entry;
-        }
-        throw new Error(`There is no footer with given reference id ${refId}`);
     }
 
     public get ContentTypes(): ContentTypes {
@@ -293,10 +454,4 @@ export class File {
     public get Settings(): Settings {
         return this.settings;
     }
-
-    public verifyUpdateFields(): void {
-        if (this.document.getTablesOfContents().length) {
-            this.settings.addUpdateFields();
-        }
-    }
 }

src/file/footer-wrapper.ts

@@ -1,16 +1,23 @@
 import { XmlComponent } from "file/xml-components";
+
+import { FooterReferenceType } from "./document";
 import { Footer } from "./footer/footer";
-import { Image, Media } from "./media";
+import { Image, IMediaData, Media } from "./media";
 import { ImageParagraph, Paragraph } from "./paragraph";
 import { Relationships } from "./relationships";
 import { Table } from "./table";
 
+export interface IDocumentFooter {
+    readonly footer: FooterWrapper;
+    readonly type: FooterReferenceType;
+}
+
 export class FooterWrapper {
     private readonly footer: Footer;
     private readonly relationships: Relationships;
 
-    constructor(private readonly media: Media, referenceId: number) {
+    constructor(private readonly media: Media, referenceId: number, initContent?: XmlComponent) {
-        this.footer = new Footer(referenceId);
+        this.footer = new Footer(referenceId, initContent);
         this.relationships = new Relationships();
     }
 
@@ -32,17 +39,33 @@ export class FooterWrapper {
         return this.footer.createTable(rows, cols);
     }
 
-    public addChildElement(childElement: XmlComponent | string): void {
+    public addChildElement(childElement: XmlComponent): void {
         this.footer.addChildElement(childElement);
     }
 
-    public createImage(image: Buffer, width?: number, height?: number): void {
+    public addImageRelationship(image: Buffer, refId: number, width?: number, height?: number): IMediaData {
-        const mediaData = this.media.addMedia(image, this.relationships.RelationshipCount, width, height);
+        const mediaData = this.media.addMedia(image, refId, width, height);
         this.relationships.createRelationship(
             mediaData.referenceId,
             "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image",
             `media/${mediaData.fileName}`,
         );
+        return mediaData;
+    }
+
+    public addHyperlinkRelationship(target: string, refId: number, targetMode?: "External" | undefined): void {
+        this.relationships.createRelationship(
+            refId,
+            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/hyperlink",
+            target,
+            targetMode,
+        );
+    }
+
+    public createImage(image: Buffer | string | Uint8Array | ArrayBuffer, width?: number, height?: number): void {
+        // TODO
+        // tslint:disable-next-line:no-any
+        const mediaData = this.addImageRelationship(image as any, this.relationships.RelationshipCount, width, height);
         this.addImage(new Image(new ImageParagraph(mediaData)));
     }
 
@@ -58,4 +81,8 @@ export class FooterWrapper {
     public get Relationships(): Relationships {
         return this.relationships;
     }
+
+    public get Media(): Media {
+        return this.media;
+    }
 }

src/file/footer/footer-attributes.ts

@@ -1,32 +1,32 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IFooterAttributesProperties {
-    wpc?: string;
+    readonly wpc?: string;
-    mc?: string;
+    readonly mc?: string;
-    o?: string;
+    readonly o?: string;
-    r?: string;
+    readonly r?: string;
-    m?: string;
+    readonly m?: string;
-    v?: string;
+    readonly v?: string;
-    wp14?: string;
+    readonly wp14?: string;
-    wp?: string;
+    readonly wp?: string;
-    w10?: string;
+    readonly w10?: string;
-    w?: string;
+    readonly w?: string;
-    w14?: string;
+    readonly w14?: string;
-    w15?: string;
+    readonly w15?: string;
-    wpg?: string;
+    readonly wpg?: string;
-    wpi?: string;
+    readonly wpi?: string;
-    wne?: string;
+    readonly wne?: string;
-    wps?: string;
+    readonly wps?: string;
-    cp?: string;
+    readonly cp?: string;
-    dc?: string;
+    readonly dc?: string;
-    dcterms?: string;
+    readonly dcterms?: string;
-    dcmitype?: string;
+    readonly dcmitype?: string;
-    xsi?: string;
+    readonly xsi?: string;
-    type?: string;
+    readonly type?: string;
 }
 
 export class FooterAttributes extends XmlAttributeComponent<IFooterAttributesProperties> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         wpc: "xmlns:wpc",
         mc: "xmlns:mc",
         o: "xmlns:o",

src/file/footer/footer.ts

@@ -1,14 +1,14 @@
 // http://officeopenxml.com/WPfooters.php
-import { XmlComponent } from "file/xml-components";
+import { InitializableXmlComponent, XmlComponent } from "file/xml-components";
 import { Paragraph } from "../paragraph";
 import { Table } from "../table";
 import { FooterAttributes } from "./footer-attributes";
 
-export class Footer extends XmlComponent {
+export class Footer extends InitializableXmlComponent {
     private readonly refId: number;
 
-    constructor(referenceNumber: number) {
+    constructor(referenceNumber: number, initContent?: XmlComponent) {
-        super("w:ftr");
+        super("w:ftr", initContent);
         this.refId = referenceNumber;
         this.root.push(
             new FooterAttributes({

src/file/footnotes/footnote/footnote-attributes.ts

@@ -1,12 +1,12 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IFootnoteAttributesProperties {
-    type?: string;
+    readonly type?: string;
-    id: number;
+    readonly id: number;
 }
 
 export class FootnoteAttributes extends XmlAttributeComponent<IFootnoteAttributesProperties> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         type: "w:type",
         id: "w:id",
     };

src/file/footnotes/footnote/footnote.spec.ts

@@ -1,5 +1,7 @@
 import { expect } from "chai";
-import { Formatter } from "../../../export/formatter";
+
+import { Formatter } from "export/formatter";
+
 import { Footnote, FootnoteType } from "./footnote";
 
 describe("Footnote", () => {

src/file/footnotes/footnote/footnote.ts

@@ -1,5 +1,6 @@
+import { Paragraph } from "file/paragraph";
 import { XmlComponent } from "file/xml-components";
-import { Paragraph } from "../../paragraph";
+
 import { FootnoteAttributes } from "./footnote-attributes";
 import { FootnoteRefRun } from "./run/footnote-ref-run";
 

src/file/footnotes/footnote/run/reference-run.ts

@@ -3,11 +3,11 @@ import { Style } from "file/paragraph/run/style";
 import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
 
 export interface IFootNoteReferenceRunAttributesProperties {
-    id: number;
+    readonly id: number;
 }
 
 export class FootNoteReferenceRunAttributes extends XmlAttributeComponent<IFootNoteReferenceRunAttributesProperties> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         id: "w:id",
     };
 }

src/file/footnotes/footnotes-attributes.ts

@@ -1,27 +1,27 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
 export interface IFootnotesAttributesProperties {
-    wpc?: string;
+    readonly wpc?: string;
-    mc?: string;
+    readonly mc?: string;
-    o?: string;
+    readonly o?: string;
-    r?: string;
+    readonly r?: string;
-    m?: string;
+    readonly m?: string;
-    v?: string;
+    readonly v?: string;
-    wp14?: string;
+    readonly wp14?: string;
-    wp?: string;
+    readonly wp?: string;
-    w10?: string;
+    readonly w10?: string;
-    w?: string;
+    readonly w?: string;
-    w14?: string;
+    readonly w14?: string;
-    w15?: string;
+    readonly w15?: string;
-    wpg?: string;
+    readonly wpg?: string;
-    wpi?: string;
+    readonly wpi?: string;
-    wne?: string;
+    readonly wne?: string;
-    wps?: string;
+    readonly wps?: string;
-    Ignorable?: string;
+    readonly Ignorable?: string;
 }
 
 export class FootnotesAttributes extends XmlAttributeComponent<IFootnotesAttributesProperties> {
-    protected xmlKeys = {
+    protected readonly xmlKeys = {
         wpc: "xmlns:wpc",
         mc: "xmlns:mc",
         o: "xmlns:o",

src/file/footnotes/footnotes.ts

@@ -6,12 +6,13 @@ import { SeperatorRun } from "./footnote/run/seperator-run";
 import { FootnotesAttributes } from "./footnotes-attributes";
 
 export class FootNotes extends XmlComponent {
-    private counter: number;
+    // tslint:disable-next-line:readonly-keyword
+    private currentId: number;
 
     constructor() {
         super("w:footnotes");
 
-        this.counter = 1;
+        this.currentId = 1;
 
         this.root.push(
             new FootnotesAttributes({
@@ -61,10 +62,10 @@ export class FootNotes extends XmlComponent {
     }
 
     public createFootNote(paragraph: Paragraph): void {
-        const footnote = new Footnote(this.counter);
+        const footnote = new Footnote(this.currentId);
         footnote.addParagraph(paragraph);
         this.root.push(footnote);
 
-        this.counter++;
+        this.currentId++;
     }
 }