Fix: Use browser compatable Buffer (#3057)

* Fix: Use browser compatable Buffer

* Update src/patcher/from-docx.ts

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

.cspell.json

@@ -0,0 +1,71 @@
+// cSpell Settings
+{
+    // Version of the setting file.  Always 0.2
+    "version": "0.2",
+    // language - current active spelling language
+    "language": "en_US",
+    "dictionaries": ["en_US", "typescript", "softwareTerms", "fonts", "npm"],
+    // words - list of words to be always considered correct
+    "words": [
+        "Abjad",
+        "aink",
+        "aiueo",
+        "ATLEAST",
+        "chosung",
+        "clippy",
+        "datas",
+        "dcmitype",
+        "dcterms",
+        "docsify",
+        "dolan",
+        "execa",
+        "falsey",
+        "horz",
+        "iife",
+        "Initializable",
+        "iroha",
+        "JOHAB",
+        "jsonify",
+        "jszip",
+        "NUMPAGES",
+        "odttf",
+        "ondata",
+        "onfile",
+        "ooxml",
+        "panose",
+        "rels",
+        "rsid",
+        "sdtdh",
+        "twip",
+        "twips",
+        "Xmlable",
+        "xmlified",
+        "xmlify",
+        "Xmlifyed"
+    ],
+    "ignoreRegExpList": [
+        "/\"w:.+\"/",
+        "/\"s:.+\"/",
+        "/\"a:.+\"/",
+        "/\"pic:.+\"/",
+        "/\"xmlns:.+\"/",
+        "/\"vt:.+\"/",
+        "/[^\\s]{40,}/",
+        "/<xsd:.+/>/",
+        "/[A-Z_]+ = \".+\"/",
+        "/XmlAttributeComponent<{[^}]+}>/g",
+        "/xmlKeys = {[^}]+}/g",
+        "/\\.to\\.deep\\.equal\\({[^)]+}\\)/g",
+        "\\.to\\.include\\.members\\(\\[[^\\]]+]\\)",
+        "/new [a-zA-Z]+\\({[^£]+}\\)/g",
+        "/<element name=\"[a-z]+\"/gi",
+        "/<attribute name=\"[a-z]+\"/gi",
+        "/key: \".+\"/"
+    ],
+    "ignorePaths": ["package.json", "docs/api", "*.docx", "build"],
+    "allowCompoundWords": true,
+    // flagWords - list of words to be always considered incorrect
+    // This is useful for offensive words and common spelling errors.
+    // For example "hte" should be "the"
+    "flagWords": ["hte"]
+}

.gitattributes

@@ -0,0 +1,2 @@
+# https://prettier.io/docs/en/options.html#end-of-line
+* text=auto eol=lf

.github/actions/install-and-build/action.yml

@@ -0,0 +1,12 @@
+name: Install dependencies and build ⚙️
+description: Install dependencies and build
+
+runs:
+    using: composite
+    steps:
+        - name: Install Dependencies
+          shell: bash
+          run: npm ci --force
+        - name: Build
+          shell: bash
+          run: npm run build

.github/actions/validate-docx/action.yml

@@ -0,0 +1,14 @@
+name: Extract and Validate Document ⚙️
+description: Extract the document and validate the XML against the schema.
+
+runs:
+    using: composite
+    steps:
+        - name: Extract Word Document
+          shell: bash
+          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/dependabot.yml

@@ -5,36 +5,3 @@ updates:
   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

@@ -13,13 +13,10 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout Repo
-              uses: actions/checkout@master
-            - name: Install Dependencies
-              run: npm ci
-            - name: Build
-              run: npm run build
+              uses: actions/checkout@v4
+            - uses: "./.github/actions/install-and-build"
             - name: Archive Production Artifact
-              uses: actions/upload-artifact@master
+              uses: actions/upload-artifact@v4
               with:
                   name: build
                   path: build
@@ -28,24 +25,26 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout Repo
-              uses: actions/checkout@master
+              uses: actions/checkout@v4
             - name: Install Dependencies
-              run: npm ci
+              run: npm ci --force
             - name: Test
-              run: npm run test.coverage
+              run: npm run test:ci
             - name: Codecov
-              uses: codecov/codecov-action@v1
+              uses: codecov/codecov-action@v4
               with:
                   fail_ci_if_error: true
                   verbose: true
+              env:
+                  CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
     lint:
         name: Lint
         runs-on: ubuntu-latest
         steps:
             - name: Checkout Repo
-              uses: actions/checkout@master
+              uses: actions/checkout@v4
             - name: Install Dependencies
-              run: npm ci
+              run: npm ci --force
             - name: Lint
               run: npm run lint
     prettier:
@@ -53,8 +52,18 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout Repo
-              uses: actions/checkout@master
+              uses: actions/checkout@v4
             - name: Install Dependencies
-              run: npm ci
+              run: npm ci --force
             - name: Prettier
-              run: npm run style
+              run: npm run prettier
+    cspell:
+        name: CSpell
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout Repo
+              uses: actions/checkout@v4
+            - name: Install Dependencies
+              run: npm ci --force
+            - name: CSpell
+              run: npm run cspell

.github/workflows/demos.yml

@@ -8,674 +8,189 @@ on:
             - 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]
+        name: Demos
         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
+            - uses: actions/checkout@v4
+            - uses: "./.github/actions/install-and-build"
+            - name: Run Demos
+              run: npm run run-ts -- ./demo/1-basic.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/2-declaritive-styles.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/3-numbering-and-bullet-points.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/4-basic-table.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/5-images.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/6-page-borders.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/7-landscape.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/8-header-footer.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/9-images-in-header-and-footer.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/10-my-cv.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/11-declaritive-styles-2.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/12-scaling-images.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/13-xml-styles.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/14-page-numbers.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/15-page-break-before.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/16-multiple-sections.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/17-footnotes.ts
             # 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
+            # - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/18-image-from-buffer.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/19-export-to-base64.ts
+            # Base 64 No longer works, abruptly. Node issue?
+            # - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/20-table-cell-borders.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/21-bookmarks.ts
             # 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
+            # - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/22-right-to-left-text.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/23-base64-images.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/24-images-to-table-cell.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/25-table-xml-styles.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/26-paragraph-borders.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/27-declaritive-styles-3.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/28-table-of-contents.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/29-numbered-lists.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/31-tables.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/32-merge-and-shade-table-cells.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/33-sequential-captions.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/34-floating-tables.ts
             # 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
+            # - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/35-hyperlinks.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/36-image-to-table-cell.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/37-images-to-header-and-footer.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/38-text-wrapping.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/39-page-numbers.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/40-line-numbers.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/41-merge-table-cells-2.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/42-restart-page-numbers.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/43-images-to-table-cell-2.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/44-multiple-columns.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/45-highlighting-text.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/46-shading-text.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/47-number-of-total-pages-section.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/48-vertical-align.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/49-table-borders.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/50-readme-demo.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/51-character-styles.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/52-japanese.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/53-chinese.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/54-custom-properties.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/55-math.ts
             #: 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
+            # - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/56-background-color.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/57-add-parent-numbered-lists.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/58-section-types.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/59-header-footer-margins.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/60-track-revisions.ts
             # 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
+            # - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/61-text-frame.ts
             # 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
+            # - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/62-paragraph-spacing.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/63-odd-even-header-footer.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/64-complex-numbering-text.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/65-page-sizes.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/66-fields.ts
             # 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
+            # - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/67-column-break.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/68-numbering-instances-and-starting-number.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/69-different-width-columns.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/70-line-numbers-suppression.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/71-page-borders-2.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/72-word-wrap.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/73-comments.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/74-nodejs-stream.ts
+            # - uses: "./.github/actions/validate-docx"
+            #   run: npm run run-ts -- ./demo/75-tab-stops.ts
+            # - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/76-compatibility.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/77-side-by-side-tables.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/78-thai-distributed.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/79-table-from-data-source.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/80-thai-distributed.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/81-continuous-header.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/82-new-headers-new-section.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/83-setting-languages.ts
+            - uses: "./.github/actions/validate-docx"
+            - run: npm run run-ts -- ./demo/84-positional-tabs.ts
+            - uses: "./.github/actions/validate-docx"

.github/workflows/github-pages.yml

@@ -10,16 +10,16 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout Repo
-              uses: actions/checkout@master
+              uses: actions/checkout@v4
             - name: Install Dependencies
-              run: npm ci
+              run: npm ci --force
             - 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
+              uses: actions/upload-artifact@v4
               with:
                   name: docs
                   path: docs
@@ -28,11 +28,11 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout Repo 🛎️
-              uses: actions/checkout@master
+              uses: actions/checkout@v4
             - name: Install Dependencies
-              run: npm ci
+              run: npm ci --force
             - name: Download Artifact
-              uses: actions/download-artifact@master
+              uses: actions/download-artifact@v4
               with:
                   name: docs
                   path: docs

.github/workflows/npm-publish.yml

@@ -0,0 +1,46 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://docs.github.com/en/actions/publishing-packages/publishing-nodejs-packages
+
+name: Node.js Package
+
+on:
+    release:
+        types: [created]
+
+jobs:
+    test:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: "20.x"
+            - run: npm ci --force
+            - run: npm run cspell
+            - run: npm run prettier
+            - run: npm run lint
+            - run: npm run test:ci
+
+    build:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: "20.x"
+            - run: npm ci --force
+            - run: npm run build
+
+    publish-npm:
+        needs: [test, build]
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
+              with:
+                  node-version: "20.x"
+                  registry-url: https://registry.npmjs.org/
+            - run: npm ci --force
+            - run: npm publish
+              env:
+                  NODE_AUTH_TOKEN: ${{secrets.npm_token}}

.gitignore

@@ -33,8 +33,7 @@ node_modules
 .node_repl_history
 
 # build
-build
-build-tests
+dist
 
 # Documentation
 docs/api/
@@ -60,5 +59,5 @@ My Document.docx
 # Temporary folder
 tmp
 
-# nyc
-.nyc_output
+# Exclude Mac .DS_Store files
+.DS_Store

.npmignore

@@ -41,3 +41,6 @@ build-tests
 
 # docs
 docs
+
+# src
+src

.npmrc

@@ -0,0 +1 @@
+registry=https://registry.npmjs.org/

.nycrc

@@ -1,25 +0,0 @@
-{
-  "check-coverage": true,
-  "lines": 99.32,
-  "functions": 99.11,
-  "branches": 96.27,
-  "statements": 99.32,
-  "include": [
-    "src/**/*.ts"
-  ],
-  "exclude": [
-    "src/**/*.spec.ts",
-    "src/import-dotx/import-dotx.ts"
-  ],
-  "reporter": [
-    "lcov",
-    "text",
-    "json"
-  ],
-  "extension": [
-    ".ts"
-  ],
-  "cache": true,
-  "all": true,
-  "sourceMap": true
-}

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+    "recommendations": ["streetsidesoftware.code-spell-checker", "dbaeumer.vscode-eslint"]
+}

.vscode/launch.json

@@ -0,0 +1,4 @@
+{
+    "version": "0.2.0",
+    "configurations": []
+}

.vscode/settings.json

@@ -5,5 +5,6 @@
     "editor.formatOnSave": false,
     "prettier.tabWidth": 4,
     "prettier.arrowParens": "always",
-    "prettier.bracketSpacing": true
+    "prettier.bracketSpacing": true,
+    "eslint.useFlatConfig": true
 }

.vscode/tasks.json

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

README.md

@@ -1,9 +1,9 @@
 <p align="center">
-    <img alt="clippy the assistant" src="https://i.imgur.com/37uBGhO.gif">
+    <img src="./logo/logo-animate.svg" width="100%" height="300" alt="clippy the assistant">
 </p>
 
 <p align="center">
