Update lock file

Add suppressLineNumber option to Paragraph

.github/dependabot.yml

@@ -0,0 +1,40 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: "@types/node"
+    versions:
+    - 14.14.22
+    - 14.14.24
+    - 14.14.25
+    - 14.14.26
+    - 14.14.28
+    - 14.14.29
+    - 14.14.30
+    - 15.0.0
+  - dependency-name: webpack
+    versions:
+    - 5.31.2
+    - 5.35.0
+  - dependency-name: ts-loader
+    versions:
+    - 9.1.0
+  - dependency-name: awesome-typescript-loader
+    versions:
+    - 5.2.1
+  - dependency-name: chai
+    versions:
+    - 4.2.0
+    - 4.3.0
+    - 4.3.1
+    - 4.3.3
+  - dependency-name: replace-in-file
+    versions:
+    - 6.1.0
+  - dependency-name: "@types/chai"
+    versions:
+    - 4.2.14

.github/workflows/default.yml

@@ -33,6 +33,11 @@ jobs:
               run: npm ci
             - name: Test
               run: npm run test.coverage
+            - name: Codecov
+              uses: codecov/codecov-action@v1
+              with:
+                  fail_ci_if_error: true
+                  verbose: true
     lint:
         name: Lint
         runs-on: ubuntu-latest

.github/workflows/remove-old-artifacts.yml

@@ -0,0 +1,26 @@
+name: Remove old artifacts
+
+on:
+  schedule:
+    # Every day at 1am
+    - cron: "0 1 * * *"
+  workflow_dispatch:
+    inputs:
+      logLevel:
+        description: "Log level"
+        required: true
+        default: "warning"
+
+jobs:
+  remove-old-artifacts:
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+
+    steps:
+      - name: Remove old artifacts
+        uses: c-hive/gha-remove-artifacts@v1
+        with:
+          age: "1 week"
+          # Optional inputs
+          # skip-tags: true
+          # skip-recent: 5

.nycrc

@@ -1,9 +1,9 @@
 {
   "check-coverage": true,
-  "lines": 98.86,
-  "functions": 97.86,
-  "branches": 95.86,
-  "statements": 98.86,
+  "lines": 99.31,
+  "functions": 99.09,
+  "branches": 96.17,
+  "statements": 99.31,
   "include": [
     "src/**/*.ts"
   ],
@@ -21,6 +21,5 @@
   ],
   "cache": true,
   "all": true,
-  "instrument": false,
   "sourceMap": true
 }

README.md

@@ -10,7 +10,6 @@
 
 [![NPM version][npm-image]][npm-url]
 [![Downloads per month][downloads-image]][downloads-url]
-[![Build Status][travis-image]][travis-url]
 [![GitHub Action Workflow Status][github-actions-workflow-image]][github-actions-workflow-url]
 [![Dependency Status][daviddm-image]][daviddm-url]
 [![Known Vulnerabilities][snky-image]][snky-url]
@@ -103,8 +102,6 @@ Made with 💖
 [npm-url]: https://npmjs.org/package/docx
 [downloads-image]: https://img.shields.io/npm/dm/docx.svg
 [downloads-url]: https://npmjs.org/package/docx
-[travis-image]: https://travis-ci.org/dolanmiu/docx.svg?branch=master
-[travis-url]: https://travis-ci.org/dolanmiu/docx
 [github-actions-workflow-image]: https://github.com/dolanmiu/docx/workflows/Default/badge.svg
 [github-actions-workflow-url]: https://github.com/dolanmiu/docx/actions
 [daviddm-image]: https://david-dm.org/dolanmiu/docx.svg?theme=shields.io

demo/11-declaritive-styles-2.ts

