Version bump

#1256 Add page border demos

.editorconfig

@@ -7,6 +7,7 @@ indent_style = space
 indent_size = 4
 insert_final_newline = true
 trim_trailing_whitespace = true
+end_of_line = lf
 
 [*.md]
 max_line_length = off

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,9 @@
+# Thank you for raising an issue to `docx`
+
+Please do not raise an issue unless it is an **issue**.
+
+-   Is your issue a feature request? Are you giving ideas to the community? Are you asking for help? Please raise a ticket in the `Discussions` section:
+
+    https://github.com/dolanmiu/docx/discussions
+
+-   Is your issue a previously asked? Please respond to that thread instead

.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

@@ -0,0 +1,60 @@
+name: Default
+on:
+    push:
+        branches:
+            - master
+    pull_request:
+        branches:
+            - master
+
+jobs:
+    build:
+        name: Build
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout Repo
+              uses: actions/checkout@master
+            - name: Install Dependencies
+              run: npm ci
+            - name: Build
+              run: npm run build
+            - name: Archive Production Artifact
+              uses: actions/upload-artifact@master
+              with:
+                  name: build
+                  path: build
+    test:
+        name: Test
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout Repo
+              uses: actions/checkout@master
+            - name: Install Dependencies
+              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
+        steps:
+            - name: Checkout Repo
+              uses: actions/checkout@master
+            - name: Install Dependencies
+              run: npm ci
+            - name: Lint
+              run: npm run lint
+    prettier:
+        name: Prettier
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout Repo
+              uses: actions/checkout@master
+            - name: Install Dependencies
+              run: npm ci
+            - name: Prettier
+              run: npm run style

.github/workflows/demos.yml

@@ -0,0 +1,690 @@
+name: Demos
+on:
+    push:
+        branches:
+            - master
+    pull_request:
+        branches:
+            - master
+
+jobs:
+    build:
+        name: Build
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout Repo
+              uses: actions/checkout@master
+            - name: Install Dependencies
+              run: npm ci
+            - name: Build
+              run: npm run build
+            - name: Archive Production Artifact
+              uses: actions/upload-artifact@master
+              with:
+                  name: build
+                  path: build
+    demos:
+        name: Run Demos and Validate
+        needs: [build]
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout Repo
+              uses: actions/checkout@master
+            - name: Install Dependencies
+              run: npm ci
+            - name: Download Artifact
+              uses: actions/download-artifact@master
+              with:
+                  name: build
+                  path: build
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/1-basic.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/2-declaritive-styles.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/3-numbering-and-bullet-points.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/4-basic-table.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/5-images.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/6-page-borders.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/7-landscape.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/8-header-footer.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/9-images-in-header-and-footer.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/10-my-cv.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/11-declaritive-styles-2.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/12-scaling-images.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/13-xml-styles.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/14-page-numbers.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/15-page-break-before.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/16-multiple-sections.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/17-footnotes.ts
+            - name: Extract Word Document
+              run: npm run extract
+            # element r: Schemas validity error : Element '{http://schemas.openxmlformats.org/wordprocessingml/2006/main}r': This element is not expected.
+            # - name: Validate XML
+            #   uses: ChristophWurst/xmllint-action@v1
+            #   with:
+            #     xml-file: build/extracted-doc/word/document.xml
+            #     xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/18-image-from-buffer.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/19-export-to-base64.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/20-table-cell-borders.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/21-bookmarks.ts
+            - name: Extract Word Document
+              run: npm run extract
+            # Bad ID - need numeric ID
+            # - name: Validate XML
+            #   uses: ChristophWurst/xmllint-action@v1
+            #   with:
+            #     xml-file: build/extracted-doc/word/document.xml
+            #     xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/22-right-to-left-text.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/23-base64-images.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/24-images-to-table-cell.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/25-table-xml-styles.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/26-paragraph-borders.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/27-declaritive-styles-3.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/28-table-of-contents.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/29-numbered-lists.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/30-template-document.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/31-tables.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/32-merge-and-shade-table-cells.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/33-sequential-captions.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/34-floating-tables.ts
+            - name: Extract Word Document
+              run: npm run extract
+            # element tblpPr: Schemas validity error : Element '{http://schemas.openxmlformats.org/wordprocessingml/2006/main}tblpPr', attribute 'overlap': The attribute 'overlap' is not allowed.
+            # element tblpPr: Schemas validity error : Element '{http://schemas.openxmlformats.org/wordprocessingml/2006/main}tblpPr': Element content is not allowed, because the content type is empty.
+            # - name: Validate XML
+            #   uses: ChristophWurst/xmllint-action@v1
+            #   with:
+            #     xml-file: build/extracted-doc/word/document.xml
+            #     xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/35-hyperlinks.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/36-image-to-table-cell.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/37-images-to-header-and-footer.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/38-text-wrapping.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/39-page-numbers.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/40-line-numbers.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/41-merge-table-cells-2.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/42-restart-page-numbers.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/43-images-to-table-cell-2.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/44-multiple-columns.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/45-highlighting-text.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/46-shading-text.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/47-number-of-total-pages-section.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/48-vertical-align.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/49-table-borders.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/50-readme-demo.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/51-character-styles.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/52-japanese.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/53-chinese.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/54-custom-properties.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/55-math.ts
+            - name: Extract Word Document
+              run: npm run extract
+            #: element subHide: Schemas validity error : Element '{http://schemas.openxmlformats.org/officeDocument/2006/math}subHide': This element is not expected. Expected is ( {http://schemas.openxmlformats.org/officeDocument/2006/math}ctrlPr ).
+            #: element e: Schemas validity error : Element '{http://schemas.openxmlformats.org/officeDocument/2006/math}e': This element is not expected. Expected is ( {http://schemas.openxmlformats.org/officeDocument/2006/math}sub ).
+            #: element e: Schemas validity error : Element '{http://schemas.openxmlformats.org/officeDocument/2006/math}e': This element is not expected. Expected is ( {http://schemas.openxmlformats.org/officeDocument/2006/math}sup ).
+            #: element e: Schemas validity error : Element '{http://schemas.openxmlformats.org/officeDocument/2006/math}e': This element is not expected. Expected is ( {http://schemas.openxmlformats.org/officeDocument/2006/math}sub ).
+            # - name: Validate XML
+            #   uses: ChristophWurst/xmllint-action@v1
+            #   with:
+            #     xml-file: build/extracted-doc/word/document.xml
+            #     xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/56-background-color.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/57-add-parent-numbered-lists.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/58-section-types.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/59-header-footer-margins.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/60-track-revisions.ts
+            - name: Extract Word Document
+              run: npm run extract
+            # element r: Schemas validity error : Element '{http://schemas.openxmlformats.org/wordprocessingml/2006/main}r': This element is not expected.
+            # - name: Validate XML
+            #   uses: ChristophWurst/xmllint-action@v1
+            #   with:
+            #     xml-file: build/extracted-doc/word/document.xml
+            #     xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/61-text-frame.ts
+            - name: Extract Word Document
+              run: npm run extract
+            # element left: Schemas validity error : Element '{http://schemas.openxmlformats.org/wordprocessingml/2006/main}left': This element is not expected. Expected is one of ( {http://schemas.openxmlformats.org/wordprocessingml/2006/main}right, {http://schemas.openxmlformats.org/wordprocessingml/2006/main}between, {http://schemas.openxmlformats.org/wordprocessingml/2006/main}bar ).
+            # - name: Validate XML
+            #   uses: ChristophWurst/xmllint-action@v1
+            #   with:
+            #     xml-file: build/extracted-doc/word/document.xml
+            #     xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/62-paragraph-spacing.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/63-odd-even-header-footer.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/64-complex-numbering-text.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/65-page-sizes.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/66-fields.ts
+            - name: Extract Word Document
+              run: npm run extract
+            # element bookmarkStart: Schemas validity error : Element '{http://schemas.openxmlformats.org/wordprocessingml/2006/main}bookmarkStart', attribute '{http://schemas.openxmlformats.org/wordprocessingml/2006/main}id': '-irrswq-ln94j4fdgdjxs' is not a valid value of the atomic type '{http://schemas.openxmlformats.org/wordprocessingml/2006/main}ST_DecimalNumber'.
+            # element bookmarkEnd: Schemas validity error : Element '{http://schemas.openxmlformats.org/wordprocessingml/2006/main}bookmarkEnd', attribute '{http://schemas.openxmlformats.org/wordprocessingml/2006/main}id': '-irrswq-ln94j4fdgdjxs' is not a valid value of the atomic type '{http://schemas.openxmlformats.org/wordprocessingml/2006/main}ST_DecimalNumber'.
+            # - name: Validate XML
+            #   uses: ChristophWurst/xmllint-action@v1
+            #   with:
+            #     xml-file: build/extracted-doc/word/document.xml
+            #     xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/67-column-break.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/68-numbering-instances-and-starting-number.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/69-different-width-columns.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/70-line-numbers-suppression.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/71-page-borders-2.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd

.github/workflows/github-pages.yml

@@ -0,0 +1,43 @@
+name: Github Pages
+on:
+    push:
+        branches:
+            - master
+
+jobs:
+    build:
+        name: Build
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout Repo
+              uses: actions/checkout@master
+            - name: Install Dependencies
+              run: npm ci
+            - name: Build 🔧
+              run: |
+                  npm run typedoc
+                  echo "docx.js.org" > docs/.nojekyll
+                  echo "docx.js.org" > docs/CNAME
+            - name: Archive Production Artifact
+              uses: actions/upload-artifact@master
+              with:
+                  name: docs
+                  path: docs
+    deploy:
+        needs: [build]
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout Repo 🛎️
+              uses: actions/checkout@master
+            - name: Install Dependencies
+              run: npm ci
+            - name: Download Artifact
+              uses: actions/download-artifact@master
+              with:
+                  name: docs
+                  path: docs
+            - name: Deploy 🚀
+              uses: JamesIves/github-pages-deploy-action@4.1.5
+              with:
+                  branch: gh-pages
+                  folder: docs

.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

.nvmrc

@@ -1 +1 @@
-v8
+v10

.nycrc

@@ -1,14 +1,15 @@
 {
   "check-coverage": true,
-  "lines": 93.53,
-  "functions": 89.63,
-  "branches": 88.57,
-  "statements": 93.34,
+  "lines": 99.32,
+  "functions": 99.11,
+  "branches": 96.27,
+  "statements": 99.32,
   "include": [
     "src/**/*.ts"
   ],
   "exclude": [
-    "src/**/*.spec.ts"
+    "src/**/*.spec.ts",
+    "src/import-dotx/import-dotx.ts"
   ],
   "reporter": [
     "lcov",
@@ -20,6 +21,5 @@
   ],
   "cache": true,
   "all": true,
-  "instrument": false,
   "sourceMap": true
 }

.travis.yml

@@ -1,63 +0,0 @@
-language: node_js
-node_js:
-  - 9
-install:
-  - npm install
-  - npm install -g codecov
-script:
-  - npm run lint
-  - npm run test.coverage
-  - npm run style
-  - npm run build
-  - npm run ts-node -- ./demo/1-basic.ts
-#   - npm run e2e "My Document.docx"
-  - npm run ts-node -- ./demo/2-declaritive-styles.ts
-  - npm run ts-node -- ./demo/3-numbering-and-bullet-points.ts
-  - npm run ts-node -- ./demo/4-basic-table.ts
-  - npm run ts-node -- ./demo/5-images.ts
-  - npm run ts-node -- ./demo/6-page-borders.ts
-  - npm run ts-node -- ./demo/7-landscape.ts
-  - npm run ts-node -- ./demo/8-header-footer.ts
-  - npm run ts-node -- ./demo/9-images-in-header-and-footer.ts
-  - npm run ts-node -- ./demo/10-my-cv.ts
-#   - npm run e2e "My Document.docx"
-  - npm run ts-node -- ./demo/11-declaritive-styles-2.ts
-  - npm run ts-node -- ./demo/12-scaling-images.ts
-  - npm run ts-node -- ./demo/13-xml-styles.ts
-  - npm run ts-node -- ./demo/14-page-numbers.ts
-  - npm run ts-node -- ./demo/15-page-break-before.ts
-  - npm run ts-node -- ./demo/16-multiple-sections.ts
-  - npm run ts-node -- ./demo/17-footnotes.ts
-  - npm run ts-node -- ./demo/18-image-from-buffer.ts
-  - npm run ts-node -- ./demo/19-export-to-base64.ts
-  - npm run ts-node -- ./demo/20-table-cell-borders.ts
-  - npm run ts-node -- ./demo/21-bookmarks.ts
-  - npm run ts-node -- ./demo/22-right-to-left-text.ts
-  - npm run ts-node -- ./demo/23-base64-images.ts
-  - npm run ts-node -- ./demo/24-images-to-table-cell.ts
-#   - npm run ts-node -- ./demo/demo25.ts
-  - npm run ts-node -- ./demo/26-paragraph-borders.ts
-  - npm run ts-node -- ./demo/27-declaritive-styles-3.ts
-  - npm run ts-node -- ./demo/28-table-of-contents.ts
-  - npm run ts-node -- ./demo/29-numbered-lists.ts
-  - npm run ts-node -- ./demo/30-template-document.ts
-  - npm run ts-node -- ./demo/31-tables.ts
-  - npm run ts-node -- ./demo/32-merge-and-shade-table-cells.ts
-#   - npm run e2e "My Document.docx" // Need to fix
-  - npm run ts-node -- ./demo/33-sequential-captions.ts
-  - npm run ts-node -- ./demo/34-floating-tables.ts
-after_failure:
-  - "cat /home/travis/builds/dolanmiu/docx/npm-debug.log"
-after_success:
-  - npm run typedoc
-  - echo "docx.js.org" > docs/.nojekyll
-  - echo "docx.js.org" > docs/CNAME
-  - codecov
-deploy:
-  provider: pages
-  skip-cleanup: true
-  github-token: $GITHUB_TOKEN
-  keep-history: true
-  local-dir: docs
-  on:
-    branch: master

README.md