-    Easily generate .docx files with JS/TS. Works for Node and on the Browser.
+    Easily generate and modify .docx files with JS/TS. Works for Node and on the Browser.
 </p>
 
 ---
@@ -11,11 +11,10 @@
 [![NPM version][npm-image]][npm-url]
 [![Downloads per month][downloads-image]][downloads-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]
 [![PRs Welcome][pr-image]][pr-url]
 [![codecov][codecov-image]][codecov-url]
+[![Docx.js Editor][docxjs-editor-image]][docxjs-editor-url]
 
 <p align="center">
     <img src="https://i.imgur.com/QeL1HuU.png" alt="drawing"/>
@@ -27,21 +26,22 @@
 
 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/onadx1gu/
+-   https://codepen.io/dolanmiu/pen/RwNeObg
+-   https://jsfiddle.net/dolanmiu/onadx1gu/
 
-Here is an example of `docx` working in `Angular`:
+Here are examples of `docx` working in `Angular`:
 
-*   https://stackblitz.com/edit/angular-docx
+-   https://stackblitz.com/edit/angular-docx
+-   https://stackblitz.com/edit/angular-wmd6k3
 
-Here is an example of `docx` working in `React`:
+Here are examples of `docx` working in `React`:
 
-*   https://stackblitz.com/edit/react-docx
-*   https://stackblitz.com/edit/react-docx-images (adding images to Word Document)
+-   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
+-   https://stackblitz.com/edit/vuejs-docx
 
 ## Node
 