@@ -15,6 +15,7 @@ import {
     TableRow,
     TabStopPosition,
     UnderlineType,
+    LevelFormat,
 } from "../build";
 
 const table = new Table({
@@ -51,6 +52,19 @@ const table = new Table({
 });
 
 const doc = new Document({
+    numbering:{
+        config:[{
+            reference: 'ref1',
+            levels: [
+            {
+                level: 0,
+                format: LevelFormat.DECIMAL,
+                text: '%1)',
+                start: 50,
+            }
+            ],
+        }]
+    },
     styles: {
         default: {
             heading1: {
@@ -155,6 +169,28 @@ const doc = new Document({
                     spacing: { line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 },
                 },
             },
+            {
+                id: "numberedPara",
+                name: "Numbered Para",
+                basedOn: "Normal",
+                next: "Normal",
+                quickFormat: true,
+                run: {
+                    font: "Calibri",
+                    size: 26,
+                    bold: true,
+                },
+                paragraph: {
+                    spacing: { line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 },
+                    rightTabStop: TabStopPosition.MAX,
+                    leftTabStop: 453.543307087,
+                    numbering : {
+                        reference: 'ref1',
+                        instance: 0,
+                        level: 0,
+                    }
+                },
+            },
         ],
     },
     sections: [
@@ -260,6 +296,14 @@ const doc = new Document({
                     text: "Test 2",
                     style: "normalPara2",
                 }),
+                new Paragraph({
+                    text: "Numbered paragraph that has numbering attached to custom styles",
+                    style: "numberedPara",
+                }),
+                new Paragraph({
+                    text: "Numbered para would show up in the styles pane at Word",
+                    style: "numberedPara",
+                }),
             ],
         },
     ],

demo/16-multiple-sections.ts

@@ -1,7 +1,7 @@
 // Multiple sections and headers
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Document, Footer, Header, Packer, PageNumber, PageNumberFormat, PageOrientation, Paragraph, TextRun } from "../build";
+import { Document, Footer, Header, Packer, PageNumber, NumberFormat, PageOrientation, Paragraph, TextRun } from "../build";
 
 const doc = new Document({
     sections: [
@@ -13,7 +13,7 @@ const doc = new Document({
                 page: {
                     pageNumbers: {
                         start: 1,
-                        formatType: PageNumberFormat.DECIMAL,
+                        formatType: NumberFormat.DECIMAL,
                     },
                 },
             },
@@ -38,7 +38,7 @@ const doc = new Document({
                     },
                     pageNumbers: {
                         start: 1,
-                        formatType: PageNumberFormat.DECIMAL,
+                        formatType: NumberFormat.DECIMAL,
                     },
                 },
             },
@@ -85,7 +85,7 @@ const doc = new Document({
                         orientation: PageOrientation.PORTRAIT,
                     },
                     pageNumbers: {
-                        formatType: PageNumberFormat.UPPER_ROMAN,
+                        formatType: NumberFormat.UPPER_ROMAN,
                     },
                 },
             },
@@ -116,7 +116,7 @@ const doc = new Document({
                     },
                     pageNumbers: {
                         start: 25,
-                        formatType: PageNumberFormat.DECIMAL,
+                        formatType: NumberFormat.DECIMAL,
                     },
                 },
             },

demo/2-declaritive-styles.ts

@@ -24,7 +24,7 @@ const doc = new Document({
                     size: 28,
                     bold: true,
                     italics: true,
-                    color: "red",
+                    color: "FF0000",
                 },
                 paragraph: {
                     spacing: {

demo/20-table-cell-borders.ts

@@ -36,17 +36,17 @@ const doc = new Document({
                                         top: {
                                             style: BorderStyle.DASH_DOT_STROKED,
                                             size: 3,
-                                            color: "red",
+                                            color: "FF0000",
                                         },
                                         bottom: {
                                             style: BorderStyle.DOUBLE,
                                             size: 3,
-                                            color: "blue",
+                                            color: "0000FF",
                                         },
                                         left: {
                                             style: BorderStyle.DASH_DOT_STROKED,
                                             size: 3,
-                                            color: "green",
+                                            color: "00FF00",
                                         },
                                         right: {
                                             style: BorderStyle.DASH_DOT_STROKED,

demo/21-bookmarks.ts

@@ -1,7 +1,7 @@
 // This demo shows how to create bookmarks then link to them with internal hyperlinks
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Bookmark, Document, Footer, HeadingLevel, InternalHyperlink, Packer, PageBreak, Paragraph, TextRun } from "../build";
+import { Bookmark, Document, Footer, HeadingLevel, InternalHyperlink, Packer, PageBreak, Paragraph, TextRun, PageReference } from "../build";
 
 const LOREM_IPSUM =
     "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam mi velit, convallis convallis scelerisque nec, faucibus nec leo. Phasellus at posuere mauris, tempus dignissim velit. Integer et tortor dolor. Duis auctor efficitur mattis. Vivamus ut metus accumsan tellus auctor sollicitudin venenatis et nibh. Cras quis massa ac metus fringilla venenatis. Proin rutrum mauris purus, ut suscipit magna consectetur id. Integer consectetur sollicitudin ante, vitae faucibus neque efficitur in. Praesent ultricies nibh lectus. Mauris pharetra id odio eget iaculis. Duis dictum, risus id pellentesque rutrum, lorem quam malesuada massa, quis ullamcorper turpis urna a diam. Cras vulputate metus vel massa porta ullamcorper. Etiam porta condimentum nulla nec tristique. Sed nulla urna, pharetra non tortor sed, sollicitudin molestie diam. Maecenas enim leo, feugiat eget vehicula id, sollicitudin vitae ante.";
@@ -18,10 +18,12 @@ const doc = new Document({
                         new Paragraph({
                             children: [
                                 new InternalHyperlink({
-                                    child: new TextRun({
+                                    children: [
+                                        new TextRun({
                                             text: "Click here!",
                                             style: "Hyperlink",
                                         }),
+                                    ],
                                     anchor: "myAnchorId",
                                 }),
                             ],
@@ -47,14 +49,24 @@ const doc = new Document({
                 new Paragraph({
                     children: [
                         new InternalHyperlink({
-                            child: new TextRun({
-                                text: "Anchor Text",
+                            children: [
+                                new TextRun({
+                                    text: "Styled",
+                                    bold: true,
                                     style: "Hyperlink",
                                 }),
+                                new TextRun({
+                                    text: " Anchor Text",
+                                    style: "Hyperlink",
+                                }),
+                            ],
                             anchor: "myAnchorId",
                         }),
                     ],
                 }),
+                new Paragraph({
+                    children: [new TextRun("The bookmark can be seen on page "), new PageReference("myAnchorId")],
+                }),
             ],
         },
     ],

demo/26-paragraph-borders.ts

@@ -1,7 +1,7 @@
 // Creates two paragraphs, one with a border and one without
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Document, Packer, Paragraph } from "../build";
+import { BorderStyle, Document, Packer, Paragraph } from "../build";
 
 const doc = new Document({
     sections: [
@@ -14,13 +14,13 @@ const doc = new Document({
                         top: {
                             color: "auto",
                             space: 1,
-                            value: "single",
+                            style: BorderStyle.SINGLE,
                             size: 6,
                         },
                         bottom: {
                             color: "auto",
                             space: 1,
-                            value: "single",
+                            style: BorderStyle.SINGLE,
                             size: 6,
                         },
                     },

demo/28-table-of-contents.ts

@@ -9,6 +9,9 @@ import { File, HeadingLevel, Packer, Paragraph, StyleLevel, TableOfContents } fr
 // Let's define the properties for generate a TOC for heading 1-5 and MySpectacularStyle,
 // making the entries be hyperlinks for the paragraph
 const doc = new File({
+    features: {
+        updateFields: true,
+    },
     styles: {
         paragraphStyles: [
             {

demo/32-merge-and-shade-table-cells.ts

@@ -98,7 +98,7 @@ const table3 = new Table({
                     children: [new Paragraph("Bar1")],
                     shading: {
                         fill: "b79c2f",
-                        val: ShadingType.REVERSE_DIAGONAL_STRIPE,
+                        type: ShadingType.REVERSE_DIAGONAL_STRIPE,
                         color: "auto",
                     },
                 }),
@@ -106,7 +106,7 @@ const table3 = new Table({
                     children: [new Paragraph("Bar2")],
                     shading: {
                         fill: "42c5f4",
-                        val: ShadingType.PERCENT_95,
+                        type: ShadingType.PERCENT_95,
                         color: "auto",
                     },
                 }),
@@ -114,7 +114,7 @@ const table3 = new Table({
                     children: [new Paragraph("Bar3")],
                     shading: {
                         fill: "880aa8",
-                        val: ShadingType.PERCENT_10,
+                        type: ShadingType.PERCENT_10,
                         color: "e2df0b",
                     },
                 }),
@@ -122,7 +122,7 @@ const table3 = new Table({
                     children: [new Paragraph("Bar4")],
                     shading: {
                         fill: "FF0000",
-                        val: ShadingType.CLEAR,
+                        type: ShadingType.CLEAR,
                         color: "auto",
                     },
                 }),
@@ -224,22 +224,22 @@ const borders = {
     top: {
         style: BorderStyle.DASH_SMALL_GAP,
         size: 1,
-        color: "red",
+        color: "FF0000",
     },
     bottom: {
         style: BorderStyle.DASH_SMALL_GAP,
         size: 1,
-        color: "red",
+        color: "FF0000",
     },
     left: {
         style: BorderStyle.DASH_SMALL_GAP,
         size: 1,
-        color: "red",
+        color: "FF0000",
     },
     right: {
         style: BorderStyle.DASH_SMALL_GAP,
         size: 1,
-        color: "red",
+        color: "FF0000",
     },
 };
 

demo/35-hyperlinks.ts

@@ -11,10 +11,12 @@ const doc = new Document({
                     children: [
                         new TextRun("Click here for the "),
                         new ExternalHyperlink({
-                            child: new TextRun({
+                            children: [
+                                new TextRun({
                                     text: "Footnotes external hyperlink",
                                     style: "Hyperlink",
                                 }),
+                            ],
                             link: "http://www.example.com",
                         }),
                     ],
@@ -31,10 +33,12 @@ const doc = new Document({
                             children: [
                                 new TextRun("Click here for the "),
                                 new ExternalHyperlink({
-                                    child: new TextRun({
+                                    children: [
+                                        new TextRun({
                                             text: "Footer external hyperlink",
                                             style: "Hyperlink",
                                         }),
+                                    ],
                                     link: "http://www.example.com",
                                 }),
                             ],
@@ -49,10 +53,12 @@ const doc = new Document({
                             children: [
                                 new TextRun("Click here for the "),
                                 new ExternalHyperlink({
-                                    child: new TextRun({
+                                    children: [
+                                        new TextRun({
                                             text: "Header external hyperlink",
                                             style: "Hyperlink",
                                         }),
+                                    ],
                                     link: "http://www.google.com",
                                 }),
                             ],
@@ -64,10 +70,12 @@ const doc = new Document({
                 new Paragraph({
                     children: [
                         new ExternalHyperlink({
-                            child: new TextRun({
+                            children: [
+                                new TextRun({
                                     text: "Anchor Text",
                                     style: "Hyperlink",
                                 }),
+                            ],
                             link: "http://www.example.com",
                         }),
                         new FootnoteReferenceRun(1),
@@ -76,24 +84,63 @@ const doc = new Document({
                 new Paragraph({
                     children: [
                         new ExternalHyperlink({
-                            child: new ImageRun({
+                            children: [
+                                new ImageRun({
                                     data: fs.readFileSync("./demo/images/image1.jpeg"),
                                     transformation: {
                                         width: 100,
                                         height: 100,
                                     },
                                 }),
+                            ],
                             link: "http://www.google.com",
                         }),
                         new ExternalHyperlink({
-                            child: new TextRun({
+                            children: [
+                                new TextRun({
                                     text: "BBC News Link",
                                     style: "Hyperlink",
                                 }),
+                            ],
                             link: "https://www.bbc.co.uk/news",
                         }),
                     ],
                 }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "This is a hyperlink with formatting: ",
+                        }),
+                        new ExternalHyperlink({
+                            children: [
+                                new TextRun({
+                                    text: "A ",
+                                    style: "Hyperlink",
+                                }),
+                                new TextRun({
+                                    text: "single ",
+                                    bold: true,
+                                    style: "Hyperlink",
+                                }),
+                                new TextRun({
+                                    text: "link",
+                                    doubleStrike: true,
+                                    style: "Hyperlink",
+                                }),
+                                new TextRun({
+                                    text: "1",
+                                    superScript: true,
+                                    style: "Hyperlink",
+                                }),
+                                new TextRun({
+                                    text: "!",
+                                    style: "Hyperlink",
+                                }),
+                            ],
+                            link: "http://www.example.com",
+                        }),
+                    ],
+                }),
             ],
         },
     ],

demo/39-page-numbers.ts

@@ -1,7 +1,7 @@
 // Example how to display page numbers
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { AlignmentType, Document, Footer, Header, Packer, PageBreak, PageNumber, PageNumberFormat, Paragraph, TextRun } from "../build";
+import { AlignmentType, Document, Footer, Header, Packer, PageBreak, PageNumber, NumberFormat, Paragraph, TextRun } from "../build";
 
 const doc = new Document({
     sections: [
@@ -10,7 +10,7 @@ const doc = new Document({
                 page: {
                     pageNumbers: {
                         start: 1,
-                        formatType: PageNumberFormat.DECIMAL,
+                        formatType: NumberFormat.DECIMAL,
                     },
                 },
             },

demo/45-highlighting-text.ts

@@ -14,7 +14,7 @@ const doc = new Document({
                             children: [
                                 new TextRun({
                                     text: "Hello World",
-                                    color: "red",
+                                    color: "FF0000",
                                     bold: true,
                                     size: 24,
                                     font: {

demo/46-shading-text.ts

@@ -14,7 +14,7 @@ const doc = new Document({
                             children: [
                                 new TextRun({
                                     text: "Hello World",
-                                    color: "red",
+                                    color: "FF0000",
                                     bold: true,
                                     size: 24,
                                     font: {

demo/47-number-of-total-pages-section.ts

@@ -1,7 +1,7 @@
 // Multiple sections with total number of pages in each section
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { AlignmentType, Document, Footer, Header, Packer, PageBreak, PageNumber, PageNumberFormat, Paragraph, TextRun } from "../build";
+import { AlignmentType, Document, Footer, Header, Packer, PageBreak, PageNumber, NumberFormat, Paragraph, TextRun } from "../build";
 
 const header = new Header({
     children: [
@@ -31,7 +31,7 @@ const doc = new Document({
                 page: {
                     pageNumbers: {
                         start: 1,
-                        formatType: PageNumberFormat.DECIMAL,
+                        formatType: NumberFormat.DECIMAL,
                     },
                 },
             },
@@ -52,7 +52,7 @@ const doc = new Document({
                 page: {
                     pageNumbers: {
                         start: 1,
-                        formatType: PageNumberFormat.DECIMAL,
+                        formatType: NumberFormat.DECIMAL,
                     },
                 },
             },

demo/48-vertical-align.ts

@@ -1,13 +1,13 @@
 // Example of making content of section vertically aligned
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Document, Packer, Paragraph, SectionVerticalAlignValue, TextRun } from "../build";
+import { Document, Packer, Paragraph, VerticalAlign, TextRun } from "../build";
 
 const doc = new Document({
     sections: [
         {
             properties: {
-                verticalAlign: SectionVerticalAlignValue.CENTER,
+                verticalAlign: VerticalAlign.CENTER,
             },
             children: [
                 new Paragraph({

demo/49-table-borders.ts

@@ -24,22 +24,22 @@ const table = new Table({
                         top: {
                             style: BorderStyle.DASH_SMALL_GAP,
                             size: 1,
-                            color: "red",
+                            color: "ff0000",
                         },
                         bottom: {
                             style: BorderStyle.DASH_SMALL_GAP,
                             size: 1,
-                            color: "red",
+                            color: "ff0000",
                         },
                         left: {
                             style: BorderStyle.DASH_SMALL_GAP,
                             size: 1,
-                            color: "red",
+                            color: "ff0000",
                         },
                         right: {
                             style: BorderStyle.DASH_SMALL_GAP,
                             size: 1,
-                            color: "red",
+                            color: "ff0000",
                         },
                     },
                     children: [new Paragraph("Hello")],

demo/60-track-revisions.ts

@@ -20,10 +20,12 @@ import {
     - https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.wordprocessing.insertedrun
     - https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.wordprocessing.deletedrun
 
-    The method `addTrackRevisions()` adds an element `<w:trackRevisions />` to the `settings.xml` file. This specifies that the application shall track *new* revisions made to the existing document.
+    The setting `features: { trackRevisions: true }` adds an element `<w:trackRevisions />` to the `settings.xml` file.
+    This specifies that the application shall track *new* revisions made to the existing document.
     See also https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.wordprocessing.trackrevisions
 
-    Note that this setting enables to track *new changes* after teh file is generated, so this example will still show inserted and deleted text runs when you remove it.
+    Note that this setting enables to track *new changes* after teh file is generated, so this example will still
+    show inserted and deleted text runs when you remove it.
 */
 
 const paragraph = new Paragraph({
@@ -85,7 +87,7 @@ const doc = new Document({
                         new DeletedTextRun({
                             break: 1,
                             text: "in order",
-                            color: "red",
+                            color: "ff0000",
                             bold: true,
                             size: 24,
                             font: {

demo/61-text-frame.ts

@@ -1,7 +1,16 @@
 // Text Frame (Text Box) example
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Document, FrameAnchorType, HorizontalPositionAlign, Packer, Paragraph, TextRun, VerticalPositionAlign } from "../build";
+import {
+    BorderStyle,
+    Document,
+    FrameAnchorType,
+    HorizontalPositionAlign,
+    Packer,
+    Paragraph,
+    TextRun,
+    VerticalPositionAlign,
+} from "../build";
 
 const doc = new Document({
     sections: [
@@ -29,25 +38,25 @@ const doc = new Document({
                         top: {
                             color: "auto",
                             space: 1,
-                            value: "single",
+                            style: BorderStyle.SINGLE,
                             size: 6,
                         },
                         bottom: {
                             color: "auto",
                             space: 1,
-                            value: "single",
+                            style: BorderStyle.SINGLE,
                             size: 6,
                         },
                         left: {
                             color: "auto",
                             space: 1,
-                            value: "single",
+                            style: BorderStyle.SINGLE,
                             size: 6,
                         },
                         right: {
                             color: "auto",
                             space: 1,
-                            value: "single",
+                            style: BorderStyle.SINGLE,
                             size: 6,
                         },
                     },

demo/64-complex-numbering-text.ts

@@ -0,0 +1,111 @@
+// Numbered lists - With complex number text
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, Paragraph, LevelFormat } from "../build";
+
+const doc = new Document({
+    numbering: {
+        config: [
+            {
+                reference: "ref1",
+                levels: [
+                    {
+                        level: 0,
+                        format: LevelFormat.DECIMAL,
+                        text: "%1",
+                    },
+                    {
+                        level: 1,
+                        format: LevelFormat.DECIMAL,
+                        text: "%1.%2",
+                    },
+                    {
+                        level: 2,
+                        format: LevelFormat.DECIMAL,
+                        text: "%1.%2.%3",
+                    },
+                ],
+            },
+        ],
+    },
+    sections: [
+        {
+            children: [
+                new Paragraph({
+                    text: "REF1 - lvl:0",
+                    numbering: {
+                        reference: "ref1",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "REF1 - lvl:1",
+                    numbering: {
+                        reference: "ref1",
+                        level: 1,
+                    },
+                }),
+                new Paragraph({
+                    text: "REF1  - lvl:2",
+                    numbering: {
+                        reference: "ref1",
+                        level: 2,
+                    },
+                }),
+                new Paragraph({
+                    text: "REF1 - lvl:0",
+                    numbering: {
+                        reference: "ref1",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "REF1 - lvl:0",
+                    numbering: {
+                        reference: "ref1",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "REF1 - lvl:0",
+                    numbering: {
+                        reference: "ref1",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "Random text",
+                }),
+                new Paragraph({
+                    text: "REF1 - inst:1 - lvl:0",
+                    numbering: {
+                        reference: "ref1",
+                        instance: 1,
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "REF1 - inst:0 - lvl:0",
+                    numbering: {
+                        reference: "ref1",
+                        instance: 0,
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "REF1 - inst:0 - lvl:0",
+                    numbering: {
+                        reference: "ref1",
+                        instance: 0,
+                        level: 0,
+                    },
+                }),
+            ],
+        },
+    ],
+});
+
+// Used to export the file into a .docx file
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("6-numbering.docx", buffer);
+});

demo/65-page-sizes.ts

@@ -0,0 +1,38 @@
+// Example of how to set the document page sizes
+// Reference from https://papersizes.io/a/a3
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { convertMillimetersToTwip, Document, Packer, PageOrientation, Paragraph } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {
+                page: {
+                    size: {
+                        orientation: PageOrientation.LANDSCAPE,
+                        height: convertMillimetersToTwip(210),
+                        width: convertMillimetersToTwip(148),
+                    },
+                },
+            },
+            children: [new Paragraph("Hello World")],
+        },
+        {
+            properties: {
+                page: {
+                    size: {
+                        orientation: PageOrientation.PORTRAIT,
+                        height: convertMillimetersToTwip(420),
+                        width: convertMillimetersToTwip(297),
+                    },
+                },
+            },
+            children: [new Paragraph("Hello World")],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/66-fields.ts

@@ -0,0 +1,43 @@
+// Use fields to include dynamic text
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Bookmark, Document, Packer, Paragraph, SimpleField, TextRun } from "../build";
+
+const doc = new Document({
+    creator: 'Me',
+    sections: [
+        {
+            properties: {},
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("This document is called "),
+                        new SimpleField("FILENAME", "My Document.docx"),
+                        new TextRun(", was created on "),
+                        new SimpleField('CREATEDATE  \\@ "d MMMM yyyy"'),
+                        new TextRun(" by "),
+                        new SimpleField("AUTHOR"),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun("The document has "),
+                        new SimpleField("NUMWORDS", "34"),
+                        new TextRun(" words and if you'd print it "),
+                        new Bookmark({
+                            id: "TimesPrinted",
+                            children: [new TextRun("42")],
+                        }),
+                        new TextRun(" times two-sided, you would need "),
+                        new SimpleField("=INT((TimesPrinted+1)/2)"),
+                        new TextRun(" sheets of paper."),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/67-column-break.ts

@@ -0,0 +1,28 @@
+// Section with 2 columns including a column break
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, Paragraph, ColumnBreak, TextRun } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {
+                column: {
+                    space: 708,
+                    count: 2,
+                },
+            },
+            children: [
+                new Paragraph({ children: [
+                    new TextRun('This text will be in the first column.'),
+                    new ColumnBreak(),
+                    new TextRun('This text will be in the second column.'),
+                ] }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/68-numbering-instances-and-starting-number.ts

@@ -0,0 +1,86 @@
+import * as fs from "fs";
+import { Document, Packer, Paragraph, PageNumberFormat} from "../build";
+
+const doc = new Document({
+  numbering:{
+    config:[
+      {
+        reference: 'ref1',
+        levels: [
+          {
+            level: 0,
+            format: PageNumberFormat.DECIMAL,
+            text: '%1',
+            start: 10,
+          }
+        ],
+      },
+      {
+        reference: 'ref2',
+        levels: [
+          {
+            level: 0,
+            format: PageNumberFormat.DECIMAL,
+            text: '%1'
+          }
+        ],
+      },
+    ]
+  },
+  sections: [{
+    children: [
+      new Paragraph({
+        text: "REF1 - inst:0 - lvl:0",
+        numbering : {
+          reference: 'ref1',
+          instance: 0,
+          level: 0,
+        }
+      }),
+      new Paragraph({
+        text: "REF1 - inst:0 - lvl:0",
+        numbering : {
+          reference: 'ref1',
+          instance: 0,
+          level: 0,
+        }
+      }),
+      new Paragraph({
+        text: "REF1 - inst:1 - lvl:0",
+        numbering : {
+          reference: 'ref1',
+          instance: 1,
+          level: 0,
+        },
+      }),
+      new Paragraph({
+        text: "REF1 - inst:1 - lvl:0",
+        numbering : {
+          reference: 'ref1',
+          instance: 1,
+          level: 0,
+        }
+      }),
+      new Paragraph({
+        text: "REF2 - inst:0 - lvl:0",
+        numbering : {
+          reference: 'ref2',
+          instance: 1,
+          level: 0,
+        }
+      }),
+      new Paragraph({
+        text: "REF2 - inst:0 - lvl:0",
+        numbering : {
+          reference: 'ref2',
+          instance: 1,
+          level: 0,
+        }
+      })
+    ],
+  }]
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/69-different-width-columns.ts

@@ -0,0 +1,31 @@
+// Sections with multiple columns
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Column, Document, Packer, Paragraph } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {
+                column: {
+                    count: 2,
+                    space: 720,
+                    equalWidth: false,
+                    children: [new Column({ width: 2880, space: 720 }), new Column({ width: 5760 })],
+                },
+            },
+            children: [
+                new Paragraph(
+                    "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
+                ),
+                new Paragraph(
+                    "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
+                ),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/70-line-numbers-suppression.ts

@@ -0,0 +1,37 @@
+// Example demonstrating line numbers with suppression.
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, HeadingLevel, LineNumberRestartFormat, Packer, Paragraph } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {
+                lineNumbers: {
+                    countBy: 1,
+                    restart: LineNumberRestartFormat.CONTINUOUS,
+                },
+            },
+            children: [
+                new Paragraph({
+                    text: "Hello",
+                    heading: HeadingLevel.HEADING_1,
+                }),
+                new Paragraph(
+                    "Himenaeos duis luctus nullam fermentum lobortis potenti vivamus non dis, sed facilisis ultricies scelerisque aenean risus hac senectus. Adipiscing id venenatis justo ante gravida placerat, ac curabitur dis pellentesque proin bibendum risus, aliquam porta taciti vulputate primis. Tortor ipsum fermentum quam vel convallis primis nisl praesent tincidunt, lobortis quisque felis vitae condimentum class ut sem nam, aenean potenti pretium ac amet lacinia himenaeos mi. Aliquam nisl turpis hendrerit est morbi malesuada, augue interdum mus inceptos curabitur tristique, parturient feugiat sodales nulla facilisi. Aliquam non pulvinar purus nulla ex integer, velit faucibus vitae at bibendum quam, risus elit aenean adipiscing posuere.",
+                ),
+                new Paragraph({
+                    text: 'Enim mollit nostrud ut dolor eiusmod id sit occaecat dolore culpa amet. Veniam dolor consequat dolor labore ullamco laborum dolore eiusmod qui adipisicing. Elit nulla cupidatat et magna. Id eiusmod tempor non laborum ipsum. Veniam et aliqua excepteur duis officia enim elit excepteur fugiat duis. Sit sunt ullamco non dolor est qui deserunt consequat magna. Esse pariatur esse dolor ut excepteur dolor nisi nisi non est cupidatat mollit.',
+                    suppressLineNumbers: true
+                }),
+                new Paragraph(
+                    "Sed laoreet id mattis egestas nam mollis elit lacinia convallis dui tincidunt ultricies habitant, pharetra per maximus interdum neque tempor risus efficitur morbi imperdiet senectus. Lectus laoreet senectus finibus inceptos donec potenti fermentum, ultrices eleifend odio suscipit magnis tellus maximus nibh, ac sit nullam eget felis himenaeos. Diam class sem magnis aenean commodo faucibus id proin mi, nullam sodales nec mus parturient ornare ad inceptos velit hendrerit, bibendum placerat eleifend integer facilisis urna dictumst suspendisse.",
+                ),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/browser-demo.html

@@ -12,9 +12,7 @@
 
         <script>
             function generate() {
-                const doc = new docx.Document();
-
-                const doc = new Document({
+                const doc = new docx.Document({
                     sections: [
                         {
                             children: [

docs/README.md

@@ -44,7 +44,7 @@ const doc = new Document({
                 ],
             }),
         ],
-    }];
+    }],
 });
 
 // Used to export the file into a .docx file

docs/_coverpage.md

@@ -4,7 +4,7 @@
 
 -   Simple, declarative API
 -   60+ usage examples
--   Battle tested, mature, 98%+ coverage
+-   Battle tested, mature, 99%+ coverage
 
 [GitHub](https://github.com/dolanmiu/docx)
 [Get Started](#Welcome)

docs/_sidebar.md

@@ -15,6 +15,7 @@
 	* [Image](usage/images.md)
 	* [Headers & Footers](usage/headers-and-footers.md)
 	* [Bullet Points](usage/bullet-points.md)
+    * [Hyperlinks](usage/hyperlinks.md)
     * [Numbering](usage/numbering.md)
     * [Tables](usage/tables.md)
 	* [Tab Stops](usage/tab-stops.md)

docs/usage/change-tracking.md

@@ -27,7 +27,7 @@ const paragraph = new Paragraph({
 });
 ```
 
-Note that for a `InsertedTextRun` and `DeletedTextRun`, it is not possible to simply call it with only a text as in `new TextRun("some text")`, since the additonal fields for change tracking need to be provided. Similar to a normal `TextRun` you can add additional text properties.
+Note that for a `InsertedTextRun` and `DeletedTextRun`, it is not possible to simply call it with only a text as in `new TextRun("some text")`, since the additional fields for change tracking need to be provided. Similar to a normal `TextRun` you can add additional text properties.
 
 ```ts
 import { Paragraph, TextRun, InsertedTextRun, DeletedTextRun } from "docx";
@@ -37,7 +37,7 @@ const paragraph = new Paragraph({
         new TextRun("This is a simple demo"),
         new DeletedTextRun({
             text: "with a deletion.",
-            color: "red",
+            color: "ff0000",
             bold: true,
             size: 24,
             id: 0,
@@ -48,7 +48,7 @@ const paragraph = new Paragraph({
 });
 ```
 
-In addtion to marking text as inserted or deleted, change tracking can also be added via the document settings. This will enable new changes to be tracked as well.
+In addition to marking text as inserted or deleted, change tracking can also be added via the document settings. This will enable new changes to be tracked as well.
 
 ```ts
 import { Document } from "docx";

docs/usage/fields.md

@@ -0,0 +1,73 @@
+# Fields
+
+Fields are pieces of dynamic text that you can include in your document. Often used fields are page numbers or references, but you can also include document properties like the author name or last saved date.
+
+## Simple fields
+
+There are very complicated fields like the table of contents, but in many cases the whole field just has the same properties (like formatting). In those cases, you can use simple fields.
+
+Word uses field codes to identify what the result of the field should be. You can find these field codes by adding a field in a document (`Insert -> Quick Parts -> Field...`) and clicking the 'Field codes'-button. Some examples include:
+
+Field type  | Example         | Description
+----------- | --------------- | ---------------------------------------------------------
+= (Formula) | `=2*21`         | Calculates the result of a formula. You can also use bookmarks as variables, see below.
+Author      | `AUTHOR`        | Includes the author mentioned in the document properties.
+CreateDate  | `CREATEDATE`    | Date the document was created.
+Date        | `DATE`          | Today's date.
+FileName    | `FILENAME \p`   | The name of the document. Add `\p` for the complete path.
+Info        | `INFO NumWords` | Data from the document properties, e.g. the number of words in the document.
+NumPages    | `NUMPAGES`      | Number of pages in the document.
+UserName    | `USERNAME`      | Your user name from the Office personalization settings.
+
+Fields can be added as a child of a paragraph:
+
+```ts
+const paragraph = new Paragraph({
+    children: [new TextRun("This document was created by: "), new SimpleField("AUTHOR")],
+});
+```
+
+Fields can contain a cached value that gives the word processor a text to show without having to calculate all fields. The cached value can be updated by selecting the field and pressing F9. A cached value can be passed in as the second argument to the constructor.
+
+```ts
+const paragraph = new Paragraph({
+    children: [new TextRun("This document was created by: "), new SimpleField("AUTHOR", "Richard Brodie")],
+});
+```
+
+### Formulas
+
+One type of field is the formula that can be used to do some basic calculations. This can be done with static values, e.g. `12 + 34`, but a value from a bookmark can also be used in a calculation. This can be seen in the following example:
+
+```ts
+const paragraph = new Paragraph({
+    children: [
+        new TextRun("Value one is: "),
+        new Bookmark({ id: "One", children: [new TextRun("451")]}),
+        new TextRun(". The second value is: "),
+        new Bookmark({ id: "Two", children: [new TextRun("886")]}),
+        new TextRun(". The sum of these values is: "),
+        new SimpleField("=One+Two"),
+    ],
+});
+```
+
+### Mail merge fields
+
+Fields are often used in a mail merge where a template document is created and data from another source (Excel or a database) is inserted in the document.
+
+A convenience class was added to add these mail merge fields to the document easily. You can add these to a paragraph like any other field and only have to supply the name of the field in your data set:
+
+```ts
+const paragraph = new Paragraph({
+    children: [new TextRun("Your score was "), new SimpleMailMergeField("Score"), new TextRun(" of 100 points")],
+});
+```
+
+This code is equivalent to:
+
+```ts
+const paragraph = new Paragraph({
+    children: [new TextRun("Your score was "), new SimpleField("MERGEFIELD Score", "«Score»"), new TextRun(" of 100 points")],
+});
+```

docs/usage/hyperlinks.md

@@ -1,47 +1,98 @@
 # Hyperlinks
 
+!> Hyperlinks require an understanding of [Paragraphs](usage/paragraph.md) and [Text](usage/text.md).
+
 There are two types of hyperlinks: internal (pointing to a bookmark inside the document) and external (pointing to an external url).
 
 ## Internal
 
-To create an internal hyperlink you need first to create a bookmark (the paragraph that will be the destination of the hyperlink) with `doc.createBookmark(anchor, text)`.
+To create an internal hyperlink you need first to create a `Bookmark`, which contains the content that will be the destination of the hyperlink.
 
-A bookmark is composed of an anchor (an identifier) and the text displayed. After creating a bookmark just add it to a paragraph with `paragraph.addBookmark(bookmark)`
-
-For example:
+A bookmark is composed of an anchor (an identifier) and the text displayed. After creating a bookmark just add it to a paragraph. For example, creating a bookmarked heading:
 
 ```ts
-const paragraph = this.doc.createParagraph();
-const bookmark = this.doc.createBookmark('anchorForChapter1', 'This is chapter1');
-paragraph.addBookmark(bookmark);
+const chapter1 = new Paragraph({
+    heading: HeadingLevel.HEADING_1,
+    children: [
+        new Bookmark({
+            id: "anchorForChapter1",
+            children: [
+                new TextRun("Chapter 1"),
+            ],
+        }),
+    ],
+})
 ```
 
-Then you can create an hyperlink pointing to that bookmark with `doc.createInternalHyperLink(anchor,text)`:
+Then you can create an hyperlink pointing to that bookmark with an `InternalHyperLink`:
 
 ```ts
-const paragraph = this.doc.createParagraph();
-const link = this.doc.createInternalHyperLink('anchorForChapter1', 'This is a link to chapter1');
-paragraph.addHyperLink(link);
+const link = new InternalHyperlink({
+    children: [
+        new TextRun({
+            text: "See Chapter 1",
+            style: "Hyperlink",
+        }),
+    ],
+    anchor: "anchorForChapter1",
+})
+```
+
+You can also get the page number of the bookmark by creating a page reference to it:
+
+```ts
+const paragraph = new Paragraph({
+    children: [
+        new TextRun("Chapter 1 can be seen on page "),
+        new PageReference("anchorForChapter1"),
+    ],
+});
 ```
 
 ## External
 
-To create an external hyperlink you just need to specify the url and the text of the link, then add it to a paragraph with `doc.createHyperlink(url, text)`:
+To create an external hyperlink you just need to specify the url and the text of the link, then add it to a paragraph:
 
 ```ts
-const paragraph = this.doc.createParagraph();
-const link = this.doc.createHyperlink('https://docx.js.org', 'This is an external link');
-paragraph.addHyperLink(link);
+const paragraph = new Paragraph({
+    children: [
+        new ExternalHyperlink({
+            children: [
+                new TextRun({
+                    text: "This is an external link!",
+                    style: "Hyperlink",
+                }),
+            ],
+            link: "https://docx.js.org",
+        }),
+    ],
+});
 ```
 
 
-## Styling an hyperlink
+## Styling hyperlinks
 
-It is possible to set the style of the text of an hyperlink. This can be done applying run formatting on `TextRun` property of the hyperlink.
+It is possible to set the style of the text of both internal and external hyperlinks. This can be done applying run formatting on any of the `TextRun` children of the hyperlink. Use the `style: "Hyperlink"` property to show the default link styles, which can be combined with any other style.
 
 Example:
 
 ```ts
-const link = this.doc.createHyperlink('https://docx.js.org', 'This is an external link');
-link.TextRun.bold().italics()
+const styledLink = new ExternalHyperlink({
+    children: [
+        new TextRun({
+            text: "This is a ",
+            style: "Hyperlink",
+        }),
+        new TextRun({
+            text: "bold",
+            bold: true,
+            style: "Hyperlink",
+        }),
+        new TextRun({
+            text: " link!",
+            style: "Hyperlink",
+        }),
+    ],
+    link: "https://docx.js.org",
+});
 ```

docs/usage/images.md

@@ -78,7 +78,7 @@ const doc = new Document({
 
 > 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)
+![Word Image Positioning](https://user-images.githubusercontent.com/34742290/41765548-b0946302-7604-11e8-96f9-166a9f0b8f39.png)
 
 Three types of image positioning is supported:
 
@@ -89,7 +89,7 @@ By default, images are exported as `Inline` elements.
 
 ### Usage
 
-Pass `options` into the `[POSITION_OPTIONS]` metioned in the [Intro above](#Intro).
+Pass `options` into the `[POSITION_OPTIONS]` mentioned in the [Intro above](#Intro).
 
 ## Floating
 

docs/usage/math.md

@@ -6,7 +6,7 @@
 
 1.  To add math, create a `Math` object
 2.  Add `MathComponents` inside `Math`
-3.  `MathComponents` can have nested `MathComponents` inside. e.g. A fraction where the numerator is a square root, and the demoninator as another fraction. More on `MathComponents` below
+3.  `MathComponents` can have nested `MathComponents` inside. e.g. A fraction where the numerator is a square root, and the denominator as another fraction. More on `MathComponents` below
 4.  Make sure to add the `Math` object inside a `Paragraph`
 
 ## Example
@@ -61,7 +61,7 @@ new Math({
 
 ### Math Fraction
 
-`MathFractions` require a `numerator` and a `demoninator`, which are both a list of `MathComponents`
+`MathFractions` require a `numerator` and a `denominator`, which are both a list of `MathComponents`
 
 #### Example
 

docs/usage/numbering.md

@@ -23,7 +23,7 @@ those bullets/numbering. An abstract numbering system defines how
 bullets/numbers are to be shown for lists, including any sublists that
 may be used. Thus each abstract definition includes a series of
 _levels_ which form a sequence starting at 0 indicating the top-level
-list look and increasing from there to descibe the sublists, then
+list look and increasing from there to describe the sublists, then
 sub-sublists, etc. Each level includes the following properties:
 
 *   **level**: This is its 0-based index in the definition stack
@@ -39,10 +39,10 @@ sub-sublists, etc. Each level includes the following properties:
     the sequence "a)", "b)", ...
 *   and a few others, which you can see in the OXML spec section 17.9.6
 
-## Document-level bullets/numbering defintions (concrete)
+## Document-level bullets/numbering definitions (concrete)
 
 Concrete definitions are sort of like concrete subclasses of the
-abstract defintions. They indicate their parent and are allowed to
+abstract definitions. They indicate their parent and are allowed to
 override certain level definitions. Thus two lists that differ only in
 how sub-sub-lists are to be displayed can share the same abstract
 numbering definition and have slightly different concrete definitions.

docs/usage/page-numbers.md

@@ -5,35 +5,49 @@
 ?> **Note:** This feature only works on Headers and Footers
 
 ```ts
-doc.Header.createParagraph().addRun(new TextRun("Page Number: ").pageNumber()).addRun(new TextRun("to ").numberOfTotalPages());
+new Paragraph({
+    children: [
+        new TextRun({
+            children: ["Page #: ", PageNumber.CURRENT],
+        })
+    ]
+})
 ```
 
 ## 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();
+PageNumber.CURRENT
 ```
 
 For example:
 
 ```ts
-const currentPageRun = new TextRun("Current Page Number: ").pageNumber();
-paragraph.addRun(currentPageRun);
+new Paragraph({
+    children: [
+        new TextRun({
+            children: ["Page Number ", PageNumber.CURRENT],
+        })
+    ]
+})
 ```
 
 ## Total number of pages
 
 ```ts
-numberOfTotalPages();
+PageNumber.TOTAL_PAGES
 ```
 
 For example:
 
 ```ts
-const lastPage = new TextRun("Total Page Number: ").numberOfTotalPages();
-paragraph.addRun(lastPage);
+new Paragraph({
+    children: [
+        new TextRun({
+            children: ["Total Pages Number: ", PageNumber.TOTAL_PAGES],
+        })
+    ]
+})
 ```
 
 
@@ -42,17 +56,14 @@ paragraph.addRun(lastPage);
 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());
+new Paragraph({
+    children: [
+        new TextRun("My awesome text here for my university dissertation. ")
+        new TextRun({
+            children: ["Page ", PageNumber.CURRENT, " of ", PageNumber.TOTAL_PAGES],
+        })
+    ]
+})
 ```
 
 ## Examples

docs/usage/paragraph.md

@@ -1,8 +1,8 @@
 # Paragraph
 
-> Everything (text, images, graphs etc) in OpenXML is organised in paragraphs.
+> Everything (text, images, graphs etc) in OpenXML is organized in paragraphs.
 
-!> Paragraphs requires an understanding of [Sections](sections.md).
+!> Paragraphs requires an understanding of [Sections](usage/sections.md).
 
 You can create `Paragraphs` in the following ways:
 
@@ -16,7 +16,7 @@ const paragraph = new Paragraph("Short hand Hello World");
 
 ### Children Method
 
-This method is useful for adding different [text](text.md) with different styles, [symbols](symbols.md), or adding [images](images.md) inline.
+This method is useful for adding different [text](usage/text.md) with different styles, [symbols](usage/symbols.md), or adding [images](usage/images.md) inline.
 
 ```ts
 const paragraph = new Paragraph({
@@ -42,7 +42,7 @@ const doc = new Document({
 });
 ```
 
-Or the preferred convension, define the paragraph inside the section and remove the usage of variables:
+Or the preferred convention, define the paragraph inside the section and remove the usage of variables:
 
 ```ts
 const doc = new Document({
@@ -180,12 +180,12 @@ Adding spacing between paragraphs
 
 ### ISpacingProperties
 
-| Property | Type           | Notes    |
-| -------- | -------------- | -------- |
-| after    | `number`       | Optional |
-| before   | `number`       | Optional |
-| line     | `number`       | Optional |
-| lineRule | `LineRuleType` | Optional |
+| Property | Type           | Notes    | Possible Values               |
+| -------- | -------------- | -------- | ----------------------------- |
+| after    | `number`       | Optional |                               |
+| before   | `number`       | Optional |                               |
+| line     | `number`       | Optional |                               |
+| lineRule | `LineRuleType` | Optional | `AT_LEAST`, `EXACTLY`, `AUTO` |
 
 **Example:**
 

docs/usage/styling-with-xml.md

@@ -3,7 +3,7 @@
 ## Setup
 
 1.  Create a new word document in Microsoft Word
-2.  Customise the styles on the Ribbon Bar.
+2.  Customize the styles on the Ribbon Bar.
     For example, modify the `Normal`, `Heading 1`, `Heading 2` like so:
 
     ![image](https://user-images.githubusercontent.com/2917613/41195113-65edebfa-6c1f-11e8-97b4-77de2d60044a.png)

docs/usage/symbols.md

@@ -1,8 +1,8 @@
 # Symbol Runs
 
-!> SymbolRuns require an understanding of [Paragraphs](paragraph.md).
+!> SymbolRuns require an understanding of [Paragraphs](usage/paragraph.md).
 
-You can add multiple `symbol runs` in `Paragraphs` along with [text runs](text.md) using the Paragraph's `children` property.
+You can add multiple `symbol runs` in `Paragraphs` along with [text runs](usage/text.md) using the Paragraph's `children` property.
 
 ```ts
 import { Paragraph, TextRun, SymbolRun } from "docx";
@@ -50,4 +50,4 @@ const symbol = new SymbolRun({
 });
 ```
 
-See the [text run](text.md) documentation for more info.
+See the [text run](usage/text.md) documentation for more info.

docs/usage/tab-stops.md

@@ -4,15 +4,15 @@
 
 !> **Note**: The unit of measurement for a tab stop is in [DXA](https://stackoverflow.com/questions/14360183/default-wordml-unit-measurement-pixel-or-point-or-inches)
 
-![Word 2013 Tabs](http://www.teachucomp.com/wp-content/uploads/blog-4-22-2015-UsingTabStopsInWord-1024x577.png "Word 2013 Tab Stops")
+![Word 2013 Tabs](https://support.content.office.net/en-us/media/d75ca75d-9fe9-4d46-9a8b-4534c13acbc5.png "Word 2013 Tab Stops")
 
-Simply call the relevant methods on the paragraph listed below. Then just add a `tab()` method call to a text object. Adding multiple `tabStops` will mean you would have to chain `tab()` until the desired `tabStop` is selected. Example is shown below.
+Simply declare the tab stops on the paragraph, as shown below. Use the tab character `\t` to indicate the tab position within the `text` property of a `TextRun`. Adding multiple `tabStops` will mean you can add additional `\t` characters until the desired `tabStop` is selected. Example is shown below.
 
 ## Example
 
 ```ts
 const paragraph = new Paragraph({
-    children: [new TextRun("Hey everyone").bold(), new TextRun(\t"11th November 1999")],
+    children: [new TextRun({ text: "Hey everyone", bold: true}), new TextRun("\t11th November 1999")],
     tabStops: [
         {
             type: TabStopType.RIGHT,
@@ -26,7 +26,7 @@ The example above will create a left aligned text, and a right aligned text on t
 
 ```ts
 const paragraph = new Paragraph({
-    children: [new TextRun("Second tab stop here I come!")],
+    children: [new TextRun("\t\tSecond tab stop here I come!")],
     tabStops: [
         {
             type: TabStopType.RIGHT,
@@ -46,7 +46,7 @@ You can add multiple tab stops of the same `type` too.
 
 ```ts
 const paragraph = new Paragraph({
-    children: [new TextRun("Multiple tab stops!")],
+    children: [new TextRun("Multiple \ttab \tstops!")],
     tabStops: [
         {
             type: TabStopType.RIGHT,
@@ -103,7 +103,7 @@ const paragraph = new Paragraph({
 });
 ```
 
-2268 is the distance fro0oum the left side.
+2268 is the distance from the left side.
 
 ## Max Right Tab Stop
 

docs/usage/table-of-contents.md

@@ -2,7 +2,7 @@
 
 You can generate table of contents with `docx`. More information can be found [here](http://officeopenxml.com/WPtableOfContents.php).
 
-> Tables of Contents are fields and, by design, it's content is only generated or updated by Word. We can't do it programatically.
+> Tables of Contents are fields and, by design, it's content is only generated or updated by Word. We can't do it programmatically.
 > This is why, when you open a the file, Word you will prompt the message "This document contains fields that may refer to other files. Do you want to update the fields in this document?".
 > You have say yes to Word generate the content of all table of contents.
 
@@ -12,14 +12,29 @@ The complete documentation can be found [here](https://www.ecma-international.or
 
 All you need to do is create a `TableOfContents` object and assign it to the document.
 
+**Note**: updateFields feature must be enabled for TableOfContents to update correctly.
+
 ```ts
-const toc = new TableOfContents("Summary", {
+const doc = new Document({
+    features: {
+        updateFields: true,
+    },
+    sections: [
+        {
+            children: [
+                new TableOfContents("Summary", {
                     hyperlink: true,
                     headingStyleRange: "1-5",
-    stylesWithLevels: [new StyleLevel("MySpectacularStyle", 1)],
+                }),
+                new Paragraph({
+                    text: "Header #1",
+                    heading: HeadingLevel.HEADING_1,
+                    pageBreakBefore: true,
+                }),
+            ]
+        }
+    ]
 });
-
-doc.addTableOfContents(toc);
 ```
 
 ## Table of Contents Options

docs/usage/tables.md

@@ -6,7 +6,7 @@
 
 -   `Tables` contain a list of `Rows`
 -   `Rows` contain a list of `TableCells`
--   `TableCells` contain a list of `Parahraphs` and/or `Tables`. You can add `Tables` as tables can be nested inside each other
+-   `TableCells` contain a list of `Paragraphs` and/or `Tables`. You can add `Tables` as tables can be nested inside each other
 
 Create a simple table like so:
 
@@ -53,6 +53,18 @@ const table = new Table({
 });
 ```
 
+### Set Indent
+
+```ts
+const table = new Table({
+    ...,
+    indent: {
+        size: 600,
+        type: WidthType.DXA,
+    }
+});
+```
+
 ## Table Row
 
 A table consists of multiple `table rows`. Table rows have a list of `children` which accepts a list of `table cells` explained below. You can create a simple `table row` like so:
@@ -145,7 +157,7 @@ const tableRow = new TableRow({
 | Property      | Type                                | Notes                                                       |
 | ------------- | ----------------------------------- | ----------------------------------------------------------- |
 | children      | `Array<Paragraph or Table>`         | Required. You can nest tables by adding a table into a cell |
-| shading       | `ITableShadingAttributesProperties` | Optional                                                    |
+| shading       | `IShadingAttributesProperties`      | Optional                                                    |
 | margins       | `ITableCellMarginOptions`           | Optional                                                    |
 | verticalAlign | `VerticalAlign`                     | Optional                                                    |
 | columnSpan    | `number`                            | Optional                                                    |
@@ -171,7 +183,7 @@ const cell = new TableCell({
         top: {
             style: BorderStyle.DASH_DOT_STROKED,
             size: 1,
-            color: "red",
+            color: "ff0000",
         },
         bottom: {
             style: BorderStyle.THICK_THIN_MEDIUM_GAP,
@@ -190,12 +202,12 @@ Google DOCS does not support start and end borders, instead they use left and ri
 const cell = new TableCell({
     ...,
     borders: {
-        top: {
+        left: {
             style: BorderStyle.DOT_DOT_DASH,
             size: 3,
-            color: "green",
+            color: "00FF00",
         },
-        bottom: {
+        right: {
             style: BorderStyle.DOT_DOT_DASH,
             size: 3,
             color: "ff8000",
@@ -231,17 +243,11 @@ const cell = new TableCell({
 `WidthType` values can be:
 
 | Property   | Notes                             |
-| -------- | --------------------------------- |
+| ---------- | --------------------------------- |
 | AUTO       |                                   |
-| DXA      | value is in twentieths of a point |
-| NIL      | is considered as zero             |
-| PCT      | percent of table width            |
-
-#### Example
-
-```ts
-cell.Properties.setWidth(100, WidthType.DXA);
-```
+| DXA        | Value is in twentieths of a point |
+| NIL        | Is considered as zero             |
+| PERCENTAGE | Percent of table width            |
 
 ### Nested Tables
 
@@ -346,7 +352,7 @@ _Source: https://github.com/dolanmiu/docx/blob/master/demo/4-basic-table.ts_
 
 ### Custom borders
 
-Example showing how to add colourful borders to tables
+Example showing how to add colorful borders to tables
 
 [Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/20-table-cell-borders.ts ':include')
 

package.json

@@ -1,26 +1,25 @@
 {
   "name": "docx",
-  "version": "6.0.1",
+  "version": "7.1.0",
   "description": "Easily generate .docx files with JS/TS with a nice declarative API. Works for Node and on the Browser.",
   "main": "build/index.js",
   "scripts": {
     "pretest": "rimraf ./build",
-    "test": "mocha-webpack \"src/**/*.ts\"",
+    "test": "mocha -r ts-node/register -r tsconfig-paths/register \"src/**/*.ts\"",
     "test.coverage": "nyc npm test",
     "test.watch": "npm test -- --watch",
     "prepublishOnly": "npm run build --production",
     "lint": "tslint --project .",
     "build": "npm run webpack && npm run fix-types",
-    "tsc": "rimraf ./build && tsc -p .",
-    "webpack": "rimraf ./build && webpack",
-    "demo": "npm run build && npm run ts-node ./demo",
+    "webpack": "rimraf ./build && webpack --config ./webpack.config.ts",
+    "demo": "npm run build && npm run ts-node --skip-project ./demo",
     "typedoc": "rimraf ./build && typedoc src/index.ts --tsconfig tsconfig.typedoc.json",
     "style": "prettier -l \"src/**/*.ts\"",
     "style.fix": "npm run style -- --write",
     "fix-types": "ts-node scripts/types-absolute-fixer.ts",
     "e2e": "ts-node scripts/e2e.ts",
     "serve.docs": "cd docs && docsify serve",
-    "ts-node": "ts-node"
+    "ts-node": "ts-node --skip-project"
   },
   "pre-commit": [
     "style",
@@ -49,8 +48,7 @@
   ],
   "types": "./build/index.d.ts",
   "dependencies": {
-    "@types/jszip": "^3.1.4",
-    "@types/node": "^14.0.5",
+    "@types/node": "^16.0.0",
     "jszip": "^3.1.5",
     "nanoid": "^3.1.20",
     "xml": "^1.0.1",
@@ -64,34 +62,37 @@
   "homepage": "https://github.com/dolanmiu/docx#readme",
   "devDependencies": {
     "@types/chai": "^4.2.15",
-    "@types/mocha": "^8.0.0",
+    "@types/mocha": "^9.0.0",
     "@types/request-promise": "^4.1.42",
-    "@types/sinon": "^9.0.4",
-    "@types/webpack": "^4.4.24",
-    "awesome-typescript-loader": "^3.4.1",
+    "@types/sinon": "^10.0.0",
+    "@types/webpack": "^5.0.0",
+    "buffer": "^6.0.3",
     "chai": "^3.5.0",
     "docsify-cli": "^4.3.0",
     "glob": "^7.1.2",
-    "istanbul-instrumenter-loader": "^3.0.1",
     "jszip": "^3.1.5",
-    "mocha": "^5.2.0",
-    "mocha-webpack": "^1.0.1",
+    "mocha": "^9.0.2",
     "nyc": "^15.1.0",
     "pre-commit": "^1.2.2",
-    "prettier": "^2.1.2",
+    "prettier": "^2.3.1",
+    "process": "^0.11.10",
     "prompt": "^1.0.0",
-    "replace-in-file": "^3.1.0",
+    "replace-in-file": "^6.2.0",
     "request": "^2.88.0",
     "request-promise": "^4.2.2",
     "rimraf": "^3.0.2",
     "shelljs": "^0.8.4",
-    "sinon": "^9.0.2",
+    "sinon": "^11.0.0",
+    "stream-browserify": "^3.0.0",
+    "ts-loader": "^9.0.0",
     "ts-node": "^9.0.0",
+    "tsconfig-paths": "^3.9.0",
     "tslint": "^6.1.3",
     "tslint-immutable": "^6.0.1",
-    "typedoc": "^0.20.29",
-    "typescript": "4.2.3",
-    "webpack": "^3.10.0"
+    "typedoc": "^0.22.3",
+    "typescript": "4.4.3",
+    "webpack": "^5.28.0",
+    "webpack-cli": "^4.6.0"
   },
   "engines": {
     "node": ">=10"

scripts/types-absolute-fixer.ts

@@ -1,18 +1,16 @@
 import * as glob from "glob";
-import * as replace from "replace-in-file";
+import { replaceInFile } from "replace-in-file";
 
 const files = glob.sync("build/**/*.d.ts");
 
 for (const file of files) {
-    replace({
+    replaceInFile({
         files: file,
         from: /"file[a-z/-]*"/gi,
         to: (match) => {
             const matchSlug = match.replace(/['"]+/g, "").trim();
             const levelCount = file.split("/").length - 2;
-            const backLevels = Array(levelCount)
-                .fill("../")
-                .join("");
+            const backLevels = Array(levelCount).fill("../").join("");
 
             return `"${backLevels}${matchSlug}"`;
         },

src/convenience-functions.spec.ts

@@ -18,14 +18,14 @@ describe("Utility", () => {
     });
 
     describe("#uniqueNumericId", () => {
-        it("should generate a unique ID", () => {
+        it("should generate a unique incrementing ID", () => {
             // tslint:disable-next-line: no-unused-expression
-            expect(uniqueNumericId()).to.not.be.empty;
+            expect(uniqueNumericId()).to.not.be.undefined;
         });
     });
 
     describe("#uniqueId", () => {
-        it("should call the underlying header's addChildElement", () => {
+        it("should generate a unique pseudorandom ID", () => {
             // tslint:disable-next-line: no-unused-expression
             expect(uniqueId()).to.not.be.empty;
         });

src/convenience-functions.ts

@@ -1,6 +1,6 @@
-import { customAlphabet, nanoid } from "nanoid/non-secure";
+import { nanoid } from "nanoid/non-secure";
 
-const numericNanoId = customAlphabet("0123456789", 15);
+let currentCount = 0;
 
 // Twip - twentieths of a point
 export const convertMillimetersToTwip = (millimeters: number): number => {
@@ -12,7 +12,7 @@ export const convertInchesToTwip = (inches: number): number => {
 };
 
 export const uniqueNumericId = (): number => {
-    return parseFloat(numericNanoId());
+    return ++currentCount;
 };
 
 export const uniqueId = (): string => {

src/export/formatter.spec.ts

@@ -1,7 +1,7 @@
 import { assert, expect } from "chai";
 import * as sinon from "sinon";
 
-import { Formatter } from "export/formatter";
+import { Formatter } from "@export/formatter";
 import { Paragraph, TextRun } from "file";
 import { CoreProperties } from "file/core-properties";
 import { Attributes } from "file/xml-components";
@@ -45,18 +45,10 @@ describe("Formatter", () => {
                             {
                                 "w:rPr": [
                                     {
-                                        "w:b": {
-                                            _attr: {
-                                                "w:val": true,
-                                            },
-                                        },
+                                        "w:b": {},
                                     },
                                     {
-                                        "w:bCs": {
-                                            _attr: {
-                                                "w:val": true,
-                                            },
-                                        },
+                                        "w:bCs": {},
                                     },
                                 ],
                             },

src/export/packer/image-replacer.spec.ts

@@ -36,7 +36,7 @@ describe("ImageReplacer", () => {
     describe("#getMediaData()", () => {
         it("should get media data", () => {
             const imageReplacer = new ImageReplacer();
-            const result = imageReplacer.getMediaData("test {test-image} test", ({
+            const result = imageReplacer.getMediaData("test {test-image} test", {
                 Array: [
                     {
                         stream: Buffer.from(""),
@@ -53,7 +53,7 @@ describe("ImageReplacer", () => {
                         },
                     },
                 ],
-            } as unknown) as Media);
+            } as unknown as Media);
 
             expect(result).to.have.length(1);
         });

src/export/packer/next-compiler.ts

@@ -70,7 +70,6 @@ export class Compiler {
     }
 
     private xmlifyFile(file: File, prettify?: boolean): IXmlifyedFileMapping {
-        file.verifyUpdateFields();
         const documentRelationshipCount = file.Document.Relationships.RelationshipCount + 1;
 
         const documentXmlData = xml(
@@ -78,7 +77,13 @@ export class Compiler {
                 viewWrapper: file.Document,
                 file,
             }),
-            prettify,
+            {
+                indent: prettify,
+                declaration: {
+                    standalone: "yes",
+                    encoding: "UTF-8",
+                },
+            },
         );
         const documentMediaDatas = this.imageReplacer.getMediaData(documentXmlData, file.Media);
 
@@ -98,7 +103,12 @@ export class Compiler {
                             viewWrapper: file.Document,
                             file,
                         }),
-                        prettify,
+                        {
+                            indent: prettify,
+                            declaration: {
+                                encoding: "UTF-8",
+                            },
+                        },
                     );
                 })(),
                 path: "word/_rels/document.xml.rels",
@@ -113,13 +123,23 @@ export class Compiler {
                 path: "word/document.xml",
             },
             Styles: {
-                data: xml(
+                data: (() => {
+                    const xmlStyles = xml(
                         this.formatter.format(file.Styles, {
                             viewWrapper: file.Document,
                             file,
                         }),
-                    prettify,
-                ),
+                        {
+                            indent: prettify,
+                            declaration: {
+                                standalone: "yes",
+                                encoding: "UTF-8",
+                            },
+                        },
+                    );
+                    const referencedXmlStyles = this.numberingReplacer.replace(xmlStyles, file.Numbering.ConcreteNumbering);
+                    return referencedXmlStyles;
+                })(),
                 path: "word/styles.xml",
             },
             Properties: {
@@ -129,6 +149,7 @@ export class Compiler {
                         file,
                     }),
                     {
+                        indent: prettify,
                         declaration: {
                             standalone: "yes",
                             encoding: "UTF-8",
@@ -143,7 +164,13 @@ export class Compiler {
                         viewWrapper: file.Document,
                         file,
                     }),
-                    prettify,
+                    {
+                        indent: prettify,
+                        declaration: {
+                            standalone: "yes",
+                            encoding: "UTF-8",
+                        },
+                    },
                 ),
                 path: "word/numbering.xml",
             },
@@ -153,7 +180,12 @@ export class Compiler {
                         viewWrapper: file.Document,
                         file,
                     }),
-                    prettify,
+                    {
+                        indent: prettify,
+                        declaration: {
+                            encoding: "UTF-8",
+                        },
+                    },
                 ),
                 path: "_rels/.rels",
             },
@@ -163,7 +195,12 @@ export class Compiler {
                         viewWrapper: headerWrapper,
                         file,
                     }),
-                    prettify,
+                    {
+                        indent: prettify,
+                        declaration: {
+                            encoding: "UTF-8",
+                        },
+                    },
                 );
                 const mediaDatas = this.imageReplacer.getMediaData(xmlData, file.Media);
 
@@ -181,7 +218,12 @@ export class Compiler {
                             viewWrapper: headerWrapper,
                             file,
                         }),
-                        prettify,
+                        {
+                            indent: prettify,
+                            declaration: {
+                                encoding: "UTF-8",
+                            },
+                        },
                     ),
                     path: `word/_rels/header${index + 1}.xml.rels`,
                 };
@@ -192,7 +234,12 @@ export class Compiler {
                         viewWrapper: footerWrapper,
                         file,
                     }),
-                    prettify,
+                    {
+                        indent: prettify,
+                        declaration: {
+                            encoding: "UTF-8",
+                        },
+                    },
                 );
                 const mediaDatas = this.imageReplacer.getMediaData(xmlData, file.Media);
 
@@ -210,7 +257,12 @@ export class Compiler {
                             viewWrapper: footerWrapper,
                             file,
                         }),
-                        prettify,
+                        {
+                            indent: prettify,
+                            declaration: {
+                                encoding: "UTF-8",
+                            },
+                        },
                     ),
                     path: `word/_rels/footer${index + 1}.xml.rels`,
                 };
@@ -221,7 +273,12 @@ export class Compiler {
                         viewWrapper: headerWrapper,
                         file,
                     }),
-                    prettify,
+                    {
+                        indent: prettify,
+                        declaration: {
+                            encoding: "UTF-8",
+                        },
+                    },
                 );
                 const mediaDatas = this.imageReplacer.getMediaData(tempXmlData, file.Media);
                 // TODO: 0 needs to be changed when headers get relationships of their own
@@ -238,7 +295,12 @@ export class Compiler {
                         viewWrapper: footerWrapper,
                         file,
                     }),
-                    prettify,
+                    {
+                        indent: prettify,
+                        declaration: {
+                            encoding: "UTF-8",
+                        },
+                    },
                 );
                 const mediaDatas = this.imageReplacer.getMediaData(tempXmlData, file.Media);
                 // TODO: 0 needs to be changed when headers get relationships of their own
@@ -255,7 +317,12 @@ export class Compiler {
                         viewWrapper: file.Document,
                         file,
                     }),
-                    prettify,
+                    {
+                        indent: prettify,
+                        declaration: {
+                            encoding: "UTF-8",
+                        },
+                    },
                 ),
                 path: "[Content_Types].xml",
             },
@@ -265,7 +332,13 @@ export class Compiler {
                         viewWrapper: file.Document,
                         file,
                     }),
-                    prettify,
+                    {
+                        indent: prettify,
+                        declaration: {
+                            standalone: "yes",
+                            encoding: "UTF-8",
+                        },
+                    },
                 ),
                 path: "docProps/custom.xml",
             },
@@ -275,7 +348,13 @@ export class Compiler {
                         viewWrapper: file.Document,
                         file,
                     }),
-                    prettify,
+                    {
+                        indent: prettify,
+                        declaration: {
+                            standalone: "yes",
+                            encoding: "UTF-8",
+                        },
+                    },
                 ),
                 path: "docProps/app.xml",
             },
@@ -285,7 +364,12 @@ export class Compiler {
                         viewWrapper: file.FootNotes,
                         file: file,
                     }),
-                    prettify,
+                    {
+                        indent: prettify,
+                        declaration: {
+                            encoding: "UTF-8",
+                        },
+                    },
                 ),
                 path: "word/footnotes.xml",
             },
@@ -295,7 +379,12 @@ export class Compiler {
                         viewWrapper: file.FootNotes,
                         file: file,
                     }),
-                    prettify,
+                    {
+                        indent: prettify,
+                        declaration: {
+                            encoding: "UTF-8",
+                        },
+                    },
                 ),
                 path: "word/_rels/footnotes.xml.rels",
             },
@@ -305,7 +394,13 @@ export class Compiler {
                         viewWrapper: file.Document,
                         file,
                     }),
-                    prettify,
+                    {
+                        indent: prettify,
+                        declaration: {
+                            standalone: "yes",
+                            encoding: "UTF-8",
+                        },
+                    },
                 ),
                 path: "word/settings.xml",
             },

src/file/border/border.spec.ts

@@ -0,0 +1,54 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+import { BorderStyle } from "file/border";
+
+import { BorderElement } from "./border";
+
+describe("BorderElement", () => {
+    describe("#constructor", () => {
+        it("should create a simple border element", () => {
+            const border = new BorderElement("w:top", {
+                style: BorderStyle.SINGLE,
+            });
+            const tree = new Formatter().format(border);
+            expect(tree).to.deep.equal({
+                "w:top": {
+                    _attr: {
+                        "w:val": "single",
+                    },
+                },
+            });
+        });
+        it("should create a simple border element with a size", () => {
+            const border = new BorderElement("w:top", {
+                style: BorderStyle.SINGLE,
+                size: 22,
+            });
+            const tree = new Formatter().format(border);
+            expect(tree).to.deep.equal({
+                "w:top": {
+                    _attr: {
+                        "w:val": "single",
+                        "w:sz": 22,
+                    },
+                },
+            });
+        });
+        it("should create a simple border element with space", () => {
+            const border = new BorderElement("w:top", {
+                style: BorderStyle.SINGLE,
+                space: 22,
+            });
+            const tree = new Formatter().format(border);
+            expect(tree).to.deep.equal({
+                "w:top": {
+                    _attr: {
+                        "w:val": "single",
+                        "w:space": 22,
+                    },
+                },
+            });
+        });
+    });
+});

src/file/border/border.ts

@@ -0,0 +1,86 @@
+// Note that the border type is identical in all places,
+// regardless of where it's used like paragraph/table/etc.
+// PageBorders are a superset, but we're not using any of those extras.
+//
+// http://officeopenxml.com/WPborders.php
+// http://officeopenxml.com/WPtableBorders.php
+// http://officeopenxml.com/WPtableCellProperties-Borders.php
+// http://officeopenxml.com/WPsectionBorders.php
+//
+// This describes the CT_Border type.
+// <xsd:complexType name="CT_Border">
+//     <xsd:attribute name="val" type="ST_Border" use="required"/>
+//     <xsd:attribute name="color" type="ST_HexColor" use="optional" default="auto"/>
+//     <xsd:attribute name="themeColor" type="ST_ThemeColor" use="optional"/>
+//     <xsd:attribute name="themeTint" type="ST_UcharHexNumber" use="optional"/>
+//     <xsd:attribute name="themeShade" type="ST_UcharHexNumber" use="optional"/>
+//     <xsd:attribute name="sz" type="ST_EighthPointMeasure" use="optional"/>
+//     <xsd:attribute name="space" type="ST_PointMeasure" use="optional" default="0"/>
+//     <xsd:attribute name="shadow" type="s:ST_OnOff" use="optional"/>
+//     <xsd:attribute name="frame" type="s:ST_OnOff" use="optional"/>
+// </xsd:complexType>
+import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+import { eighthPointMeasureValue, hexColorValue, pointMeasureValue } from "../values";
+
+export interface IBorderOptions {
+    readonly style: BorderStyle;
+    /** Border color, in hex (eg 'FF00AA') */
+    readonly color?: string;
+    /** Size of the border in 1/8 pt */
+    readonly size?: number;
+    /** Spacing offset. Values are specified in pt */
+    readonly space?: number;
+}
+
+export class BorderElement extends XmlComponent {
+    constructor(elementName: string, { color, size, space, style }: IBorderOptions) {
+        super(elementName);
+        this.root.push(
+            new BordersAttributes({
+                style,
+                color: color === undefined ? undefined : hexColorValue(color),
+                size: size === undefined ? undefined : eighthPointMeasureValue(size),
+                space: space === undefined ? undefined : pointMeasureValue(space),
+            }),
+        );
+    }
+}
+
+class BordersAttributes extends XmlAttributeComponent<IBorderOptions> {
+    protected readonly xmlKeys = {
+        style: "w:val",
+        color: "w:color",
+        size: "w:sz",
+        space: "w:space",
+    };
+}
+
+export enum BorderStyle {
+    SINGLE = "single",
+    DASH_DOT_STROKED = "dashDotStroked",
+    DASHED = "dashed",
+    DASH_SMALL_GAP = "dashSmallGap",
+    DOT_DASH = "dotDash",
+    DOT_DOT_DASH = "dotDotDash",
+    DOTTED = "dotted",
+    DOUBLE = "double",
+    DOUBLE_WAVE = "doubleWave",
+    INSET = "inset",
+    NIL = "nil",
+    NONE = "none",
+    OUTSET = "outset",
+    THICK = "thick",
+    THICK_THIN_LARGE_GAP = "thickThinLargeGap",
+    THICK_THIN_MEDIUM_GAP = "thickThinMediumGap",
+    THICK_THIN_SMALL_GAP = "thickThinSmallGap",
+    THIN_THICK_LARGE_GAP = "thinThickLargeGap",
+    THIN_THICK_MEDIUM_GAP = "thinThickMediumGap",
+    THIN_THICK_SMALL_GAP = "thinThickSmallGap",
+    THIN_THICK_THIN_LARGE_GAP = "thinThickThinLargeGap",
+    THIN_THICK_THIN_MEDIUM_GAP = "thinThickThinMediumGap",
+    THIN_THICK_THIN_SMALL_GAP = "thinThickThinSmallGap",
+    THREE_D_EMBOSS = "threeDEmboss",
+    THREE_D_ENGRAVE = "threeDEngrave",
+    TRIPLE = "triple",
+    WAVE = "wave",
+}

src/file/border/index.ts

@@ -0,0 +1 @@
+export * from "./border";

src/file/core-properties/components.ts

@@ -1,89 +0,0 @@
-import { XmlComponent } from "file/xml-components";
-import { DocumentAttributes } from "../document/document-attributes";
-
-export class Title extends XmlComponent {
-    constructor(value: string) {
-        super("dc:title");
-        this.root.push(value);
-    }
-}
-
-export class Subject extends XmlComponent {
-    constructor(value: string) {
-        super("dc:subject");
-        this.root.push(value);
-    }
-}
-
-export class Creator extends XmlComponent {
-    constructor(value: string) {
-        super("dc:creator");
-        this.root.push(value);
-    }
-}
-
-export class Keywords extends XmlComponent {
-    constructor(value: string) {
-        super("cp:keywords");
-        this.root.push(value);
-    }
-}
-
-export class Description extends XmlComponent {
-    constructor(value: string) {
-        super("dc:description");
-        this.root.push(value);
-    }
-}
-
-export class LastModifiedBy extends XmlComponent {
-    constructor(value: string) {
-        super("cp:lastModifiedBy");
-        this.root.push(value);
-    }
-}
-
-export class Revision extends XmlComponent {
-    constructor(value: string) {
-        super("cp:revision");
-        this.root.push(value);
-    }
-}
-
-export abstract class DateComponent extends XmlComponent {
-    protected getCurrentDate(): string {
-        const date = new Date();
-        const year = date.getFullYear();
-        const month = ("0" + (date.getMonth() + 1)).slice(-2);
-        const day = ("0" + date.getDate()).slice(-2);
-        const hours = ("0" + date.getHours()).slice(-2);
-        const minutes = ("0" + date.getMinutes()).slice(-2);
-        const seconds = ("0" + date.getSeconds()).slice(-2);
-
-        return year + "-" + month + "-" + day + "T" + hours + ":" + minutes + ":" + seconds + "Z";
-    }
-}
-
-export class Created extends DateComponent {
-    constructor() {
-        super("dcterms:created");
-        this.root.push(
-            new DocumentAttributes({
-                type: "dcterms:W3CDTF",
-            }),
-        );
-        this.root.push(this.getCurrentDate());
-    }
-}
-
-export class Modified extends DateComponent {
-    constructor() {
-        super("dcterms:modified");
-        this.root.push(
-            new DocumentAttributes({
-                type: "dcterms:W3CDTF",
-            }),
-        );
-        this.root.push(this.getCurrentDate());
-    }
-}

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

@@ -27,8 +27,7 @@ describe("Properties", () => {
             const tree = new Formatter().format(properties);
             expect(Object.keys(tree)).to.deep.equal(["cp:coreProperties"]);
             expect(tree["cp:coreProperties"]).to.be.an.instanceof(Array);
-            expect(Object.keys(tree["cp:coreProperties"][0])).to.deep.equal(["_attr"]);
-            expect(tree["cp:coreProperties"][1]).to.deep.equal({ "dc:title": ["test document"] });
+            expect(tree["cp:coreProperties"]).to.deep.include({ "dc:title": ["test document"] });
         });
 
         it("should create properties with all the attributes given", () => {
@@ -44,9 +43,9 @@ describe("Properties", () => {
             const tree = new Formatter().format(properties);
             expect(Object.keys(tree)).to.deep.equal(["cp:coreProperties"]);
             expect(tree["cp:coreProperties"]).to.be.an.instanceof(Array);
+
             const key = (obj) => Object.keys(obj)[0];
-            const props = tree["cp:coreProperties"].map(key).sort();
-            expect(props).to.deep.equal([
+            expect(tree["cp:coreProperties"].map(key)).to.include.members([
                 "_attr",
                 "cp:keywords",
                 "cp:lastModifiedBy",
@@ -58,7 +57,7 @@ describe("Properties", () => {
                 "dcterms:created",
                 "dcterms:modified",
             ]);
-            expect(tree["cp:coreProperties"].slice(1, -2).sort((a, b) => (key(a) < key(b) ? -1 : 1))).to.deep.equal([
+            expect(tree["cp:coreProperties"]).to.deep.include.members([
                 { "cp:keywords": ["test docx"] },
                 { "cp:lastModifiedBy": ["the author"] },
                 { "cp:revision": ["123"] },

src/file/core-properties/properties.ts

@@ -1,4 +1,4 @@
-import { XmlComponent } from "file/xml-components";
+import { StringContainer, XmlComponent } from "file/xml-components";
 import { ICustomPropertyOptions } from "../custom-properties";
 import { IDocumentBackgroundOptions } from "../document";
 
@@ -7,7 +7,7 @@ import { ISectionOptions } from "../file";
 import { INumberingOptions } from "../numbering";
 import { Paragraph } from "../paragraph";
 import { IStylesOptions } from "../styles";
-import { Created, Creator, Description, Keywords, LastModifiedBy, Modified, Revision, Subject, Title } from "./components";
+import { dateTimeValue } from "../values";
 
 export interface IPropertiesOptions {
     readonly sections: ISectionOptions[];
@@ -29,12 +29,35 @@ export interface IPropertiesOptions {
     readonly background?: IDocumentBackgroundOptions;
     readonly features?: {
         readonly trackRevisions?: boolean;
+        readonly updateFields?: boolean;
     };
     readonly compatabilityModeVersion?: number;
     readonly customProperties?: ICustomPropertyOptions[];
     readonly evenAndOddHeaderAndFooters?: boolean;
 }
 
+// <xs:element name="coreProperties" type="CT_CoreProperties"/>
+
+// <xs:complexType name="CT_CoreProperties">
+//   <xs:all>
+//     <xs:element name="category" minOccurs="0" maxOccurs="1" type="xs:string"/>
+//     <xs:element name="contentStatus" minOccurs="0" maxOccurs="1" type="xs:string"/>
+//     <xs:element ref="dcterms:created" minOccurs="0" maxOccurs="1"/>
+//     <xs:element ref="dc:creator" minOccurs="0" maxOccurs="1"/>
+//     <xs:element ref="dc:description" minOccurs="0" maxOccurs="1"/>
+//     <xs:element ref="dc:identifier" minOccurs="0" maxOccurs="1"/>
+//     <xs:element name="keywords" minOccurs="0" maxOccurs="1" type="CT_Keywords"/>
+//     <xs:element ref="dc:language" minOccurs="0" maxOccurs="1"/>
+//     <xs:element name="lastModifiedBy" minOccurs="0" maxOccurs="1" type="xs:string"/>
+//     <xs:element name="lastPrinted" minOccurs="0" maxOccurs="1" type="xs:dateTime"/>
+//     <xs:element ref="dcterms:modified" minOccurs="0" maxOccurs="1"/>
+//     <xs:element name="revision" minOccurs="0" maxOccurs="1" type="xs:string"/>
+//     <xs:element ref="dc:subject" minOccurs="0" maxOccurs="1"/>
+//     <xs:element ref="dc:title" minOccurs="0" maxOccurs="1"/>
+//     <xs:element name="version" minOccurs="0" maxOccurs="1" type="xs:string"/>
+//   </xs:all>
+// </xs:complexType>
+
 export class CoreProperties extends XmlComponent {
     constructor(options: Omit<IPropertiesOptions, "sections">) {
         super("cp:coreProperties");
@@ -48,27 +71,39 @@ export class CoreProperties extends XmlComponent {
             }),
         );
         if (options.title) {
-            this.root.push(new Title(options.title));
+            this.root.push(new StringContainer("dc:title", options.title));
         }
         if (options.subject) {
-            this.root.push(new Subject(options.subject));
+            this.root.push(new StringContainer("dc:subject", options.subject));
         }
         if (options.creator) {
-            this.root.push(new Creator(options.creator));
+            this.root.push(new StringContainer("dc:creator", options.creator));
         }
         if (options.keywords) {
-            this.root.push(new Keywords(options.keywords));
+            this.root.push(new StringContainer("cp:keywords", options.keywords));
         }
         if (options.description) {
-            this.root.push(new Description(options.description));
+            this.root.push(new StringContainer("dc:description", options.description));
         }
         if (options.lastModifiedBy) {
-            this.root.push(new LastModifiedBy(options.lastModifiedBy));
+            this.root.push(new StringContainer("cp:lastModifiedBy", options.lastModifiedBy));
         }
         if (options.revision) {
-            this.root.push(new Revision(options.revision));
+            this.root.push(new StringContainer("cp:revision", options.revision));
         }
-        this.root.push(new Created());
-        this.root.push(new Modified());
+        this.root.push(new TimestampElement("dcterms:created"));
+        this.root.push(new TimestampElement("dcterms:modified"));
+    }
+}
+
+class TimestampElement extends XmlComponent {
+    constructor(name: string) {
+        super(name);
+        this.root.push(
+            new DocumentAttributes({
+                type: "dcterms:W3CDTF",
+            }),
+        );
+        this.root.push(dateTimeValue(new Date()));
     }
 }

src/file/document-wrapper.ts

@@ -1,5 +1,5 @@
 import { Document, IDocumentOptions } from "./document";
-import { Footer } from "./footer";
+import { Footer } from "./footer/footer";
 import { FootNotes } from "./footnotes";
 import { Header } from "./header/header";
 import { Relationships } from "./relationships";

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

@@ -3,6 +3,7 @@ import { expect } from "chai";
 import { Formatter } from "export/formatter";
 
 import { Body } from "./body";
+import { sectionMarginDefaults } from "./section-properties";
 
 describe("Body", () => {
     let body: Body;
@@ -32,24 +33,23 @@ describe("Body", () => {
                             {
                                 "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:top": sectionMarginDefaults.TOP,
+                                        "w:right": sectionMarginDefaults.RIGHT,
+                                        "w:bottom": sectionMarginDefaults.BOTTOM,
+                                        "w:left": sectionMarginDefaults.LEFT,
+                                        "w:header": sectionMarginDefaults.HEADER,
+                                        "w:footer": sectionMarginDefaults.FOOTER,
+                                        "w:gutter": sectionMarginDefaults.GUTTER,
                                     },
                                 },
                             },
-                            { "w:cols": { _attr: { "w:space": 708, "w:sep": false, "w:num": 1 } } },
-                            { "w:docGrid": { _attr: { "w:linePitch": 360 } } },
                             {
                                 "w:pgNumType": {
                                     _attr: {},
                                 },
                             },
+                            // { "w:cols": { _attr: { "w:space": 708, "w:sep": false, "w:num": 1 } } },
+                            { "w:docGrid": { _attr: { "w:linePitch": 360 } } },
                         ],
                     },
                 ],

src/file/document/body/body.ts

@@ -1,6 +1,6 @@
 import { IContext, IXmlableObject, XmlComponent } from "file/xml-components";
 
-import { Paragraph, ParagraphProperties, TableOfContents } from "../..";
+import { Paragraph, ParagraphProperties } from "../..";
 import { ISectionPropertiesOptions, SectionProperties } from "./section-properties/section-properties";
 
 export class Body extends XmlComponent {
@@ -38,10 +38,6 @@ export class Body extends XmlComponent {
         this.root.push(component);
     }
 
-    public getTablesOfContents(): TableOfContents[] {
-        return this.root.filter((child) => child instanceof TableOfContents) as TableOfContents[];
-    }
-
     private createSectionParagraph(section: SectionProperties): Paragraph {
         const paragraph = new Paragraph({});
         const properties = new ParagraphProperties({});

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

@@ -1,13 +0,0 @@
-import { XmlAttributeComponent } from "file/xml-components";
-
-export class ColumnsAttributes extends XmlAttributeComponent<{
-    readonly space?: number;
-    readonly num?: number;
-    readonly separate?: boolean;
-}> {
-    protected readonly xmlKeys = {
-        space: "w:space",
-        num: "w:num",
-        separate: "w:sep",
-    };
-}

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

@@ -1,15 +0,0 @@
-import { XmlComponent } from "file/xml-components";
-import { ColumnsAttributes } from "./columns-attributes";
-
-export class Columns extends XmlComponent {
-    constructor(space: number, num: number, separate: boolean) {
-        super("w:cols");
-        this.root.push(
-            new ColumnsAttributes({
-                space: space,
-                num: num,
-                separate: separate,
-            }),
-        );
-    }
-}

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

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

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

@@ -1,13 +0,0 @@
-import { XmlComponent } from "file/xml-components";
-import { DocGridAttributes } from "./doc-grid-attributes";
-
-export class DocumentGrid extends XmlComponent {
-    constructor(linePitch: number) {
-        super("w:docGrid");
-        this.root.push(
-            new DocGridAttributes({
-                linePitch: linePitch,
-            }),
-        );
-    }
-}

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

@@ -1,17 +0,0 @@
-import { XmlAttributeComponent } from "file/xml-components";
-
-export enum FooterReferenceType {
-    DEFAULT = "default",
-    FIRST = "first",
-    EVEN = "even",
-}
-
-export class FooterReferenceAttributes extends XmlAttributeComponent<{
-    readonly type: string;
-    readonly id: string;
-}> {
-    protected readonly xmlKeys = {
-        type: "w:type",
-        id: "r:id",
-    };
-}

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

@@ -1,42 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "export/formatter";
-import { FooterReference } from "./footer-reference";
-import { FooterReferenceType } from "./footer-reference-attributes";
-
-describe("footerReference", () => {
-    it("should create", () => {
-        const footer = new FooterReference({
-            footerType: FooterReferenceType.DEFAULT,
-            footerId: 1,
-        });
-
-        const tree = new Formatter().format(footer);
-
-        expect(tree).to.deep.equal({
-            "w:footerReference": {
-                _attr: {
-                    "r:id": "rId1",
-                    "w:type": "default",
-                },
-            },
-        });
-    });
-
-    it("should create without a footer type", () => {
-        const footer = new FooterReference({
-            footerId: 1,
-        });
-
-        const tree = new Formatter().format(footer);
-
-        expect(tree).to.deep.equal({
-            "w:footerReference": {
-                _attr: {
-                    "r:id": "rId1",
-                    "w:type": "default",
-                },
-            },
-        });
-    });
-});

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

@@ -1,20 +0,0 @@
-import { XmlComponent } from "file/xml-components";
-import { FooterReferenceAttributes, FooterReferenceType } from "./footer-reference-attributes";
-
-export interface IFooterOptions {
-    readonly footerType?: FooterReferenceType;
-    readonly footerId?: number;
-}
-
-export class FooterReference extends XmlComponent {
-    constructor(options: IFooterOptions) {
-        super("w:footerReference");
-
-        this.root.push(
-            new FooterReferenceAttributes({
-                type: options.footerType || FooterReferenceType.DEFAULT,
-                id: `rId${options.footerId}`,
-            }),
-        );
-    }
-}

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

@@ -1,2 +0,0 @@
-export * from "./footer-reference";
-export * from "./footer-reference-attributes";

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

@@ -1,17 +0,0 @@
-import { XmlAttributeComponent } from "file/xml-components";
-
-export enum HeaderReferenceType {
-    DEFAULT = "default",
-    FIRST = "first",
-    EVEN = "even",
-}
-
-export class HeaderReferenceAttributes extends XmlAttributeComponent<{
-    readonly type: string;
-    readonly id: string;
-}> {
-    protected readonly xmlKeys = {
-        type: "w:type",
-        id: "r:id",
-    };
-}

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

@@ -1,42 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "export/formatter";
-import { HeaderReference } from "./header-reference";
-import { HeaderReferenceType } from "./header-reference-attributes";
-
-describe("HeaderReference", () => {
-    it("should create", () => {
-        const footer = new HeaderReference({
-            headerType: HeaderReferenceType.DEFAULT,
-            headerId: 1,
-        });
-
-        const tree = new Formatter().format(footer);
-
-        expect(tree).to.deep.equal({
-            "w:headerReference": {
-                _attr: {
-                    "r:id": "rId1",
-                    "w:type": "default",
-                },
-            },
-        });
-    });
-
-    it("should create without a header type", () => {
-        const footer = new HeaderReference({
-            headerId: 1,
-        });
-
-        const tree = new Formatter().format(footer);
-
-        expect(tree).to.deep.equal({
-            "w:headerReference": {
-                _attr: {
-                    "r:id": "rId1",
-                    "w:type": "default",
-                },
-            },
-        });
-    });
-});

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

@@ -1,19 +0,0 @@
-import { XmlComponent } from "file/xml-components";
-import { HeaderReferenceAttributes, HeaderReferenceType } from "./header-reference-attributes";
-
-export interface IHeaderReferenceOptions {
-    readonly headerType?: HeaderReferenceType;
-    readonly headerId?: number;
-}
-
-export class HeaderReference extends XmlComponent {
-    constructor(options: IHeaderReferenceOptions) {
-        super("w:headerReference");
-        this.root.push(
-            new HeaderReferenceAttributes({
-                type: options.headerType || HeaderReferenceType.DEFAULT,
-                id: `rId${options.headerId}`,
-            }),
-        );
-    }
-}

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

@@ -1,2 +0,0 @@
-export * from "./header-reference";
-export * from "./header-reference-attributes";

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

@@ -1,9 +1,2 @@
 export * from "./section-properties";
-export * from "./footer-reference";
-export * from "./header-reference";
-export * from "./page-size";
-export * from "./page-number";
-export * from "./page-border";
-export * from "./line-number";
-export * from "./vertical-align";
-export * from "./type";
+export * from "./properties";

src/file/document/body/section-properties/line-number/index.ts

@@ -1 +0,0 @@
-export * from "./line-number";

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

@@ -1,38 +0,0 @@
-// http://officeopenxml.com/WPsectionLineNumbering.php
-import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
-
-export enum LineNumberRestartFormat {
-    CONTINUOUS = "continuous",
-    NEW_SECTION = "newSection",
-    NEW_PAGE = "newPage",
-}
-
-export interface ILineNumberAttributes {
-    readonly countBy?: number;
-    readonly start?: number;
-    readonly restart?: LineNumberRestartFormat;
-    readonly distance?: number;
-}
-
-export class LineNumberAttributes extends XmlAttributeComponent<ILineNumberAttributes> {
-    protected readonly xmlKeys = {
-        countBy: "w:countBy",
-        start: "w:start",
-        restart: "w:restart",
-        distance: "w:distance",
-    };
-}
-
-export class LineNumberType extends XmlComponent {
-    constructor(countBy?: number, start?: number, restart?: LineNumberRestartFormat, dist?: number) {
-        super("w:lnNumType");
-        this.root.push(
-            new LineNumberAttributes({
-                countBy: countBy,
-                start: start,
-                restart: restart,
-                distance: dist,
-            }),
-        );
-    }
-}

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

@@ -1 +0,0 @@
-export * from "./page-borders";

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

@@ -1,100 +0,0 @@
-// http://officeopenxml.com/WPsectionBorders.php
-import { BorderStyle } from "file/styles";
-import { IgnoreIfEmptyXmlComponent, XmlAttributeComponent, XmlComponent } from "file/xml-components";
-
-export enum PageBorderDisplay {
-    ALL_PAGES = "allPages",
-    FIRST_PAGE = "firstPage",
-    NOT_FIRST_PAGE = "notFirstPage",
-}
-
-export enum PageBorderOffsetFrom {
-    PAGE = "page",
-    TEXT = "text",
-}
-
-export enum PageBorderZOrder {
-    BACK = "back",
-    FRONT = "front",
-}
-
-export interface IPageBorderAttributes {
-    readonly display?: PageBorderDisplay;
-    readonly offsetFrom?: PageBorderOffsetFrom;
-    readonly zOrder?: PageBorderZOrder;
-}
-
-export interface IPageBorderConfiguration {
-    readonly style?: BorderStyle;
-    readonly size?: number;
-    readonly color?: string;
-    readonly space?: number;
-}
-
-export interface IPageBordersOptions {
-    readonly pageBorders?: IPageBorderAttributes;
-    readonly pageBorderTop?: IPageBorderConfiguration;
-    readonly pageBorderRight?: IPageBorderConfiguration;
-    readonly pageBorderBottom?: IPageBorderConfiguration;
-    readonly pageBorderLeft?: IPageBorderConfiguration;
-}
-
-class PageBordeAttributes extends XmlAttributeComponent<IPageBorderConfiguration> {
-    protected readonly xmlKeys = {
-        style: "w:val",
-        size: "w:size",
-        color: "w:color",
-        space: "w:space",
-    };
-}
-
-class PageBorder extends XmlComponent {
-    constructor(key: string, options: IPageBorderConfiguration) {
-        super(key);
-
-        this.root.push(new PageBordeAttributes(options));
-    }
-}
-
-class PageBordersAttributes extends XmlAttributeComponent<IPageBorderAttributes> {
-    protected readonly xmlKeys = {
-        display: "w:display",
-        offsetFrom: "w:offsetFrom",
-        zOrder: "w:zOrder",
-    };
-}
-
-export class PageBorders extends IgnoreIfEmptyXmlComponent {
-    constructor(options?: IPageBordersOptions) {
-        super("w:pgBorders");
-
-        if (!options) {
-            return;
-        }
-
-        if (options.pageBorders) {
-            this.root.push(
-                new PageBordersAttributes({
-                    display: options.pageBorders.display,
-                    offsetFrom: options.pageBorders.offsetFrom,
-                    zOrder: options.pageBorders.zOrder,
-                }),
-            );
-        } else {
-            this.root.push(new PageBordersAttributes({}));
-        }
-
-        if (options.pageBorderTop) {
-            this.root.push(new PageBorder("w:top", options.pageBorderTop));
-        }
-        if (options.pageBorderRight) {
-            this.root.push(new PageBorder("w:right", options.pageBorderRight));
-        }
-        if (options.pageBorderBottom) {
-            this.root.push(new PageBorder("w:bottom", options.pageBorderBottom));
-        }
-        if (options.pageBorderLeft) {
-            this.root.push(new PageBorder("w:left", options.pageBorderLeft));
-        }
-    }
-}

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

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

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

@@ -1,20 +0,0 @@
-import { XmlComponent } from "file/xml-components";
-import { PageMarginAttributes } from "./page-margin-attributes";
-
-export class PageMargin extends XmlComponent {
-    constructor(top: number, right: number, bottom: number, left: number, header: number, footer: number, gutter: number, mirror: boolean) {
-        super("w:pgMar");
-        this.root.push(
-            new PageMarginAttributes({
-                top: top,
-                right: right,
-                bottom: bottom,
-                left: left,
-                header: header,
-                footer: footer,
-                gutter: gutter,
-                mirror: mirror,
-            }),
-        );
-    }
-}

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

@@ -1 +0,0 @@
-export * from "./page-number";

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

@@ -1,53 +0,0 @@
-// http://officeopenxml.com/WPSectionPgNumType.php
-import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
-
-export enum PageNumberFormat {
-    CARDINAL_TEXT = "cardinalText",
-    DECIMAL = "decimal",
-    DECIMAL_ENCLOSED_CIRCLE = "decimalEnclosedCircle",
-    DECIMAL_ENCLOSED_FULL_STOP = "decimalEnclosedFullstop",
-    DECIMAL_ENCLOSED_PAREN = "decimalEnclosedParen",
-    DECIMAL_ZERO = "decimalZero",
-    LOWER_LETTER = "lowerLetter",
-    LOWER_ROMAN = "lowerRoman",
-    NONE = "none",
-    ORDINAL_TEXT = "ordinalText",
-    UPPER_LETTER = "upperLetter",
-    UPPER_ROMAN = "upperRoman",
-    DECIMAL_FULL_WIDTH = "decimalFullWidth",
-}
-
-export enum PageNumberSeparator {
-    COLON = "colon",
-    EM_DASH = "emDash",
-    EN_DASH = "endash",
-    HYPHEN = "hyphen",
-    PERIOD = "period",
-}
-
-export interface IPageNumberTypeAttributes {
-    readonly start?: number;
-    readonly formatType?: PageNumberFormat;
-    readonly separator?: PageNumberSeparator;
-}
-
-export class PageNumberTypeAttributes extends XmlAttributeComponent<IPageNumberTypeAttributes> {
-    protected readonly xmlKeys = {
-        start: "w:start",
-        formatType: "w:fmt",
-        separator: "w:chapSep",
-    };
-}
-
-export class PageNumberType extends XmlComponent {
-    constructor(start?: number, numberFormat?: PageNumberFormat, separator?: PageNumberSeparator) {
-        super("w:pgNumType");
-        this.root.push(
-            new PageNumberTypeAttributes({
-                start: start,
-                formatType: numberFormat,
-                separator: separator,
-            }),
-        );
-    }
-}

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

@@ -1,2 +0,0 @@
-export * from "./page-size";
-export * from "./page-size-attributes";

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

@@ -1,20 +0,0 @@
-import { XmlAttributeComponent } from "file/xml-components";
-
-export enum PageOrientation {
-    PORTRAIT = "portrait",
-    LANDSCAPE = "landscape",
-}
-
-export interface IPageSizeAttributes {
-    readonly width?: number;
-    readonly height?: number;
-    readonly orientation?: PageOrientation;
-}
-
-export class PageSizeAttributes extends XmlAttributeComponent<IPageSizeAttributes> {
-    protected readonly xmlKeys = {
-        width: "w:w",
-        height: "w:h",
-        orientation: "w:orient",
-    };
-}

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

@@ -1,18 +0,0 @@
-import { XmlComponent } from "file/xml-components";
-import { PageOrientation, PageSizeAttributes } from "./page-size-attributes";
-
-export class PageSize extends XmlComponent {
-    constructor(width: number, height: number, orientation: PageOrientation) {
-        super("w:pgSz");
-
-        const flip = orientation === PageOrientation.LANDSCAPE;
-
-        this.root.push(
-            new PageSizeAttributes({
-                width: flip ? height : width,
-                height: flip ? width : height,
-                orientation: orientation,
-            }),
-        );
-    }
-}

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

@@ -0,0 +1,26 @@
+import { twipsMeasureValue } from "file/values";
+import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+
+export interface IColumnAttributes {
+    readonly width: number | string;
+    readonly space?: number | string;
+}
+
+export class ColumnAttributes extends XmlAttributeComponent<IColumnAttributes> {
+    protected readonly xmlKeys = {
+        width: "w:w",
+        space: "w:space",
+    };
+}
+
+export class Column extends XmlComponent {
+    constructor({ width, space }: IColumnAttributes) {
+        super("w:col");
+        this.root.push(
+            new ColumnAttributes({
+                width: twipsMeasureValue(width),
+                space: space === undefined ? undefined : twipsMeasureValue(space),
+            }),
+        );
+    }
+}

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

@@ -0,0 +1,38 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { Column, Columns } from ".";
+
+describe("Columns", () => {
+    describe("#constructor()", () => {
+        it("should create columns of equal width if equalWidth is true", () => {
+            const columns = new Columns({ count: 3, space: 720 });
+            const tree = new Formatter().format(columns);
+
+            expect(tree["w:cols"]).to.deep.equal({ _attr: { "w:num": 3, "w:space": 720 } });
+        });
+
+        it("should ignore individual column attributes if equalWidth is true", () => {
+            const unequalColumns = [new Column({ width: 1000, space: 400 }), new Column({ width: 2000 })];
+            const columns = new Columns({ count: 3, space: 720, equalWidth: true, children: unequalColumns });
+            const tree = new Formatter().format(columns);
+
+            expect(tree).to.deep.equal({ "w:cols": { _attr: { "w:num": 3, "w:space": 720, "w:equalWidth": true } } });
+        });
+
+        it("should have column children if equalWidth is false and individual columns are provided", () => {
+            const unequalColumns = [new Column({ width: 1000, space: 400 }), new Column({ width: 2000 })];
+            const columns = new Columns({ count: 3, space: 720, equalWidth: false, children: unequalColumns });
+            const tree = new Formatter().format(columns);
+
+            expect(tree).to.deep.equal({
+                "w:cols": [
+                    { _attr: { "w:num": 3, "w:space": 720, "w:equalWidth": false } },
+                    { "w:col": { _attr: { "w:space": 400, "w:w": 1000 } } },
+                    { "w:col": { _attr: { "w:w": 2000 } } },
+                ],
+            });
+        });
+    });
+});

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

@@ -0,0 +1,47 @@
+import { decimalNumber, twipsMeasureValue } from "file/values";
+import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+import { Column } from "./column";
+
+// <xsd:complexType name="CT_Columns">
+//     <xsd:sequence minOccurs="0">
+//         <xsd:element name="col" type="CT_Column" maxOccurs="45"/>
+//     </xsd:sequence>
+//     <xsd:attribute name="equalWidth" type="s:ST_OnOff" use="optional"/>
+//     <xsd:attribute name="space" type="s:ST_TwipsMeasure" use="optional" default="720"/>
+//     <xsd:attribute name="num" type="ST_DecimalNumber" use="optional" default="1"/>
+//     <xsd:attribute name="sep" type="s:ST_OnOff" use="optional"/>
+// </xsd:complexType>
+export interface IColumnsAttributes {
+    readonly space?: number | string;
+    readonly count?: number;
+    readonly separate?: boolean;
+    readonly equalWidth?: boolean;
+    readonly children?: Column[];
+}
+
+export class ColumnsAttributes extends XmlAttributeComponent<IColumnsAttributes> {
+    protected readonly xmlKeys = {
+        space: "w:space",
+        count: "w:num",
+        separate: "w:sep",
+        equalWidth: "w:equalWidth",
+    };
+}
+
+export class Columns extends XmlComponent {
+    constructor({ space, count, separate, equalWidth, children }: IColumnsAttributes) {
+        super("w:cols");
+        this.root.push(
+            new ColumnsAttributes({
+                space: space === undefined ? undefined : twipsMeasureValue(space),
+                count: count === undefined ? undefined : decimalNumber(count),
+                separate,
+                equalWidth,
+            }),
+        );
+
+        if (!equalWidth && children) {
+            children.forEach((column) => this.addChildElement(column));
+        }
+    }
+}

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

@@ -0,0 +1,38 @@
+import { decimalNumber } from "file/values";
+import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+
+// not implemented
+// <xsd:simpleType name="ST_DocGrid">
+// <xsd:restriction base="xsd:string">
+//   <xsd:enumeration value="default"/>
+//   <xsd:enumeration value="lines"/>
+//   <xsd:enumeration value="linesAndChars"/>
+//   <xsd:enumeration value="snapToChars"/>
+// </xsd:restriction>
+// </xsd:simpleType>
+
+// <xsd:complexType name="CT_DocGrid">
+//     <xsd:attribute name="type" type="ST_DocGrid"/>
+//     <xsd:attribute name="linePitch" type="ST_DecimalNumber"/>
+//     <xsd:attribute name="charSpace" type="ST_DecimalNumber"/>
+// </xsd:complexType>
+export interface IDocGridAttributesProperties {
+    readonly linePitch?: number;
+}
+
+export class DocGridAttributes extends XmlAttributeComponent<IDocGridAttributesProperties> {
+    protected readonly xmlKeys = {
+        linePitch: "w:linePitch",
+    };
+}
+
+export class DocumentGrid extends XmlComponent {
+    constructor(linePitch: number) {
+        super("w:docGrid");
+        this.root.push(
+            new DocGridAttributes({
+                linePitch: decimalNumber(linePitch),
+            }),
+        );
+    }
+}

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

@@ -0,0 +1,56 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+import { HeaderFooterReference, HeaderFooterReferenceType, HeaderFooterType } from "./header-footer-reference";
+
+describe("HeaderFooterReference", () => {
+    it("#constructor (footer)", () => {
+        const footer = new HeaderFooterReference(HeaderFooterType.FOOTER, {
+            type: HeaderFooterReferenceType.DEFAULT,
+            id: 1,
+        });
+
+        const tree = new Formatter().format(footer);
+        expect(tree).to.deep.equal({
+            "w:footerReference": {
+                _attr: {
+                    "r:id": "rId1",
+                    "w:type": "default",
+                },
+            },
+        });
+    });
+
+    it("#constructor (header)", () => {
+        const header = new HeaderFooterReference(HeaderFooterType.HEADER, {
+            type: HeaderFooterReferenceType.DEFAULT,
+            id: 1,
+        });
+
+        const tree = new Formatter().format(header);
+        expect(tree).to.deep.equal({
+            "w:headerReference": {
+                _attr: {
+                    "r:id": "rId1",
+                    "w:type": "default",
+                },
+            },
+        });
+    });
+
+    it("should create without a type", () => {
+        const footer = new HeaderFooterReference(HeaderFooterType.FOOTER, {
+            id: 1,
+        });
+
+        const tree = new Formatter().format(footer);
+        expect(tree).to.deep.equal({
+            "w:footerReference": {
+                _attr: {
+                    "r:id": "rId1",
+                    "w:type": "default",
+                },
+            },
+        });
+    });
+});

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

@@ -0,0 +1,65 @@
+import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+
+// <xsd:simpleType name="ST_HdrFtr">
+// <xsd:restriction base="xsd:string">
+//   <xsd:enumeration value="even"/>
+//   <xsd:enumeration value="default"/>
+//   <xsd:enumeration value="first"/>
+// </xsd:restriction>
+// </xsd:simpleType>
+export enum HeaderFooterReferenceType {
+    DEFAULT = "default",
+    FIRST = "first",
+    EVEN = "even",
+}
+
+// </xsd:complexType>
+// <xsd:group name="EG_HdrFtrReferences">
+// <xsd:choice>
+//   <xsd:element name="headerReference" type="CT_HdrFtrRef" minOccurs="0"/>
+//   <xsd:element name="footerReference" type="CT_HdrFtrRef" minOccurs="0"/>
+// </xsd:choice>
+// </xsd:group>
+
+// <xsd:complexType name="CT_HdrFtrRef">
+// <xsd:complexContent>
+//   <xsd:extension base="CT_Rel">
+//     <xsd:attribute name="type" type="ST_HdrFtr" use="required"/>
+//   </xsd:extension>
+// </xsd:complexContent>
+
+// <xsd:complexType name="CT_Rel">
+//   <xsd:attribute ref="r:id" use="required"/>
+// </xsd:complexType>
+
+export interface IHeaderFooterOptions {
+    readonly type?: HeaderFooterReferenceType;
+    readonly id?: number;
+}
+
+class FooterReferenceAttributes extends XmlAttributeComponent<{
+    readonly type: HeaderFooterReferenceType;
+    readonly id: string;
+}> {
+    protected readonly xmlKeys = {
+        type: "w:type",
+        id: "r:id",
+    };
+}
+
+export enum HeaderFooterType {
+    HEADER = "w:headerReference",
+    FOOTER = "w:footerReference",
+}
+export class HeaderFooterReference extends XmlComponent {
+    constructor(type: HeaderFooterType, options: IHeaderFooterOptions) {
+        super(type);
+
+        this.root.push(
+            new FooterReferenceAttributes({
+                type: options.type || HeaderFooterReferenceType.DEFAULT,
+                id: `rId${options.id}`,
+            }),
+        );
+    }
+}

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

@@ -0,0 +1,12 @@
+export * from "./column";
+export * from "./columns";
+export * from "./doc-grid";
+// export * from "./header-reference";
+export * from "./page-size";
+export * from "./page-number";
+export * from "./page-borders";
+export * from "./page-margin";
+export * from "./page-borders";
+export * from "./line-number";
+export * from "./section-type";
+export * from "./header-footer-reference";

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

@@ -0,0 +1,53 @@
+// http://officeopenxml.com/WPsectionLineNumbering.php
+import { decimalNumber, twipsMeasureValue } from "file/values";
+import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+
+// <xsd:simpleType name="ST_LineNumberRestart">
+// <xsd:restriction base="xsd:string">
+//   <xsd:enumeration value="newPage"/>
+//   <xsd:enumeration value="newSection"/>
+//   <xsd:enumeration value="continuous"/>
+// </xsd:restriction>
+// </xsd:simpleType>
+export enum LineNumberRestartFormat {
+    NEW_PAGE = "newPage",
+    NEW_SECTION = "newSection",
+    CONTINUOUS = "continuous",
+}
+
+// <xsd:complexType name="CT_LineNumber">
+//     <xsd:attribute name="countBy" type="ST_DecimalNumber" use="optional"/>
+//     <xsd:attribute name="start" type="ST_DecimalNumber" use="optional" default="1"/>
+//     <xsd:attribute name="distance" type="s:ST_TwipsMeasure" use="optional"/>
+//     <xsd:attribute name="restart" type="ST_LineNumberRestart" use="optional" default="newPage"/>
+// </xsd:complexType>
+
+export interface ILineNumberAttributes {
+    readonly countBy?: number;
+    readonly start?: number;
+    readonly restart?: LineNumberRestartFormat;
+    readonly distance?: number | string;
+}
+
+export class LineNumberAttributes extends XmlAttributeComponent<ILineNumberAttributes> {
+    protected readonly xmlKeys = {
+        countBy: "w:countBy",
+        start: "w:start",
+        restart: "w:restart",
+        distance: "w:distance",
+    };
+}
+
+export class LineNumberType extends XmlComponent {
+    constructor({ countBy, start, restart, distance }: ILineNumberAttributes) {
+        super("w:lnNumType");
+        this.root.push(
+            new LineNumberAttributes({
+                countBy: countBy === undefined ? undefined : decimalNumber(countBy),
+                start: start === undefined ? undefined : decimalNumber(start),
+                restart,
+                distance: distance === undefined ? undefined : twipsMeasureValue(distance),
+            }),
+        );
+    }
+}

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

@@ -1,7 +1,7 @@
 import { expect } from "chai";
 
 import { Formatter } from "export/formatter";
-import { BorderStyle } from "file/styles";
+import { BorderStyle } from "file/border";
 
 import { PageBorderDisplay, PageBorders, PageBorderZOrder } from "./page-borders";
 
@@ -70,22 +70,22 @@ describe("PageBorders", () => {
             expect(tree["w:pgBorders"][0]).to.deep.equal({ _attr: { "w:display": "firstPage", "w:zOrder": "back" } });
             expect(tree["w:pgBorders"][1]).to.deep.equal({
                 "w:top": {
-                    _attr: { "w:color": "001122", "w:size": 10, "w:val": "doubleWave" },
+                    _attr: { "w:color": "001122", "w:sz": 10, "w:val": "doubleWave" },
                 },
             });
             expect(tree["w:pgBorders"][2]).to.deep.equal({
-                "w:right": {
-                    _attr: { "w:color": "223344", "w:size": 20, "w:val": "double" },
+                "w:left": {
+                    _attr: { "w:color": "889900", "w:sz": 40, "w:val": "dotted" },
                 },
             });
             expect(tree["w:pgBorders"][3]).to.deep.equal({
                 "w:bottom": {
-                    _attr: { "w:color": "556677", "w:size": 30, "w:val": "single" },
+                    _attr: { "w:color": "556677", "w:sz": 30, "w:val": "single" },
                 },
             });
             expect(tree["w:pgBorders"][4]).to.deep.equal({
-                "w:left": {
-                    _attr: { "w:color": "889900", "w:size": 40, "w:val": "dotted" },
+                "w:right": {
+                    _attr: { "w:color": "223344", "w:sz": 20, "w:val": "double" },
                 },
             });
         });

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

@@ -0,0 +1,106 @@
+// http://officeopenxml.com/WPsectionBorders.php
+import { BorderElement, IBorderOptions } from "file/border";
+import { IgnoreIfEmptyXmlComponent, XmlAttributeComponent } from "file/xml-components";
+
+// <xsd:simpleType name="ST_PageBorderDisplay">
+// <xsd:restriction base="xsd:string">
+//   <xsd:enumeration value="allPages"/>
+//   <xsd:enumeration value="firstPage"/>
+//   <xsd:enumeration value="notFirstPage"/>
+// </xsd:restriction>
+// </xsd:simpleType>
+export enum PageBorderDisplay {
+    ALL_PAGES = "allPages",
+    FIRST_PAGE = "firstPage",
+    NOT_FIRST_PAGE = "notFirstPage",
+}
+
+// <xsd:simpleType name="ST_PageBorderOffset">
+// <xsd:restriction base="xsd:string">
+//   <xsd:enumeration value="page"/>
+//   <xsd:enumeration value="text"/>
+// </xsd:restriction>
+// </xsd:simpleType>
+export enum PageBorderOffsetFrom {
+    PAGE = "page",
+    TEXT = "text",
+}
+
+// <xsd:simpleType name="ST_PageBorderZOrder">
+// <xsd:restriction base="xsd:string">
+//   <xsd:enumeration value="front"/>
+//   <xsd:enumeration value="back"/>
+// </xsd:restriction>
+// </xsd:simpleType>
+export enum PageBorderZOrder {
+    BACK = "back",
+    FRONT = "front",
+}
+
+export interface IPageBorderAttributes {
+    readonly display?: PageBorderDisplay;
+    readonly offsetFrom?: PageBorderOffsetFrom;
+    readonly zOrder?: PageBorderZOrder;
+}
+
+export interface IPageBordersOptions {
+    readonly pageBorders?: IPageBorderAttributes;
+    readonly pageBorderTop?: IBorderOptions;
+    readonly pageBorderRight?: IBorderOptions;
+    readonly pageBorderBottom?: IBorderOptions;
+    readonly pageBorderLeft?: IBorderOptions;
+}
+
+class PageBordersAttributes extends XmlAttributeComponent<IPageBorderAttributes> {
+    protected readonly xmlKeys = {
+        display: "w:display",
+        offsetFrom: "w:offsetFrom",
+        zOrder: "w:zOrder",
+    };
+}
+
+// <xsd:complexType name="CT_PageBorders">
+// <xsd:sequence>
+//   <xsd:element name="top" type="CT_TopPageBorder" minOccurs="0"/>
+//   <xsd:element name="left" type="CT_PageBorder" minOccurs="0"/>
+//   <xsd:element name="bottom" type="CT_BottomPageBorder" minOccurs="0"/>
+//   <xsd:element name="right" type="CT_PageBorder" minOccurs="0"/>
+// </xsd:sequence>
+// <xsd:attribute name="zOrder" type="ST_PageBorderZOrder" use="optional" default="front"/>
+// <xsd:attribute name="display" type="ST_PageBorderDisplay" use="optional"/>
+// <xsd:attribute name="offsetFrom" type="ST_PageBorderOffset" use="optional" default="text"/>
+// </xsd:complexType>
+export class PageBorders extends IgnoreIfEmptyXmlComponent {
+    constructor(options?: IPageBordersOptions) {
+        super("w:pgBorders");
+
+        if (!options) {
+            return;
+        }
+
+        if (options.pageBorders) {
+            this.root.push(
+                new PageBordersAttributes({
+                    display: options.pageBorders.display,
+                    offsetFrom: options.pageBorders.offsetFrom,
+                    zOrder: options.pageBorders.zOrder,
+                }),
+            );
+        } else {
+            this.root.push(new PageBordersAttributes({}));
+        }
+
+        if (options.pageBorderTop) {
+            this.root.push(new BorderElement("w:top", options.pageBorderTop));
+        }
+        if (options.pageBorderLeft) {
+            this.root.push(new BorderElement("w:left", options.pageBorderLeft));
+        }
+        if (options.pageBorderBottom) {
+            this.root.push(new BorderElement("w:bottom", options.pageBorderBottom));
+        }
+        if (options.pageBorderRight) {
+            this.root.push(new BorderElement("w:right", options.pageBorderRight));
+        }
+    }
+}

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

@@ -0,0 +1,58 @@
+import { signedTwipsMeasureValue, twipsMeasureValue } from "file/values";
+import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+
+// <xsd:complexType name="CT_PageMar">
+//     <xsd:attribute name="top" type="ST_SignedTwipsMeasure" use="required"/>
+//     <xsd:attribute name="right" type="s:ST_TwipsMeasure" use="required"/>
+//     <xsd:attribute name="bottom" type="ST_SignedTwipsMeasure" use="required"/>
+//     <xsd:attribute name="left" type="s:ST_TwipsMeasure" use="required"/>
+//     <xsd:attribute name="header" type="s:ST_TwipsMeasure" use="required"/>
+//     <xsd:attribute name="footer" type="s:ST_TwipsMeasure" use="required"/>
+//     <xsd:attribute name="gutter" type="s:ST_TwipsMeasure" use="required"/>
+// </xsd:complexType>
+export interface IPageMarginAttributes {
+    readonly top?: number | string;
+    readonly right?: number | string;
+    readonly bottom?: number | string;
+    readonly left?: number | string;
+    readonly header?: number | string;
+    readonly footer?: number | string;
+    readonly gutter?: number | string;
+}
+
+export class PageMarginAttributes extends XmlAttributeComponent<IPageMarginAttributes> {
+    protected readonly xmlKeys = {
+        top: "w:top",
+        right: "w:right",
+        bottom: "w:bottom",
+        left: "w:left",
+        header: "w:header",
+        footer: "w:footer",
+        gutter: "w:gutter",
+    };
+}
+
+export class PageMargin extends XmlComponent {
+    constructor(
+        top: number | string,
+        right: number | string,
+        bottom: number | string,
+        left: number | string,
+        header: number | string,
+        footer: number | string,
+        gutter: number | string,
+    ) {
+        super("w:pgMar");
+        this.root.push(
+            new PageMarginAttributes({
+                top: signedTwipsMeasureValue(top),
+                right: twipsMeasureValue(right),
+                bottom: signedTwipsMeasureValue(bottom),
+                left: twipsMeasureValue(left),
+                header: twipsMeasureValue(header),
+                footer: twipsMeasureValue(footer),
+                gutter: twipsMeasureValue(gutter),
+            }),
+        );
+    }
+}

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

@@ -0,0 +1,54 @@
+// http://officeopenxml.com/WPSectionPgNumType.php
+import { NumberFormat } from "file/shared/number-format";
+import { decimalNumber } from "file/values";
+import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+
+// <xsd:simpleType name="ST_ChapterSep">
+// <xsd:restriction base="xsd:string">
+//   <xsd:enumeration value="hyphen"/>
+//   <xsd:enumeration value="period"/>
+//   <xsd:enumeration value="colon"/>
+//   <xsd:enumeration value="emDash"/>
+//   <xsd:enumeration value="enDash"/>
+// </xsd:restriction>
+// </xsd:simpleType>
+export enum PageNumberSeparator {
+    HYPHEN = "hyphen",
+    PERIOD = "period",
+    COLON = "colon",
+    EM_DASH = "emDash",
+    EN_DASH = "endash",
+}
+
+export interface IPageNumberTypeAttributes {
+    readonly start?: number;
+    readonly formatType?: NumberFormat;
+    readonly separator?: PageNumberSeparator;
+}
+
+// <xsd:complexType name="CT_PageNumber">
+//     <xsd:attribute name="fmt" type="ST_NumberFormat" use="optional" default="decimal"/>
+//     <xsd:attribute name="start" type="ST_DecimalNumber" use="optional"/>
+//     <xsd:attribute name="chapStyle" type="ST_DecimalNumber" use="optional"/>
+//     <xsd:attribute name="chapSep" type="ST_ChapterSep" use="optional" default="hyphen"/>
+// </xsd:complexType>
+
+export class PageNumberTypeAttributes extends XmlAttributeComponent<IPageNumberTypeAttributes> {
+    protected readonly xmlKeys = {
+        start: "w:start",
+        formatType: "w:fmt",
+        separator: "w:chapSep",
+    };
+}
+export class PageNumberType extends XmlComponent {
+    constructor({ start, formatType, separator }: IPageNumberTypeAttributes) {
+        super("w:pgNumType");
+        this.root.push(
+            new PageNumberTypeAttributes({
+                start: start === undefined ? undefined : decimalNumber(start),
+                formatType,
+                separator,
+            }),
+        );
+    }
+}

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

@@ -2,8 +2,7 @@ import { expect } from "chai";
 
 import { Formatter } from "export/formatter";
 
-import { PageSize } from "./page-size";
-import { PageOrientation } from "./page-size-attributes";
+import { PageOrientation, PageSize } from "./page-size";
 
 describe("PageSize", () => {
     describe("#constructor()", () => {