@@ -10,7 +10,7 @@
 
 [![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]
 [![Chat on Gitter][gitter-image]][gitter-url]
@@ -18,7 +18,7 @@
 [![codecov][codecov-image]][codecov-url]
 
 <p align="center">
-    <img src="https://i.imgur.com/TCH0YzD.png" alt="drawing" width="800"/>
+    <img src="https://i.imgur.com/QeL1HuU.png" alt="drawing"/>
 </p>
 
 # Demo
@@ -28,11 +28,20 @@
 Here are examples of `docx` being used with basic `HTML/JS` in a browser environment:
 
 *   https://codepen.io/dolanmiu/pen/RwNeObg
-*   https://jsfiddle.net/dolanmiu/kqxrj35u/1/
+*   https://jsfiddle.net/dolanmiu/onadx1gu/
 
 Here is an example of `docx` working in `Angular`:
 
-*   https://stackblitz.com/edit/angular-afvxtz
+*   https://stackblitz.com/edit/angular-docx
+
+Here is an example of `docx` working in `React`:
+
+*   https://stackblitz.com/edit/react-docx
+*   https://stackblitz.com/edit/react-docx-images (adding images to Word Document)
+
+Here is an example of `docx` working in `Vue.js`:
+
+*   https://stackblitz.com/edit/vuejs-docx
 
 ## Node
 
@@ -50,7 +59,7 @@ Press `endpoint` on the `RunKit` website:
 *   https://runkit.com/dolanmiu/docx-demo8 - Header and Footer
 *   https://runkit.com/dolanmiu/docx-demo10 - **My CV generated with docx**
 
-More [here](https://docx.js.org/#/examples) and [here](https://github.com/dolanmiu/docx/tree/master/demo)
+More [here](https://github.com/dolanmiu/docx/tree/master/demo)
 
 # How to use & Documentation
 
@@ -58,7 +67,7 @@ Please refer to the [documentation at https://docx.js.org/](https://docx.js.org/
 
 # Examples
 
-Check the `examples` section in the [documentation](https://docx.js.org/#/examples) and the [demo folder](https://github.com/dolanmiu/docx/tree/master/demo) for examples.
+Check the [demo folder](https://github.com/dolanmiu/docx/tree/master/demo) for examples.
 
 # Contributing
 
@@ -74,8 +83,10 @@ Read the contribution guidelines [here](https://docx.js.org/#/contribution-guide
 [<img src="https://i.imgur.com/1LjuK2M.png" alt="drawing" height="50"/>](https://turbopatent.com/)
 [<img src="https://i.imgur.com/dHMg0wF.gif" alt="drawing" height="50"/>](http://www.madisoncres.com/)
 [<img src="https://i.imgur.com/QEZXU5b.png" alt="drawing" height="50"/>](https://www.beekast.com/)
-[<img src="https://imgur.com/XVU6aoi.png" alt="drawing" height="50"/>](https://herraizsoto.com/)
+[<img src="https://i.imgur.com/XVU6aoi.png" alt="drawing" height="50"/>](https://herraizsoto.com/)
 [<img src="https://i.imgur.com/fn1xccG.png" alt="drawing" height="50"/>](http://www.ativer.com.br/)
+[<img src="https://i.imgur.com/cmykN7c.png" alt="drawing" />](https://www.arity.co/)
+[<img src="https://i.imgur.com/PXo25um.png" alt="drawing" height="50"/>](https://www.circadianrisk.com/)
 
 
 ...and many more!
@@ -91,8 +102,8 @@ 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
 [daviddm-url]: https://david-dm.org/dolanmiu/docx
 [snky-image]: https://snyk.io/test/github/dolanmiu/docx/badge.svg

demo/1-basic.ts

@@ -3,9 +3,9 @@
 import * as fs from "fs";
 import { Document, Packer, Paragraph, TextRun } from "../build";
 
-const doc = new Document();
-
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             properties: {},
             children: [
                 new Paragraph({
@@ -22,6 +22,8 @@ doc.addSection({
                     ],
                 }),
             ],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/10-my-cv.ts

@@ -9,7 +9,46 @@ const PHONE_NUMBER = "07534563401";
 const PROFILE_URL = "https://www.linkedin.com/in/dolan1";
 const EMAIL = "docx@com";
 
-const experiences = [
+interface Experience {
+    readonly isCurrent: boolean;
+    readonly summary: string;
+    readonly title: string;
+    readonly startDate: {
+        readonly month: number;
+        readonly year: number;
+    };
+    readonly endDate?: {
+        readonly month: number;
+        readonly year: number;
+    };
+    readonly company: {
+        readonly name: string;
+    };
+}
+
+interface Education {
+    readonly degree: string;
+    readonly fieldOfStudy: string;
+    readonly notes: string;
+    readonly schoolName: string;
+    readonly startDate: {
+        readonly year: number;
+    };
+    readonly endDate: {
+        readonly year: number;
+    };
+}
+
+interface Skill {
+    readonly name: string;
+}
+
+interface Achivement {
+    readonly issuer: string;
+    readonly name: string;
+}
+
+const experiences: Experience[] = [
     {
         isCurrent: true,
         summary: "Full-stack developer working with Angular and Java. Working for the iShares platform",
@@ -75,12 +114,11 @@ const experiences = [
     },
 ];
 
-const education = [
+const education: Education[] = [
     {
         degree: "Master of Science (MSc)",
         fieldOfStudy: "Computer Science",
-        notes:
-            "Exam Results: 1st Class with Distinction, Dissertation: 1st Class with Distinction\n\nRelevant Courses: Java and C# Programming, Software Engineering, Artificial Intelligence, \nComputational Photography, Algorithmics, Architecture and Hardware.\n\nCreated a Windows 8 game in JavaScript for the dissertation. \n\nCreated an award-winning 3D stereoscopic game in C# using XNA.",
+        notes: "Exam Results: 1st Class with Distinction, Dissertation: 1st Class with Distinction\n\nRelevant Courses: Java and C# Programming, Software Engineering, Artificial Intelligence, \nComputational Photography, Algorithmics, Architecture and Hardware.\n\nCreated a Windows 8 game in JavaScript for the dissertation. \n\nCreated an award-winning 3D stereoscopic game in C# using XNA.",
         schoolName: "University College London",
         startDate: {
             year: 2012,
@@ -92,8 +130,7 @@ const education = [
     {
         degree: "Bachelor of Engineering (BEng)",
         fieldOfStudy: "Material Science and Engineering",
-        notes:
-            "Exam Results: 2:1, Dissertation: 1st Class with Distinction\n\nRelevant courses: C Programming, Mathematics and Business for Engineers.",
+        notes: "Exam Results: 2:1, Dissertation: 1st Class with Distinction\n\nRelevant courses: C Programming, Mathematics and Business for Engineers.",
         schoolName: "Imperial College London",
         startDate: {
             year: 2009,
@@ -104,7 +141,7 @@ const education = [
     },
 ];
 
-const skills = [
+const skills: Skill[] = [
     {
         name: "Angular",
     },
@@ -119,7 +156,7 @@ const skills = [
     },
 ];
 
-const achievements = [
+const achievements: Achivement[] = [
     {
         issuer: "Oracle",
         name: "Oracle Certified Expert",
@@ -128,10 +165,10 @@ const achievements = [
 
 class DocumentCreator {
     // tslint:disable-next-line: typedef
-    public create([experiences, educations, skills, achivements]): Document {
-        const document = new Document();
-
-        document.addSection({
+    public create([experiences, educations, skills, achivements]: [Experience[], Education[], Skill[], Achivement[]]): Document {
+        const document = new Document({
+            sections: [
+                {
                     children: [
                         new Paragraph({
                             text: "Dolan Miu",
@@ -143,7 +180,10 @@ class DocumentCreator {
                             .map((education) => {
                                 const arr: Paragraph[] = [];
                                 arr.push(
-                            this.createInstitutionHeader(education.schoolName, `${education.startDate.year} - ${education.endDate.year}`),
+                                    this.createInstitutionHeader(
+                                        education.schoolName,
+                                        `${education.startDate.year} - ${education.endDate.year}`,
+                                    ),
                                 );
                                 arr.push(this.createRoleText(`${education.fieldOfStudy} - ${education.degree}`));
 
@@ -194,6 +234,8 @@ class DocumentCreator {
                             alignment: AlignmentType.CENTER,
                         }),
                     ],
+                },
+            ],
         });
 
         return document;
@@ -204,7 +246,10 @@ class DocumentCreator {
             alignment: AlignmentType.CENTER,
             children: [
                 new TextRun(`Mobile: ${phoneNumber} | LinkedIn: ${profileUrl} | Email: ${email}`),
-                new TextRun("Address: 58 Elm Avenue, Kent ME4 6ER, UK").break(),
+                new TextRun({
+                    text: "Address: 58 Elm Avenue, Kent ME4 6ER, UK",
+                    break: 1,
+                }),
             ],
         });
     }

demo/11-declaritive-styles-2.ts

@@ -3,10 +3,11 @@
 import * as fs from "fs";
 import {
     AlignmentType,
+    convertInchesToTwip,
     Document,
     Footer,
     HeadingLevel,
-    Media,
+    ImageRun,
     Packer,
     Paragraph,
     Table,
@@ -14,17 +15,59 @@ import {
     TableRow,
     TabStopPosition,
     UnderlineType,
+    LevelFormat,
 } from "../build";
 
+const table = new Table({
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("Test cell 1.")],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("Test cell 2.")],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("Test cell 3.")],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("Test cell 4.")],
+                }),
+            ],
+        }),
+    ],
+});
+
 const doc = new Document({
-    styles: {
-        paragraphStyles: [
+    numbering:{
+        config:[{
+            reference: 'ref1',
+            levels: [
             {
-                id: "Heading1",
-                name: "Heading 1",
-                basedOn: "Normal",
-                next: "Normal",
-                quickFormat: true,
+                level: 0,
+                format: LevelFormat.DECIMAL,
+                text: '%1)',
+                start: 50,
+            }
+            ],
+        }]
+    },
+    styles: {
+        default: {
+            heading1: {
                 run: {
                     font: "Calibri",
                     size: 52,
@@ -40,12 +83,7 @@ const doc = new Document({
                     spacing: { line: 340 },
                 },
             },
-            {
-                id: "Heading2",
-                name: "Heading 2",
-                basedOn: "Normal",
-                next: "Normal",
-                quickFormat: true,
+            heading2: {
                 run: {
                     font: "Calibri",
                     size: 26,
@@ -55,12 +93,7 @@ const doc = new Document({
                     spacing: { line: 340 },
                 },
             },
-            {
-                id: "Heading3",
-                name: "Heading 3",
-                basedOn: "Normal",
-                next: "Normal",
-                quickFormat: true,
+            heading3: {
                 run: {
                     font: "Calibri",
                     size: 26,
@@ -70,12 +103,7 @@ const doc = new Document({
                     spacing: { line: 276 },
                 },
             },
-            {
-                id: "Heading4",
-                name: "Heading 4",
-                basedOn: "Normal",
-                next: "Normal",
-                quickFormat: true,
+            heading4: {
                 run: {
                     font: "Calibri",
                     size: 26,
@@ -85,6 +113,8 @@ const doc = new Document({
                     alignment: AlignmentType.JUSTIFIED,
                 },
             },
+        },
+        paragraphStyles: [
             {
                 id: "normalPara",
                 name: "Normal Para",
@@ -128,7 +158,7 @@ const doc = new Document({
                 },
                 paragraph: {
                     spacing: { line: 276 },
-                    indent: { left: 720 },
+                    indent: { left: convertInchesToTwip(0.5) },
                 },
             },
             {
@@ -140,60 +170,41 @@ const doc = new Document({
                 },
             },
             {
-                id: "ListParagraph",
-                name: "List Paragraph",
+                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,
+                    }
+                },
             },
         ],
     },
-});
-
-const image = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
-
-const table = new Table({
-    rows: [
-        new TableRow({
-            children: [
-                new TableCell({
-                    children: [new Paragraph("Test cell 1.")],
-                }),
-            ],
-        }),
-        new TableRow({
-            children: [
-                new TableCell({
-                    children: [new Paragraph("Test cell 2.")],
-                }),
-            ],
-        }),
-        new TableRow({
-            children: [
-                new TableCell({
-                    children: [new Paragraph("Test cell 3.")],
-                }),
-            ],
-        }),
-        new TableRow({
-            children: [
-                new TableCell({
-                    children: [new Paragraph("Test cell 4.")],
-                }),
-            ],
-        }),
-    ],
-});
-
-const image1 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
-const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
-
-doc.addSection({
+    sections: [
+        {
             properties: {
+                page: {
+                    margin: {
                         top: 700,
                         right: 700,
                         bottom: 700,
                         left: 700,
                     },
+                },
+            },
             footers: {
                 default: new Footer({
                     children: [
@@ -206,7 +217,17 @@ doc.addSection({
                 }),
             },
             children: [
-        new Paragraph(image),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
                 new Paragraph({
                     text: "HEADING",
                     heading: HeadingLevel.HEADING_1,
@@ -245,16 +266,46 @@ doc.addSection({
                     style: "normalPara",
                 }),
                 table,
-        new Paragraph(image1),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
                 new Paragraph({
                     text: "Test",
                     style: "normalPara2",
                 }),
-        new Paragraph(image2),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
                 new Paragraph({
                     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/12-scaling-images.ts

@@ -1,17 +1,60 @@
 // Scaling images
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Document, Media, Packer, Paragraph } from "../build";
+import { Document, ImageRun, Packer, Paragraph } from "../build";
 
-const doc = new Document();
-
-const image = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 50, 50);
-const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 100, 100);
-const image3 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 250, 250);
-const image4 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 400, 400);
-
-doc.addSection({
-    children: [new Paragraph("Hello World"), new Paragraph(image), new Paragraph(image2), new Paragraph(image3), new Paragraph(image4)],
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Paragraph("Hello World"),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 50,
+                                height: 50,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 250,
+                                height: 250,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 400,
+                                height: 400,
+                            },
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/13-xml-styles.ts

@@ -7,9 +7,8 @@ const styles = fs.readFileSync("./demo/assets/custom-styles.xml", "utf-8");
 const doc = new Document({
     title: "Title",
     externalStyles: styles,
-});
-
-doc.addSection({
+    sections: [
+        {
             children: [
                 new Paragraph({
                     text: "Cool Heading Text",
@@ -25,6 +24,8 @@ doc.addSection({
                     style: "MyFancyStyle",
                 }),
             ],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/14-page-numbers.ts

@@ -1,11 +1,14 @@
 // Page numbers
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { AlignmentType, Document, Header, Packer, PageBreak, PageNumber, Paragraph, TextRun } from "../build";
+import { AlignmentType, Document, Footer, Header, Packer, PageBreak, PageNumber, Paragraph, TextRun } from "../build";
 
-const doc = new Document();
-
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
+            properties: {
+                titlePage: true,
+            },
             headers: {
                 default: new Header({
                     children: [
@@ -34,12 +37,42 @@ doc.addSection({
                     ],
                 }),
             },
+            footers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            alignment: AlignmentType.RIGHT,
+                            children: [
+                                new TextRun("My Title "),
+                                new TextRun({
+                                    children: ["Footer - Page ", PageNumber.CURRENT],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                first: new Footer({
+                    children: [
+                        new Paragraph({
+                            alignment: AlignmentType.RIGHT,
+                            children: [
+                                new TextRun("First Page Footer "),
+                                new TextRun({
+                                    children: ["Page ", PageNumber.CURRENT],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
             children: [
                 new Paragraph({
                     children: [new TextRun("First Page"), new PageBreak()],
                 }),
                 new Paragraph("Second Page"),
             ],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/15-page-break-before.ts

@@ -3,9 +3,9 @@
 import * as fs from "fs";
 import { Document, Packer, Paragraph } from "../build";
 
-const doc = new Document();
-
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             children: [
                 new Paragraph("Hello World"),
                 new Paragraph({
@@ -13,6 +13,8 @@ doc.addSection({
                     pageBreakBefore: true,
                 }),
             ],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/16-multiple-sections.ts

@@ -1,15 +1,22 @@
 // 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();
-
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             children: [new Paragraph("Hello World")],
-});
-
-doc.addSection({
+        },
+        {
+            properties: {
+                page: {
+                    pageNumbers: {
+                        start: 1,
+                        formatType: NumberFormat.DECIMAL,
+                    },
+                },
+            },
             headers: {
                 default: new Header({
                     children: [new Paragraph("First Default Header on another page")],
@@ -20,14 +27,21 @@ doc.addSection({
                     children: [new Paragraph("Footer on another page")],
                 }),
             },
-    properties: {
-        pageNumberStart: 1,
-        pageNumberFormatType: PageNumberFormat.DECIMAL,
-    },
-    children: [new Paragraph("hello")],
-});
 
-doc.addSection({
+            children: [new Paragraph("hello")],
+        },
+        {
+            properties: {
+                page: {
+                    size: {
+                        orientation: PageOrientation.LANDSCAPE,
+                    },
+                    pageNumbers: {
+                        start: 1,
+                        formatType: NumberFormat.DECIMAL,
+                    },
+                },
+            },
             headers: {
                 default: new Header({
                     children: [new Paragraph("Second Default Header on another page")],
@@ -38,37 +52,16 @@ doc.addSection({
                     children: [new Paragraph("Footer on another page")],
                 }),
             },
-    size: {
-        orientation: PageOrientation.LANDSCAPE,
-    },
-    properties: {
-        pageNumberStart: 1,
-        pageNumberFormatType: PageNumberFormat.DECIMAL,
-    },
             children: [new Paragraph("hello in landscape")],
-});
-
-doc.addSection({
-    headers: {
-        default: new Header({
-            children: [
-                new Paragraph({
-                    children: [
-                        new TextRun({
-                            children: ["Page number: ", PageNumber.CURRENT],
-                        }),
-                    ],
-                }),
-            ],
-        }),
         },
+        {
+            properties: {
+                page: {
                     size: {
                         orientation: PageOrientation.PORTRAIT,
                     },
-    children: [new Paragraph("Page number in the header must be 2, because it continues from the previous section.")],
-});
-
-doc.addSection({
+                },
+            },
             headers: {
                 default: new Header({
                     children: [
@@ -82,18 +75,51 @@ doc.addSection({
                     ],
                 }),
             },
+
+            children: [new Paragraph("Page number in the header must be 2, because it continues from the previous section.")],
+        },
+        {
             properties: {
-        pageNumberFormatType: PageNumberFormat.UPPER_ROMAN,
+                page: {
+                    size: {
                         orientation: PageOrientation.PORTRAIT,
                     },
+                    pageNumbers: {
+                        formatType: NumberFormat.UPPER_ROMAN,
+                    },
+                },
+            },
+            headers: {
+                default: new Header({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new TextRun({
+                                    children: ["Page number: ", PageNumber.CURRENT],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
             children: [
                 new Paragraph(
                     "Page number in the header must be III, because it continues from the previous section, but is defined as upper roman.",
                 ),
             ],
-});
-
-doc.addSection({
+        },
+        {
+            properties: {
+                page: {
+                    size: {
+                        orientation: PageOrientation.PORTRAIT,
+                    },
+                    pageNumbers: {
+                        start: 25,
+                        formatType: NumberFormat.DECIMAL,
+                    },
+                },
+            },
             headers: {
                 default: new Header({
                     children: [
@@ -107,15 +133,12 @@ doc.addSection({
                     ],
                 }),
             },
-    size: {
-        orientation: PageOrientation.PORTRAIT,
-    },
-    properties: {
-        pageNumberFormatType: PageNumberFormat.DECIMAL,
-        pageNumberStart: 25,
-    },
             children: [
-        new Paragraph("Page number in the header must be 25, because it is defined to start at 25 and to be decimal in this section."),
+                new Paragraph(
+                    "Page number in the header must be 25, because it is defined to start at 25 and to be decimal in this section.",
+                ),
+            ],
+        },
     ],
 });
 

demo/17-footnotes.ts

@@ -4,17 +4,16 @@ import * as fs from "fs";
 import { Document, FootnoteReferenceRun, Packer, Paragraph, TextRun } from "../build";
 
 const doc = new Document({
-    footnotes: [
-        new Paragraph("Foo"),
-        new Paragraph("Test"),
-        new Paragraph("My amazing reference"),
-        new Paragraph("Foo1"),
-        new Paragraph("Test1"),
-        new Paragraph("My amazing reference1"),
-    ],
-});
-
-doc.addSection({
+    footnotes: {
+        1: { children: [new Paragraph("Foo"), new Paragraph("Bar")] },
+        2: { children: [new Paragraph("Test")] },
+        3: { children: [new Paragraph("My amazing reference")] },
+        4: { children: [new Paragraph("Foo1")] },
+        5: { children: [new Paragraph("Test1")] },
+        6: { children: [new Paragraph("My amazing reference1")] },
+    },
+    sections: [
+        {
             children: [
                 new Paragraph({
                     children: [
@@ -30,9 +29,8 @@ doc.addSection({
                     children: [new TextRun("Hello World"), new FootnoteReferenceRun(3)],
                 }),
             ],
-});
-
-doc.addSection({
+        },
+        {
             children: [
                 new Paragraph({
                     children: [
@@ -48,6 +46,8 @@ doc.addSection({
                     children: [new TextRun("Hello World"), new FootnoteReferenceRun(6)],
                 }),
             ],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/18-image-from-buffer.ts

@@ -1,20 +1,28 @@
 // Insert image from a buffer
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Document, Media, Packer, Paragraph } from "../build";
-
-const doc = new Document();
+import { Document, ImageRun, Packer, Paragraph } from "../build";
 
 const imageBase64Data = `iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAMAAAD04JH5AAACzVBMVEUAAAAAAAAAAAAAAAA/AD8zMzMqKiokJCQfHx8cHBwZGRkuFxcqFSonJyckJCQiIiIfHx8eHh4cHBwoGhomGSYkJCQhISEfHx8eHh4nHR0lHBwkGyQjIyMiIiIgICAfHx8mHh4lHh4kHR0jHCMiGyIhISEgICAfHx8lHx8kHh4jHR0hHCEhISEgICAlHx8kHx8jHh4jHh4iHSIhHCEhISElICAkHx8jHx8jHh4iHh4iHSIhHSElICAkICAjHx8jHx8iHh4iHh4hHiEhHSEkICAjHx8iHx8iHx8hHh4hHiEkHSEjHSAjHx8iHx8iHx8hHh4kHiEkHiEjHSAiHx8hHx8hHh4kHiEjHiAjHSAiHx8iHx8hHx8kHh4jHiEjHiAjHiAiICAiHx8kHx8jHh4jHiEjHiAiHiAiHSAiHx8jHx8jHx8jHiAiHiAiHiAiHSAiHx8jHx8jHx8iHiAiHiAiHiAjHx8jHx8jHx8jHx8iHiAiHiAiHiAjHx8jHx8jHx8iHx8iHSAiHiAjHiAjHx8jHx8hHx8iHx8iHyAiHiAjHiAjHiAjHh4hHx8iHx8iHx8iHyAjHSAjHiAjHiAjHh4hHx8iHx8iHx8jHyAjHiAhHh4iHx8iHx8jHyAjHSAjHSAhHiAhHh4iHx8iHx8jHx8jHyAjHSAjHSAiHh4iHh4jHx8jHx8jHyAjHyAhHSAhHSAiHh4iHh4jHx8jHx8jHyAhHyAhHSAiHSAiHh4jHh4jHx8jHx8jHyAhHyAhHSAiHSAjHR4jHh4jHx8jHx8hHyAhHyAiHSAjHSAjHR4jHh4jHx8hHx8hHyAhHyAiHyAjHSAjHR4jHR4hHh4hHx8hHyAiHyAjHyAjHSAjHR4jHR4hHh4hHx8hHyAjHyAjHyAjHSAjHR4hHR4hHR4hHx8iHyAjHyAjHyAjHSAhHR4hHR4hHR4hHx8jHyAjHyAjHyAjHyC9S2xeAAAA7nRSTlMAAQIDBAUGBwgJCgsMDQ4PEBESExQVFxgZGhscHR4fICEiIyQlJicoKSorLS4vMDEyMzQ1Njc4OTo7PD0+P0BBQkNERUZISUpLTE1OUFFSU1RVVllaW1xdXmBhYmNkZWZnaGprbG1ub3Byc3R1dnd4eXp8fn+AgYKDhIWGiImKi4yNj5CRkpOUlZaXmJmam5ydnp+goaKjpKaoqqusra6vsLGys7S1tri5uru8vb6/wMHCw8TFxsfIycrLzM3Oz9DR0tPU1dbX2Nna29zd3t/g4eLj5OXm5+jp6uvs7e7v8PHy8/T19vf4+fr7/P3+fkZpVQAABcBJREFUGBntwftjlQMcBvDnnLNL22qzJjWlKLHFVogyty3SiFq6EZliqZGyhnSxsLlMRahYoZKRFcul5dKFCatYqWZaNKvWtrPz/A2+7/b27qRzec/lPfvl/XxgMplMJpPJZDKZAtA9HJ3ppnIez0KnSdtC0RCNznHdJrbrh85wdSlVVRaEXuoGamYi5K5430HNiTiEWHKJg05eRWgNfKeV7RxbqUhGKPV/207VupQ8is0IoX5vtFC18SqEHaK4GyHTZ2kzVR8PBTCO4oANIZL4ShNVZcOhKKeYg9DoWdhI1ec3os2VFI0JCIUez5+i6st0qJZRrEAIJCw+QdW223BG/EmKwTBc/IJ/qfp2FDrkUnwFo8U9dZyqnaPhxLqfYjyM1S3vb6p+GGOBszsojoTDSDFz6qj66R4LzvYJxVMwUNRjf1H1ywQr/megg2RzLximy8waqvbda8M5iijegVEiHjlM1W/3h+FcXesphsMY4dMOUnUgOxyuPEzxPQwRNvV3qg5Nj4BreyimwADWe/dRVTMjEm6MoGLzGwtystL6RyOY3qSqdlYU3FpLZw1VW0sK5943MvUCKwJ1noNtjs6Ohge76Zq9ZkfpigU5WWkDYuCfbs1U5HWFR8/Qq4a9W0uK5k4ZmdrTCl8spGIePLPlbqqsc1Afe83O0hULc8alDYiBd7ZyitYMeBfR55rR2fOKP6ioPk2dGvZ+UVI0d8rtqT2tcCexlqK2F3wRn5Q+YVbBqrLKOupkr9lZujAOrmS0UpTb4JeIPkNHZ+cXr6uoPk2vyuBSPhWLEKj45PQJuQWryyqP0Z14uGLdROHIRNBEXDR09EP5r62rOHCazhrD4VKPwxTH+sIA3ZPTJ+YuWV22n+IruHFDC8X2CBjnPoolcGc2FYUwzmsUWXDHsoGKLBhmN0VvuBVfTVE/AAbpaid5CB4MbaLY1QXGuIViLTyZQcVyGGMuxWPwaA0Vk2GI9RRp8Ci2iuLkIBjhT5LNUfAspZFiTwyC72KK7+DNg1SsRvCNp3gZXq2k4iEEXSHFJHgVXUlxejCCbTvFAHiXdIJiXxyCK7KJ5FHoMZGK9xBcwyg2QpdlVMxEUM2iyIMuXXZQNF+HswxMsSAAJRQjoE//eoqDCXBSTO6f1xd+O0iyNRY6jaWi1ALNYCocZROj4JdEikroVkjFk9DcStXxpdfCD2MoXodu4RUU9ptxxmXssOfxnvDVcxRTod9FxyhqLoAqis5aPhwTDp9spRgEH2Q6KLbYoKqlaKTm6Isp0C/sJMnjFvhiERXPQvUNRe9p29lhR04CdBpC8Sl8YiuncIxEuzUUg4Dkgj+paVozygY9plPMh28SaymO9kabAopREGF3vt9MzeFFl8G7lRSZ8FFGK8XX4VA8QjEd7XrM3M0OXz8YCy+qKBLgq3wqnofiTorF0Ax56Rg1J1elW+BBAsVe+My6iYq7IK6keBdOIseV2qn5Pb8f3MqkWAXf9ThM8c8lAOIotuFsF875lRrH5klRcG0+xcPwQ1oLxfeRAP4heQTnGL78X2rqlw2DK59SXAV/zKaiGMAuko5InCt68mcOan5+ohf+z1pP8lQY/GHZQMV4YD3FpXDp4qerqbF/lBWBswyi+AL+ia+maLgcRRQj4IYlY/UpauqKBsPJAxQF8NM1TRQ/RudSPAD34rK3scOuR8/HGcspxsJfOVS8NZbiGXiUtPgINU3v3WFDmx8pEuG3EiqKKVbCC1vm2iZqap5LAtCtleQf8F9sFYWDohzeJczYyQ4V2bEZFGsQgJRGqqqhS2phHTWn9lDkIhBTqWqxQZ+IsRvtdHY9AvI2VX2hW68nfqGmuQsCEl3JdjfCF8OW1bPdtwhQ0gm2mQzfRE3a7KCYj0BNZJs8+Kxf/r6WtTEI2FIqlsMfFgRB5A6KUnSe/vUkX0AnuvUIt8SjM1m6wWQymUwmk8lkMgXRf5vi8rLQxtUhAAAAAElFTkSuQmCC`;
 
-const image = Media.addImage(doc, Buffer.from(imageBase64Data, "base64"), 100, 100);
-
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             children: [
                 new Paragraph({
-            children: [image],
+                    children: [
+                        new ImageRun({
+                            data: Buffer.from(imageBase64Data, "base64"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
                         }),
                     ],
+                }),
+            ],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/19-export-to-base64.ts

@@ -3,9 +3,9 @@
 import * as fs from "fs";
 import { Document, Packer, Paragraph, TextRun } from "../build";
 
-const doc = new Document();
-
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             children: [
                 new Paragraph({
                     children: [
@@ -21,6 +21,8 @@ doc.addSection({
                     ],
                 }),
             ],
+        },
+    ],
 });
 
 Packer.toBase64String(doc).then((str) => {

demo/2-declaritive-styles.ts

@@ -1,25 +1,30 @@
 // Example on how to customise the look at feel using Styles
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { AlignmentType, Document, HeadingLevel, Packer, Paragraph, TextRun, UnderlineType } from "../build";
+import {
+    AlignmentType,
+    convertInchesToTwip,
+    Document,
+    HeadingLevel,
+    LevelFormat,
+    Packer,
+    Paragraph,
+    TextRun,
+    UnderlineType,
+} from "../build";
 
 const doc = new Document({
     creator: "Clippy",
     title: "Sample Document",
     description: "A brief example of using docx",
     styles: {
-        paragraphStyles: [
-            {
-                id: "Heading1",
-                name: "Heading 1",
-                basedOn: "Normal",
-                next: "Normal",
-                quickFormat: true,
+        default: {
+            heading1: {
                 run: {
                     size: 28,
                     bold: true,
                     italics: true,
-                    color: "red",
+                    color: "FF0000",
                 },
                 paragraph: {
                     spacing: {
@@ -27,12 +32,7 @@ const doc = new Document({
                     },
                 },
             },
-            {
-                id: "Heading2",
-                name: "Heading 2",
-                basedOn: "Normal",
-                next: "Normal",
-                quickFormat: true,
+            heading2: {
                 run: {
                     size: 26,
                     bold: true,
@@ -48,6 +48,13 @@ const doc = new Document({
                     },
                 },
             },
+            listParagraph: {
+                run: {
+                    color: "#FF0000",
+                },
+            },
+        },
+        paragraphStyles: [
             {
                 id: "aside",
                 name: "Aside",
@@ -59,7 +66,7 @@ const doc = new Document({
                 },
                 paragraph: {
                     indent: {
-                        left: 720,
+                        left: convertInchesToTwip(0.5),
                     },
                     spacing: {
                         line: 276,
@@ -75,12 +82,6 @@ const doc = new Document({
                     spacing: { line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 },
                 },
             },
-            {
-                id: "ListParagraph",
-                name: "List Paragraph",
-                basedOn: "Normal",
-                quickFormat: true,
-            },
         ],
     },
     numbering: {
@@ -90,7 +91,7 @@ const doc = new Document({
                 levels: [
                     {
                         level: 0,
-                        format: "lowerLetter",
+                        format: LevelFormat.LOWER_LETTER,
                         text: "%1)",
                         alignment: AlignmentType.LEFT,
                     },
@@ -98,9 +99,8 @@ const doc = new Document({
             },
         ],
     },
-});
-
-doc.addSection({
+    sections: [
+        {
             children: [
                 new Paragraph({
                     text: "Test heading1, bold and italicized",
@@ -117,6 +117,7 @@ doc.addSection({
                         reference: "my-crazy-numbering",
                         level: 0,
                     },
+                    style: "aside",
                 }),
                 new Paragraph({
                     text: "Option5 -- override 2 to 5",
@@ -170,6 +171,19 @@ doc.addSection({
                         }),
                     ],
                 }),
+                new Paragraph({
+                    style: "Strong",
+                    children: [
+                        new TextRun({
+                            text: "Strong Style",
+                        }),
+                        new TextRun({
+                            text: " - Very strong.",
+                        }),
+                    ],
+                }),
+            ],
+        },
     ],
 });
 

demo/20-table-cell-borders.ts

@@ -3,9 +3,11 @@
 import * as fs from "fs";
 import { BorderStyle, Document, Packer, Paragraph, Table, TableCell, TableRow } from "../build";
 
-const doc = new Document();
-
-const table = new Table({
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Table({
                     rows: [
                         new TableRow({
                             children: [
@@ -34,17 +36,17 @@ const table = new Table({
                                         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,
@@ -94,10 +96,12 @@ const table = new Table({
                             ],
                         }),
                     ],
+                }),
+            ],
+        },
+    ],
 });
 
-doc.addSection({ children: [table] });
-
 Packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

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, HeadingLevel, HyperlinkRef, HyperlinkType, Packer, PageBreak, Paragraph } 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.";
@@ -10,19 +10,36 @@ const doc = new Document({
     creator: "Clippy",
     title: "Sample Document",
     description: "A brief example of using docx with bookmarks and internal hyperlinks",
-    hyperlinks: {
-        myAnchorId: {
-            text: "Hyperlink",
-            type: HyperlinkType.INTERNAL,
+    sections: [
+        {
+            footers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new InternalHyperlink({
+                                    children: [
+                                        new TextRun({
+                                            text: "Click here!",
+                                            style: "Hyperlink",
+                                        }),
+                                    ],
+                                    anchor: "myAnchorId",
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
             },
-    },
-});
-
-doc.addSection({
             children: [
                 new Paragraph({
                     heading: HeadingLevel.HEADING_1,
-            children: [new Bookmark("myAnchorId", "Lorem Ipsum")],
+                    children: [
+                        new Bookmark({
+                            id: "myAnchorId",
+                            children: [new TextRun("Lorem Ipsum")],
+                        }),
+                    ],
                 }),
                 new Paragraph("\n"),
                 new Paragraph(LOREM_IPSUM),
@@ -30,8 +47,28 @@ doc.addSection({
                     children: [new PageBreak()],
                 }),
                 new Paragraph({
-            children: [new HyperlinkRef("myAnchorId")],
+                    children: [
+                        new InternalHyperlink({
+                            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/22-right-to-left-text.ts

@@ -1,11 +1,11 @@
 // This demo shows right to left for special languages
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Document, Packer, Paragraph, TextRun } from "../build";
+import { Document, Packer, Paragraph, Table, TableCell, TableRow, TextRun } from "../build";
 
-const doc = new Document();
-
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             children: [
                 new Paragraph({
                     bidirectional: true,
@@ -36,6 +36,33 @@ doc.addSection({
                         }),
                     ],
                 }),
+                new Table({
+                    visuallyRightToLeft: true,
+                    rows: [
+                        new TableRow({
+                            children: [
+                                new TableCell({
+                                    children: [new Paragraph("שלום עולם")],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                            ],
+                        }),
+                        new TableRow({
+                            children: [
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [new Paragraph("שלום עולם")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            ],
+        },
     ],
 });
 

demo/23-base64-images.ts

@@ -1,29 +1,83 @@
 // This demo adds an image to the Media cache, and then insert to the document afterwards
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Document, Media, Packer, Paragraph, TextRun } from "../build";
-
-const doc = new Document();
-
-const image = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
-const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/dog.png"));
-const image3 = Media.addImage(doc, fs.readFileSync("./demo/images/cat.jpg"));
-const image4 = Media.addImage(doc, fs.readFileSync("./demo/images/parrots.bmp"));
-const image5 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
+import { Document, ImageRun, Packer, Paragraph, TextRun } from "../build";
 
 const imageBase64Data = `iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAMAAAD04JH5AAACzVBMVEUAAAAAAAAAAAAAAAA/AD8zMzMqKiokJCQfHx8cHBwZGRkuFxcqFSonJyckJCQiIiIfHx8eHh4cHBwoGhomGSYkJCQhISEfHx8eHh4nHR0lHBwkGyQjIyMiIiIgICAfHx8mHh4lHh4kHR0jHCMiGyIhISEgICAfHx8lHx8kHh4jHR0hHCEhISEgICAlHx8kHx8jHh4jHh4iHSIhHCEhISElICAkHx8jHx8jHh4iHh4iHSIhHSElICAkICAjHx8jHx8iHh4iHh4hHiEhHSEkICAjHx8iHx8iHx8hHh4hHiEkHSEjHSAjHx8iHx8iHx8hHh4kHiEkHiEjHSAiHx8hHx8hHh4kHiEjHiAjHSAiHx8iHx8hHx8kHh4jHiEjHiAjHiAiICAiHx8kHx8jHh4jHiEjHiAiHiAiHSAiHx8jHx8jHx8jHiAiHiAiHiAiHSAiHx8jHx8jHx8iHiAiHiAiHiAjHx8jHx8jHx8jHx8iHiAiHiAiHiAjHx8jHx8jHx8iHx8iHSAiHiAjHiAjHx8jHx8hHx8iHx8iHyAiHiAjHiAjHiAjHh4hHx8iHx8iHx8iHyAjHSAjHiAjHiAjHh4hHx8iHx8iHx8jHyAjHiAhHh4iHx8iHx8jHyAjHSAjHSAhHiAhHh4iHx8iHx8jHx8jHyAjHSAjHSAiHh4iHh4jHx8jHx8jHyAjHyAhHSAhHSAiHh4iHh4jHx8jHx8jHyAhHyAhHSAiHSAiHh4jHh4jHx8jHx8jHyAhHyAhHSAiHSAjHR4jHh4jHx8jHx8hHyAhHyAiHSAjHSAjHR4jHh4jHx8hHx8hHyAhHyAiHyAjHSAjHR4jHR4hHh4hHx8hHyAiHyAjHyAjHSAjHR4jHR4hHh4hHx8hHyAjHyAjHyAjHSAjHR4hHR4hHR4hHx8iHyAjHyAjHyAjHSAhHR4hHR4hHR4hHx8jHyAjHyAjHyAjHyC9S2xeAAAA7nRSTlMAAQIDBAUGBwgJCgsMDQ4PEBESExQVFxgZGhscHR4fICEiIyQlJicoKSorLS4vMDEyMzQ1Njc4OTo7PD0+P0BBQkNERUZISUpLTE1OUFFSU1RVVllaW1xdXmBhYmNkZWZnaGprbG1ub3Byc3R1dnd4eXp8fn+AgYKDhIWGiImKi4yNj5CRkpOUlZaXmJmam5ydnp+goaKjpKaoqqusra6vsLGys7S1tri5uru8vb6/wMHCw8TFxsfIycrLzM3Oz9DR0tPU1dbX2Nna29zd3t/g4eLj5OXm5+jp6uvs7e7v8PHy8/T19vf4+fr7/P3+fkZpVQAABcBJREFUGBntwftjlQMcBvDnnLNL22qzJjWlKLHFVogyty3SiFq6EZliqZGyhnSxsLlMRahYoZKRFcul5dKFCatYqWZaNKvWtrPz/A2+7/b27qRzec/lPfvl/XxgMplMJpPJZDKZAtA9HJ3ppnIez0KnSdtC0RCNznHdJrbrh85wdSlVVRaEXuoGamYi5K5430HNiTiEWHKJg05eRWgNfKeV7RxbqUhGKPV/207VupQ8is0IoX5vtFC18SqEHaK4GyHTZ2kzVR8PBTCO4oANIZL4ShNVZcOhKKeYg9DoWdhI1ec3os2VFI0JCIUez5+i6st0qJZRrEAIJCw+QdW223BG/EmKwTBc/IJ/qfp2FDrkUnwFo8U9dZyqnaPhxLqfYjyM1S3vb6p+GGOBszsojoTDSDFz6qj66R4LzvYJxVMwUNRjf1H1ywQr/megg2RzLximy8waqvbda8M5iijegVEiHjlM1W/3h+FcXesphsMY4dMOUnUgOxyuPEzxPQwRNvV3qg5Nj4BreyimwADWe/dRVTMjEm6MoGLzGwtystL6RyOY3qSqdlYU3FpLZw1VW0sK5943MvUCKwJ1noNtjs6Ohge76Zq9ZkfpigU5WWkDYuCfbs1U5HWFR8/Qq4a9W0uK5k4ZmdrTCl8spGIePLPlbqqsc1Afe83O0hULc8alDYiBd7ZyitYMeBfR55rR2fOKP6ioPk2dGvZ+UVI0d8rtqT2tcCexlqK2F3wRn5Q+YVbBqrLKOupkr9lZujAOrmS0UpTb4JeIPkNHZ+cXr6uoPk2vyuBSPhWLEKj45PQJuQWryyqP0Z14uGLdROHIRNBEXDR09EP5r62rOHCazhrD4VKPwxTH+sIA3ZPTJ+YuWV22n+IruHFDC8X2CBjnPoolcGc2FYUwzmsUWXDHsoGKLBhmN0VvuBVfTVE/AAbpaid5CB4MbaLY1QXGuIViLTyZQcVyGGMuxWPwaA0Vk2GI9RRp8Ci2iuLkIBjhT5LNUfAspZFiTwyC72KK7+DNg1SsRvCNp3gZXq2k4iEEXSHFJHgVXUlxejCCbTvFAHiXdIJiXxyCK7KJ5FHoMZGK9xBcwyg2QpdlVMxEUM2iyIMuXXZQNF+HswxMsSAAJRQjoE//eoqDCXBSTO6f1xd+O0iyNRY6jaWi1ALNYCocZROj4JdEikroVkjFk9DcStXxpdfCD2MoXodu4RUU9ptxxmXssOfxnvDVcxRTod9FxyhqLoAqis5aPhwTDp9spRgEH2Q6KLbYoKqlaKTm6Isp0C/sJMnjFvhiERXPQvUNRe9p29lhR04CdBpC8Sl8YiuncIxEuzUUg4Dkgj+paVozygY9plPMh28SaymO9kabAopREGF3vt9MzeFFl8G7lRSZ8FFGK8XX4VA8QjEd7XrM3M0OXz8YCy+qKBLgq3wqnofiTorF0Ax56Rg1J1elW+BBAsVe+My6iYq7IK6keBdOIseV2qn5Pb8f3MqkWAXf9ThM8c8lAOIotuFsF875lRrH5klRcG0+xcPwQ1oLxfeRAP4heQTnGL78X2rqlw2DK59SXAV/zKaiGMAuko5InCt68mcOan5+ohf+z1pP8lQY/GHZQMV4YD3FpXDp4qerqbF/lBWBswyi+AL+ia+maLgcRRQj4IYlY/UpauqKBsPJAxQF8NM1TRQ/RudSPAD34rK3scOuR8/HGcspxsJfOVS8NZbiGXiUtPgINU3v3WFDmx8pEuG3EiqKKVbCC1vm2iZqap5LAtCtleQf8F9sFYWDohzeJczYyQ4V2bEZFGsQgJRGqqqhS2phHTWn9lDkIhBTqWqxQZ+IsRvtdHY9AvI2VX2hW68nfqGmuQsCEl3JdjfCF8OW1bPdtwhQ0gm2mQzfRE3a7KCYj0BNZJs8+Kxf/r6WtTEI2FIqlsMfFgRB5A6KUnSe/vUkX0AnuvUIt8SjM1m6wWQymUwmk8lkMgXRf5vi8rLQxtUhAAAAAElFTkSuQmCC`;
-const image6 = Media.addImage(doc, Buffer.from(imageBase64Data, "base64"), 100, 100);
 
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             children: [
                 new Paragraph({
-            children: [new TextRun("Hello World"), image5],
+                    children: [
+                        new TextRun("Hello World"),
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/parrots.bmp"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
                         }),
-        new Paragraph(image),
-        new Paragraph(image2),
-        new Paragraph(image3),
-        new Paragraph(image4),
-        new Paragraph(image6),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/image1.jpeg"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/dog.png"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/cat.jpg"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/parrots.bmp"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: Buffer.from(imageBase64Data, "base64"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+            ],
+        },
     ],
 });
 

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

@@ -1,13 +1,13 @@
 // Add image to table cell
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Document, Media, Packer, Paragraph, Table, TableCell, TableRow } from "../build";
+import { Document, ImageRun, Packer, Paragraph, Table, TableCell, TableRow } from "../build";
 
-const doc = new Document();
-
-const image = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
-
-const table = new Table({
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Table({
                     rows: [
                         new TableRow({
                             children: [
@@ -31,7 +31,19 @@ const table = new Table({
                                     children: [],
                                 }),
                                 new TableCell({
-                    children: [new Paragraph(image)],
+                                    children: [
+                                        new Paragraph({
+                                            children: [
+                                                new ImageRun({
+                                                    data: fs.readFileSync("./demo/images/image1.jpeg"),
+                                                    transformation: {
+                                                        width: 100,
+                                                        height: 100,
+                                                    },
+                                                }),
+                                            ],
+                                        }),
+                                    ],
                                 }),
                                 new TableCell({
                                     children: [],
@@ -74,10 +86,10 @@ const table = new Table({
                             ],
                         }),
                     ],
-});
-
-doc.addSection({
-    children: [table],
+                }),
+            ],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/25-table-xml-styles.ts

@@ -0,0 +1,51 @@
+// Example of how you would create a table and add data to it
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, Paragraph, Table, TableCell, TableRow, WidthType } from "../build";
+
+const styles = fs.readFileSync("./demo/assets/custom-styles.xml", "utf-8");
+
+// Create a table and pass the XML Style
+const table = new Table({
+    style: "MyCustomTableStyle",
+    width: {
+        size: 9070,
+        type: WidthType.DXA,
+    },
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("Header Colum 1")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("Header Colum 2")],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("Column Content 3")],
+                }),
+                new TableCell({
+                    children: [new Paragraph("Column Content 2")],
+                }),
+            ],
+        }),
+    ],
+});
+
+const doc = new Document({
+    title: "Title",
+    externalStyles: styles,
+    sections: [
+        {
+            children: [table],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/26-paragraph-borders.ts

@@ -1,11 +1,11 @@
 // 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();
-
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             children: [
                 new Paragraph("No border!"),
                 new Paragraph({
@@ -14,18 +14,20 @@ doc.addSection({
                         top: {
                             color: "auto",
                             space: 1,
-                    value: "single",
+                            style: BorderStyle.SINGLE,
                             size: 6,
                         },
                         bottom: {
                             color: "auto",
                             space: 1,
-                    value: "single",
+                            style: BorderStyle.SINGLE,
                             size: 6,
                         },
                     },
                 }),
             ],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/27-declaritive-styles-3.ts

@@ -1,7 +1,7 @@
 // Custom styles using JavaScript configuration
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Document, HeadingLevel, Packer, Paragraph, UnderlineType } from "../build";
+import { Document, convertInchesToTwip, HeadingLevel, Packer, Paragraph, UnderlineType } from "../build";
 
 const doc = new Document({
     styles: {
@@ -17,7 +17,7 @@ const doc = new Document({
                 },
                 paragraph: {
                     indent: {
-                        left: 720,
+                        left: convertInchesToTwip(0.5),
                     },
                     spacing: {
                         line: 276,
@@ -47,9 +47,8 @@ const doc = new Document({
             },
         ],
     },
-});
-
-doc.addSection({
+    sections: [
+        {
             children: [
                 new Paragraph({
                     text: "Hello",
@@ -60,6 +59,8 @@ doc.addSection({
                     heading: HeadingLevel.HEADING_2,
                 }),
             ],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/28-table-of-contents.ts

@@ -3,7 +3,15 @@
 import * as fs from "fs";
 import { File, HeadingLevel, Packer, Paragraph, StyleLevel, TableOfContents } from "../build";
 
+// WordprocessingML docs for TableOfContents can be found here:
+// http://officeopenxml.com/WPtableOfContents.php
+
+// 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: [
             {
@@ -19,15 +27,8 @@ const doc = new File({
             },
         ],
     },
-});
-
-// WordprocessingML docs for TableOfContents can be found here:
-// http://officeopenxml.com/WPtableOfContents.php
-
-// Let's define the properties for generate a TOC for heading 1-5 and MySpectacularStyle,
-// making the entries be hyperlinks for the paragraph
-
-doc.addSection({
+    sections: [
+        {
             children: [
                 new TableOfContents("Summary", {
                     hyperlink: true,
@@ -57,6 +58,8 @@ doc.addSection({
                     pageBreakBefore: true,
                 }),
             ],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/29-numbered-lists.ts

@@ -1,7 +1,8 @@
 // Numbered lists
+// The lists can also be restarted by specifying the instance number
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { AlignmentType, Document, Packer, Paragraph } from "../build";
+import { AlignmentType, convertInchesToTwip, Document, HeadingLevel, LevelFormat, Packer, Paragraph } from "../build";
 
 const doc = new Document({
     numbering: {
@@ -10,12 +11,12 @@ const doc = new Document({
                 levels: [
                     {
                         level: 0,
-                        format: "upperRoman",
+                        format: LevelFormat.UPPER_ROMAN,
                         text: "%1",
                         alignment: AlignmentType.START,
                         style: {
                             paragraph: {
-                                indent: { left: 720, hanging: 260 },
+                                indent: { left: convertInchesToTwip(0.5), hanging: convertInchesToTwip(0.18) },
                             },
                         },
                     },
@@ -26,23 +27,38 @@ const doc = new Document({
                 levels: [
                     {
                         level: 0,
-                        format: "decimal",
+                        format: LevelFormat.DECIMAL,
                         text: "%1",
                         alignment: AlignmentType.START,
                         style: {
                             paragraph: {
-                                indent: { left: 720, hanging: 260 },
+                                indent: { left: convertInchesToTwip(0.5), hanging: convertInchesToTwip(0.18) },
                             },
                         },
                     },
                 ],
                 reference: "my-number-numbering-reference",
             },
+            {
+                levels: [
+                    {
+                        level: 0,
+                        format: LevelFormat.DECIMAL_ZERO,
+                        text: "[%1]",
+                        alignment: AlignmentType.START,
+                        style: {
+                            paragraph: {
+                                indent: { left: convertInchesToTwip(0.5), hanging: convertInchesToTwip(0.18) },
+                            },
+                        },
+                    },
+                ],
+                reference: "padded-numbering-reference",
+            },
         ],
     },
-});
-
-doc.addSection({
+    sections: [
+        {
             children: [
                 new Paragraph({
                     text: "line with contextual spacing",
@@ -109,6 +125,158 @@ doc.addSection({
                         level: 0,
                     },
                 }),
+                new Paragraph({
+                    text: "Next",
+                    heading: HeadingLevel.HEADING_2,
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                        instance: 2,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                        instance: 2,
+                    },
+                }),
+                new Paragraph({
+                    text: "Next",
+                    heading: HeadingLevel.HEADING_2,
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                        instance: 3,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                        instance: 3,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                        instance: 3,
+                    },
+                }),
+                new Paragraph({
+                    text: "Next",
+                    heading: HeadingLevel.HEADING_2,
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "test",
+                    numbering: {
+                        reference: "padded-numbering-reference",
+                        level: 0,
+                    },
+                }),
+            ],
+        },
     ],
 });
 

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

@@ -1,7 +1,7 @@
 // Numbering and bullet points example
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { AlignmentType, Document, Packer, Paragraph } from "../build";
+import { AlignmentType, convertInchesToTwip, Document, HeadingLevel, LevelFormat, Packer, Paragraph } from "../build";
 
 const doc = new Document({
     numbering: {
@@ -11,40 +11,40 @@ const doc = new Document({
                 levels: [
                     {
                         level: 0,
-                        format: "upperRoman",
+                        format: LevelFormat.UPPER_ROMAN,
                         text: "%1",
                         alignment: AlignmentType.START,
                         style: {
                             paragraph: {
-                                indent: { left: 720, hanging: 260 },
+                                indent: { left: convertInchesToTwip(0.5), hanging: convertInchesToTwip(0.18) },
                             },
                         },
                     },
                     {
                         level: 1,
-                        format: "decimal",
+                        format: LevelFormat.DECIMAL,
                         text: "%2.",
                         alignment: AlignmentType.START,
                         style: {
                             paragraph: {
-                                indent: { left: 1440, hanging: 980 },
+                                indent: { left: convertInchesToTwip(1), hanging: convertInchesToTwip(0.68) },
                             },
                         },
                     },
                     {
                         level: 2,
-                        format: "lowerLetter",
+                        format: LevelFormat.LOWER_LETTER,
                         text: "%3)",
                         alignment: AlignmentType.START,
                         style: {
                             paragraph: {
-                                indent: { left: 2160, hanging: 1700 },
+                                indent: { left: convertInchesToTwip(1.5), hanging: convertInchesToTwip(1.18) },
                             },
                         },
                     },
                     {
                         level: 3,
-                        format: "upperLetter",
+                        format: LevelFormat.UPPER_LETTER,
                         text: "%4)",
                         alignment: AlignmentType.START,
                         style: {
@@ -55,11 +55,70 @@ const doc = new Document({
                     },
                 ],
             },
+            {
+                reference: "my-unique-bullet-points",
+                levels: [
+                    {
+                        level: 0,
+                        format: LevelFormat.BULLET,
+                        text: "\u1F60",
+                        alignment: AlignmentType.LEFT,
+                        style: {
+                            paragraph: {
+                                indent: { left: convertInchesToTwip(0.5), hanging: convertInchesToTwip(0.25) },
+                            },
+                        },
+                    },
+                    {
+                        level: 1,
+                        format: LevelFormat.BULLET,
+                        text: "\u00A5",
+                        alignment: AlignmentType.LEFT,
+                        style: {
+                            paragraph: {
+                                indent: { left: convertInchesToTwip(1), hanging: convertInchesToTwip(0.25) },
+                            },
+                        },
+                    },
+                    {
+                        level: 2,
+                        format: LevelFormat.BULLET,
+                        text: "\u273F",
+                        alignment: AlignmentType.LEFT,
+                        style: {
+                            paragraph: {
+                                indent: { left: 2160, hanging: convertInchesToTwip(0.25) },
+                            },
+                        },
+                    },
+                    {
+                        level: 3,
+                        format: LevelFormat.BULLET,
+                        text: "\u267A",
+                        alignment: AlignmentType.LEFT,
+                        style: {
+                            paragraph: {
+                                indent: { left: 2880, hanging: convertInchesToTwip(0.25) },
+                            },
+                        },
+                    },
+                    {
+                        level: 4,
+                        format: LevelFormat.BULLET,
+                        text: "\u2603",
+                        alignment: AlignmentType.LEFT,
+                        style: {
+                            paragraph: {
+                                indent: { left: 3600, hanging: convertInchesToTwip(0.25) },
+                            },
+                        },
+                    },
                 ],
             },
-});
-
-doc.addSection({
+        ],
+    },
+    sections: [
+        {
             children: [
                 new Paragraph({
                     text: "Hey you",
@@ -134,6 +193,61 @@ doc.addSection({
                         level: 0,
                     },
                 }),
+                new Paragraph({
+                    text: "Custom Bullet points",
+                    heading: HeadingLevel.HEADING_1,
+                }),
+                new Paragraph({
+                    text: "What's up fam",
+                    numbering: {
+                        reference: "my-unique-bullet-points",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "Hey you",
+                    numbering: {
+                        reference: "my-unique-bullet-points",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "What's up fam",
+                    numbering: {
+                        reference: "my-unique-bullet-points",
+                        level: 1,
+                    },
+                }),
+                new Paragraph({
+                    text: "Hello World 2",
+                    numbering: {
+                        reference: "my-unique-bullet-points",
+                        level: 2,
+                    },
+                }),
+                new Paragraph({
+                    text: "Yeah boi",
+                    numbering: {
+                        reference: "my-unique-bullet-points",
+                        level: 3,
+                    },
+                }),
+                new Paragraph({
+                    text: "my Awesome numbering",
+                    numbering: {
+                        reference: "my-unique-bullet-points",
+                        level: 4,
+                    },
+                }),
+                new Paragraph({
+                    text: "Back to level 1",
+                    numbering: {
+                        reference: "my-unique-bullet-points",
+                        level: 1,
+                    },
+                }),
+            ],
+        },
     ],
 });
 

demo/30-template-document.ts

@@ -12,16 +12,21 @@ fs.readFile(filePath, (err, data) => {
     }
 
     importDotx.extract(data).then((templateDocument) => {
-        const doc = new Document(undefined, {
-            template: templateDocument,
-        });
-
-        doc.addSection({
+        const doc = new Document(
+            {
+                sections: [
+                    {
                         properties: {
                             titlePage: templateDocument.titlePageIsDefined,
                         },
                         children: [new Paragraph("Hello World")],
-        });
+                    },
+                ],
+            },
+            {
+                template: templateDocument,
+            },
+        );
 
         Packer.toBuffer(doc).then((buffer) => {
             fs.writeFileSync("My Document.docx", buffer);

demo/31-tables.ts

@@ -3,9 +3,11 @@
 import * as fs from "fs";
 import { Document, HeadingLevel, Packer, Paragraph, Table, TableCell, TableRow, VerticalAlign, TextDirection } from "../build";
 
-const doc = new Document();
-
-const table = new Table({
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Table({
                     rows: [
                         new TableRow({
                             children: [
@@ -65,10 +67,10 @@ const table = new Table({
                             ],
                         }),
                     ],
-});
-
-doc.addSection({
-    children: [table],
+                }),
+            ],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

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

@@ -2,9 +2,20 @@
 // Also includes an example on how to center tables
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { AlignmentType, BorderStyle, Document, HeadingLevel, Packer, Paragraph, ShadingType, Table, TableCell, TableRow, WidthType } from "../build";
-
-const doc = new Document();
+import {
+    AlignmentType,
+    BorderStyle,
+    convertInchesToTwip,
+    Document,
+    HeadingLevel,
+    Packer,
+    Paragraph,
+    ShadingType,
+    Table,
+    TableCell,
+    TableRow,
+    WidthType,
+} from "../build";
 
 const table = new Table({
     rows: [
@@ -37,10 +48,10 @@ const table2 = new Table({
                 new TableCell({
                     children: [new Paragraph("World")],
                     margins: {
-                        top: 1000,
-                        bottom: 1000,
-                        left: 1000,
-                        right: 1000,
+                        top: convertInchesToTwip(0.69),
+                        bottom: convertInchesToTwip(0.69),
+                        left: convertInchesToTwip(0.69),
+                        right: convertInchesToTwip(0.69),
                     },
                     columnSpan: 3,
                 }),
@@ -64,7 +75,7 @@ const table2 = new Table({
         size: 100,
         type: WidthType.AUTO,
     },
-    columnWidths: [1000, 1000, 1000],
+    columnWidths: [convertInchesToTwip(0.69), convertInchesToTwip(0.69), convertInchesToTwip(0.69)],
 });
 
 const table3 = new Table({
@@ -87,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",
                     },
                 }),
@@ -95,7 +106,7 @@ const table3 = new Table({
                     children: [new Paragraph("Bar2")],
                     shading: {
                         fill: "42c5f4",
-                        val: ShadingType.PERCENT_95,
+                        type: ShadingType.PERCENT_95,
                         color: "auto",
                     },
                 }),
@@ -103,7 +114,7 @@ const table3 = new Table({
                     children: [new Paragraph("Bar3")],
                     shading: {
                         fill: "880aa8",
-                        val: ShadingType.PERCENT_10,
+                        type: ShadingType.PERCENT_10,
                         color: "e2df0b",
                     },
                 }),
@@ -111,7 +122,7 @@ const table3 = new Table({
                     children: [new Paragraph("Bar4")],
                     shading: {
                         fill: "FF0000",
-                        val: ShadingType.CLEAR,
+                        type: ShadingType.CLEAR,
                         color: "auto",
                     },
                 }),
@@ -119,14 +130,14 @@ const table3 = new Table({
         }),
     ],
     width: {
-        size: 7000,
+        size: convertInchesToTwip(4.86),
         type: WidthType.DXA,
     },
     margins: {
-        top: 400,
-        bottom: 400,
-        right: 400,
-        left: 400,
+        top: convertInchesToTwip(0.27),
+        bottom: convertInchesToTwip(0.27),
+        right: convertInchesToTwip(0.27),
+        left: convertInchesToTwip(0.27),
     },
 });
 
@@ -213,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",
     },
 };
 
@@ -355,9 +366,7 @@ const table8 = new Table({
             ],
         }),
         new TableRow({
-            children: [
-                new TableCell({ children: [new Paragraph("4,1")] }),
-            ],
+            children: [new TableCell({ children: [new Paragraph("4,1")] })],
         }),
     ],
     width: {
@@ -365,8 +374,9 @@ const table8 = new Table({
         type: WidthType.PERCENTAGE,
     },
 });
-
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             children: [
                 table,
                 new Paragraph({
@@ -390,6 +400,8 @@ doc.addSection({
                 new Paragraph("Merging columns 5"),
                 table8,
             ],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/33-sequential-captions.ts

@@ -3,9 +3,9 @@
 import * as fs from "fs";
 import { Document, Packer, Paragraph, SequentialIdentifier, TextRun } from "../build";
 
-const doc = new Document();
-
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             children: [
                 new Paragraph({
                     children: [
@@ -40,6 +40,8 @@ doc.addSection({
                     ],
                 }),
             ],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/34-floating-tables.ts

@@ -16,8 +16,6 @@ import {
     WidthType,
 } from "../build";
 
-const doc = new Document();
-
 const table = new Table({
     rows: [
         new TableRow({
@@ -45,6 +43,10 @@ const table = new Table({
         relativeHorizontalPosition: RelativeHorizontalPosition.RIGHT,
         relativeVerticalPosition: RelativeVerticalPosition.BOTTOM,
         overlap: OverlapType.NEVER,
+        leftFromText: 1000,
+        rightFromText: 2000,
+        topFromText: 1500,
+        bottomFromText: 30,
     },
     width: {
         size: 4535,
@@ -53,8 +55,12 @@ const table = new Table({
     layout: TableLayoutType.FIXED,
 });
 
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             children: [table],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/35-hyperlinks.ts

@@ -1,34 +1,149 @@
 // Example on how to add hyperlinks to websites
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Document, HyperlinkRef, HyperlinkType, Packer, Paragraph, Media } from "../build";
+import { Document, ExternalHyperlink, Footer, FootnoteReferenceRun, ImageRun, Packer, Paragraph, TextRun } from "../build";
 
 const doc = new Document({
-    hyperlinks: {
-        myCoolLink: {
-            link: "http://www.example.com",
-            text: "Hyperlink",
-            type: HyperlinkType.EXTERNAL,
-        },
-        myOtherLink: {
-            link: "http://www.google.com",
-            text: "Google Link",
-            type: HyperlinkType.EXTERNAL,
-        },
-    },
-});
-
-const image1 = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
-
-doc.addSection({
+    footnotes: {
+        1: {
             children: [
                 new Paragraph({
-            children: [new HyperlinkRef("myCoolLink")],
+                    children: [
+                        new TextRun("Click here for the "),
+                        new ExternalHyperlink({
+                            children: [
+                                new TextRun({
+                                    text: "Footnotes external hyperlink",
+                                    style: "Hyperlink",
+                                }),
+                            ],
+                            link: "http://www.example.com",
+                        }),
+                    ],
+                }),
+            ],
+        },
+    },
+    sections: [
+        {
+            footers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new TextRun("Click here for the "),
+                                new ExternalHyperlink({
+                                    children: [
+                                        new TextRun({
+                                            text: "Footer external hyperlink",
+                                            style: "Hyperlink",
+                                        }),
+                                    ],
+                                    link: "http://www.example.com",
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            headers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new TextRun("Click here for the "),
+                                new ExternalHyperlink({
+                                    children: [
+                                        new TextRun({
+                                            text: "Header external hyperlink",
+                                            style: "Hyperlink",
+                                        }),
+                                    ],
+                                    link: "http://www.google.com",
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            children: [
+                new Paragraph({
+                    children: [
+                        new ExternalHyperlink({
+                            children: [
+                                new TextRun({
+                                    text: "Anchor Text",
+                                    style: "Hyperlink",
+                                }),
+                            ],
+                            link: "http://www.example.com",
+                        }),
+                        new FootnoteReferenceRun(1),
+                    ],
                 }),
                 new Paragraph({
-            children: [image1, new HyperlinkRef("myOtherLink")],
+                    children: [
+                        new ExternalHyperlink({
+                            children: [
+                                new ImageRun({
+                                    data: fs.readFileSync("./demo/images/image1.jpeg"),
+                                    transformation: {
+                                        width: 100,
+                                        height: 100,
+                                    },
                                 }),
                             ],
+                            link: "http://www.google.com",
+                        }),
+                        new ExternalHyperlink({
+                            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",
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

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

@@ -1,10 +1,7 @@
 // Add image to table cell in a header and body
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Document, Header, Media, Packer, Paragraph, Table, TableCell, TableRow } from "../build";
-
-const doc = new Document();
-const image = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
+import { Document, Header, ImageRun, Packer, Paragraph, Table, TableCell, TableRow } from "../build";
 
 const table = new Table({
     rows: [
@@ -30,7 +27,19 @@ const table = new Table({
                     children: [],
                 }),
                 new TableCell({
-                    children: [new Paragraph(image)],
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new ImageRun({
+                                    data: fs.readFileSync("./demo/images/image1.jpeg"),
+                                    transformation: {
+                                        width: 100,
+                                        height: 100,
+                                    },
+                                }),
+                            ],
+                        }),
+                    ],
                 }),
             ],
         }),
@@ -58,13 +67,17 @@ const table = new Table({
 });
 
 // Adding same table in the body and in the header
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             headers: {
                 default: new Header({
                     children: [table],
                 }),
             },
             children: [table],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

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

@@ -1,20 +1,53 @@
 // Add images to header and footer
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Document, Header, Media, Packer, Paragraph } from "../build";
+import { Document, Header, ImageRun, Packer, Paragraph } from "../build";
 
-const doc = new Document();
-const image = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
-const image1 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
-const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
-
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             headers: {
                 default: new Header({
-            children: [new Paragraph(image), new Paragraph(image1), new Paragraph(image2)],
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new ImageRun({
+                                    data: fs.readFileSync("./demo/images/image1.jpeg"),
+                                    transformation: {
+                                        width: 100,
+                                        height: 100,
+                                    },
+                                }),
+                            ],
+                        }),
+                        new Paragraph({
+                            children: [
+                                new ImageRun({
+                                    data: fs.readFileSync("./demo/images/pizza.gif"),
+                                    transformation: {
+                                        width: 100,
+                                        height: 100,
+                                    },
+                                }),
+                            ],
+                        }),
+                        new Paragraph({
+                            children: [
+                                new ImageRun({
+                                    data: fs.readFileSync("./demo/images/image1.jpeg"),
+                                    transformation: {
+                                        width: 100,
+                                        height: 100,
+                                    },
+                                }),
+                            ],
+                        }),
+                    ],
                 }),
             },
             children: [new Paragraph("Hello World")],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/38-text-wrapping.ts

@@ -2,11 +2,29 @@
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
 // import { Document, Packer, Paragraph } from "../build";
-import { Document, Media, Packer, Paragraph, TextWrappingSide, TextWrappingType } from "../build";
+import { Document, ImageRun, Packer, Paragraph, TextWrappingSide, TextWrappingType } from "../build";
 
-const doc = new Document();
-
-const image = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 200, 200, {
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Paragraph(
+                    "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque vehicula nec nulla vitae efficitur. Ut interdum mauris eu ipsum rhoncus, nec pharetra velit placerat. Sed vehicula libero ac urna molestie, id pharetra est pellentesque. Praesent iaculis vehicula fringilla. Duis pretium gravida orci eu vestibulum. Mauris tincidunt ipsum dolor, ut ornare dolor pellentesque id. Integer in nulla gravida, lacinia ante non, commodo ex. Vivamus vulputate nisl id lectus finibus vulputate. Ut et nisl mi. Cras fermentum augue arcu, ac accumsan elit euismod id. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed ac posuere nisi. Pellentesque tincidunt vehicula bibendum. Phasellus eleifend viverra nisl.",
+                ),
+                new Paragraph(
+                    "Proin ac purus faucibus, porttitor magna ut, cursus nisl. Vivamus ante purus, porta accumsan nibh eget, eleifend dignissim odio. Integer sed dictum est, aliquam lacinia justo. Donec ultrices auctor venenatis. Etiam interdum et elit nec elementum. Pellentesque nec viverra mauris. Etiam suscipit leo nec velit fringilla mattis. Pellentesque justo lacus, sodales eu condimentum in, dapibus finibus lacus. Morbi vitae nibh sit amet sem molestie feugiat. In non porttitor enim.",
+                ),
+                new Paragraph(
+                    "Ut eget diam cursus quam accumsan interdum at id ante. Ut mollis mollis arcu, eu scelerisque dui tempus in. Quisque aliquam, augue quis ornare aliquam, ex purus ultrices mauris, ut porta dolor dolor nec justo. Nunc a tempus odio, eu viverra arcu. Suspendisse vitae nibh nec mi pharetra tempus. Mauris ut ullamcorper sapien, et sagittis sapien. Vestibulum in urna metus. In scelerisque, massa id bibendum tempus, quam orci rutrum turpis, a feugiat nisi ligula id metus. Praesent id dictum purus. Proin interdum ipsum nulla.",
+                ),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 200,
+                                height: 200,
+                            },
                             floating: {
                                 horizontalPosition: {
                                     offset: 2014400,
@@ -23,20 +41,11 @@ const image = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 20
                                     bottom: 201440,
                                 },
                             },
-});
-
-doc.addSection({
-    children: [
-        new Paragraph(
-            "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque vehicula nec nulla vitae efficitur. Ut interdum mauris eu ipsum rhoncus, nec pharetra velit placerat. Sed vehicula libero ac urna molestie, id pharetra est pellentesque. Praesent iaculis vehicula fringilla. Duis pretium gravida orci eu vestibulum. Mauris tincidunt ipsum dolor, ut ornare dolor pellentesque id. Integer in nulla gravida, lacinia ante non, commodo ex. Vivamus vulputate nisl id lectus finibus vulputate. Ut et nisl mi. Cras fermentum augue arcu, ac accumsan elit euismod id. Vestibulum ante ipsum primis in faucibus orci luctus et ultrices posuere cubilia Curae; Sed ac posuere nisi. Pellentesque tincidunt vehicula bibendum. Phasellus eleifend viverra nisl.",
-        ),
-        new Paragraph(
-            "Proin ac purus faucibus, porttitor magna ut, cursus nisl. Vivamus ante purus, porta accumsan nibh eget, eleifend dignissim odio. Integer sed dictum est, aliquam lacinia justo. Donec ultrices auctor venenatis. Etiam interdum et elit nec elementum. Pellentesque nec viverra mauris. Etiam suscipit leo nec velit fringilla mattis. Pellentesque justo lacus, sodales eu condimentum in, dapibus finibus lacus. Morbi vitae nibh sit amet sem molestie feugiat. In non porttitor enim.",
-        ),
-        new Paragraph(
-            "Ut eget diam cursus quam accumsan interdum at id ante. Ut mollis mollis arcu, eu scelerisque dui tempus in. Quisque aliquam, augue quis ornare aliquam, ex purus ultrices mauris, ut porta dolor dolor nec justo. Nunc a tempus odio, eu viverra arcu. Suspendisse vitae nibh nec mi pharetra tempus. Mauris ut ullamcorper sapien, et sagittis sapien. Vestibulum in urna metus. In scelerisque, massa id bibendum tempus, quam orci rutrum turpis, a feugiat nisi ligula id metus. Praesent id dictum purus. Proin interdum ipsum nulla.",
-        ),
-        new Paragraph(image),
+                        }),
+                    ],
+                }),
+            ],
+        },
     ],
 });
 

demo/39-page-numbers.ts

@@ -1,11 +1,19 @@
 // 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({});
-
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
+            properties: {
+                page: {
+                    pageNumbers: {
+                        start: 1,
+                        formatType: NumberFormat.DECIMAL,
+                    },
+                },
+            },
             headers: {
                 default: new Header({
                     children: [
@@ -41,10 +49,6 @@ doc.addSection({
                     ],
                 }),
             },
-    properties: {
-        pageNumberStart: 1,
-        pageNumberFormatType: PageNumberFormat.DECIMAL,
-    },
             children: [
                 new Paragraph({
                     children: [new TextRun("Hello World 1"), new PageBreak()],
@@ -62,6 +66,8 @@ doc.addSection({
                     children: [new TextRun("Hello World 5"), new PageBreak()],
                 }),
             ],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/4-basic-table.ts

@@ -1,11 +1,93 @@
 // Example of how you would create a table and add data to it
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Document, Packer, Paragraph, Table, TableCell, TableRow } from "../build";
-
-const doc = new Document();
+import { Document, Packer, Paragraph, Table, TableCell, TableRow, WidthType } from "../build";
 
 const table = new Table({
+    columnWidths: [3505, 5505],
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    width: {
+                        size: 3505,
+                        type: WidthType.DXA,
+                    },
+                    children: [new Paragraph("Hello")],
+                }),
+                new TableCell({
+                    width: {
+                        size: 5505,
+                        type: WidthType.DXA,
+                    },
+                    children: [],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    width: {
+                        size: 3505,
+                        type: WidthType.DXA,
+                    },
+                    children: [],
+                }),
+                new TableCell({
+                    width: {
+                        size: 5505,
+                        type: WidthType.DXA,
+                    },
+                    children: [new Paragraph("World")],
+                }),
+            ],
+        }),
+    ],
+});
+
+const table2 = new Table({
+    columnWidths: [4505, 4505],
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    width: {
+                        size: 4505,
+                        type: WidthType.DXA,
+                    },
+                    children: [new Paragraph("Hello")],
+                }),
+                new TableCell({
+                    width: {
+                        size: 4505,
+                        type: WidthType.DXA,
+                    },
+                    children: [],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    width: {
+                        size: 4505,
+                        type: WidthType.DXA,
+                    },
+                    children: [],
+                }),
+                new TableCell({
+                    width: {
+                        size: 4505,
+                        type: WidthType.DXA,
+                    },
+                    children: [new Paragraph("World")],
+                }),
+            ],
+        }),
+    ],
+});
+
+const table3 = new Table({
     rows: [
         new TableRow({
             children: [
@@ -30,8 +112,19 @@ const table = new Table({
     ],
 });
 
-doc.addSection({
-    children: [table],
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Paragraph({ text: "Table with skewed widths" }),
+                table,
+                new Paragraph({ text: "Table with equal widths" }),
+                table2,
+                new Paragraph({ text: "Table without setting widths" }),
+                table3,
+            ],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/40-line-numbers.ts

@@ -3,12 +3,14 @@
 import * as fs from "fs";
 import { Document, HeadingLevel, LineNumberRestartFormat, Packer, Paragraph } from "../build";
 
-const doc = new Document();
-
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             properties: {
-        lineNumberCountBy: 1,
-        lineNumberRestart: LineNumberRestartFormat.CONTINUOUS,
+                lineNumbers: {
+                    countBy: 1,
+                    restart: LineNumberRestartFormat.CONTINUOUS,
+                },
             },
             children: [
                 new Paragraph({
@@ -22,6 +24,8 @@ doc.addSection({
                     "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) => {

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

@@ -3,8 +3,6 @@
 import * as fs from "fs";
 import { Document, Packer, Paragraph, Table, TableCell, TableRow } from "../build";
 
-const doc = new Document();
-
 const table = new Table({
     rows: [
         new TableRow({
@@ -252,8 +250,12 @@ const table2 = new Table({
     ],
 });
 
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             children: [table, new Paragraph(""), table2],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/42-restart-page-numbers.ts

@@ -0,0 +1,93 @@
+// Page numbers - Start from 0 on a new section
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { AlignmentType, Document, Header, Packer, PageBreak, PageNumber, PageNumberSeparator, Paragraph, TextRun } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            headers: {
+                default: new Header({
+                    children: [
+                        new Paragraph({
+                            alignment: AlignmentType.RIGHT,
+                            children: [
+                                new TextRun("My Title "),
+                                new TextRun({
+                                    children: ["Page ", PageNumber.CURRENT],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                first: new Header({
+                    children: [
+                        new Paragraph({
+                            alignment: AlignmentType.RIGHT,
+                            children: [
+                                new TextRun("First Page Header "),
+                                new TextRun({
+                                    children: ["Page ", PageNumber.CURRENT],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            children: [
+                new Paragraph({
+                    children: [new TextRun("First Page"), new PageBreak()],
+                }),
+                new Paragraph("Second Page"),
+            ],
+        },
+        {
+            properties: {
+                page: {
+                    pageNumbers: {
+                        start: 1,
+                        separator: PageNumberSeparator.EM_DASH,
+                    },
+                },
+            },
+            headers: {
+                default: new Header({
+                    children: [
+                        new Paragraph({
+                            alignment: AlignmentType.RIGHT,
+                            children: [
+                                new TextRun("My Title "),
+                                new TextRun({
+                                    children: ["Page ", PageNumber.CURRENT],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                first: new Header({
+                    children: [
+                        new Paragraph({
+                            alignment: AlignmentType.RIGHT,
+                            children: [
+                                new TextRun("First Page Header of Second section"),
+                                new TextRun({
+                                    children: ["Page ", PageNumber.CURRENT],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            children: [
+                new Paragraph({
+                    children: [new TextRun("Third Page"), new PageBreak()],
+                }),
+                new Paragraph("Fourth Page"),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

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

@@ -3,8 +3,6 @@
 import * as fs from "fs";
 import { Document, Packer, Paragraph, Table, TableCell, TableRow } from "../build";
 
-const doc = new Document();
-
 const table = new Table({
     rows: [
         new TableRow({
@@ -75,8 +73,12 @@ const table = new Table({
     ],
 });
 
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             children: [table],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/44-multiple-columns.ts

@@ -3,9 +3,9 @@
 import * as fs from "fs";
 import { Document, Packer, Paragraph } from "../build";
 
-const doc = new Document();
-
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             properties: {
                 column: {
                     space: 708,
@@ -18,9 +18,8 @@ doc.addSection({
                     "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.",
                 ),
             ],
-});
-
-doc.addSection({
+        },
+        {
             properties: {
                 column: {
                     space: 708,
@@ -33,6 +32,23 @@ doc.addSection({
                     "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.",
                 ),
             ],
+        },
+        {
+            properties: {
+                column: {
+                    space: 708,
+                    count: 2,
+                    separate: true,
+                },
+            },
+            children: [
+                new Paragraph("This text will be split into 2 columns on a page."),
+                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) => {

demo/45-highlighting-text.ts

@@ -3,9 +3,9 @@
 import * as fs from "fs";
 import { AlignmentType, Document, Header, Packer, Paragraph, TextRun } from "../build";
 
-const doc = new Document();
-
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             headers: {
                 default: new Header({
                     children: [
@@ -14,7 +14,7 @@ doc.addSection({
                             children: [
                                 new TextRun({
                                     text: "Hello World",
-                            color: "red",
+                                    color: "FF0000",
                                     bold: true,
                                     size: 24,
                                     font: {
@@ -28,6 +28,8 @@ doc.addSection({
                 }),
             },
             children: [],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/46-shading-text.ts

@@ -3,9 +3,9 @@
 import * as fs from "fs";
 import { AlignmentType, Document, Header, Packer, Paragraph, ShadingType, TextRun } from "../build";
 
-const doc = new Document();
-
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             headers: {
                 default: new Header({
                     children: [
@@ -14,7 +14,7 @@ doc.addSection({
                             children: [
                                 new TextRun({
                                     text: "Hello World",
-                            color: "red",
+                                    color: "FF0000",
                                     bold: true,
                                     size: 24,
                                     font: {
@@ -28,10 +28,37 @@ doc.addSection({
                                 }),
                             ],
                         }),
+                        new Paragraph({
+                            shading: {
+                                type: ShadingType.DIAGONAL_CROSS,
+                                color: "00FFFF",
+                                fill: "FF0000",
+                            },
+                            children: [
+                                new TextRun({
+                                    text: "Hello World for entire paragraph",
+                                }),
+                            ],
+                        }),
                     ],
                 }),
             },
-    children: [],
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            emboss: true,
+                            text: "Embossed text - hello world",
+                        }),
+                        new TextRun({
+                            imprint: true,
+                            text: "Imprinted text - hello world",
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

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

@@ -1,9 +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";
-
-const doc = new Document();
+import { AlignmentType, Document, Footer, Header, Packer, PageBreak, PageNumber, NumberFormat, Paragraph, TextRun } from "../build";
 
 const header = new Header({
     children: [
@@ -26,40 +24,51 @@ const footer = new Footer({
     children: [new Paragraph("Foo Bar corp. ")],
 });
 
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
+            properties: {
+                page: {
+                    pageNumbers: {
+                        start: 1,
+                        formatType: NumberFormat.DECIMAL,
+                    },
+                },
+            },
             headers: {
                 default: header,
             },
             footers: {
                 default: footer,
             },
-    properties: {
-        pageNumberStart: 1,
-        pageNumberFormatType: PageNumberFormat.DECIMAL,
-    },
             children: [
                 new Paragraph({
                     children: [new TextRun("Section 1"), new PageBreak(), new TextRun("Section 1"), new PageBreak()],
                 }),
             ],
-});
-
-doc.addSection({
+        },
+        {
+            properties: {
+                page: {
+                    pageNumbers: {
+                        start: 1,
+                        formatType: NumberFormat.DECIMAL,
+                    },
+                },
+            },
             headers: {
                 default: header,
             },
             footers: {
                 default: footer,
             },
-    properties: {
-        pageNumberStart: 1,
-        pageNumberFormatType: PageNumberFormat.DECIMAL,
-    },
             children: [
                 new Paragraph({
                     children: [new TextRun("Section 2"), new PageBreak(), new TextRun("Section 2"), new PageBreak()],
                 }),
             ],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

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();
-
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             properties: {
-        verticalAlign: SectionVerticalAlignValue.CENTER,
+                verticalAlign: VerticalAlign.CENTER,
             },
             children: [
                 new Paragraph({
@@ -24,6 +24,8 @@ doc.addSection({
                     ],
                 }),
             ],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/49-table-borders.ts

@@ -1,15 +1,47 @@
-// Add custom borders to the table itself
+// Add custom borders and no-borders to the table itself
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { BorderStyle, Document, Packer, Paragraph, Table, TableCell, TableRow } from "../build";
-
-const doc = new Document();
+import {
+    BorderStyle,
+    Document,
+    HeadingLevel,
+    Packer,
+    Paragraph,
+    Table,
+    TableBorders,
+    TableCell,
+    TableRow,
+    TextDirection,
+    VerticalAlign,
+} from "../build";
 
 const table = new Table({
     rows: [
         new TableRow({
             children: [
                 new TableCell({
+                    borders: {
+                        top: {
+                            style: BorderStyle.DASH_SMALL_GAP,
+                            size: 1,
+                            color: "ff0000",
+                        },
+                        bottom: {
+                            style: BorderStyle.DASH_SMALL_GAP,
+                            size: 1,
+                            color: "ff0000",
+                        },
+                        left: {
+                            style: BorderStyle.DASH_SMALL_GAP,
+                            size: 1,
+                            color: "ff0000",
+                        },
+                        right: {
+                            style: BorderStyle.DASH_SMALL_GAP,
+                            size: 1,
+                            color: "ff0000",
+                        },
+                    },
                     children: [new Paragraph("Hello")],
                 }),
                 new TableCell({
@@ -30,7 +62,105 @@ const table = new Table({
     ],
 });
 
-doc.addSection({ children: [table] });
+// Using the no-border convenience object. It is the same as writing this manually:
+// const borders = {
+//     top: {
+//         style: BorderStyle.NONE,
+//         size: 0,
+//         color: "auto",
+//     },
+//     bottom: {
+//         style: BorderStyle.NONE,
+//         size: 0,
+//         color: "auto",
+//     },
+//     left: {
+//         style: BorderStyle.NONE,
+//         size: 0,
+//         color: "auto",
+//     },
+//     right: {
+//         style: BorderStyle.NONE,
+//         size: 0,
+//         color: "auto",
+//     },
+//     insideHorizontal: {
+//         style: BorderStyle.NONE,
+//         size: 0,
+//         color: "auto",
+//     },
+//     insideVertical: {
+//         style: BorderStyle.NONE,
+//         size: 0,
+//         color: "auto",
+//     },
+// };
+const noBorderTable = new Table({
+    borders: TableBorders.NONE,
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph({}), new Paragraph({})],
+                    verticalAlign: VerticalAlign.CENTER,
+                }),
+                new TableCell({
+                    children: [new Paragraph({}), new Paragraph({})],
+                    verticalAlign: VerticalAlign.CENTER,
+                }),
+                new TableCell({
+                    children: [new Paragraph({ text: "bottom to top" }), new Paragraph({})],
+                    textDirection: TextDirection.BOTTOM_TO_TOP_LEFT_TO_RIGHT,
+                }),
+                new TableCell({
+                    children: [new Paragraph({ text: "top to bottom" }), new Paragraph({})],
+                    textDirection: TextDirection.TOP_TO_BOTTOM_RIGHT_TO_LEFT,
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [
+                        new Paragraph({
+                            text:
+                                "Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah",
+                            heading: HeadingLevel.HEADING_1,
+                        }),
+                    ],
+                }),
+                new TableCell({
+                    children: [
+                        new Paragraph({
+                            text: "This text should be in the middle of the cell",
+                        }),
+                    ],
+                    verticalAlign: VerticalAlign.CENTER,
+                }),
+                new TableCell({
+                    children: [
+                        new Paragraph({
+                            text: "Text above should be vertical from bottom to top",
+                        }),
+                    ],
+                    verticalAlign: VerticalAlign.CENTER,
+                }),
+                new TableCell({
+                    children: [
+                        new Paragraph({
+                            text: "Text above should be vertical from top to bottom",
+                        }),
+                    ],
+                    verticalAlign: VerticalAlign.CENTER,
+                }),
+            ],
+        }),
+    ],
+});
+
+const doc = new Document({
+    sections: [{ children: [table, new Paragraph("Hello"), noBorderTable] }],
+});
 
 Packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);

demo/5-images.ts

@@ -1,27 +1,99 @@
 // Example of how to add images to the document - You can use Buffers, UInt8Arrays or Base64 strings
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-// import { Document, Packer, Paragraph } from "../build";
 import {
     Document,
     HorizontalPositionAlign,
     HorizontalPositionRelativeFrom,
-    Media,
+    ImageRun,
     Packer,
     Paragraph,
     VerticalPositionAlign,
     VerticalPositionRelativeFrom,
 } from "../build";
 
-const doc = new Document();
-
-const image1 = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
-const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/dog.png").toString("base64"));
-const image3 = Media.addImage(doc, fs.readFileSync("./demo/images/cat.jpg"));
-const image4 = Media.addImage(doc, fs.readFileSync("./demo/images/parrots.bmp"));
-const image5 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
-const image6 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 200, 200, {
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Paragraph("Hello World"),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/image1.jpeg"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/dog.png").toString("base64"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/cat.jpg"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                                flip: {
+                                    vertical: true,
+                                },
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/parrots.bmp"),
+                            transformation: {
+                                width: 150,
+                                height: 150,
+                                flip: {
+                                    horizontal: true,
+                                },
+                                rotation: 225,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 200,
+                                height: 200,
+                                flip: {
+                                    horizontal: true,
+                                    vertical: true,
+                                },
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 200,
+                                height: 200,
+                                rotation: 45,
+                            },
                             floating: {
+                                zIndex: 10,
                                 horizontalPosition: {
                                     offset: 1014400,
                                 },
@@ -29,10 +101,19 @@ const image6 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 2
                                     offset: 1014400,
                                 },
                             },
-});
-
-const image7 = Media.addImage(doc, fs.readFileSync("./demo/images/cat.jpg"), 200, 200, {
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/cat.jpg"),
+                            transformation: {
+                                width: 200,
+                                height: 200,
+                            },
                             floating: {
+                                zIndex: 5,
                                 horizontalPosition: {
                                     relative: HorizontalPositionRelativeFrom.PAGE,
                                     align: HorizontalPositionAlign.RIGHT,
@@ -42,18 +123,11 @@ const image7 = Media.addImage(doc, fs.readFileSync("./demo/images/cat.jpg"), 200
                                     align: VerticalPositionAlign.BOTTOM,
                                 },
                             },
-});
-
-doc.addSection({
-    children: [
-        new Paragraph("Hello World"),
-        new Paragraph(image1),
-        new Paragraph(image2),
-        new Paragraph(image3),
-        new Paragraph(image4),
-        new Paragraph(image5),
-        new Paragraph(image6),
-        new Paragraph(image7),
+                        }),
+                    ],
+                }),
+            ],
+        },
     ],
 });
 

demo/50-readme-demo.ts

@@ -1,19 +1,26 @@
-// Simple example to add text to a document
+// The demo on the README.md
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Document, HeadingLevel, Media, Packer, Paragraph, Table, TableCell, TableRow, VerticalAlign } from "../build";
-
-const doc = new Document();
-
-const image1 = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
-const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
+import { Document, HeadingLevel, ImageRun, Packer, Paragraph, Table, TableCell, TableRow, VerticalAlign } from "../build";
 
 const table = new Table({
     rows: [
         new TableRow({
             children: [
                 new TableCell({
-                    children: [new Paragraph(image1)],
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new ImageRun({
+                                    data: fs.readFileSync("./demo/images/image1.jpeg"),
+                                    transformation: {
+                                        width: 100,
+                                        height: 100,
+                                    },
+                                }),
+                            ],
+                        }),
+                    ],
                     verticalAlign: VerticalAlign.CENTER,
                 }),
                 new TableCell({
@@ -38,21 +45,47 @@ const table = new Table({
                     ],
                 }),
                 new TableCell({
-                    children: [new Paragraph(image1)],
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new ImageRun({
+                                    data: fs.readFileSync("./demo/images/image1.jpeg"),
+                                    transformation: {
+                                        width: 100,
+                                        height: 100,
+                                    },
+                                }),
+                            ],
+                        }),
+                    ],
                 }),
             ],
         }),
     ],
 });
 
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             children: [
                 new Paragraph({
                     text: "Hello World",
                     heading: HeadingLevel.HEADING_1,
                 }),
                 table,
-        new Paragraph(image2),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+            ],
+        },
     ],
 });
 

demo/51-character-styles.ts

@@ -15,11 +15,18 @@ const doc = new Document({
                     italics: true,
                 },
             },
+            {
+                id: "strong",
+                name: "Strong",
+                basedOn: "Normal",
+                run: {
+                    bold: true,
+                },
+            },
         ],
     },
-});
-
-doc.addSection({
+    sections: [
+        {
             children: [
                 new Paragraph({
                     children: [
@@ -29,6 +36,20 @@ doc.addSection({
                         }),
                     ],
                 }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "First Word",
+                            style: "strong",
+                        }),
+                        new TextRun({
+                            text:
+                                " - 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.",
+                        }),
+                    ],
+                }),
+            ],
+        },
     ],
 });
 

demo/52-japanese.ts

@@ -18,9 +18,8 @@ const doc = new Document({
             },
         ],
     },
-});
-
-doc.addSection({
+    sections: [
+        {
             children: [
                 new Paragraph({
                     text: "KFCを食べるのが好き",
@@ -30,6 +29,8 @@ doc.addSection({
                     text: "こんにちは",
                 }),
             ],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/53-chinese.ts

@@ -11,6 +11,18 @@ import { Document, HeadingLevel, Packer, Paragraph, TextRun } from "../build";
 
 const doc = new Document({
     styles: {
+        default: {
+            document: {
+                run: {
+                    font: {
+                        ascii: "minorHAnsi",
+                        eastAsia: "minorEastAsia",
+                        cs: "minorBidi",
+                        hAnsi: "minorHAnsi",
+                    },
+                },
+            },
+        },
         paragraphStyles: [
             {
                 id: "Normal",
@@ -20,16 +32,17 @@ const doc = new Document({
                 quickFormat: true,
                 run: {
                     font: {
-                        ascii: "Times",
-                        eastAsia: "KaiTi",
+                        ascii: "minorHAnsi", // Can also use minorHAnsi
+                        eastAsia: "minorEastAsia", // Can also use minorEastAsia
+                        cs: "minorBidi",
+                        hAnsi: "minorHAnsi",
                     },
                 },
             },
         ],
     },
-});
-
-doc.addSection({
+    sections: [
+        {
             children: [
                 new Paragraph({
                     text: "中文和英文 Chinese and English",
@@ -47,6 +60,29 @@ doc.addSection({
                         }),
                     ],
                 }),
+                new Paragraph({
+                    text: `店様付旅母正役基社発破班。発治治京岡局本因追意金紀統責郵滴尽。立功日庁重天富評界明済不着法返祉経正引行。載区列防新目治日群付無人道言越名。界安無死専体風木人教録覧訃。女問堂容県作先芸便効証帯債土全極的日。能山中岡仕関攻井季接店線幌温後率事阜止。成間路行究今式歌像祉帯式媛読徹。安行息古入出文侵監株登部席内文第珍鶴問用。
+    
+                編竹入俳多応日氏陸福芸北供動。情績拠僧肺軍油能認郷翌南対韓短東食束兵晶。政予任習口佐所当止市告号。悩申無式立医毎部観潟訴菱権。発臼背郎上予配光記芸注然出。梨場株以政囲下球品材県動政押婚面見。米共試使落帳遅毅間三子開。問与大八地芸第線体架辺今死。押構草齢戦重最変社豪記目盗連報準周込。系貸劇様重鷲始能質村異社学動導勤。
+                
+                残様的荻仲刺局標績供質球就雄。考和母問者役尊紙推新経革個事編安観。益学北日著楽車山勢流泉四犯投台戒設対臨百。危謄初治穴委済本索労刊回。月写政覧女事棋違年終索情響白子泉転企堀社。江遊著西高開面毎分芸責成創査全判調目止懇。原育会夏作売望人転乱融抜心。制川供健水示囲阜厚高右断季人役。持面必日暮気管像冬間影図健行格阪。
+                
+                来入工速会健評下町慮大貸社一見園外申憶。服豊舞入面沢交使奥見記写意岩。北観提女刊液城共五擦相売田合是由読。回歳売苦定記点郎意増賛治北渡本応。受送文携村陸情静了申注際。順負子研済老上変女産第内無費携投展達。東初乗回動合語学待聴暮沢流全場導敷記賞次。更物中備著後渡売第部時禁新田木下昨。備護起織服久権意全海馬適応。
+                
+                幸速団供地信討川安矛場消学年。去茂玉東今要出約元教負限載始今簡。編掲証的情仕渡室手映法部始。紙反語清阪曜税受知選謝個印観聞。教人超死準無者参生撤技真価椿景破市見国。左需臓道力趣暮際丁高会近部敗岡力当社。壊態毒期波超長写島断兆国世行共絞私報。反野番点図択女撃脱案情王援。減属考論月院催者門料約覧市戦。
+                
+                山部午金査投立集争教殺巣作世動北部応。通負考隙問粛中帯閉要程規化小。橋棋互界時引就現省竹去子無系容米。竹転起日本新田強済購書区庁集作容同会窓教。文公神転待究挙登投川選囲針能楽路断出歌。祥新現寄公史真玉属元始員金抜関前百衝能。国眺暮囲世嘘面外営国内報夜九掲事春葉。来月刊台先良理著自供法投。通渡請当月学安首一押実展介況。
+                
+                法優分独込右得里記域目順供進乗。憂婚転峰大写医投社曲題任能務熱県展覧港専。栄余歯真著改追事作果石芸。青感将南便再転領鈴投提鉄索競虎師体物想。牲打迎達携度開技書催掲安去変念座。革混疑生採就枢当住回県組北意寛。爆新和級掲交象温十賛展木開有結日。新海辺小除京物興量写界裁上。文師建関面取質也底沼画者図空医心無季。
+                
+                高館湯転名気業以際置講詰方活礎組調軽際。発変東作訪乃小化理利提目気。極季本問号面帯勤戦行新禁情堀郎携。座所転再祥業必変昌今歩佐王立抗後養崩。支物猪躍芸整縦焦供防続相護治時語朝分刊定。綿田幸崎責本欲間載神調崎答志政報与速美載。飯治止稿原先明画森群進見情幕。女民館終調質並伝車慌供科。支田国傷自動献疑討医足公成公主断的望。
+                
+                責開児食福実帰治師今策今。水重寺圧医観送連東者秒途。選央力律式開作掲写様階組戦写型紙。式国販時天遣国出難共前次領体康稲住転。査見保重議原速群者内月正連。爾天膨装芸別巨平運数準三浜念載創県奈飛提。素京発揮田談気党示見象定電類代級。善返跡国有話権入猛府週亡辞馬脳。関残主祐雪塚去集村完海関文受載表川護照立。
+                
+                発闘美慎健育旅布容広互無秋認天歌媛芸。転器合読県増認会賞倒点系。食気母服絵知去祝芸車報熱勝。能貿月更障文的欠賞現覇声敏施会。懲病写昼法族業律記聡生開緊楽暮護。東地二員者説盟治害討面提。第北乗査庭年近的禁疑報方店記必迷都流通。聞有力前愛院梨野関業前訳本清滋補。蒲読火死勝広保会婚際気二由保国。用君込村需起相点選紙拡氏訃不。`,
+                }),
+            ],
+        },
     ],
 });
 

demo/54-custom-properties.ts

@@ -0,0 +1,27 @@
+// Custom Properties
+// Custom properties are incredibly useful if you want to be able to apply quick parts or custom cover pages
+// to the document in Word after the document has been generated. Standard properties (such as creator, title
+// and subject) cover typical use cases, but sometimes custom properties are required.
+
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer } from "../build";
+
+const doc = new Document(
+    // Standard properties
+    {
+        creator: "Creator",
+        title: "Title",
+        subject: "Subject",
+        description: "Description",
+        customProperties: [
+            { name: "Subtitle", value: "Subtitle" },
+            { name: "Address", value: "Address" },
+        ],
+        sections: [],
+    },
+);
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/55-math.ts

@@ -0,0 +1,296 @@
+// Simple example to add text to a document
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import {
+    Document,
+    Math,
+    MathAngledBrackets,
+    MathCurlyBrackets,
+    MathFraction,
+    MathFunction,
+    MathPreSubSuperScript,
+    MathRadical,
+    MathRoundBrackets,
+    MathRun,
+    MathSquareBrackets,
+    MathSubScript,
+    MathSubSuperScript,
+    MathSum,
+    MathSuperScript,
+    Packer,
+    Paragraph,
+    TextRun,
+} from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {},
+            children: [
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathRun("2+2"),
+                                new MathFraction({
+                                    numerator: [new MathRun("hi")],
+                                    denominator: [new MathRun("2")],
+                                }),
+                            ],
+                        }),
+                        new TextRun({
+                            text: "Foo Bar",
+                            bold: true,
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathFraction({
+                                    numerator: [
+                                        new MathRun("1"),
+                                        new MathRadical({
+                                            children: [new MathRun("2")],
+                                        }),
+                                    ],
+                                    denominator: [new MathRun("2")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathSum({
+                                    children: [new MathRun("test")],
+                                }),
+                                new MathSum({
+                                    children: [
+                                        new MathSuperScript({
+                                            children: [new MathRun("e")],
+                                            superScript: [new MathRun("2")],
+                                        }),
+                                    ],
+                                    subScript: [new MathRun("i")],
+                                }),
+                                new MathSum({
+                                    children: [
+                                        new MathRadical({
+                                            children: [new MathRun("i")],
+                                        }),
+                                    ],
+                                    subScript: [new MathRun("i")],
+                                    superScript: [new MathRun("10")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathSuperScript({
+                                    children: [new MathRun("test")],
+                                    superScript: [new MathRun("hello")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathSubScript({
+                                    children: [new MathRun("test")],
+                                    subScript: [new MathRun("hello")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathSubScript({
+                                    children: [new MathRun("x")],
+                                    subScript: [
+                                        new MathSuperScript({
+                                            children: [new MathRun("y")],
+                                            superScript: [new MathRun("2")],
+                                        }),
+                                    ],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathSubSuperScript({
+                                    children: [new MathRun("test")],
+                                    superScript: [new MathRun("hello")],
+                                    subScript: [new MathRun("world")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathPreSubSuperScript({
+                                    children: [new MathRun("test")],
+                                    superScript: [new MathRun("hello")],
+                                    subScript: [new MathRun("world")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathSubScript({
+                                    children: [
+                                        new MathFraction({
+                                            numerator: [new MathRun("1")],
+                                            denominator: [new MathRun("2")],
+                                        }),
+                                    ],
+                                    subScript: [new MathRun("4")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathSubScript({
+                                    children: [
+                                        new MathRadical({
+                                            children: [
+                                                new MathFraction({
+                                                    numerator: [new MathRun("1")],
+                                                    denominator: [new MathRun("2")],
+                                                }),
+                                            ],
+                                            degree: [new MathRun("4")],
+                                        }),
+                                    ],
+                                    subScript: [new MathRun("x")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathRadical({
+                                    children: [new MathRun("4")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathFunction({
+                                    name: [
+                                        new MathSuperScript({
+                                            children: [new MathRun("cos")],
+                                            superScript: [new MathRun("-1")],
+                                        }),
+                                    ],
+                                    children: [new MathRun("100")],
+                                }),
+                                new MathRun("×"),
+                                new MathFunction({
+                                    name: [new MathRun("sin")],
+                                    children: [new MathRun("360")],
+                                }),
+                                new MathRun("= x"),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathRoundBrackets({
+                                    children: [
+                                        new MathFraction({
+                                            numerator: [new MathRun("1")],
+                                            denominator: [new MathRun("2")],
+                                        }),
+                                    ],
+                                }),
+                                new MathSquareBrackets({
+                                    children: [
+                                        new MathFraction({
+                                            numerator: [new MathRun("1")],
+                                            denominator: [new MathRun("2")],
+                                        }),
+                                    ],
+                                }),
+                                new MathCurlyBrackets({
+                                    children: [
+                                        new MathFraction({
+                                            numerator: [new MathRun("1")],
+                                            denominator: [new MathRun("2")],
+                                        }),
+                                    ],
+                                }),
+                                new MathAngledBrackets({
+                                    children: [
+                                        new MathFraction({
+                                            numerator: [new MathRun("1")],
+                                            denominator: [new MathRun("2")],
+                                        }),
+                                    ],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathFraction({
+                                    numerator: [
+                                        new MathRadical({
+                                            children: [new MathRun("4")],
+                                        }),
+                                    ],
+                                    denominator: [new MathRun("2a")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/56-background-color.ts

@@ -0,0 +1,34 @@
+// Change background colour of whole document
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, Paragraph, TextRun } from "../build";
+
+const doc = new Document({
+    background: {
+        color: "C45911",
+    },
+    sections: [
+        {
+            properties: {},
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World"),
+                        new TextRun({
+                            text: "Foo Bar",
+                            bold: true,
+                        }),
+                        new TextRun({
+                            text: "\tGithub is the best",
+                            bold: true,
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/57-add-parent-numbered-lists.ts

@@ -0,0 +1,89 @@
+// Numbered lists - Add parent number in sub number
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { AlignmentType, convertInchesToTwip, Document, HeadingLevel, LevelFormat, Packer, Paragraph } from "../build";
+
+const doc = new Document({
+    numbering: {
+        config: [
+            {
+                levels: [
+                    {
+                        level: 0,
+                        format: LevelFormat.DECIMAL,
+                        text: "%1",
+                        alignment: AlignmentType.START,
+                        style: {
+                            paragraph: {
+                                indent: { left: convertInchesToTwip(0.5), hanging: 260 },
+                            },
+                        },
+                    },
+                    {
+                        level: 1,
+                        format: LevelFormat.DECIMAL,
+                        text: "%1.%2",
+                        alignment: AlignmentType.START,
+                        style: {
+                            paragraph: {
+                                indent: { left: 1.25 * convertInchesToTwip(0.5), hanging: 1.25 * 260 },
+                            },
+                            run: {
+                                bold: true,
+                                size: 18,
+                                font: "Times New Roman",
+                            },
+                        },
+                    },
+                ],
+                reference: "my-number-numbering-reference",
+            },
+        ],
+    },
+    sections: [
+        {
+            children: [
+                new Paragraph({
+                    text: "How to make cake",
+                    heading: HeadingLevel.HEADING_1,
+                }),
+                new Paragraph({
+                    text: "Step 1 - Add sugar",
+                    numbering: {
+                        reference: "my-number-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "Step 2 - Add wheat",
+                    numbering: {
+                        reference: "my-number-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "Step 2a - Stir the wheat in a circle",
+                    numbering: {
+                        reference: "my-number-numbering-reference",
+                        level: 1,
+                    },
+                }),
+                new Paragraph({
+                    text: "Step 3 - Put in oven",
+                    numbering: {
+                        reference: "my-number-numbering-reference",
+                        level: 0,
+                    },
+                }),
+                new Paragraph({
+                    text: "How to make cake",
+                    heading: HeadingLevel.HEADING_1,
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/58-section-types.ts

@@ -0,0 +1,91 @@
+// Usage of different Section Types
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, Paragraph, TextRun, SectionType } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {},
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World"),
+                        new TextRun({
+                            text: "Foo Bar",
+                            bold: true,
+                        }),
+                    ],
+                }),
+            ],
+        },
+        {
+            properties: {
+                type: SectionType.CONTINUOUS,
+            },
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World"),
+                        new TextRun({
+                            text: "Foo Bar",
+                            bold: true,
+                        }),
+                    ],
+                }),
+            ],
+        },
+        {
+            properties: {
+                type: SectionType.ODD_PAGE,
+            },
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World"),
+                        new TextRun({
+                            text: "Foo Bar",
+                            bold: true,
+                        }),
+                    ],
+                }),
+            ],
+        },
+        {
+            properties: {
+                type: SectionType.EVEN_PAGE,
+            },
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World"),
+                        new TextRun({
+                            text: "Foo Bar",
+                            bold: true,
+                        }),
+                    ],
+                }),
+            ],
+        },
+        {
+            properties: {
+                type: SectionType.NEXT_PAGE,
+            },
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World"),
+                        new TextRun({
+                            text: "Foo Bar",
+                            bold: true,
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/59-header-footer-margins.ts

@@ -0,0 +1,54 @@
+// Move + offset header and footer
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Footer, Header, Packer, Paragraph } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {
+                page: {
+                    margin: {
+                        header: 100,
+                        footer: 50,
+                    },
+                },
+            },
+            headers: {
+                default: new Header({
+                    children: [
+                        new Paragraph({
+                            text: "Header text",
+                            indent: {
+                                left: -400,
+                            },
+                        }),
+                        new Paragraph({
+                            text: "Some more header text",
+                            indent: {
+                                left: -600,
+                            },
+                        }),
+                    ],
+                }),
+            },
+            footers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            text: "Footer text",
+                            indent: {
+                                left: -400,
+                            },
+                        }),
+                    ],
+                }),
+            },
+            children: [new Paragraph("Hello World")],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/6-page-borders.ts

@@ -3,15 +3,19 @@
 import * as fs from "fs";
 import { Document, HeadingLevel, Packer, Paragraph, TextRun } from "../build";
 
-const doc = new Document();
-
-doc.addSection({
-    margins: {
+const doc = new Document({
+    sections: [
+        {
+            properties: {
+                page: {
+                    margin: {
                         top: 0,
                         right: 0,
                         bottom: 0,
                         left: 0,
                     },
+                },
+            },
             children: [
                 new Paragraph({
                     children: [
@@ -33,6 +37,8 @@ doc.addSection({
                 new Paragraph("Foo bar"),
                 new Paragraph("Github is the best"),
             ],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/60-track-revisions.ts

@@ -0,0 +1,153 @@
+// Track Revisions aka. "Track Changes"
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import {
+    AlignmentType,
+    DeletedTextRun,
+    Document,
+    Footer,
+    FootnoteReferenceRun,
+    InsertedTextRun,
+    Packer,
+    PageNumber,
+    Paragraph,
+    ShadingType,
+    TextRun,
+} from "../build";
+
+/*
+    For reference, see
+    - 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 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.
+*/
+
+const paragraph = new Paragraph({
+    children: [
+        new TextRun("This is a simple demo "),
+        new TextRun({
+            text: "on how to ",
+        }),
+        new InsertedTextRun({
+            text: "mark a text as an insertion ",
+            id: 0,
+            author: "Firstname Lastname",
+            date: "2020-10-06T09:00:00Z",
+        }),
+        new DeletedTextRun({
+            text: "or a deletion.",
+            id: 1,
+            author: "Firstname Lastname",
+            date: "2020-10-06T09:00:00Z",
+        }),
+    ],
+});
+
+const doc = new Document({
+    footnotes: {
+        1: {
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("This is a footnote"),
+                        new DeletedTextRun({
+                            text: " with some extra text which was deleted",
+                            id: 0,
+                            author: "Firstname Lastname",
+                            date: "2020-10-06T09:05:00Z",
+                        }),
+                        new InsertedTextRun({
+                            text: " and new content",
+                            id: 1,
+                            author: "Firstname Lastname",
+                            date: "2020-10-06T09:05:00Z",
+                        }),
+                    ],
+                }),
+            ],
+        },
+    },
+    features: {
+        trackRevisions: true,
+    },
+    sections: [
+        {
+            properties: {},
+            children: [
+                paragraph,
+                new Paragraph({
+                    children: [
+                        new TextRun("This is a demo "),
+                        new DeletedTextRun({
+                            break: 1,
+                            text: "in order",
+                            color: "ff0000",
+                            bold: true,
+                            size: 24,
+                            font: {
+                                name: "Garamond",
+                            },
+                            shading: {
+                                type: ShadingType.REVERSE_DIAGONAL_STRIPE,
+                                color: "00FFFF",
+                                fill: "FF0000",
+                            },
+                            id: 2,
+                            author: "Firstname Lastname",
+                            date: "2020-10-06T09:00:00Z",
+                        }),
+                        new InsertedTextRun({
+                            text: "to show how to ",
+                            bold: false,
+                            id: 3,
+                            author: "Firstname Lastname",
+                            date: "2020-10-06T09:05:00Z",
+                        }),
+                        new TextRun({
+                            bold: true,
+                            children: ["\tuse Inserted and Deleted TextRuns.", new FootnoteReferenceRun(1)],
+                        }),
+                    ],
+                }),
+            ],
+            footers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            alignment: AlignmentType.CENTER,
+                            children: [
+                                new TextRun("Awesome LLC"),
+                                new TextRun({
+                                    children: ["Page Number: ", PageNumber.CURRENT],
+                                }),
+                                new DeletedTextRun({
+                                    children: [" to ", PageNumber.TOTAL_PAGES],
+                                    id: 4,
+                                    author: "Firstname Lastname",
+                                    date: "2020-10-06T09:05:00Z",
+                                }),
+                                new InsertedTextRun({
+                                    children: [" from ", PageNumber.TOTAL_PAGES],
+                                    bold: true,
+                                    id: 5,
+                                    author: "Firstname Lastname",
+                                    date: "2020-10-06T09:05:00Z",
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/61-text-frame.ts

@@ -0,0 +1,82 @@
+// Text Frame (Text Box) example
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import {
+    BorderStyle,
+    Document,
+    FrameAnchorType,
+    HorizontalPositionAlign,
+    Packer,
+    Paragraph,
+    TextRun,
+    VerticalPositionAlign,
+} from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {},
+            children: [
+                new Paragraph({
+                    frame: {
+                        position: {
+                            x: 1000,
+                            y: 3000,
+                        },
+                        width: 4000,
+                        height: 1000,
+                        anchor: {
+                            horizontal: FrameAnchorType.MARGIN,
+                            vertical: FrameAnchorType.MARGIN,
+                        },
+                        alignment: {
+                            x: HorizontalPositionAlign.CENTER,
+                            y: VerticalPositionAlign.TOP,
+                        },
+                    },
+                    border: {
+                        top: {
+                            color: "auto",
+                            space: 1,
+                            style: BorderStyle.SINGLE,
+                            size: 6,
+                        },
+                        bottom: {
+                            color: "auto",
+                            space: 1,
+                            style: BorderStyle.SINGLE,
+                            size: 6,
+                        },
+                        left: {
+                            color: "auto",
+                            space: 1,
+                            style: BorderStyle.SINGLE,
+                            size: 6,
+                        },
+                        right: {
+                            color: "auto",
+                            space: 1,
+                            style: BorderStyle.SINGLE,
+                            size: 6,
+                        },
+                    },
+                    children: [
+                        new TextRun("Hello World"),
+                        new TextRun({
+                            text: "Foo Bar",
+                            bold: true,
+                        }),
+                        new TextRun({
+                            text: "\tGithub is the best",
+                            bold: true,
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/62-paragraph-spacing.ts

@@ -0,0 +1,36 @@
+// Simple example to add text to a document
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, LineRuleType, Packer, Paragraph, TextRun } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {},
+            children: [
+                new Paragraph({
+                    spacing: {
+                        after: 5000,
+                        before: 5000,
+                    },
+                    children: [new TextRun("Hello World")],
+                }),
+                new Paragraph({
+                    spacing: {
+                        line: 2000,
+                        lineRule: LineRuleType.AUTO,
+                    },
+                    children: [
+                        new TextRun(
+                            "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed turpis ex, aliquet et faucibus quis, euismod in odio. Fusce gravida tempor nunc sed lacinia. Nulla sed dolor fringilla, fermentum libero ut, egestas ex. Donec pellentesque metus non orci lacinia bibendum. Cras porta ex et mollis hendrerit. Suspendisse id lectus suscipit, elementum lacus eu, convallis felis. Fusce sed bibendum dolor, id posuere ligula. Aliquam eu elit ut urna eleifend vestibulum. Praesent condimentum at turpis sed scelerisque. Suspendisse porttitor metus nec vestibulum egestas. Sed in eros sapien. Morbi efficitur placerat est a consequat. Nunc bibendum porttitor mi nec tempus. Morbi dictum augue porttitor nisi sodales sodales.",
+                        ),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/63-odd-even-header-footer.ts

@@ -0,0 +1,71 @@
+// Move + offset header and footer
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Footer, Header, Packer, PageBreak, Paragraph, TextRun } from "../build";
+
+const doc = new Document({
+    evenAndOddHeaderAndFooters: true,
+    sections: [
+        {
+            headers: {
+                default: new Header({
+                    children: [
+                        new Paragraph({
+                            text: "Odd Header text",
+                        }),
+                        new Paragraph({
+                            text: "Odd - Some more header text",
+                        }),
+                    ],
+                }),
+                even: new Header({
+                    children: [
+                        new Paragraph({
+                            text: "Even header text",
+                        }),
+                        new Paragraph({
+                            text: "Even - Some more header text",
+                        }),
+                    ],
+                }),
+            },
+            footers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            text: "Odd Footer text",
+                        }),
+                    ],
+                }),
+                even: new Footer({
+                    children: [
+                        new Paragraph({
+                            text: "Even Cool Footer text",
+                        }),
+                    ],
+                }),
+            },
+            children: [
+                new Paragraph({
+                    children: [new TextRun("Hello World 1"), new PageBreak()],
+                }),
+                new Paragraph({
+                    children: [new TextRun("Hello World 2"), new PageBreak()],
+                }),
+                new Paragraph({
+                    children: [new TextRun("Hello World 3"), new PageBreak()],
+                }),
+                new Paragraph({
+                    children: [new TextRun("Hello World 4"), new PageBreak()],
+                }),
+                new Paragraph({
+                    children: [new TextRun("Hello World 5"), new PageBreak()],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

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,88 @@
+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",
+                        start: 10,
+                    },
+                ],
+            },
+            {
+                reference: "ref2",
+                levels: [
+                    {
+                        level: 0,
+                        format: LevelFormat.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/7-landscape.ts

@@ -3,13 +3,19 @@
 import * as fs from "fs";
 import { Document, Packer, PageOrientation, Paragraph } from "../build";
 
-const doc = new Document();
-
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
+            properties: {
+                page: {
                     size: {
                         orientation: PageOrientation.LANDSCAPE,
                     },
+                },
+            },
             children: [new Paragraph("Hello World")],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((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/71-page-borders-2.ts

@@ -0,0 +1,63 @@
+// Example demonstrating page borders with style, colors and size
+// Import from 'docx' rather than '../build' if you install from npm
+import * as fs from "fs";
+import { Document, Packer, TextRun, Paragraph, BorderStyle, PageBorderDisplay, PageBorderOffsetFrom, PageBorderZOrder } from "../build";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {
+                page: {
+                    borders: {
+                        pageBorderBottom: {
+                            style: BorderStyle.SINGLE,
+                            size: 2 * 8, //2pt;
+                            color: "000000",
+                        },
+                        pageBorderLeft: {
+                            style: BorderStyle.SINGLE,
+                            size: 1 * 8, //1pt;
+                            color: "000000",
+                        },
+                        pageBorderRight: {
+                            style: BorderStyle.SINGLE,
+                            size: 1 * 8, //1pt;
+                            color: "FF00AA",
+                        },
+                        pageBorderTop: {
+                            style: BorderStyle.SINGLE,
+                            size: 1 * 8, //1pt;
+                            color: "000000",
+                        },
+                        pageBorders: {
+                            display: PageBorderDisplay.ALL_PAGES,
+                            offsetFrom: PageBorderOffsetFrom.TEXT,
+                            zOrder: PageBorderZOrder.FRONT,
+                        },
+                    },
+                },
+            },
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: `Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.`,
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: `Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.`,
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+// Used to export the file into a .docx file
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/8-header-footer.ts

@@ -3,9 +3,9 @@
 import * as fs from "fs";
 import { Document, Footer, Header, Packer, Paragraph } from "../build";
 
-const doc = new Document();
-
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             headers: {
                 default: new Header({
                     children: [new Paragraph("Header text")],
@@ -17,6 +17,8 @@ doc.addSection({
                 }),
             },
             children: [new Paragraph("Hello World")],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

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

@@ -1,19 +1,24 @@
 // Add images to header and footer
 // Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Document, Footer, Header, Media, Packer, Paragraph } from "../build";
+import { Document, Footer, Header, ImageRun, Packer, Paragraph } from "../build";
 
-const doc = new Document();
-
-const image1 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
-const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
-
-doc.addSection({
+const doc = new Document({
+    sections: [
+        {
             headers: {
                 default: new Header({
                     children: [
                         new Paragraph({
-                    children: [image1],
+                            children: [
+                                new ImageRun({
+                                    data: fs.readFileSync("./demo/images/pizza.gif"),
+                                    transformation: {
+                                        width: 100,
+                                        height: 100,
+                                    },
+                                }),
+                            ],
                         }),
                     ],
                 }),
@@ -22,12 +27,22 @@ doc.addSection({
                 default: new Footer({
                     children: [
                         new Paragraph({
-                    children: [image2],
+                            children: [
+                                new ImageRun({
+                                    data: fs.readFileSync("./demo/images/pizza.gif"),
+                                    transformation: {
+                                        width: 100,
+                                        height: 100,
+                                    },
+                                }),
+                            ],
                         }),
                     ],
                 }),
             },
             children: [new Paragraph("Hello World")],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/browser-demo.html

@@ -12,9 +12,9 @@
 
         <script>
             function generate() {
-                const doc = new docx.Document();
-
-                doc.addSection({
+                const doc = new docx.Document({
+                    sections: [
+                        {
                             children: [
                                 new docx.Paragraph({
                                     children: [
@@ -30,10 +30,10 @@
                                     ],
                                 }),
                             ],
+                        },
+                    ],
                 });
 
-
-
                 docx.Packer.toBlob(doc).then((blob) => {
                     console.log(blob);
                     saveAs(blob, "example.docx");

demo/index.ts

@@ -1,7 +1,7 @@
 // tslint:disable:no-console
-import * as fs from "fs";
-import * as prompt from "prompt";
-import * as shelljs from "shelljs";
+import fs from "fs";
+import prompt from "prompt";
+import shelljs from "shelljs";
 
 console.log("What demo do you wish to run? (Enter a number)");
 
@@ -17,8 +17,8 @@ const schema = {
 
 prompt.start();
 
-prompt.get(schema, (_, result) => {
-    const demoNumber = result.number;
+prompt.get(schema as any, (_, result) => {
+    const demoNumber = result.number as string;
     const files = fs.readdirSync("./demo").filter((fn) => fn.startsWith(demoNumber));
 
     if (files.length === 0) {

docs/README.md

@@ -1,13 +1,3 @@
-<p align="center">
-    <img alt="clippy the assistant" src="https://i.imgur.com/37uBGhO.gif">
-</p>
-
-<p align="center">
-    Easily generate .docx files with JS/TS. Works for Node and on the Browser. :100:
-</p>
-
----
-
 # Welcome
 
 ## Installation
@@ -34,12 +24,10 @@ import { ... } from "docx";
 import * as fs from "fs";
 import { Document, Packer, Paragraph, TextRun } from "docx";
 
-// Create document
-const doc = new Document();
-
 // Documents contain sections, you can have multiple sections per document, go here to learn more about sections
 // This simple example will only contain one section
-doc.addSection({
+const doc = new Document({
+    sections: [{
         properties: {},
         children: [
             new Paragraph({
@@ -56,6 +44,7 @@ doc.addSection({
                 ],
             }),
         ],
+    }],
 });
 
 // Used to export the file into a .docx file
@@ -63,17 +52,11 @@ Packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });
 
-// Done! A file called 'My First Document.docx' will be in your file system.
+// Done! A file called 'My Document.docx' will be in your file system.
 ```
 
-## Honoured Mentions
-
-[@felipeochoa](https://github.com/felipeochoa)
-
-[@h4buli](https://github.com/h4buli)
-
 <p align="center">
-    <img alt="clippy the assistant" src="http://i60.tinypic.com/339pvtt.png">
+    <img alt="clippy the assistant" src="./clippy.png">
 </p>
 
 ---

docs/_coverpage.md

@@ -0,0 +1,10 @@
+<img src="https://i.imgur.com/37uBGhO.gif" alt="drawing" style="width:200px;"/>
+
+> Easily generate .docx files with JS/TS. Works for Node and on the Browser. :100:
+
+-   Simple, declarative API
+-   60+ usage examples
+-   Battle tested, mature, 99%+ coverage
+
+[GitHub](https://github.com/dolanmiu/docx)
+[Get Started](#Welcome)

docs/_sidebar.md

@@ -1,6 +1,6 @@
 * [Getting Started](/)
 
-* [Examples](examples.md)
+* [Examples](https://github.com/dolanmiu/docx/tree/master/demo)
 
 * API
 
@@ -15,17 +15,23 @@
 	* [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)
     * [Table of Contents](usage/table-of-contents.md)
     * [Page Numbers](usage/page-numbers.md)
+    * [Change Tracking](usage/change-tracking.md)
+    * [Math](usage/math.md)
+    * [Text Frames](usage/text-frames.md)
 	* Styling
         * [Styling with JS](usage/styling-with-js.md)
         * [Styling with XML](usage/styling-with-xml.md)
 * Exporting
 
     * [Packers](usage/packers.md)
+* Utility
+
+    * [Convenience functions](usage/convenience-functions.md)
 
 * [Contribution Guidelines](contribution-guidelines.md)
-

docs/contribution-guidelines.md

@@ -1,25 +1,23 @@
 # Contribution Guidelines
 
-*   Include documentation reference(s) at the top of each file:
+-   Include documentation reference(s) at the top of each file:
 
     ```ts
     // http://officeopenxml.com/WPdocument.php
     ```
 
-*   Follow Prettier standards, and consider using the [Prettier VSCode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) plugin.
+-   Follow Prettier standards, and consider using the [Prettier VSCode](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) plugin.
 
-*   Follow the `TSLint` rules
+-   Follow the `TSLint` rules
 
 ## Always think about the user
 
-The number one pillar for contribution to `docx` is to **ALWAYS** think about how the user will use `docx`.
-
 Put yourself in their position, and imagine how they would feel about your feature you wrote.
 
 1. Is it easy to use?
 2. Has it been documented well?
 3. Is it intuitive?
-4. Is it consistent with the rest of the API?
+4. Is it declarative?
 5. Is it fun to use?
 
 ## Good Commit Names
@@ -27,6 +25,7 @@ Put yourself in their position, and imagine how they would feel about your featu
 Please write good commit messages when making a commit: https://chris.beams.io/posts/git-commit/
 
 **Do not:**
+
 ```
 c // What?
 rtl // Adding acryonyms without explaining anything else is not helpful
@@ -35,34 +34,6 @@ demo updated // Getting better, but capitalize the first letter
 Unesesary coment removed // Make sure to use correct spelling
 ```
 
-## No leaky components in API interface
-
-> This mainly applies to the API the end user will consume.
-
-Try to make method parameters of the outside API accept primitives, or `json` objects, so that child components are created **inside** the component, rather than being **injected** in.
-
-This is so that:
-
-1. Imports are much cleaner for the end user, no need for:
-   ```ts
-   import { ChildComponent } from "./my-feature/sub-component/deeper/.../my-deep.component";
-   ```
-
-2. This is what I consider "leakage". The code is aware of the underlying implementation of the component.
-3. It means the end user does not need to import and create the child component to be injected.
-
-**Do not**
-
-`TableFloatProperties` is a class. The outside world would have to `new` up the object, and inject it in like so:
-
-```ts
-    public float(tableFloatProperties: TableFloatProperties): Table
-```
-
-```ts
-    table.float(new TableFloatProperties(...));
-```
-
 **Do**
 
 `ITableFloatOptions` is an interface for a JSON of primitives. The end user would need to pass in a json object and not need to worry about the internals:
@@ -71,30 +42,30 @@ This is so that:
     public float(tableFloatOptions: ITableFloatOptions): Table
 ```
 
+## Delcariative API
+
+Make sure the API is declarative, so no _method calling_ or _mutation_. This is a design decision, consistent with the rest of the project. There are benefits to delcariative code over other styles of code, explained here: https://dzone.com/articles/why-declarative-coding-makes-you-a-better-programm
+
+**Do not:**
+
 ```ts
-    table.float({...});
+const paragraph = doc.createParagraph();
+const text = paragraph.createText();
+text.contents = "Hello World";
 ```
 
-## Add vs Create
-
-This is just a guideline, and the rules can sometimes be broken.
-
-*   Use `create` if the method `new`'s up an element inside:
+**Do**
 
 ```ts
-    public createParagraph() {
-        const paragraph = new Paragraph();
-        this.root.push(paragraph);
-    }
-    ```
-
-*   Use `add` if you add the element into the method as a parameter.
-    *Note:* This may look like its breaking the previous guideline, but it has semantically different meanings. The previous one is using data to construct an object, whereas this one is simply adding elements into the document:
-
-    ```ts
-    public add(paragraph: Paragraph) {
-        this.root.push(paragraph);
-    }
+const doc = new Document({
+    sections: [{
+        children: [
+            new Paragraph({
+                children: [new TextRun("Hello World")],
+            }),
+        ],
+    }];
+});
 ```
 
 ## Getters and Setters
@@ -107,7 +78,7 @@ public get Level() {
 }
 ```
 
-There is no performance advantage by doing this. It means we don't need to prefix all private variables with the ugly `_`:
+This is the convention of this project. There is no performance advantage by doing this. It means we don't need to prefix all private variables with `_`:
 
 **Do not:**
 
@@ -121,30 +92,6 @@ private get _level: string;
 private get level: string;
 ```
 
-## Temporal Methods
-
-Some methods  are `non-temporal`, which means regardless of when you call the method, it will have the same affect on the document. For example, setting the width of a table at the end of the document will have the same effect as setting the width at the start:
-
-```ts
-table.setWidth(1000); // now removed as of version 5.0.0
-```
-
-Whereas some methods are `temporal`, which means depending on the time-frame they are called, it would produce a difference result. For example, moving `createParagraph()` around your code will physically alter the document.
-
-```ts
-doc.createParagraph("hello");
-```
-
-If a method is `non-temporal`, put it in the objects `constructor`. For example:
-
-```ts
-const table = new Table(width: number);
-```
-
-`Non-temporal` methods are usually methods which can only be used one time and one time only. For example, `.float()`. It does not make sense to call `.float()` again if its already floating.
-
-I am not sure what the real term is, but this will do.
-
 ## Interfaces over type alias
 
 Do not use `type`, but rather use `Interfaces`. `type` cannot be extended, and a class cannot implement it.
@@ -152,14 +99,14 @@ Do not use `type`, but rather use `Interfaces`. `type` cannot be extended, and a
 > "In general, use what you want ( type alias / interface ) just be consistent"
 > "always use interface for public API's definition when authoring a library or 3rd party ambient type definitions"
 >
-> *   https://medium.com/@martin_hotell/interface-vs-type-alias-in-typescript-2-7-2a8f1777af4c
+> -   https://medium.com/@martin_hotell/interface-vs-type-alias-in-typescript-2-7-2a8f1777af4c
 
 `Interface` is generally preferred over `type`: https://stackoverflow.com/questions/37233735/typescript-interfaces-vs-types
 
 **Do not:**
 
 ```ts
-type RelationshipFileInfo = { id: number, target: string };
+type RelationshipFileInfo = { id: number; target: string };
 ```
 
 **Do:**
@@ -193,26 +140,26 @@ enum WeaponType = {
 
 ## Spell correctly, in full and in American English
 
-I am not sure where these habits in software development come from, but I do not believe it is beneficial:
-
 **Do not:**
+
 ```ts
-readdy // misspelling
-perm // abbreviation
-conf // abbreviation
-cnty // abbreviation
-relationFile // abbreviation
-colour // U.K. English
+readdy; // misspelling
+perm; // abbreviation
+conf; // abbreviation
+cnty; // abbreviation
+relationFile; // abbreviation
+colour; // U.K. English
 ```
 
 **Do:**
+
 ```ts
-ready
-permission
-config
-country
-relationshipFile
-color
+ready;
+permission;
+config;
+country;
+relationshipFile;
+color;
 ```
 
 ## Keep files small (within reason)

docs/examples.md

@@ -1,219 +0,0 @@
-# Examples
-
-> All examples can run independently and can be found in the `/demo` folder of the project
-
-All the examples below can be ran locally, to do so, run the following command:
-
-```sh
-npm run demo
-```
-
-This command will run the `demo selector app` in the `/demo` folder. It will prompt you to select a demo number, which will run a demo from that folder.
-
-## Simple
-
-A simple hello world of the `docx` library:
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo1.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo1.ts_
-
-## Styles
-
-### Styling with JS
-
-This example shows how to customise the look and feel of a document using JS configuration
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo2.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo2.ts_
-
-### Styling with XML
-
-This example shows how to customise the look and feel of a document using XML configuration
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo13.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo13.ts_
-
-## Numbering
-
-This example shows many levels of numbering
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo3.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo3.ts_
-
-## Table
-
-Example of simple table
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo4.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo4.ts_
-
-### Styling table borders
-
-Styling the borders of a table
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo20.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo20.ts_
-
-## Images
-
-### Add image to the document
-
-Importing Images from file system path
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo5.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo5.ts_
-
-### Add images to header and footer
-
-Example showing how to add image to headers and footers
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo9.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo9.ts_
-
-### Scaling images
-
-Example showing how to scale images
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo12.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo12.ts_
-
-### Add Image to media before adding to document
-
-This is the best way to add an image to a document because you can add the same image in two locations without increasing document size by re-using the same image
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo23.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo23.ts_
-
-### Add image to table
-
-As before, to add an image to a table, you would need to add it to the `Media` object first
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo24.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo24.ts_
-
-### Images using Base64 URI
-
-If you want to use a Base64 image instead
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo18.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo18.ts_
-
-## Margins
-
-Example showing how to set custom margins
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo6.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo6.ts_
-
-## Orientation
-
-Example showing how to set the document to `landscape` or `portrait`
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo7.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo7.ts_
-
-## Headers & Footers
-
-Example showing how to add headers and footers
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo8.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo8.ts_
-
-## Multiple headers and footers
-
-Check out `Sections` for this feature
-
-## Page Breaks
-
-### Normal page breaks
-
-Example showing how to page break
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo14.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo14.ts_
-
-### Page break before
-
-Example showing how to page break before like in Word
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo15.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo15.ts_
-
-## Sections
-
-Example of how sections work. Sections allow multiple headers and footers, and `landscape`/`portrait` inside the same document. 
-Also you can have different page number formats and starts for different sections.
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo16.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo16.ts_
-
-## Footnotes
-
-Example of how to add footnotes. Good for references
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo17.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo17.ts_
-
-## Packers
-
-## Buffer output
-
-Example showing how to use the Buffer packer and then write that buffer to the file system
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo19.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo19.ts_
-
-
-## Bookmarks
-
-Example showing how to make bookmarks to make internal hyperlinks within the document
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo21.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo21.ts_
-
-## Bidirectional text
-
-Example showing how to use bidirectional text for certain languages such as Hebrew
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo22.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo22.ts_
-
-## Showcase
-
-### My CV
-
-Example showing how to add headers and footers
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo10.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo10.ts_
-
-### Style and Images
-
-This example shows how to customise the look and feel of a document and add images
-
-[Example](https://raw.githubusercontent.com/dolanmiu/docx/master/demo/demo11.ts ':include')
-
-_Source: https://github.com/dolanmiu/docx/blob/master/demo/demo11.ts_

docs/index.html

@@ -1,12 +1,11 @@
 <!DOCTYPE html>
 <html lang="en">
-
     <head>
-    <meta charset="UTF-8">
+        <meta charset="UTF-8" />
         <title>docx - Generate .docx documents with JavaScript</title>
         <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
-    <meta name="description" content="Generate .docx documents with JavaScript">
-    <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+        <meta name="description" content="Generate .docx documents with JavaScript" />
+        <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0" />
         <link
             rel="stylesheet"
             href="//cdn.jsdelivr.net/npm/docsify-darklight-theme@latest/dist/style.min.css"
@@ -19,22 +18,19 @@
         <div id="app"></div>
         <script>
             window.$docsify = {
-            name: 'docx',
-            repo: 'https://github.com/dolanmiu/docx',
+                name: "docx",
+                repo: "https://github.com/dolanmiu/docx",
                 loadSidebar: true,
                 subMaxLevel: 2,
-            search: 'auto',
-        }
+                search: "auto",
+                coverpage: true,
+            };
         </script>
         <script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
         <script src="//unpkg.com/docsify/lib/plugins/emoji.min.js"></script>
         <script src="https://unpkg.com/docsify-copy-code@2"></script>
         <script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
         <script src="//unpkg.com/prismjs/components/prism-typescript.min.js"></script>
-    <script 
-        src="//cdn.jsdelivr.net/npm/docsify-darklight-theme@latest/dist/index.min.js"
-        type="text/javascript">
-    </script>
+        <script src="//cdn.jsdelivr.net/npm/docsify-darklight-theme@latest/dist/index.min.js" type="text/javascript"></script>
     </body>
-
 </html>

docs/usage/bullet-points.md

@@ -1,16 +1,28 @@
 # Bullet Points
 
+!> Bullet Points requires an understanding of [Paragraphs](usage/paragraph.md).
 ## Example
 
 To make a bullet point, simply make a paragraph into a bullet point:
 
 ```ts
-const text = new TextRun("Bullet points");
-const paragraph = new Paragraph({
+const doc = new Document({
+    sections: [{
+        children: [
+            new Paragraph({
                 text: "Bullet points",
                 bullet: {
-        level: 0, // How deep you want the bullet to me
-    },
+                    level: 0 //How deep you want the bullet to be
+                }
+            }),
+            new Paragraph({
+                text: "Are awesome",
+                bullet: {
+                    level: 0
+                }
+            })
+        ],
+    }];
 });
 ```
 

docs/usage/change-tracking.md

@@ -0,0 +1,61 @@
+# Change Tracking
+
+> Instead of adding a `TextRun` into a `Paragraph`, you can also add an `InsertedTextRun` or `DeletedTextRun` where you need to supply an `id`, `author` and `date` for the change.
+
+```ts
+import { Paragraph, TextRun, InsertedTextRun, DeletedTextRun } from "docx";
+
+const paragraph = new Paragraph({
+    children: [
+        new TextRun("This is a simple demo "),
+        new TextRun({
+            text: "on how to "
+        }),
+        new InsertedTextRun({
+            text: "mark a text as an insertion ",
+            id: 0,
+            author: "Firstname Lastname",
+            date: "2020-10-06T09:00:00Z",
+        }),
+        new DeletedTextRun({
+            text: "or a deletion.",
+            id: 1,
+            author: "Firstname Lastname",
+            date: "2020-10-06T09:00:00Z",
+        })
+    ],
+});
+```
+
+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";
+
+const paragraph = new Paragraph({
+    children: [
+        new TextRun("This is a simple demo"),
+        new DeletedTextRun({
+            text: "with a deletion.",
+            color: "ff0000",
+            bold: true,
+            size: 24,
+            id: 0,
+            author: "Firstname Lastname",
+            date: "2020-10-06T09:00:00Z",
+        })
+    ],
+});
+```
+
+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";
+
+const doc = new Document({
+    features: {
+        trackRevisions: true,
+    },
+});
+```

docs/usage/convenience-functions.md

@@ -0,0 +1,22 @@
+# Convenience functions
+
+OOXML and this library mainly uses a unit called twentieths of a point or `twip` for short. a twip is a typographical measurement, defined as 1/20 of a typographical point. One twip is 1/1440 inch, or 17.64 μm. This unit is not intuitive for many users, so some functions were created to help
+
+More info here: https://en.wikipedia.org/wiki/Twip
+
+## Convert Inches to Twip
+
+```ts
+import { convertInchesToTwip } from "docx";
+
+const twip = convertInchesToTwip(1); // returns 1440
+const twip = convertInchesToTwip(0.5); // returns 720
+```
+
+## Convert Millimeters to Twip
+
+```ts
+import { convertMillimetersToTwip } from "docx";
+
+const twip = convertMillimetersToTwip(50); // returns 2834
+```

docs/usage/document.md

@@ -30,6 +30,24 @@ const doc = new docx.Document({
 * keywords
 * lastModifiedBy
 * revision
+* externalStyles
+* styles
+* numbering
+* footnotes
+* hyperlinks
+* background
+
+### Change background color of Document
+
+Set the hex value in the document like so:
+
+```ts
+const doc = new docx.Document({
+    background: {
+        color: "C45911",
+    },
+});
+```
 
 You can mix and match whatever properties you want, or provide no properties.
 

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/headers-and-footers.md

@@ -5,35 +5,35 @@
 Every Section has a sections which you can define its Headers and Footers:
 
 ```ts
-doc.addSection({
+const doc = new Document({
+    sections: [{
         headers: {
-        default: new Header({ // The standard default header
+            default: new Header({ // The standard default header on every page or header on odd pages when the 'Different Odd & Even Pages' option is activated
                 children: [],
             }),
-        first: new Header({ // The first header
+            first: new Header({ // The header on first page when the 'Different First Page' option is activated
                 children: [],
             }),
-        even: new Header({ // The header on every other page
+            even: new Header({ // The header on even pages when the 'Different Odd & Even Pages' option is activated
                 children: [],
             }),
         },
         footers: {
-        default: new Footer({ // The standard default footer
+            default: new Footer({ // The standard default footer on every page or footer on odd pages when the 'Different Odd & Even Pages' option is activated
                 children: [],
             }),
-        first: new Footer({ // The first footer
+            first: new Footer({ // The footer on first page when the 'Different First Page' option is activated
                 children: [],
             }),
-        even: new Footer({ // The footer on every other page
+            even: new Footer({ // The footer on even pages when the 'Different Odd & Even Pages' option is activated
                 children: [],
             }),
         },
         children: [],
+    }];
 });
 ```
 
-If you want more head
-
 ## Example
 
 Example showing basic header and footer