@@ -49,15 +49,15 @@ Press `endpoint` on the `RunKit` website:
 
 ![RunKit Instructions](https://user-images.githubusercontent.com/2917613/38582539-f84311b6-3d07-11e8-90db-5885ae02c3c4.png)
 
-*   https://runkit.com/dolanmiu/docx-demo1 - Simple paragraph and text
-*   https://runkit.com/dolanmiu/docx-demo2 - Advanced Paragraphs and text
-*   https://runkit.com/dolanmiu/docx-demo3 - Bullet points
-*   https://runkit.com/dolanmiu/docx-demo4 - Simple table
-*   https://runkit.com/dolanmiu/docx-demo5 - Images
-*   https://runkit.com/dolanmiu/docx-demo6 - Margins
-*   https://runkit.com/dolanmiu/docx-demo7 - Landscape
-*   https://runkit.com/dolanmiu/docx-demo8 - Header and Footer
-*   https://runkit.com/dolanmiu/docx-demo10 - **My CV generated with docx**
+-   https://runkit.com/dolanmiu/docx-demo1 - Simple paragraph and text
+-   https://runkit.com/dolanmiu/docx-demo2 - Advanced Paragraphs and text
+-   https://runkit.com/dolanmiu/docx-demo3 - Bullet points
+-   https://runkit.com/dolanmiu/docx-demo4 - Simple table
+-   https://runkit.com/dolanmiu/docx-demo5 - Images
+-   https://runkit.com/dolanmiu/docx-demo6 - Margins
+-   https://runkit.com/dolanmiu/docx-demo7 - Landscape
+-   https://runkit.com/dolanmiu/docx-demo8 - Header and Footer
+-   https://runkit.com/dolanmiu/docx-demo10 - **My CV generated with docx**
 
 More [here](https://github.com/dolanmiu/docx/tree/master/demo)
 
@@ -65,6 +65,10 @@ More [here](https://github.com/dolanmiu/docx/tree/master/demo)
 
 Please refer to the [documentation at https://docx.js.org/](https://docx.js.org/) for details on how to use this library, examples and much more!
 
+# Playground
+
+Experience `docx` in action through [Docx.js Editor][docxjs-editor-url], an interactive playground where you can code and preview the results in real-time.
+
 # Examples
 
 Check the [demo folder](https://github.com/dolanmiu/docx/tree/master/demo) for examples.
@@ -85,9 +89,11 @@ Read the contribution guidelines [here](https://docx.js.org/#/contribution-guide
 [<img src="https://i.imgur.com/QEZXU5b.png" alt="drawing" height="50"/>](https://www.beekast.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/cmykN7c.png" alt="drawing"/>](https://www.arity.co/)
 [<img src="https://i.imgur.com/PXo25um.png" alt="drawing" height="50"/>](https://www.circadianrisk.com/)
-
+[<img src="https://i.imgur.com/AKGhtlh.png" alt="drawing"/>](https://lexense.com/)
+[<img src="https://i.imgur.com/9tqJaHw.png" alt="drawing" height="50"/>](https://novelpad.co/)
+[<img src="https://i.imgur.com/5bLKFeP.png" alt="drawing" height="50"/>](https://proton.me/)
 
 ...and many more!
 
@@ -104,12 +110,8 @@ Made with 💖
 [downloads-url]: https://npmjs.org/package/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
 [snky-url]: https://snyk.io/test/github/dolanmiu/docx
-[gitter-image]: https://badges.gitter.im/dolanmiu/docx.svg
-[gitter-url]: https://gitter.im/docx-lib/Lobby
 [pr-image]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
 [pr-url]: http://makeapullrequest.com
 [codecov-image]: https://codecov.io/gh/dolanmiu/docx/branch/master/graph/badge.svg
@@ -118,3 +120,5 @@ Made with 💖
 [patreon-url]: https://www.patreon.com/dolanmiu
 [browserstack-image]: https://user-images.githubusercontent.com/2917613/54233552-128e9d00-4505-11e9-88fb-025a4e04007c.png
 [browserstack-url]: https://www.browserstack.com
+[docxjs-editor-image]: https://img.shields.io/badge/Docx.js%20Editor-2b579a.svg?style=flat&amp;logo=javascript&amp;logoColor=white
+[docxjs-editor-url]: https://docxjs-editor.vercel.app/

SECURITY.md

@@ -0,0 +1,24 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 9.0.x   | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+We encourage responsible disclosure of security vulnerabilities. If you believe you have found a security vulnerability in this project, please report it via the [Security Tab](https://github.com/dolanmiu/docx/security/advisories)
+
+Please include the following information in your report:
+
+* A description of the vulnerability
+* Steps to reproduce the vulnerability
+* Impact of the vulnerability
+
+We will investigate all reported vulnerabilities and take appropriate action.
+
+We appreciate your help in keeping this project secure.

demo/1-basic.ts

@@ -1,7 +1,7 @@
 // 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, Packer, Paragraph, TextRun } from "../build";
+import { Document, Packer, Paragraph, Tab, TextRun } from "docx";
 
 const doc = new Document({
     sections: [
@@ -14,9 +14,10 @@ const doc = new Document({
                         new TextRun({
                             text: "Foo Bar",
                             bold: true,
+                            size: 40,
                         }),
                         new TextRun({
-                            text: "\tGithub is the best",
+                            children: [new Tab(), "Github is the best"],
                             bold: true,
                         }),
                     ],

demo/10-my-cv.ts

@@ -1,7 +1,7 @@
 // Generate a CV
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { AlignmentType, Document, HeadingLevel, Packer, Paragraph, TabStopPosition, TabStopType, TextRun } from "../build";
+import { AlignmentType, Document, HeadingLevel, Packer, Paragraph, Tab, TabStopPosition, TabStopType, TextRun } from "docx";
 
 // tslint:disable:no-shadowed-variable
 
@@ -43,7 +43,7 @@ interface Skill {
     readonly name: string;
 }
 
-interface Achivement {
+interface Achievement {
     readonly issuer: string;
     readonly name: string;
 }
@@ -64,7 +64,7 @@ const experiences: Experience[] = [
     {
         isCurrent: false,
         summary:
-            "Full-stack developer working with Angular, Node and TypeScript. Working for the iShares platform. Emphasis on Dev-ops and developing the continous integration pipeline.",
+            "Full-stack developer working with Angular, Node and TypeScript. Working for the iShares platform. Emphasis on Dev-ops and developing the continuous integration pipeline.",
         title: "Software Developer",
         endDate: {
             month: 11,
@@ -98,6 +98,7 @@ const experiences: Experience[] = [
     {
         isCurrent: false,
         summary:
+            // cspell:disable-next-line
             "Develop web commerce platforms for various high profile clients.\n\nCreated a log analysis web application with the Play Framework in Java, incorporating Test Driven Development. It asynchronously uploads and processes large (2 GB) log files, and outputs meaningful results in context with the problem. \n\nAnalysis  and  development  of  the payment system infrastructure and user accounts section to be used by several clients of the company such as Waitrose, Tally Weijl, DJ Sports, Debenhams, Ann Summers, John Lewis and others.\n\nTechnologies used include WebSphere Commerce, Java, JavaScript and JSP.",
         title: "Java Developer",
         endDate: {
@@ -118,7 +119,7 @@ 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, Algorithms, 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,
@@ -156,7 +157,7 @@ const skills: Skill[] = [
     },
 ];
 
-const achievements: Achivement[] = [
+const achievements: Achievement[] = [
     {
         issuer: "Oracle",
         name: "Oracle Certified Expert",
@@ -165,7 +166,7 @@ const achievements: Achivement[] = [
 
 class DocumentCreator {
     // tslint:disable-next-line: typedef
-    public create([experiences, educations, skills, achivements]: [Experience[], Education[], Skill[], Achivement[]]): Document {
+    public create([experiences, educations, skills, achievements]: [Experience[], Education[], Skill[], Achievement[]]): Document {
         const document = new Document({
             sections: [
                 {
@@ -221,7 +222,7 @@ class DocumentCreator {
                         this.createSubHeading("Skills"),
                         this.createSkillList(skills),
                         this.createSubHeading("Achievements"),
-                        ...this.createAchivementsList(achivements),
+                        ...this.createAchievementsList(achievements),
                         this.createSubHeading("Interests"),
                         this.createInterests("Programming, Technology, Music Production, Web Design, 3D Modelling, Dancing."),
                         this.createHeading("References"),
@@ -283,7 +284,7 @@ class DocumentCreator {
                     bold: true,
                 }),
                 new TextRun({
-                    text: `\t${dateText}`,
+                    children: [new Tab(), dateText],
                     bold: true,
                 }),
             ],
@@ -318,8 +319,8 @@ class DocumentCreator {
     }
 
     // tslint:disable-next-line:no-any
-    public createAchivementsList(achivements: any[]): Paragraph[] {
-        return achivements.map(
+    public createAchievementsList(achievements: any[]): Paragraph[] {
+        return achievements.map(
             (achievement) =>
                 new Paragraph({
                     text: achievement.name,

demo/11-declaritive-styles-2.ts

@@ -1,5 +1,5 @@
 // Setting styles with JavaScript configuration
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
 import {
     AlignmentType,
@@ -16,7 +16,7 @@ import {
     TabStopPosition,
     UnderlineType,
     LevelFormat,
-} from "../build";
+} from "docx";
 
 const table = new Table({
     rows: [
@@ -52,18 +52,20 @@ const table = new Table({
 });
 
 const doc = new Document({
-    numbering:{
-        config:[{
-            reference: 'ref1',
+    numbering: {
+        config: [
+            {
+                reference: "ref1",
                 levels: [
                     {
                         level: 0,
                         format: LevelFormat.DECIMAL,
-                text: '%1)',
+                        text: "%1)",
                         start: 50,
-            }
+                    },
+                ],
+            },
         ],
-        }]
     },
     styles: {
         default: {
@@ -184,11 +186,11 @@ const doc = new Document({
                     spacing: { line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 },
                     rightTabStop: TabStopPosition.MAX,
                     leftTabStop: 453.543307087,
-                    numbering : {
-                        reference: 'ref1',
+                    numbering: {
+                        reference: "ref1",
                         instance: 0,
                         level: 0,
-                    }
+                    },
                 },
             },
         ],

demo/12-scaling-images.ts

@@ -1,7 +1,7 @@
 // Scaling images
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, ImageRun, Packer, Paragraph } from "../build";
+import { Document, ImageRun, Packer, Paragraph } from "docx";
 
 const doc = new Document({
     sections: [

demo/13-xml-styles.ts

@@ -1,7 +1,7 @@
 // This example shows 3 styles using XML styles
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, HeadingLevel, Packer, Paragraph } from "../build";
+import { Document, HeadingLevel, Packer, Paragraph } from "docx";
 
 const styles = fs.readFileSync("./demo/assets/custom-styles.xml", "utf-8");
 const doc = new Document({

demo/14-page-numbers.ts

@@ -1,7 +1,7 @@
 // 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, Paragraph, TextRun } from "../build";
+import { AlignmentType, Document, Footer, Header, Packer, PageBreak, PageNumber, Paragraph, TextRun } from "docx";
 
 const doc = new Document({
     sections: [
@@ -45,7 +45,7 @@ const doc = new Document({
                             children: [
                                 new TextRun("My Title "),
                                 new TextRun({
-                                    children: ["Footer - Page ", PageNumber.CURRENT],
+                                    children: ["Footer - Page ", PageNumber.CURRENT, " of ", PageNumber.TOTAL_PAGES],
                                 }),
                             ],
                         }),

demo/15-page-break-before.ts

@@ -1,7 +1,7 @@
 // Page break before example
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, Packer, Paragraph } from "../build";
+import { Document, Packer, Paragraph } from "docx";
 
 const doc = new Document({
     sections: [

demo/16-multiple-sections.ts

@@ -1,7 +1,7 @@
 // Multiple sections and headers
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, Footer, Header, Packer, PageNumber, NumberFormat, PageOrientation, Paragraph, TextRun } from "../build";
+import { Document, Footer, Header, Packer, PageNumber, NumberFormat, PageOrientation, Paragraph, TextRun } from "docx";
 
 const doc = new Document({
     sections: [

demo/17-footnotes.ts

@@ -1,7 +1,7 @@
 // Footnotes
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, FootnoteReferenceRun, Packer, Paragraph, TextRun } from "../build";
+import { Document, FootnoteReferenceRun, Packer, Paragraph, TextRun } from "docx";
 
 const doc = new Document({
     footnotes: {
@@ -18,10 +18,15 @@ const doc = new Document({
                 new Paragraph({
                     children: [
                         new TextRun({
-                            children: ["Hello", new FootnoteReferenceRun(1)],
+                            children: ["Hello"],
                         }),
+                        new FootnoteReferenceRun(1),
                         new TextRun({
-                            children: [" World!", new FootnoteReferenceRun(2)],
+                            children: [" World!"],
+                        }),
+                        new FootnoteReferenceRun(2),
+                        new TextRun({
+                            children: [" GitHub!"],
                         }),
                     ],
                 }),
@@ -35,15 +40,17 @@ const doc = new Document({
                 new Paragraph({
                     children: [
                         new TextRun({
-                            children: ["Hello", new FootnoteReferenceRun(4)],
+                            children: ["Hello"],
                         }),
+                        new FootnoteReferenceRun(4),
                         new TextRun({
-                            children: [" World!", new FootnoteReferenceRun(5)],
+                            children: [" World!"],
                         }),
+                        new FootnoteReferenceRun(5),
                     ],
                 }),
                 new Paragraph({
-                    children: [new TextRun("Hello World"), new FootnoteReferenceRun(6)],
+                    children: [new TextRun("Hello World Again"), new FootnoteReferenceRun(6)],
                 }),
             ],
         },

demo/18-image-from-buffer.ts

@@ -1,7 +1,7 @@
 // Insert image from a buffer
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, ImageRun, Packer, Paragraph } from "../build";
+import { Document, ImageRun, Packer, Paragraph } from "docx";
 
 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`;
 

demo/19-export-to-base64.ts

@@ -1,7 +1,7 @@
 // Export to base64 string - Useful in a browser environment.
-// 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, Tab, TextRun } from "docx";
 
 const doc = new Document({
     sections: [
@@ -15,7 +15,7 @@ const doc = new Document({
                             bold: true,
                         }),
                         new TextRun({
-                            text: "\tBar",
+                            children: [new Tab(), "Bar"],
                             bold: true,
                         }),
                     ],

demo/2-declaritive-styles.ts

@@ -1,17 +1,7 @@
-// Example on how to customise the look at feel using Styles
-// Import from 'docx' rather than '../build' if you install from npm
+// Example on how to customize the look at feel using Styles
+
 import * as fs from "fs";
-import {
-    AlignmentType,
-    convertInchesToTwip,
-    Document,
-    HeadingLevel,
-    LevelFormat,
-    Packer,
-    Paragraph,
-    TextRun,
-    UnderlineType,
-} from "../build";
+import { AlignmentType, convertInchesToTwip, Document, HeadingLevel, LevelFormat, Packer, Paragraph, TextRun, UnderlineType } from "docx";
 
 const doc = new Document({
     creator: "Clippy",
@@ -53,6 +43,15 @@ const doc = new Document({
                     color: "#FF0000",
                 },
             },
+            document: {
+                run: {
+                    size: "11pt",
+                    font: "Calibri",
+                },
+                paragraph: {
+                    alignment: AlignmentType.RIGHT,
+                },
+            },
         },
         paragraphStyles: [
             {
@@ -82,6 +81,32 @@ const doc = new Document({
                     spacing: { line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 },
                 },
             },
+            {
+                id: "strikeUnderline",
+                name: "Strike Underline",
+                basedOn: "Normal",
+                quickFormat: true,
+                run: {
+                    strike: true,
+                    underline: {
+                        type: UnderlineType.SINGLE,
+                    },
+                },
+            },
+        ],
+        characterStyles: [
+            {
+                id: "strikeUnderlineCharacter",
+                name: "Strike Underline",
+                basedOn: "Normal",
+                quickFormat: true,
+                run: {
+                    strike: true,
+                    underline: {
+                        type: UnderlineType.SINGLE,
+                    },
+                },
+            },
         ],
     },
     numbering: {
@@ -169,6 +194,14 @@ const doc = new Document({
                         new TextRun({
                             text: "and back to normal.",
                         }),
+                        new TextRun({
+                            text: "This text will be invisible!",
+                            vanish: true,
+                        }),
+                        new TextRun({
+                            text: "This text will be VERY invisible! Word processors cannot override this!",
+                            specVanish: true,
+                        }),
                     ],
                 }),
                 new Paragraph({
@@ -182,6 +215,49 @@ const doc = new Document({
                         }),
                     ],
                 }),
+                new Paragraph({
+                    style: "strikeUnderline",
+                    children: [
+                        new TextRun({
+                            text: "Underline and Strike",
+                        }),
+                        new TextRun({
+                            text: " Override Underline ",
+                            underline: {
+                                type: UnderlineType.NONE,
+                            },
+                        }),
+                        new TextRun({
+                            text: "Strike and Underline",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "Hello World ",
+                        }),
+                        new TextRun({
+                            style: "strikeUnderlineCharacter",
+                            text: "Underline and Strike",
+                        }),
+                        new TextRun({
+                            text: " Another Hello World",
+                        }),
+                        new TextRun({
+                            scale: 50,
+                            text: " Scaled text",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    scale: 200,
+                    children: [
+                        new TextRun({
+                            text: "Scaled paragraph",
+                        }),
+                    ],
+                }),
             ],
         },
     ],

demo/20-table-cell-borders.ts

@@ -1,7 +1,7 @@
 // Add custom borders to table cell
-// 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";
+import { BorderStyle, Document, Packer, Paragraph, Table, TableCell, TableRow } from "docx";
 
 const doc = new Document({
     sections: [

demo/21-bookmarks.ts

@@ -1,9 +1,10 @@
 // This demo shows how to create bookmarks then link to them with internal hyperlinks
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Bookmark, Document, Footer, HeadingLevel, InternalHyperlink, Packer, PageBreak, Paragraph, TextRun, PageReference } from "../build";
+import { Bookmark, Document, Footer, HeadingLevel, InternalHyperlink, Packer, PageBreak, Paragraph, TextRun, PageReference } from "docx";
 
 const LOREM_IPSUM =
+    /* cspell:disable-next-line */
     "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.";
 
 const doc = new Document({

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

@@ -1,7 +1,7 @@
 // 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, Table, TableCell, TableRow, TextRun } from "../build";
+import { Document, Packer, Paragraph, Table, TableCell, TableRow, TextRun } from "docx";
 
 const doc = new Document({
     sections: [

demo/23-base64-images.ts

@@ -1,7 +1,7 @@
 // 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, ImageRun, Packer, Paragraph, TextRun } from "../build";
+import { Document, ImageRun, Packer, Paragraph, TextRun } from "docx";
 
 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`;
 

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

@@ -1,7 +1,7 @@
 // Add image to table cell
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, ImageRun, Packer, Paragraph, Table, TableCell, TableRow } from "../build";
+import { Document, ImageRun, Packer, Paragraph, Table, TableCell, TableRow } from "docx";
 
 const doc = new Document({
     sections: [

demo/25-table-xml-styles.ts

@@ -1,7 +1,7 @@
 // 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";
+import { Document, Packer, Paragraph, Table, TableCell, TableRow, WidthType } from "docx";
 
 const styles = fs.readFileSync("./demo/assets/custom-styles.xml", "utf-8");
 

demo/26-paragraph-borders.ts

@@ -1,7 +1,7 @@
 // Creates two paragraphs, one with a border and one without
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { BorderStyle, Document, Packer, Paragraph } from "../build";
+import { BorderStyle, Document, Packer, Paragraph, TextRun } from "docx";
 
 const doc = new Document({
     sections: [
@@ -25,6 +25,36 @@ const doc = new Document({
                         },
                     },
                 }),
+                new Paragraph({
+                    text: "",
+                    border: {
+                        top: {
+                            color: "auto",
+                            space: 1,
+                            style: BorderStyle.SINGLE,
+                            size: 6,
+                        },
+                    },
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "This will ",
+                        }),
+                        new TextRun({
+                            text: "have a border.",
+                            border: {
+                                color: "auto",
+                                space: 1,
+                                style: BorderStyle.SINGLE,
+                                size: 6,
+                            },
+                        }),
+                        new TextRun({
+                            text: " This will not.",
+                        }),
+                    ],
+                }),
             ],
         },
     ],

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, convertInchesToTwip, HeadingLevel, Packer, Paragraph, UnderlineType } from "../build";
+import { Document, convertInchesToTwip, HeadingLevel, Packer, Paragraph, UnderlineType } from "docx";
 
 const doc = new Document({
     styles: {

demo/28-table-of-contents.ts

@@ -1,7 +1,7 @@
 // Table of contents
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { File, HeadingLevel, Packer, Paragraph, StyleLevel, TableOfContents } from "../build";
+import { File, HeadingLevel, Packer, Paragraph, StyleLevel, TableOfContents } from "docx";
 
 // WordprocessingML docs for TableOfContents can be found here:
 // http://officeopenxml.com/WPtableOfContents.php

demo/29-numbered-lists.ts

@@ -1,8 +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, convertInchesToTwip, Document, HeadingLevel, LevelFormat, Packer, Paragraph } from "../build";
+import { AlignmentType, convertInchesToTwip, Document, HeadingLevel, LevelFormat, Packer, Paragraph } from "docx";
 
 const doc = new Document({
     numbering: {

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, convertInchesToTwip, Document, HeadingLevel, LevelFormat, Packer, Paragraph } from "../build";
+import { AlignmentType, convertInchesToTwip, Document, Footer, Header, HeadingLevel, LevelFormat, Packer, Paragraph } from "docx";
 
 const doc = new Document({
     numbering: {
@@ -119,6 +119,46 @@ const doc = new Document({
     },
     sections: [
         {
+            headers: {
+                default: new Header({
+                    children: [
+                        new Paragraph({
+                            text: "Hey you",
+                            numbering: {
+                                reference: "my-crazy-numbering",
+                                level: 0,
+                            },
+                        }),
+                        new Paragraph({
+                            text: "What's up fam",
+                            numbering: {
+                                reference: "my-crazy-numbering",
+                                level: 1,
+                            },
+                        }),
+                    ],
+                }),
+            },
+            footers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            text: "Hey you",
+                            numbering: {
+                                reference: "my-crazy-numbering",
+                                level: 0,
+                            },
+                        }),
+                        new Paragraph({
+                            text: "What's up fam",
+                            numbering: {
+                                reference: "my-crazy-numbering",
+                                level: 1,
+                            },
+                        }),
+                    ],
+                }),
+            },
             children: [
                 new Paragraph({
                     text: "Hey you",

demo/30-template-document.ts

@@ -1,35 +0,0 @@
-// Example on how to use a template document
-// Import from 'docx' rather than '../build' if you install from npm
-import * as fs from "fs";
-import { Document, ImportDotx, Packer, Paragraph } from "../build";
-
-const importDotx = new ImportDotx();
-const filePath = "./demo/dotx/template.dotx";
-
-fs.readFile(filePath, (err, data) => {
-    if (err) {
-        throw new Error(`Failed to read file ${filePath}.`);
-    }
-
-    importDotx.extract(data).then((templateDocument) => {
-        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

@@ -1,7 +1,7 @@
 // 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, HeadingLevel, Packer, Paragraph, Table, TableCell, TableRow, VerticalAlign, TextDirection } from "../build";
+import { Document, HeadingLevel, Packer, Paragraph, Table, TableCell, TableRow, VerticalAlign, TextDirection } from "docx";
 
 const doc = new Document({
     sections: [
@@ -34,8 +34,7 @@ const doc = new Document({
                                 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",
+                                            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,
                                         }),
                                     ],

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

@@ -1,6 +1,6 @@
 // Example of how you would merge cells together (Rows and Columns) and apply shading
 // 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,
@@ -15,7 +15,7 @@ import {
     TableCell,
     TableRow,
     WidthType,
-} from "../build";
+} from "docx";
 
 const table = new Table({
     rows: [

demo/33-sequential-captions.ts

@@ -1,7 +1,7 @@
 // Sequential Captions
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, Packer, Paragraph, SequentialIdentifier, TextRun } from "../build";
+import { Document, Packer, Paragraph, SequentialIdentifier, TextRun } from "docx";
 
 const doc = new Document({
     sections: [

demo/34-floating-tables.ts

@@ -1,5 +1,5 @@
 // Example of how you would create a table with float positions
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
 import {
     Document,
@@ -14,7 +14,7 @@ import {
     TableLayoutType,
     TableRow,
     WidthType,
-} from "../build";
+} from "docx";
 
 const table = new Table({
     rows: [

demo/35-hyperlinks.ts

@@ -1,9 +1,21 @@
 // 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, ExternalHyperlink, Footer, FootnoteReferenceRun, ImageRun, Packer, Paragraph, TextRun } from "../build";
+import { Document, ExternalHyperlink, Footer, FootnoteReferenceRun, ImageRun, Packer, Paragraph, TextRun } from "docx";
 
 const doc = new Document({
+    styles: {
+        default: {
+            hyperlink: {
+                run: {
+                    color: "FF0000",
+                    underline: {
+                        color: "0000FF",
+                    },
+                },
+            },
+        },
+    },
     footnotes: {
         1: {
             children: [

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

@@ -1,7 +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, ImageRun, Packer, Paragraph, Table, TableCell, TableRow } from "../build";
+import { Document, Header, ImageRun, Packer, Paragraph, Table, TableCell, TableRow } from "docx";
 
 const table = new Table({
     rows: [

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

@@ -1,7 +1,7 @@
 // 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, ImageRun, Packer, Paragraph } from "../build";
+import { Document, Header, ImageRun, Packer, Paragraph } from "docx";
 
 const doc = new Document({
     sections: [

demo/38-text-wrapping.ts

@@ -1,8 +1,8 @@
 // Example of how to "wrap" text around an image
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-// import { Document, Packer, Paragraph } from "../build";
-import { Document, ImageRun, Packer, Paragraph, TextWrappingSide, TextWrappingType } from "../build";
+// import { Document, Packer, Paragraph } from "docx";
+import { Document, ImageRun, Packer, Paragraph, TextWrappingSide, TextWrappingType } from "docx";
 
 const doc = new Document({
     sections: [

demo/39-page-numbers.ts

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

demo/4-basic-table.ts

@@ -1,7 +1,7 @@
 // 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";
+import { Document, Packer, Paragraph, Table, TableCell, TableRow, WidthType } from "docx";
 
 const table = new Table({
     columnWidths: [3505, 5505],

demo/40-line-numbers.ts

@@ -1,7 +1,7 @@
 // Example demonstrating line numbers.
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, HeadingLevel, LineNumberRestartFormat, Packer, Paragraph } from "../build";
+import { Document, HeadingLevel, LineNumberRestartFormat, Packer, Paragraph } from "docx";
 
 const doc = new Document({
     sections: [

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

@@ -1,7 +1,7 @@
 // Multiple cells merging in the same table - Rows and Columns
-// 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";
+import { Document, Packer, Paragraph, Table, TableCell, TableRow } from "docx";
 
 const table = new Table({
     rows: [

demo/42-restart-page-numbers.ts

@@ -1,7 +1,7 @@
 // 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";
+import { AlignmentType, Document, Header, Packer, PageBreak, PageNumber, PageNumberSeparator, Paragraph, TextRun } from "docx";
 
 const doc = new Document({
     sections: [

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

@@ -1,9 +1,15 @@
 // Add image to table cell
-// 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";
+import { Document, ImageRun, Packer, Paragraph, Table, TableCell, TableRow, WidthType } from "docx";
+
+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 table = new Table({
+    width: {
+        size: 8640,
+        type: WidthType.DXA,
+    },
     rows: [
         new TableRow({
             children: [
@@ -17,7 +23,19 @@ const table = new Table({
                     children: [],
                 }),
                 new TableCell({
-                    children: [],
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new ImageRun({
+                                    data: Buffer.from(imageBase64Data, "base64"),
+                                    transformation: {
+                                        width: 100,
+                                        height: 100,
+                                    },
+                                }),
+                            ],
+                        }),
+                    ],
                 }),
             ],
         }),
@@ -27,7 +45,19 @@ const table = new Table({
                     children: [],
                 }),
                 new TableCell({
-                    children: [],
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new ImageRun({
+                                    data: fs.readFileSync("./demo/images/image1.jpeg"),
+                                    transformation: {
+                                        width: 100,
+                                        height: 100,
+                                    },
+                                }),
+                            ],
+                        }),
+                    ],
                 }),
                 new TableCell({
                     children: [],

demo/44-multiple-columns.ts

@@ -1,7 +1,7 @@
 // Sections with multiple columns
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, Packer, Paragraph } from "../build";
+import { Document, Packer, Paragraph } from "docx";
 
 const doc = new Document({
     sections: [

demo/45-highlighting-text.ts

@@ -1,7 +1,7 @@
 // Highlighting text
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { AlignmentType, Document, Header, Packer, Paragraph, TextRun } from "../build";
+import { AlignmentType, Document, Header, Packer, Paragraph, TextRun } from "docx";
 
 const doc = new Document({
     sections: [

demo/46-shading-text.ts

@@ -1,7 +1,7 @@
 // Shading text
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { AlignmentType, Document, Header, Packer, Paragraph, ShadingType, TextRun } from "../build";
+import { AlignmentType, Document, Header, Packer, Paragraph, ShadingType, TextRun } from "docx";
 
 const doc = new Document({
     sections: [

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

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

demo/48-vertical-align.ts

@@ -1,7 +1,7 @@
 // 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, VerticalAlign, TextRun } from "../build";
+import { Document, Packer, Paragraph, VerticalAlign, TextRun, Tab } from "docx";
 
 const doc = new Document({
     sections: [
@@ -18,7 +18,7 @@ const doc = new Document({
                             bold: true,
                         }),
                         new TextRun({
-                            text: "\tGithub is the best",
+                            children: [new Tab(), "Github is the best"],
                             bold: true,
                         }),
                     ],

demo/49-table-borders.ts

@@ -1,5 +1,5 @@
 // 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,
@@ -13,7 +13,7 @@ import {
     TableRow,
     TextDirection,
     VerticalAlign,
-} from "../build";
+} from "docx";
 
 const table = new Table({
     rows: [
@@ -123,8 +123,7 @@ const noBorderTable = new Table({
                 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",
+                            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,
                         }),
                     ],

demo/5-images.ts

@@ -1,7 +1,8 @@
 // Example of how to add images to the document - You can use Buffers, UInt8Arrays or Base64 strings
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
 import {
+    convertMillimetersToTwip,
     Document,
     HorizontalPositionAlign,
     HorizontalPositionRelativeFrom,
@@ -10,7 +11,7 @@ import {
     Paragraph,
     VerticalPositionAlign,
     VerticalPositionRelativeFrom,
-} from "../build";
+} from "docx";
 
 const doc = new Document({
     sections: [
@@ -20,21 +21,16 @@ const doc = new Document({
                 new Paragraph({
                     children: [
                         new ImageRun({
+                            type: "jpg",
                             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,
+                            altText: {
+                                title: "This is an ultimate title",
+                                description: "This is an ultimate image",
+                                name: "My Ultimate Image",
                             },
                         }),
                     ],
@@ -42,6 +38,24 @@ const doc = new Document({
                 new Paragraph({
                     children: [
                         new ImageRun({
+                            type: "png",
+                            data: fs.readFileSync("./demo/images/dog.png").toString("base64"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                            outline: {
+                                type: "solidFill",
+                                solidFillType: "rgb",
+                                value: "FF0000",
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            type: "jpg",
                             data: fs.readFileSync("./demo/images/cat.jpg"),
                             transformation: {
                                 width: 100,
@@ -50,12 +64,19 @@ const doc = new Document({
                                     vertical: true,
                                 },
                             },
+                            outline: {
+                                type: "solidFill",
+                                solidFillType: "rgb",
+                                value: "0000FF",
+                                width: convertMillimetersToTwip(600),
+                            },
                         }),
                     ],
                 }),
                 new Paragraph({
                     children: [
                         new ImageRun({
+                            type: "bmp",
                             data: fs.readFileSync("./demo/images/parrots.bmp"),
                             transformation: {
                                 width: 150,
@@ -71,6 +92,7 @@ const doc = new Document({
                 new Paragraph({
                     children: [
                         new ImageRun({
+                            type: "gif",
                             data: fs.readFileSync("./demo/images/pizza.gif"),
                             transformation: {
                                 width: 200,
@@ -86,6 +108,7 @@ const doc = new Document({
                 new Paragraph({
                     children: [
                         new ImageRun({
+                            type: "gif",
                             data: fs.readFileSync("./demo/images/pizza.gif"),
                             transformation: {
                                 width: 200,
@@ -107,6 +130,7 @@ const doc = new Document({
                 new Paragraph({
                     children: [
                         new ImageRun({
+                            type: "jpg",
                             data: fs.readFileSync("./demo/images/cat.jpg"),
                             transformation: {
                                 width: 200,
@@ -126,6 +150,22 @@ const doc = new Document({
                         }),
                     ],
                 }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            type: "svg",
+                            data: fs.readFileSync("./demo/images/linux-svg.svg"),
+                            transformation: {
+                                width: 200,
+                                height: 200,
+                            },
+                            fallback: {
+                                type: "png",
+                                data: fs.readFileSync("./demo/images/linux-png.png"),
+                            },
+                        }),
+                    ],
+                }),
             ],
         },
     ],

demo/50-readme-demo.ts

@@ -1,7 +1,7 @@
 // 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, ImageRun, Packer, Paragraph, Table, TableCell, TableRow, VerticalAlign } from "../build";
+import { Document, HeadingLevel, ImageRun, Packer, Paragraph, Table, TableCell, TableRow, VerticalAlign } from "docx";
 
 const table = new Table({
     rows: [

demo/51-character-styles.ts

@@ -1,7 +1,7 @@
 // Custom character styles using JavaScript configuration
-// 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, TextRun } from "docx";
 
 const doc = new Document({
     styles: {
@@ -43,8 +43,7 @@ const doc = new Document({
                             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.",
+                            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

@@ -1,7 +1,7 @@
 // Japanese text - Need to use a Japanese font
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, HeadingLevel, Packer, Paragraph } from "../build";
+import { Document, HeadingLevel, Packer, Paragraph } from "docx";
 
 const doc = new Document({
     styles: {

demo/53-chinese.ts

@@ -5,9 +5,8 @@
 
 // Note that if the OS have not install `KaiTi` font, this demo doesn't work.
 
-// Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Document, HeadingLevel, Packer, Paragraph, TextRun } from "../build";
+import { Document, HeadingLevel, Packer, Paragraph, TextRun } from "docx";
 
 const doc = new Document({
     styles: {

demo/54-custom-properties.ts

@@ -3,9 +3,8 @@
 // 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";
+import { Document, Packer } from "docx";
 
 const doc = new Document(
     // Standard properties

demo/55-math.ts

@@ -1,5 +1,5 @@
 // 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,
@@ -16,11 +16,14 @@ import {
     MathSubScript,
     MathSubSuperScript,
     MathSum,
+    MathIntegral,
     MathSuperScript,
     Packer,
     Paragraph,
     TextRun,
-} from "../build";
+    MathLimitLower,
+    MathLimitUpper,
+} from "docx";
 
 const doc = new Document({
     sections: [
@@ -90,6 +93,35 @@ const doc = new Document({
                         }),
                     ],
                 }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathIntegral({
+                                    children: [new MathRun("test")],
+                                }),
+                                new MathIntegral({
+                                    children: [
+                                        new MathSuperScript({
+                                            children: [new MathRun("e")],
+                                            superScript: [new MathRun("2")],
+                                        }),
+                                    ],
+                                    subScript: [new MathRun("i")],
+                                }),
+                                new MathIntegral({
+                                    children: [
+                                        new MathRadical({
+                                            children: [new MathRun("i")],
+                                        }),
+                                    ],
+                                    subScript: [new MathRun("i")],
+                                    superScript: [new MathRun("10")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
                 new Paragraph({
                     children: [
                         new Math({
@@ -286,6 +318,23 @@ const doc = new Document({
                         }),
                     ],
                 }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathLimitUpper({
+                                    children: [new MathRun("x")],
+                                    limit: [new MathRun("-")],
+                                }),
+                                new MathRun("="),
+                                new MathLimitLower({
+                                    children: [new MathRun("lim")],
+                                    limit: [new MathRun("x→0")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
             ],
         },
     ],

demo/56-background-color.ts

@@ -1,7 +1,7 @@
 // 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";
+import { Document, Packer, Paragraph, Tab, TextRun } from "docx";
 
 const doc = new Document({
     background: {
@@ -19,7 +19,7 @@ const doc = new Document({
                             bold: true,
                         }),
                         new TextRun({
-                            text: "\tGithub is the best",
+                            children: [new Tab(), "Github is the best"],
                             bold: true,
                         }),
                     ],

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

@@ -1,7 +1,7 @@
 // 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";
+import { AlignmentType, convertInchesToTwip, Document, HeadingLevel, LevelFormat, Packer, Paragraph } from "docx";
 
 const doc = new Document({
     numbering: {

demo/58-section-types.ts

@@ -1,7 +1,7 @@
 // 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";
+import { Document, Packer, Paragraph, TextRun, SectionType } from "docx";
 
 const doc = new Document({
     sections: [

demo/59-header-footer-margins.ts

@@ -1,7 +1,7 @@
 // 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";
+import { Document, Footer, Header, Packer, Paragraph } from "docx";
 
 const doc = new Document({
     sections: [

demo/6-page-borders.ts

@@ -1,7 +1,7 @@
 // Example of how to change page borders
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, HeadingLevel, Packer, Paragraph, TextRun } from "../build";
+import { Document, HeadingLevel, Packer, Paragraph, Tab, TextRun } from "docx";
 
 const doc = new Document({
     sections: [
@@ -25,7 +25,7 @@ const doc = new Document({
                             bold: true,
                         }),
                         new TextRun({
-                            text: "\tGithub is the best",
+                            children: [new Tab(), "Github is the best"],
                             bold: true,
                         }),
                     ],

demo/60-track-revisions.ts

@@ -1,5 +1,5 @@
 // Track Revisions aka. "Track Changes"
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
 import {
     AlignmentType,
@@ -12,8 +12,9 @@ import {
     PageNumber,
     Paragraph,
     ShadingType,
+    Tab,
     TextRun,
-} from "../build";
+} from "docx";
 
 /*
     For reference, see
@@ -111,7 +112,17 @@ const doc = new Document({
                         }),
                         new TextRun({
                             bold: true,
-                            children: ["\tuse Inserted and Deleted TextRuns.", new FootnoteReferenceRun(1)],
+                            children: [new Tab(), "use Inserted and Deleted TextRuns.", new FootnoteReferenceRun(1)],
+                        }),
+                        new TextRun({
+                            bold: true,
+                            text: "And some style changes",
+                            revision: {
+                                id: 4,
+                                author: "Firstname Lastname",
+                                date: "2020-10-06T09:05:00Z",
+                                bold: false,
+                            },
                         }),
                     ],
                 }),

demo/61-text-frame.ts

@@ -1,16 +1,18 @@
 // Text Frame (Text Box) example
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
 import {
+    AlignmentType,
     BorderStyle,
     Document,
     FrameAnchorType,
     HorizontalPositionAlign,
     Packer,
     Paragraph,
+    Tab,
     TextRun,
     VerticalPositionAlign,
-} from "../build";
+} from "docx";
 
 const doc = new Document({
     sections: [
@@ -19,6 +21,7 @@ const doc = new Document({
             children: [
                 new Paragraph({
                     frame: {
+                        type: "absolute",
                         position: {
                             x: 1000,
                             y: 3000,
@@ -29,6 +32,54 @@ const doc = new Document({
                             horizontal: FrameAnchorType.MARGIN,
                             vertical: FrameAnchorType.MARGIN,
                         },
+                    },
+                    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({
+                            children: [new Tab(), "Github is the best"],
+                            bold: true,
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    frame: {
+                        type: "alignment",
+                        width: 4000,
+                        height: 1000,
+                        anchor: {
+                            horizontal: FrameAnchorType.MARGIN,
+                            vertical: FrameAnchorType.MARGIN,
+                        },
                         alignment: {
                             x: HorizontalPositionAlign.CENTER,
                             y: VerticalPositionAlign.TOP,
@@ -67,7 +118,60 @@ const doc = new Document({
                             bold: true,
                         }),
                         new TextRun({
-                            text: "\tGithub is the best",
+                            children: [new Tab(), "Github is the best"],
+                            bold: true,
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    frame: {
+                        type: "alignment",
+                        width: 4000,
+                        height: 1000,
+                        anchor: {
+                            horizontal: FrameAnchorType.MARGIN,
+                            vertical: FrameAnchorType.MARGIN,
+                        },
+                        alignment: {
+                            x: HorizontalPositionAlign.CENTER,
+                            y: VerticalPositionAlign.BOTTOM,
+                        },
+                    },
+                    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,
+                        },
+                    },
+                    alignment: AlignmentType.RIGHT,
+                    children: [
+                        new TextRun("Hello World"),
+                        new TextRun({
+                            text: "Foo Bar",
+                            bold: true,
+                        }),
+                        new TextRun({
+                            children: [new Tab(), "Github is the best"],
                             bold: true,
                         }),
                     ],

demo/62-paragraph-spacing.ts

@@ -1,7 +1,7 @@
 // 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";
+import { Document, LineRuleType, Packer, Paragraph, TextRun } from "docx";
 
 const doc = new Document({
     sections: [

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

@@ -1,7 +1,7 @@
 // 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";
+import { Document, Footer, Header, Packer, PageBreak, Paragraph, TextRun } from "docx";
 
 const doc = new Document({
     evenAndOddHeaderAndFooters: true,

demo/64-complex-numbering-text.ts

@@ -1,7 +1,7 @@
 // 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";
+import { Document, Packer, Paragraph, LevelFormat } from "docx";
 
 const doc = new Document({
     numbering: {
@@ -107,5 +107,5 @@ const doc = new Document({
 
 // Used to export the file into a .docx file
 Packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("6-numbering.docx", buffer);
+    fs.writeFileSync("My Document.docx", buffer);
 });

demo/65-page-sizes.ts

@@ -1,8 +1,8 @@
 // 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";
+import { convertMillimetersToTwip, Document, Packer, PageOrientation, Paragraph } from "docx";
 
 const doc = new Document({
     sections: [

demo/66-fields.ts

@@ -1,10 +1,10 @@
 // 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";
+import { Bookmark, Document, Packer, Paragraph, SimpleField, TextRun } from "docx";
 
 const doc = new Document({
-    creator: 'Me',
+    creator: "Me",
     sections: [
         {
             properties: {},

demo/67-column-break.ts

@@ -1,7 +1,7 @@
 // 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";
+import { Document, Packer, Paragraph, ColumnBreak, TextRun } from "docx";
 
 const doc = new Document({
     sections: [
@@ -13,11 +13,13 @@ const doc = new Document({
                 },
             },
             children: [
-                new Paragraph({ children: [
-                    new TextRun('This text will be in the first column.'),
+                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.'),
-                ] }),
+                        new TextRun("This text will be in the second column."),
+                    ],
+                }),
             ],
         },
     ],

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

@@ -1,5 +1,5 @@
 import * as fs from "fs";
-import { Document, Packer, Paragraph, LevelFormat } from "../build";
+import { Document, Packer, Paragraph, LevelFormat } from "docx";
 
 const doc = new Document({
     numbering: {

demo/69-different-width-columns.ts

@@ -1,7 +1,7 @@
 // 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";
+import { Column, Document, Packer, Paragraph } from "docx";
 
 const doc = new Document({
     sections: [

demo/7-landscape.ts

@@ -1,7 +1,7 @@
 // Example of how to set the document to landscape
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, Packer, PageOrientation, Paragraph } from "../build";
+import { Document, Packer, PageOrientation, Paragraph } from "docx";
 
 const doc = new Document({
     sections: [

demo/70-line-numbers-suppression.ts

@@ -1,7 +1,7 @@
 // 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";
+import { Document, HeadingLevel, LineNumberRestartFormat, Packer, Paragraph } from "docx";
 
 const doc = new Document({
     sections: [

demo/71-page-borders-2.ts

@@ -0,0 +1,63 @@
+// Example demonstrating page borders with style, colors and size
+
+import { BorderStyle, Document, Packer, PageBorderDisplay, PageBorderOffsetFrom, PageBorderZOrder, Paragraph, TextRun } from "docx";
+import * as fs from "fs";
+
+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/72-word-wrap.ts

@@ -0,0 +1,55 @@
+// Example on how to preserve word wrap text. Works with all languages.
+
+import * as fs from "fs";
+import { Document, Packer, Paragraph, TextRun } from "docx";
+
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Paragraph({
+                    wordWrap: true,
+                    children: [
+                        new TextRun("我今天遛狗去公园"),
+                        new TextRun({
+                            text: "456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    wordWrap: true,
+                    children: [
+                        new TextRun(
+                            "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua",
+                        ),
+                        new TextRun({
+                            text: "456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun("我今天遛狗去公园"),
+                        new TextRun({
+                            text: "456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun(
+                            "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua",
+                        ),
+                        new TextRun({
+                            text: "456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345",
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/73-comments.ts

@@ -0,0 +1,146 @@
+// Simple example to add comments to a document
+
+import * as fs from "fs";
+import { Document, Packer, Paragraph, TextRun, CommentRangeStart, CommentRangeEnd, CommentReference, ImageRun } from "docx";
+
+const doc = new Document({
+    comments: {
+        children: [
+            {
+                id: 0,
+                author: "Ray Chen",
+                date: new Date(),
+                children: [
+                    new Paragraph({
+                        children: [
+                            new TextRun({
+                                text: "some initial text content",
+                            }),
+                        ],
+                    }),
+                    new Paragraph({
+                        children: [
+                            new ImageRun({
+                                type: "jpg",
+                                data: fs.readFileSync("./demo/images/cat.jpg"),
+                                transformation: {
+                                    width: 100,
+                                    height: 100,
+                                },
+                            }),
+                            new TextRun({
+                                text: "comment text content",
+                            }),
+                            new TextRun({ text: "", break: 1 }),
+                            new TextRun({
+                                text: "More text here",
+                                bold: true,
+                            }),
+                        ],
+                    }),
+                ],
+            },
+            {
+                id: 1,
+                author: "Bob Ross",
+                date: new Date(),
+                children: [
+                    new Paragraph({
+                        children: [
+                            new TextRun({
+                                text: "Some initial text content",
+                            }),
+                        ],
+                    }),
+                    new Paragraph({
+                        children: [
+                            new TextRun({
+                                text: "comment text content",
+                            }),
+                        ],
+                    }),
+                ],
+            },
+            {
+                id: 2,
+                author: "John Doe",
+                date: new Date(),
+                children: [
+                    new Paragraph({
+                        children: [
+                            new TextRun({
+                                text: "Hello World",
+                            }),
+                        ],
+                    }),
+                ],
+            },
+            {
+                id: 3,
+                author: "Beatriz",
+                date: new Date(),
+                children: [
+                    new Paragraph({
+                        children: [
+                            new TextRun({
+                                text: "Another reply",
+                            }),
+                        ],
+                    }),
+                ],
+            },
+        ],
+    },
+    sections: [
+        {
+            properties: {},
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World"),
+                        new CommentRangeStart(0),
+                        new TextRun({
+                            text: "Foo Bar",
+                            bold: true,
+                        }),
+                        new CommentRangeEnd(0),
+                        new TextRun({
+                            children: [new CommentReference(0)],
+                            bold: true,
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new CommentRangeStart(1),
+                        new CommentRangeStart(2),
+                        new CommentRangeStart(3),
+                        new TextRun({
+                            text: "Some text which need commenting",
+                            bold: true,
+                        }),
+                        new CommentRangeEnd(1),
+                        new TextRun({
+                            children: [new CommentReference(1)],
+                            bold: true,
+                        }),
+                        new CommentRangeEnd(2),
+                        new TextRun({
+                            children: [new CommentReference(2)],
+                            bold: true,
+                        }),
+                        new CommentRangeEnd(3),
+                        new TextRun({
+                            children: [new CommentReference(3)],
+                            bold: true,
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/74-nodejs-stream.ts

@@ -0,0 +1,30 @@
+// Exporting the document as a stream
+
+import * as fs from "fs";
+import { Document, Packer, Paragraph, Tab, TextRun } from "docx";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {},
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World"),
+                        new TextRun({
+                            text: "Foo Bar",
+                            bold: true,
+                        }),
+                        new TextRun({
+                            children: [new Tab(), "Github is the best"],
+                            bold: true,
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+const stream = Packer.toStream(doc);
+stream.pipe(fs.createWriteStream("My Document.docx"));

demo/75-tab-stops.ts

@@ -0,0 +1,81 @@
+// Example of using tab stops
+
+import * as fs from "fs";
+import { Document, HeadingLevel, Packer, Paragraph, TabStopPosition, TabStopType, TextRun } from "docx";
+
+const columnWidth = TabStopPosition.MAX / 4;
+const receiptTabStops = [
+    // no need to define first left tab column
+    // the right aligned tab column position should point to the end of column
+    // i.e. in this case
+    // (end position of 1st) + (end position of current)
+    // columnWidth + columnWidth = columnWidth * 2
+
+    { type: TabStopType.RIGHT, position: columnWidth * 2 },
+    { type: TabStopType.RIGHT, position: columnWidth * 3 },
+    { type: TabStopType.RIGHT, position: TabStopPosition.MAX },
+];
+const twoTabStops = [{ type: TabStopType.RIGHT, position: TabStopPosition.MAX }];
+
+const doc = new Document({
+    defaultTabStop: 0,
+    sections: [
+        {
+            properties: {},
+            children: [
+                new Paragraph({
+                    heading: HeadingLevel.HEADING_1,
+                    children: [new TextRun("Receipt 001")],
+                }),
+                new Paragraph({
+                    tabStops: twoTabStops,
+                    children: [
+                        new TextRun({
+                            text: "To Bob.\tBy Alice.",
+                            bold: true,
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    tabStops: twoTabStops,
+                    children: [new TextRun("Foo Inc\tBar Inc")],
+                }),
+                new Paragraph({ text: "" }),
+                new Paragraph({
+                    tabStops: receiptTabStops,
+
+                    children: [
+                        new TextRun({
+                            text: "Item\tPrice\tQuantity\tSub-total",
+                            bold: true,
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    tabStops: receiptTabStops,
+                    text: "Item 3\t10\t5\t50",
+                }),
+                new Paragraph({
+                    tabStops: receiptTabStops,
+                    text: "Item 3\t10\t5\t50",
+                }),
+                new Paragraph({
+                    tabStops: receiptTabStops,
+                    text: "Item 3\t10\t5\t50",
+                }),
+                new Paragraph({
+                    tabStops: receiptTabStops,
+                    children: [
+                        new TextRun({
+                            text: "\t\t\tTotal: 200",
+                            bold: true,
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+const stream = Packer.toStream(doc);
+stream.pipe(fs.createWriteStream("My Document.docx"));

demo/76-compatibility.ts

@@ -0,0 +1,87 @@
+// Add compatibility options
+
+import * as fs from "fs";
+import { Document, Packer, Paragraph, TextRun } from "docx";
+
+const doc = new Document({
+    compatibility: {
+        useSingleBorderforContiguousCells: true,
+        wordPerfectJustification: true,
+        noTabStopForHangingIndent: true,
+        noLeading: true,
+        spaceForUnderline: true,
+        noColumnBalance: true,
+        balanceSingleByteDoubleByteWidth: true,
+        noExtraLineSpacing: true,
+        doNotLeaveBackslashAlone: true,
+        underlineTrailingSpaces: true,
+        doNotExpandShiftReturn: true,
+        spacingInWholePoints: true,
+        lineWrapLikeWord6: true,
+        printBodyTextBeforeHeader: true,
+        printColorsBlack: true,
+        spaceWidth: true,
+        showBreaksInFrames: true,
+        subFontBySize: true,
+        suppressBottomSpacing: true,
+        suppressTopSpacing: true,
+        suppressSpacingAtTopOfPage: true,
+        suppressTopSpacingWP: true,
+        suppressSpBfAfterPgBrk: true,
+        swapBordersFacingPages: true,
+        convertMailMergeEsc: true,
+        truncateFontHeightsLikeWP6: true,
+        macWordSmallCaps: true,
+        usePrinterMetrics: true,
+        doNotSuppressParagraphBorders: true,
+        wrapTrailSpaces: true,
+        footnoteLayoutLikeWW8: true,
+        shapeLayoutLikeWW8: true,
+        alignTablesRowByRow: true,
+        forgetLastTabAlignment: true,
+        adjustLineHeightInTable: true,
+        autoSpaceLikeWord95: true,
+        noSpaceRaiseLower: true,
+        doNotUseHTMLParagraphAutoSpacing: true,
+        layoutRawTableWidth: true,
+        layoutTableRowsApart: true,
+        useWord97LineBreakRules: true,
+        doNotBreakWrappedTables: true,
+        doNotSnapToGridInCell: true,
+        selectFieldWithFirstOrLastCharacter: true,
+        applyBreakingRules: true,
+        doNotWrapTextWithPunctuation: true,
+        doNotUseEastAsianBreakRules: true,
+        useWord2002TableStyleRules: true,
+        growAutofit: true,
+        useFELayout: true,
+        useNormalStyleForList: true,
+        doNotUseIndentAsNumberingTabStop: true,
+        useAlternateEastAsianLineBreakRules: true,
+        allowSpaceOfSameStyleInTable: true,
+        doNotSuppressIndentation: true,
+        doNotAutofitConstrainedTables: true,
+        autofitToFirstFixedWidthCell: true,
+        underlineTabInNumberingList: true,
+        displayHangulFixedWidth: true,
+        splitPgBreakAndParaMark: true,
+        doNotVerticallyAlignCellWithSp: true,
+        doNotBreakConstrainedForcedTable: true,
+        ignoreVerticalAlignmentInTextboxes: true,
+        useAnsiKerningPairs: true,
+        cachedColumnBalance: true,
+    },
+    sections: [
+        {
+            children: [
+                new Paragraph({
+                    children: [new TextRun("Hello World")],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/77-side-by-side-tables.ts

@@ -0,0 +1,116 @@
+// Exporting the document as a stream
+
+import * as fs from "fs";
+import { Document, Packer, Paragraph, Table, TableBorders, TableCell, TableRow, WidthType } from "docx";
+
+const table1 = 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: [3505, 5505],
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    width: {
+                        size: 3505,
+                        type: WidthType.DXA,
+                    },
+                    children: [new Paragraph("Foo")],
+                }),
+                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("Bar")],
+                }),
+            ],
+        }),
+    ],
+});
+
+const noBorderTable = new Table({
+    borders: TableBorders.NONE,
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [table1],
+                }),
+                new TableCell({
+                    children: [table2],
+                }),
+            ],
+        }),
+    ],
+});
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {},
+            children: [noBorderTable],
+        },
+    ],
+});
+
+const stream = Packer.toStream(doc);
+stream.pipe(fs.createWriteStream("My Document.docx"));

demo/78-thai-distributed.ts

@@ -0,0 +1,27 @@
+// Simple example to add text to a document
+
+import * as fs from "fs";
+import { AlignmentType, Document, Packer, Paragraph, TextRun } from "docx";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {},
+            children: [
+                new Paragraph({
+                    alignment: AlignmentType.THAI_DISTRIBUTE,
+                    children: [
+                        new TextRun({
+                            text: "บริษัท บิสกิด จำกัด (บริษัทฯ) ได้จดทะเบียนจัดตั้งขึ้นเป็นบริษัทจำกัดตามประมวลกฎหมายแพ่งและพาณิชย์ของประเทศไทย เมื่อวันที่ 30 พฤษภาคม 2561 ทะเบียนนิติบุคคลเลขที่ 0845561005665",
+                            size: 36,
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/79-table-from-data-source.ts

@@ -0,0 +1,193 @@
+// Example of how you would create a table and add data to it from a data source
+
+import * as fs from "fs";
+import {
+    Document,
+    HeadingLevel,
+    Packer,
+    Paragraph,
+    Table,
+    TableCell,
+    TableRow,
+    VerticalAlign,
+    TextDirection,
+    TextRun,
+    WidthType,
+} from "docx";
+
+interface StockPrice {
+    readonly date: Date;
+    readonly ticker: string;
+    readonly price: number;
+}
+
+const DATA: StockPrice[] = [
+    {
+        date: new Date("2007-08-28"),
+        ticker: "Apple",
+        price: 18.12,
+    },
+    {
+        date: new Date("2007-08-29"),
+        ticker: "Apple",
+        price: 19.15,
+    },
+    {
+        date: new Date("2007-08-30"),
+        ticker: "Apple",
+        price: 19.46,
+    },
+    {
+        date: new Date("2007-08-31"),
+        ticker: "Apple",
+        price: 19.78,
+    },
+    {
+        date: new Date("2007-09-04"),
+        ticker: "Apple",
+        price: 20.59,
+    },
+    {
+        date: new Date("2007-09-05"),
+        ticker: "Apple",
+        price: 19.54,
+    },
+    {
+        date: new Date("2007-09-06"),
+        ticker: "Apple",
+        price: 19.29,
+    },
+    {
+        date: new Date("2007-09-07"),
+        ticker: "Apple",
+        price: 18.82,
+    },
+    {
+        date: new Date("2007-09-10"),
+        ticker: "Apple",
+        price: 19.53,
+    },
+    {
+        date: new Date("2007-09-11"),
+        ticker: "Apple",
+        price: 19.36,
+    },
+    {
+        date: new Date("2007-09-12"),
+        ticker: "Apple",
+        price: 19.55,
+    },
+    {
+        date: new Date("2007-09-13"),
+        ticker: "Apple",
+        price: 19.6,
+    },
+    {
+        date: new Date("2007-09-14"),
+        ticker: "Apple",
+        price: 19.83,
+    },
+    {
+        date: new Date("2007-09-17"),
+        ticker: "Apple",
+        price: 19.77,
+    },
+];
+
+const generateRows = (prices: StockPrice[]): TableRow[] =>
+    prices.map(
+        ({ date, ticker, price }) =>
+            new TableRow({
+                children: [
+                    new TableCell({
+                        children: [new Paragraph(date.toString())],
+                        verticalAlign: VerticalAlign.CENTER,
+                        textDirection: TextDirection.LEFT_TO_RIGHT_TOP_TO_BOTTOM,
+                    }),
+                    new TableCell({
+                        children: [new Paragraph(ticker)],
+                        verticalAlign: VerticalAlign.CENTER,
+                        textDirection: TextDirection.LEFT_TO_RIGHT_TOP_TO_BOTTOM,
+                    }),
+                    new TableCell({
+                        children: [new Paragraph(price.toString())],
+                        verticalAlign: VerticalAlign.CENTER,
+                        textDirection: TextDirection.TOP_TO_BOTTOM_RIGHT_TO_LEFT,
+                    }),
+                ],
+            }),
+    );
+
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Table({
+                    width: {
+                        size: 9070,
+                        type: WidthType.DXA,
+                    },
+                    rows: [
+                        new TableRow({
+                            children: [
+                                new TableCell({
+                                    children: [
+                                        new Paragraph({
+                                            heading: HeadingLevel.HEADING_2,
+                                            children: [
+                                                new TextRun({
+                                                    text: "Date",
+                                                    bold: true,
+                                                    size: 40,
+                                                }),
+                                            ],
+                                        }),
+                                    ],
+                                    verticalAlign: VerticalAlign.CENTER,
+                                    textDirection: TextDirection.LEFT_TO_RIGHT_TOP_TO_BOTTOM,
+                                }),
+                                new TableCell({
+                                    children: [
+                                        new Paragraph({
+                                            heading: HeadingLevel.HEADING_2,
+                                            children: [
+                                                new TextRun({
+                                                    text: "Ticker",
+                                                    bold: true,
+                                                    size: 40,
+                                                }),
+                                            ],
+                                        }),
+                                    ],
+                                    verticalAlign: VerticalAlign.CENTER,
+                                    textDirection: TextDirection.LEFT_TO_RIGHT_TOP_TO_BOTTOM,
+                                }),
+                                new TableCell({
+                                    children: [
+                                        new Paragraph({
+                                            heading: HeadingLevel.HEADING_2,
+                                            children: [
+                                                new TextRun({
+                                                    text: "Price",
+                                                    bold: true,
+                                                    size: 40,
+                                                }),
+                                            ],
+                                        }),
+                                    ],
+                                    verticalAlign: VerticalAlign.CENTER,
+                                    textDirection: TextDirection.TOP_TO_BOTTOM_RIGHT_TO_LEFT,
+                                }),
+                            ],
+                        }),
+                        ...generateRows(DATA),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/8-header-footer.ts

@@ -1,7 +1,7 @@
 // Add text to 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";
+import { Document, Footer, Header, Packer, Paragraph } from "docx";
 
 const doc = new Document({
     sections: [

demo/80-thai-distributed.ts

@@ -0,0 +1,49 @@
+// Simple example to add text to a document
+
+import * as fs from "fs";
+import { AlignmentType, convertMillimetersToTwip, Document, Packer, Paragraph, TextRun } from "docx";
+
+const doc = new Document({
+    styles: {
+        paragraphStyles: [
+            {
+                id: "test",
+                name: "Test",
+                basedOn: "Normal",
+                next: "Normal",
+                paragraph: {
+                    indent: { left: convertMillimetersToTwip(6.4) },
+                },
+            },
+        ],
+    },
+    sections: [
+        {
+            properties: {
+                page: {
+                    margin: {
+                        top: 0,
+                        right: convertMillimetersToTwip(24),
+                        bottom: convertMillimetersToTwip(24),
+                        left: convertMillimetersToTwip(24),
+                    },
+                },
+            },
+            children: [
+                new Paragraph({
+                    alignment: AlignmentType.THAI_DISTRIBUTE,
+                    children: [
+                        new TextRun({
+                            text: "บริษัทฯ มีเงินสด 41,985.00 บาท และ 25,855.66 บาทตามลำดับ เงินสดทั้งจำนวนอยู่ในความดูแลและรับผิดชอบของกรรมการ บริษัทฯบันทึกการรับชำระเงินและการจ่ายชำระเงินผ่านบัญชีเงินสดเพียงเท่านั้น ซึ่งอาจกระทบต่อความถูกต้องครบถ้วนของการบันทึกบัญชี ทั้งนี้ขึ้นอยู่กับระบบการควบคุมภายในของบริษัท",
+                            size: 28,
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/81-continuous-header.ts

@@ -0,0 +1,148 @@
+// Example of a continuous header
+
+import * as fs from "fs";
+import { Document, Footer, Header, Packer, Paragraph, SectionType, TextRun } from "docx";
+
+const doc = new Document({
+    creator: "Creator",
+    title: "Title",
+    sections: [
+        {
+            properties: { titlePage: true },
+            headers: {
+                first: new Header({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new TextRun({
+                                    text: "HEADER PAGE ONE",
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                default: new Header({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new TextRun({
+                                    text: "HEADER PAGE TWO AND FOLLOWING PAGES",
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            footers: {
+                first: new Footer({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new TextRun({
+                                    text: "FOOTER PAGE ONE",
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new TextRun({
+                                    text: "FOOTER PAGE TWO AND FOLLOWING PAGES",
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer ac suscipit orci, in lobortis risus. Nulla vehicula rutrum finibus. Nullam consequat, magna in vehicula commodo, enim massa consectetur nisl, sit amet rutrum nunc ante vel lorem. Sed sit amet scelerisque velit. Proin non quam eget mauris aliquet posuere a sed orci. Proin posuere ante suscipit neque dignissim hendrerit. Pellentesque eget dapibus metus. Donec at mollis mauris. Vestibulum sit amet scelerisque nulla. Vivamus ipsum erat, tempor sed volutpat non, molestie at odio. Vivamus lectus ligula, finibus at mattis vitae, euismod sed tellus. Etiam neque massa, faucibus a fringilla nec, mollis at ex. Aliquam eget nibh tortor. Sed ut viverra libero. Nulla facilisis bibendum quam eget porttitor.",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "Sed eget nunc ac turpis facilisis volutpat. Duis eget arcu vitae neque porta hendrerit. Proin vel ante nulla. Duis congue efficitur dui. Suspendisse potenti. Aliquam aliquam nibh eu ipsum sagittis efficitur. Quisque sagittis metus dui, vitae suscipit tortor sollicitudin at. Suspendisse convallis, sem ac ornare condimentum, odio ipsum dapibus justo, a aliquam risus massa ut enim. Mauris vel placerat nibh. Ut iaculis vitae nibh at elementum. Quisque hendrerit et magna vitae mollis. Duis dictum euismod leo, at cursus risus sodales sed.",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "Sed gravida commodo felis, at aliquet risus volutpat ut. Nam nec ex eleifend tellus sodales volutpat nec ac nibh. Vestibulum pretium, leo vitae lobortis accumsan, urna libero euismod ante, consequat aliquam enim risus id nisl. Donec sagittis, justo eu luctus posuere, leo purus pellentesque turpis, eget volutpat mi leo vitae lacus. Etiam ante ante, posuere at augue non, lacinia ornare purus. Praesent vitae velit in enim congue maximus. Vivamus tincidunt fringilla neque. Curabitur fermentum justo nec sapien porttitor, ac ullamcorper nisi imperdiet. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed non orci vel eros egestas eleifend sit amet a diam. Duis mattis at ligula quis faucibus. Donec elementum lacus velit, a vehicula nunc gravida a. Phasellus eget nunc vehicula, varius velit a, maximus velit. Sed a suscipit nisi, non hendrerit felis. Proin mattis facilisis massa, quis elementum neque fringilla non.",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "Sed gravida commodo felis, at aliquet risus volutpat ut. Nam nec ex eleifend tellus sodales volutpat nec ac nibh. Vestibulum pretium, leo vitae lobortis accumsan, urna libero euismod ante, consequat aliquam enim risus id nisl. Donec sagittis, justo eu luctus posuere, leo purus pellentesque turpis, eget volutpat mi leo vitae lacus. Etiam ante ante, posuere at augue non, lacinia ornare purus. Praesent vitae velit in enim congue maximus. Vivamus tincidunt fringilla neque. Curabitur fermentum justo nec sapien porttitor, ac ullamcorper nisi imperdiet. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed non orci vel eros egestas eleifend sit amet a diam. Duis mattis at ligula quis faucibus. Donec elementum lacus velit, a vehicula nunc gravida a. Phasellus eget nunc vehicula, varius velit a, maximus velit. Sed a suscipit nisi, non hendrerit felis. Proin mattis facilisis massa, quis elementum neque fringilla non.",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    spacing: {
+                        after: 500,
+                    },
+                    children: [
+                        new TextRun({
+                            text: "The first section ends after this paragraph.",
+                        }),
+                    ],
+                }),
+            ],
+        },
+        {
+            properties: {
+                type: SectionType.CONTINUOUS,
+            },
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer ac suscipit orci, in lobortis risus. Nulla vehicula rutrum finibus. Nullam consequat, magna in vehicula commodo, enim massa consectetur nisl, sit amet rutrum nunc ante vel lorem. Sed sit amet scelerisque velit. Proin non quam eget mauris aliquet posuere a sed orci. Proin posuere ante suscipit neque dignissim hendrerit. Pellentesque eget dapibus metus. Donec at mollis mauris. Vestibulum sit amet scelerisque nulla. Vivamus ipsum erat, tempor sed volutpat non, molestie at odio. Vivamus lectus ligula, finibus at mattis vitae, euismod sed tellus. Etiam neque massa, faucibus a fringilla nec, mollis at ex. Aliquam eget nibh tortor. Sed ut viverra libero. Nulla facilisis bibendum quam eget porttitor.",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "Sed eget nunc ac turpis facilisis volutpat. Duis eget arcu vitae neque porta hendrerit. Proin vel ante nulla. Duis congue efficitur dui. Suspendisse potenti. Aliquam aliquam nibh eu ipsum sagittis efficitur. Quisque sagittis metus dui, vitae suscipit tortor sollicitudin at. Suspendisse convallis, sem ac ornare condimentum, odio ipsum dapibus justo, a aliquam risus massa ut enim. Mauris vel placerat nibh. Ut iaculis vitae nibh at elementum. Quisque hendrerit et magna vitae mollis. Duis dictum euismod leo, at cursus risus sodales sed.",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "Sed gravida commodo felis, at aliquet risus volutpat ut. Nam nec ex eleifend tellus sodales volutpat nec ac nibh. Vestibulum pretium, leo vitae lobortis accumsan, urna libero euismod ante, consequat aliquam enim risus id nisl. Donec sagittis, justo eu luctus posuere, leo purus pellentesque turpis, eget volutpat mi leo vitae lacus. Etiam ante ante, posuere at augue non, lacinia ornare purus. Praesent vitae velit in enim congue maximus. Vivamus tincidunt fringilla neque. Curabitur fermentum justo nec sapien porttitor, ac ullamcorper nisi imperdiet. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed non orci vel eros egestas eleifend sit amet a diam. Duis mattis at ligula quis faucibus. Donec elementum lacus velit, a vehicula nunc gravida a. Phasellus eget nunc vehicula, varius velit a, maximus velit. Sed a suscipit nisi, non hendrerit felis. Proin mattis facilisis massa, quis elementum neque fringilla non.",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "Sed gravida commodo felis, at aliquet risus volutpat ut. Nam nec ex eleifend tellus sodales volutpat nec ac nibh. Vestibulum pretium, leo vitae lobortis accumsan, urna libero euismod ante, consequat aliquam enim risus id nisl. Donec sagittis, justo eu luctus posuere, leo purus pellentesque turpis, eget volutpat mi leo vitae lacus. Etiam ante ante, posuere at augue non, lacinia ornare purus. Praesent vitae velit in enim congue maximus. Vivamus tincidunt fringilla neque. Curabitur fermentum justo nec sapien porttitor, ac ullamcorper nisi imperdiet. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed non orci vel eros egestas eleifend sit amet a diam. Duis mattis at ligula quis faucibus. Donec elementum lacus velit, a vehicula nunc gravida a. Phasellus eget nunc vehicula, varius velit a, maximus velit. Sed a suscipit nisi, non hendrerit felis. Proin mattis facilisis massa, quis elementum neque fringilla non.",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "The second section starts with the headline above. Move cursor to the end of this text and press enter until next page is generated in continuous section break mode.",
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/82-new-headers-new-section.ts

@@ -0,0 +1,148 @@
+// Example of using headers and footers in a new section
+
+import * as fs from "fs";
+import { Document, Footer, Header, Packer, Paragraph, TextRun } from "docx";
+
+const doc = new Document({
+    creator: "Creator",
+    title: "Title",
+    sections: [
+        {
+            headers: {
+                default: new Header({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new TextRun({
+                                    text: "HEADER PAGE ONE",
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            footers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new TextRun({
+                                    text: "FOOTER PAGE ONE",
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer ac suscipit orci, in lobortis risus. Nulla vehicula rutrum finibus. Nullam consequat, magna in vehicula commodo, enim massa consectetur nisl, sit amet rutrum nunc ante vel lorem. Sed sit amet scelerisque velit. Proin non quam eget mauris aliquet posuere a sed orci. Proin posuere ante suscipit neque dignissim hendrerit. Pellentesque eget dapibus metus. Donec at mollis mauris. Vestibulum sit amet scelerisque nulla. Vivamus ipsum erat, tempor sed volutpat non, molestie at odio. Vivamus lectus ligula, finibus at mattis vitae, euismod sed tellus. Etiam neque massa, faucibus a fringilla nec, mollis at ex. Aliquam eget nibh tortor. Sed ut viverra libero. Nulla facilisis bibendum quam eget porttitor.",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "Sed eget nunc ac turpis facilisis volutpat. Duis eget arcu vitae neque porta hendrerit. Proin vel ante nulla. Duis congue efficitur dui. Suspendisse potenti. Aliquam aliquam nibh eu ipsum sagittis efficitur. Quisque sagittis metus dui, vitae suscipit tortor sollicitudin at. Suspendisse convallis, sem ac ornare condimentum, odio ipsum dapibus justo, a aliquam risus massa ut enim. Mauris vel placerat nibh. Ut iaculis vitae nibh at elementum. Quisque hendrerit et magna vitae mollis. Duis dictum euismod leo, at cursus risus sodales sed.",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "Sed gravida commodo felis, at aliquet risus volutpat ut. Nam nec ex eleifend tellus sodales volutpat nec ac nibh. Vestibulum pretium, leo vitae lobortis accumsan, urna libero euismod ante, consequat aliquam enim risus id nisl. Donec sagittis, justo eu luctus posuere, leo purus pellentesque turpis, eget volutpat mi leo vitae lacus. Etiam ante ante, posuere at augue non, lacinia ornare purus. Praesent vitae velit in enim congue maximus. Vivamus tincidunt fringilla neque. Curabitur fermentum justo nec sapien porttitor, ac ullamcorper nisi imperdiet. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed non orci vel eros egestas eleifend sit amet a diam. Duis mattis at ligula quis faucibus. Donec elementum lacus velit, a vehicula nunc gravida a. Phasellus eget nunc vehicula, varius velit a, maximus velit. Sed a suscipit nisi, non hendrerit felis. Proin mattis facilisis massa, quis elementum neque fringilla non.",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "Sed gravida commodo felis, at aliquet risus volutpat ut. Nam nec ex eleifend tellus sodales volutpat nec ac nibh. Vestibulum pretium, leo vitae lobortis accumsan, urna libero euismod ante, consequat aliquam enim risus id nisl. Donec sagittis, justo eu luctus posuere, leo purus pellentesque turpis, eget volutpat mi leo vitae lacus. Etiam ante ante, posuere at augue non, lacinia ornare purus. Praesent vitae velit in enim congue maximus. Vivamus tincidunt fringilla neque. Curabitur fermentum justo nec sapien porttitor, ac ullamcorper nisi imperdiet. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed non orci vel eros egestas eleifend sit amet a diam. Duis mattis at ligula quis faucibus. Donec elementum lacus velit, a vehicula nunc gravida a. Phasellus eget nunc vehicula, varius velit a, maximus velit. Sed a suscipit nisi, non hendrerit felis. Proin mattis facilisis massa, quis elementum neque fringilla non.",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    spacing: {
+                        after: 500,
+                    },
+                    children: [
+                        new TextRun({
+                            text: "The first section ends after this paragraph.",
+                        }),
+                    ],
+                }),
+            ],
+        },
+        {
+            headers: {
+                default: new Header({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new TextRun({
+                                    text: "HEADER PAGE TWO AND FOLLOWING PAGES",
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            footers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new TextRun({
+                                    text: "FOOTER PAGE TWO AND FOLLOWING PAGES",
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer ac suscipit orci, in lobortis risus. Nulla vehicula rutrum finibus. Nullam consequat, magna in vehicula commodo, enim massa consectetur nisl, sit amet rutrum nunc ante vel lorem. Sed sit amet scelerisque velit. Proin non quam eget mauris aliquet posuere a sed orci. Proin posuere ante suscipit neque dignissim hendrerit. Pellentesque eget dapibus metus. Donec at mollis mauris. Vestibulum sit amet scelerisque nulla. Vivamus ipsum erat, tempor sed volutpat non, molestie at odio. Vivamus lectus ligula, finibus at mattis vitae, euismod sed tellus. Etiam neque massa, faucibus a fringilla nec, mollis at ex. Aliquam eget nibh tortor. Sed ut viverra libero. Nulla facilisis bibendum quam eget porttitor.",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "Sed eget nunc ac turpis facilisis volutpat. Duis eget arcu vitae neque porta hendrerit. Proin vel ante nulla. Duis congue efficitur dui. Suspendisse potenti. Aliquam aliquam nibh eu ipsum sagittis efficitur. Quisque sagittis metus dui, vitae suscipit tortor sollicitudin at. Suspendisse convallis, sem ac ornare condimentum, odio ipsum dapibus justo, a aliquam risus massa ut enim. Mauris vel placerat nibh. Ut iaculis vitae nibh at elementum. Quisque hendrerit et magna vitae mollis. Duis dictum euismod leo, at cursus risus sodales sed.",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "Sed gravida commodo felis, at aliquet risus volutpat ut. Nam nec ex eleifend tellus sodales volutpat nec ac nibh. Vestibulum pretium, leo vitae lobortis accumsan, urna libero euismod ante, consequat aliquam enim risus id nisl. Donec sagittis, justo eu luctus posuere, leo purus pellentesque turpis, eget volutpat mi leo vitae lacus. Etiam ante ante, posuere at augue non, lacinia ornare purus. Praesent vitae velit in enim congue maximus. Vivamus tincidunt fringilla neque. Curabitur fermentum justo nec sapien porttitor, ac ullamcorper nisi imperdiet. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed non orci vel eros egestas eleifend sit amet a diam. Duis mattis at ligula quis faucibus. Donec elementum lacus velit, a vehicula nunc gravida a. Phasellus eget nunc vehicula, varius velit a, maximus velit. Sed a suscipit nisi, non hendrerit felis. Proin mattis facilisis massa, quis elementum neque fringilla non.",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "Sed gravida commodo felis, at aliquet risus volutpat ut. Nam nec ex eleifend tellus sodales volutpat nec ac nibh. Vestibulum pretium, leo vitae lobortis accumsan, urna libero euismod ante, consequat aliquam enim risus id nisl. Donec sagittis, justo eu luctus posuere, leo purus pellentesque turpis, eget volutpat mi leo vitae lacus. Etiam ante ante, posuere at augue non, lacinia ornare purus. Praesent vitae velit in enim congue maximus. Vivamus tincidunt fringilla neque. Curabitur fermentum justo nec sapien porttitor, ac ullamcorper nisi imperdiet. Orci varius natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Sed non orci vel eros egestas eleifend sit amet a diam. Duis mattis at ligula quis faucibus. Donec elementum lacus velit, a vehicula nunc gravida a. Phasellus eget nunc vehicula, varius velit a, maximus velit. Sed a suscipit nisi, non hendrerit felis. Proin mattis facilisis massa, quis elementum neque fringilla non.",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "The second section starts with the headline above. Move cursor to the end of this text and press enter until next page is generated in continuous section break mode.",
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});