Version bump

Bumps [typescript-eslint](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/typescript-eslint) from 8.16.0 to 8.19.1.
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/typescript-eslint/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v8.19.1/packages/typescript-eslint)

---
updated-dependencies:
- dependency-name: typescript-eslint
  dependency-type: direct:development
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@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"]
+}

.editorconfig

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

.gitattributes

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

.github/ISSUE_TEMPLATE.md

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

.github/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

@@ -0,0 +1,7 @@
+version: 2
+updates:
+- package-ecosystem: npm
+  directory: "/"
+  schedule:
+    interval: daily
+  open-pull-requests-limit: 10

.github/workflows/default.yml

@@ -13,13 +13,10 @@ jobs:
         runs-on: ubuntu-latest
         steps:
             - name: Checkout Repo
-              uses: actions/checkout@master
+              uses: actions/checkout@v4
-            - name: Install Dependencies
+            - uses: "./.github/actions/install-and-build"
-              run: npm ci
-            - name: Build
-              run: npm run build
             - name: Archive Production Artifact
-              uses: actions/upload-artifact@master
+              uses: actions/upload-artifact@v4
               with:
                   name: build
                   path: build
@@ -28,19 +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@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:
@@ -48,57 +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
-    demos:
+    cspell:
-        name: Run Demos
+        name: CSpell
-        needs: [build]
         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
+            - name: CSpell
-              uses: actions/download-artifact@master
+              run: npm run cspell
-              with:
-                  name: build
-                  path: build
-            - name: Run demos
-              run: |
-                  npm run ts-node -- ./demo/1-basic.ts
-                  npm run ts-node -- ./demo/2-declaritive-styles.ts
-                  npm run ts-node -- ./demo/3-numbering-and-bullet-points.ts
-                  npm run ts-node -- ./demo/4-basic-table.ts
-                  npm run ts-node -- ./demo/5-images.ts
-                  npm run ts-node -- ./demo/6-page-borders.ts
-                  npm run ts-node -- ./demo/7-landscape.ts
-                  npm run ts-node -- ./demo/8-header-footer.ts
-                  npm run ts-node -- ./demo/9-images-in-header-and-footer.ts
-                  npm run ts-node -- ./demo/10-my-cv.ts
-                  npm run ts-node -- ./demo/11-declaritive-styles-2.ts
-                  npm run ts-node -- ./demo/12-scaling-images.ts
-                  npm run ts-node -- ./demo/13-xml-styles.ts
-                  npm run ts-node -- ./demo/14-page-numbers.ts
-                  npm run ts-node -- ./demo/15-page-break-before.ts
-                  npm run ts-node -- ./demo/16-multiple-sections.ts
-                  npm run ts-node -- ./demo/17-footnotes.ts
-                  npm run ts-node -- ./demo/18-image-from-buffer.ts
-                  npm run ts-node -- ./demo/19-export-to-base64.ts
-                  npm run ts-node -- ./demo/20-table-cell-borders.ts
-                  npm run ts-node -- ./demo/21-bookmarks.ts
-                  npm run ts-node -- ./demo/22-right-to-left-text.ts
-                  npm run ts-node -- ./demo/23-base64-images.ts
-                  npm run ts-node -- ./demo/24-images-to-table-cell.ts
-                  npm run ts-node -- ./demo/26-paragraph-borders.ts
-                  npm run ts-node -- ./demo/27-declaritive-styles-3.ts
-                  npm run ts-node -- ./demo/28-table-of-contents.ts
-                  npm run ts-node -- ./demo/29-numbered-lists.ts
-                  npm run ts-node -- ./demo/30-template-document.ts
-                  npm run ts-node -- ./demo/31-tables.ts
-                  npm run ts-node -- ./demo/32-merge-and-shade-table-cells.ts
-                  npm run ts-node -- ./demo/33-sequential-captions.ts
-                  npm run ts-node -- ./demo/34-floating-tables.ts

.github/workflows/demos.yml

@@ -0,0 +1,196 @@
+name: Demos
+on:
+    push:
+        branches:
+            - master
+    pull_request:
+        branches:
+            - master
+
+jobs:
+    demos:
+        name: Demos
+        runs-on: ubuntu-latest
+        steps:
+            - 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.
+            # - 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
+            # - 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.
+            # - 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 ).
+            # - 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.
+            # - 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 ).
+            # - 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'.
+            # - 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

@@ -0,0 +1,43 @@
+name: Github Pages
+on:
+    push:
+        branches:
+            - master
+
+jobs:
+    build:
+        name: Build
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout Repo
+              uses: actions/checkout@v4
+            - name: Install Dependencies
+              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@v4
+              with:
+                  name: docs
+                  path: docs
+    deploy:
+        needs: [build]
+        runs-on: ubuntu-latest
+        steps:
+            - name: Checkout Repo 🛎️
+              uses: actions/checkout@v4
+            - name: Install Dependencies
+              run: npm ci --force
+            - name: Download Artifact
+              uses: actions/download-artifact@v4
+              with:
+                  name: docs
+                  path: docs
+            - name: Deploy 🚀
+              uses: JamesIves/github-pages-deploy-action@4.1.5
+              with:
+                  branch: gh-pages
+                  folder: 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}}

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

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

.gitignore

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

.npmignore

@@ -40,4 +40,7 @@ build-tests
 .vscode
 
 # docs
-docs
+docs
+
+# src
+src

.npmrc

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

.nycrc

@@ -1,26 +0,0 @@
-{
-  "check-coverage": true,
-  "lines": 96.81,
-  "functions": 93.80,
-  "branches": 92.63,
-  "statements": 96.80,
-  "include": [
-    "src/**/*.ts"
-  ],
-  "exclude": [
-    "src/**/*.spec.ts",
-    "src/import-dotx/import-dotx.ts"
-  ],
-  "reporter": [
-    "lcov",
-    "text",
-    "json"
-  ],
-  "extension": [
-    ".ts"
-  ],
-  "cache": true,
-  "all": true,
-  "instrument": false,
-  "sourceMap": true
-}

.travis.yml

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

.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": [
+    "tasks": []
-        {
-            "type": "typescript",
-            "tsconfig": "tsconfig.json",
-            "option": "watch",
-            "problemMatcher": [
-                "$tsc-watch"
-            ]
-        },
-        {
-            "type": "npm",
-            "script": "ts-node",
-            "problemMatcher": [],
-            "group": {
-                "kind": "build",
-                "isDefault": true
-            }
-        }
-    ]
 }

README.md

@@ -1,25 +1,22 @@
 <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>
 
 ---
 
 [![NPM version][npm-image]][npm-url]
 [![Downloads per month][downloads-image]][downloads-url]
-[![Build Status][travis-image]][travis-url]
 [![GitHub Action Workflow Status][github-actions-workflow-image]][github-actions-workflow-url]
-[![Dependency Status][daviddm-image]][daviddm-url]
 [![Known Vulnerabilities][snky-image]][snky-url]
-[![Chat on Gitter][gitter-image]][gitter-url]
 [![PRs Welcome][pr-image]][pr-url]
 [![codecov][codecov-image]][codecov-url]
 
 <p align="center">
-    <img src="https://i.imgur.com/TCH0YzD.png" alt="drawing" width="800"/>
+    <img src="https://i.imgur.com/QeL1HuU.png" alt="drawing"/>
 </p>
 
 # Demo
@@ -28,21 +25,22 @@
 
 Here are examples of `docx` being used with basic `HTML/JS` in a browser environment:
 
-*   https://codepen.io/dolanmiu/pen/RwNeObg
+-   https://codepen.io/dolanmiu/pen/RwNeObg
-*   https://jsfiddle.net/dolanmiu/kqxrj35u/1/
+-   https://jsfiddle.net/dolanmiu/onadx1gu/
 
-Here is an example of `docx` working in `Angular`:
+Here are examples of `docx` working in `Angular`:
 
-*   https://stackblitz.com/edit/angular-afvxtz
+-   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-ts-qq25sp
+-   https://stackblitz.com/edit/react-docx
-*   https://stackblitz.com/edit/react-ts-qdqu7z (adding images to Word Document)
+-   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
 
@@ -50,15 +48,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-demo1 - Simple paragraph and text
-*   https://runkit.com/dolanmiu/docx-demo2 - Advanced Paragraphs 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-demo3 - Bullet points
-*   https://runkit.com/dolanmiu/docx-demo4 - Simple table
+-   https://runkit.com/dolanmiu/docx-demo4 - Simple table
-*   https://runkit.com/dolanmiu/docx-demo5 - Images
+-   https://runkit.com/dolanmiu/docx-demo5 - Images
-*   https://runkit.com/dolanmiu/docx-demo6 - Margins
+-   https://runkit.com/dolanmiu/docx-demo6 - Margins
-*   https://runkit.com/dolanmiu/docx-demo7 - Landscape
+-   https://runkit.com/dolanmiu/docx-demo7 - Landscape
-*   https://runkit.com/dolanmiu/docx-demo8 - Header and Footer
+-   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-demo10 - **My CV generated with docx**
 
 More [here](https://github.com/dolanmiu/docx/tree/master/demo)
 
@@ -84,10 +82,13 @@ Read the contribution guidelines [here](https://docx.js.org/#/contribution-guide
 [<img src="https://i.imgur.com/1LjuK2M.png" alt="drawing" height="50"/>](https://turbopatent.com/)
 [<img src="https://i.imgur.com/dHMg0wF.gif" alt="drawing" height="50"/>](http://www.madisoncres.com/)
 [<img src="https://i.imgur.com/QEZXU5b.png" alt="drawing" height="50"/>](https://www.beekast.com/)
-[<img src="https://imgur.com/XVU6aoi.png" alt="drawing" height="50"/>](https://herraizsoto.com/)
+[<img src="https://i.imgur.com/XVU6aoi.png" alt="drawing" height="50"/>](https://herraizsoto.com/)
 [<img src="https://i.imgur.com/fn1xccG.png" alt="drawing" height="50"/>](http://www.ativer.com.br/)
 [<img src="https://i.imgur.com/cmykN7c.png" alt="drawing"/>](https://www.arity.co/)
-
+[<img src="https://i.imgur.com/PXo25um.png" alt="drawing" height="50"/>](https://www.circadianrisk.com/)
+[<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!
 
@@ -102,16 +103,10 @@ Made with 💖
 [npm-url]: https://npmjs.org/package/docx
 [downloads-image]: https://img.shields.io/npm/dm/docx.svg
 [downloads-url]: https://npmjs.org/package/docx
-[travis-image]: https://travis-ci.org/dolanmiu/docx.svg?branch=master
-[travis-url]: https://travis-ci.org/dolanmiu/docx
 [github-actions-workflow-image]: https://github.com/dolanmiu/docx/workflows/Default/badge.svg
 [github-actions-workflow-url]: https://github.com/dolanmiu/docx/actions
-[daviddm-image]: https://david-dm.org/dolanmiu/docx.svg?theme=shields.io
-[daviddm-url]: https://david-dm.org/dolanmiu/docx
 [snky-image]: https://snyk.io/test/github/dolanmiu/docx/badge.svg
 [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

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,26 +1,29 @@
 // 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();
+const doc = new Document({
-
+    sections: [
-doc.addSection({
+        {
-    properties: {},
+            properties: {},
-    children: [
-        new Paragraph({
             children: [
-                new TextRun("Hello World"),
+                new Paragraph({
-                new TextRun({
+                    children: [
-                    text: "Foo Bar",
+                        new TextRun("Hello World"),
-                    bold: true,
+                        new TextRun({
-                }),
+                            text: "Foo Bar",
-                new TextRun({
+                            bold: true,
-                    text: "\tGithub is the best",
+                            size: 40,
-                    bold: true,
+                        }),
+                        new TextRun({
+                            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
 
@@ -9,7 +9,46 @@ const PHONE_NUMBER = "07534563401";
 const PROFILE_URL = "https://www.linkedin.com/in/dolan1";
 const EMAIL = "docx@com";
 
-const experiences = [
+interface Experience {
+    readonly isCurrent: boolean;
+    readonly summary: string;
+    readonly title: string;
+    readonly startDate: {
+        readonly month: number;
+        readonly year: number;
+    };
+    readonly endDate?: {
+        readonly month: number;
+        readonly year: number;
+    };
+    readonly company: {
+        readonly name: string;
+    };
+}
+
+interface Education {
+    readonly degree: string;
+    readonly fieldOfStudy: string;
+    readonly notes: string;
+    readonly schoolName: string;
+    readonly startDate: {
+        readonly year: number;
+    };
+    readonly endDate: {
+        readonly year: number;
+    };
+}
+
+interface Skill {
+    readonly name: string;
+}
+
+interface Achievement {
+    readonly issuer: string;
+    readonly name: string;
+}
+
+const experiences: Experience[] = [
     {
         isCurrent: true,
         summary: "Full-stack developer working with Angular and Java. Working for the iShares platform",
@@ -25,7 +64,7 @@ const experiences = [
     {
         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,
@@ -59,6 +98,7 @@ const experiences = [
     {
         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: {
@@ -75,12 +115,11 @@ const experiences = [
     },
 ];
 
-const education = [
+const education: Education[] = [
     {
         degree: "Master of Science (MSc)",
         fieldOfStudy: "Computer Science",
-        notes:
+        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.",
-            "Exam Results: 1st Class with Distinction, Dissertation: 1st Class with Distinction\n\nRelevant Courses: Java and C# Programming, Software Engineering, Artificial Intelligence, \nComputational Photography, Algorithmics, Architecture and Hardware.\n\nCreated a Windows 8 game in JavaScript for the dissertation. \n\nCreated an award-winning 3D stereoscopic game in C# using XNA.",
         schoolName: "University College London",
         startDate: {
             year: 2012,
@@ -92,8 +131,7 @@ const education = [
     {
         degree: "Bachelor of Engineering (BEng)",
         fieldOfStudy: "Material Science and Engineering",
-        notes:
+        notes: "Exam Results: 2:1, Dissertation: 1st Class with Distinction\n\nRelevant courses: C Programming, Mathematics and Business for Engineers.",
-            "Exam Results: 2:1, Dissertation: 1st Class with Distinction\n\nRelevant courses: C Programming, Mathematics and Business for Engineers.",
         schoolName: "Imperial College London",
         startDate: {
             year: 2009,
@@ -104,7 +142,7 @@ const education = [
     },
 ];
 
-const skills = [
+const skills: Skill[] = [
     {
         name: "Angular",
     },
@@ -119,7 +157,7 @@ const skills = [
     },
 ];
 
-const achievements = [
+const achievements: Achievement[] = [
     {
         issuer: "Oracle",
         name: "Oracle Certified Expert",
@@ -128,71 +166,76 @@ const achievements = [
 
 class DocumentCreator {
     // tslint:disable-next-line: typedef
-    public create([experiences, educations, skills, achivements]): Document {
+    public create([experiences, educations, skills, achievements]: [Experience[], Education[], Skill[], Achievement[]]): Document {
-        const document = new Document();
+        const document = new Document({
+            sections: [
+                {
+                    children: [
+                        new Paragraph({
+                            text: "Dolan Miu",
+                            heading: HeadingLevel.TITLE,
+                        }),
+                        this.createContactInfo(PHONE_NUMBER, PROFILE_URL, EMAIL),
+                        this.createHeading("Education"),
+                        ...educations
+                            .map((education) => {
+                                const arr: Paragraph[] = [];
+                                arr.push(
+                                    this.createInstitutionHeader(
+                                        education.schoolName,
+                                        `${education.startDate.year} - ${education.endDate.year}`,
+                                    ),
+                                );
+                                arr.push(this.createRoleText(`${education.fieldOfStudy} - ${education.degree}`));
 
-        document.addSection({
+                                const bulletPoints = this.splitParagraphIntoBullets(education.notes);
-            children: [
+                                bulletPoints.forEach((bulletPoint) => {
-                new Paragraph({
+                                    arr.push(this.createBullet(bulletPoint));
-                    text: "Dolan Miu",
+                                });
-                    heading: HeadingLevel.TITLE,
-                }),
-                this.createContactInfo(PHONE_NUMBER, PROFILE_URL, EMAIL),
-                this.createHeading("Education"),
-                ...educations
-                    .map((education) => {
-                        const arr: Paragraph[] = [];
-                        arr.push(
-                            this.createInstitutionHeader(education.schoolName, `${education.startDate.year} - ${education.endDate.year}`),
-                        );
-                        arr.push(this.createRoleText(`${education.fieldOfStudy} - ${education.degree}`));
 
-                        const bulletPoints = this.splitParagraphIntoBullets(education.notes);
+                                return arr;
-                        bulletPoints.forEach((bulletPoint) => {
+                            })
-                            arr.push(this.createBullet(bulletPoint));
+                            .reduce((prev, curr) => prev.concat(curr), []),
-                        });
+                        this.createHeading("Experience"),
+                        ...experiences
+                            .map((position) => {
+                                const arr: Paragraph[] = [];
 
-                        return arr;
+                                arr.push(
-                    })
+                                    this.createInstitutionHeader(
-                    .reduce((prev, curr) => prev.concat(curr), []),
+                                        position.company.name,
-                this.createHeading("Experience"),
+                                        this.createPositionDateText(position.startDate, position.endDate, position.isCurrent),
-                ...experiences
+                                    ),
-                    .map((position) => {
+                                );
-                        const arr: Paragraph[] = [];
+                                arr.push(this.createRoleText(position.title));
 
-                        arr.push(
+                                const bulletPoints = this.splitParagraphIntoBullets(position.summary);
-                            this.createInstitutionHeader(
-                                position.company.name,
-                                this.createPositionDateText(position.startDate, position.endDate, position.isCurrent),
-                            ),
-                        );
-                        arr.push(this.createRoleText(position.title));
 
-                        const bulletPoints = this.splitParagraphIntoBullets(position.summary);
+                                bulletPoints.forEach((bulletPoint) => {
+                                    arr.push(this.createBullet(bulletPoint));
+                                });
 
-                        bulletPoints.forEach((bulletPoint) => {
+                                return arr;
-                            arr.push(this.createBullet(bulletPoint));
+                            })
-                        });
+                            .reduce((prev, curr) => prev.concat(curr), []),
-
+                        this.createHeading("Skills, Achievements and Interests"),
-                        return arr;
+                        this.createSubHeading("Skills"),
-                    })
+                        this.createSkillList(skills),
-                    .reduce((prev, curr) => prev.concat(curr), []),
+                        this.createSubHeading("Achievements"),
-                this.createHeading("Skills, Achievements and Interests"),
+                        ...this.createAchievementsList(achievements),
-                this.createSubHeading("Skills"),
+                        this.createSubHeading("Interests"),
-                this.createSkillList(skills),
+                        this.createInterests("Programming, Technology, Music Production, Web Design, 3D Modelling, Dancing."),
-                this.createSubHeading("Achievements"),
+                        this.createHeading("References"),
-                ...this.createAchivementsList(achivements),
+                        new Paragraph(
-                this.createSubHeading("Interests"),
+                            "Dr. Dean Mohamedally Director of Postgraduate Studies Department of Computer Science, University College London Malet Place, Bloomsbury, London WC1E d.mohamedally@ucl.ac.uk",
-                this.createInterests("Programming, Technology, Music Production, Web Design, 3D Modelling, Dancing."),
+                        ),
-                this.createHeading("References"),
+                        new Paragraph("More references upon request"),
-                new Paragraph(
+                        new Paragraph({
-                    "Dr. Dean Mohamedally Director of Postgraduate Studies Department of Computer Science, University College London Malet Place, Bloomsbury, London WC1E d.mohamedally@ucl.ac.uk",
+                            text: "This CV was generated in real-time based on my Linked-In profile from my personal website www.dolan.bio.",
-                ),
+                            alignment: AlignmentType.CENTER,
-                new Paragraph("More references upon request"),
+                        }),
-                new Paragraph({
+                    ],
-                    text: "This CV was generated in real-time based on my Linked-In profile from my personal website www.dolan.bio.",
+                },
-                    alignment: AlignmentType.CENTER,
-                }),
             ],
         });
 
@@ -204,7 +247,10 @@ class DocumentCreator {
             alignment: AlignmentType.CENTER,
             children: [
                 new TextRun(`Mobile: ${phoneNumber} | LinkedIn: ${profileUrl} | Email: ${email}`),
-                new TextRun("Address: 58 Elm Avenue, Kent ME4 6ER, UK").break(),
+                new TextRun({
+                    text: "Address: 58 Elm Avenue, Kent ME4 6ER, UK",
+                    break: 1,
+                }),
             ],
         });
     }
@@ -238,7 +284,7 @@ class DocumentCreator {
                     bold: true,
                 }),
                 new TextRun({
-                    text: `\t${dateText}`,
+                    children: [new Tab(), dateText],
                     bold: true,
                 }),
             ],
@@ -273,8 +319,8 @@ class DocumentCreator {
     }
 
     // tslint:disable-next-line:no-any
-    public createAchivementsList(achivements: any[]): Paragraph[] {
+    public createAchievementsList(achievements: any[]): Paragraph[] {
-        return achivements.map(
+        return achievements.map(
             (achievement) =>
                 new Paragraph({
                     text: achievement.name,

demo/11-declaritive-styles-2.ts

@@ -1,12 +1,13 @@
 // Setting styles with JavaScript configuration
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
 import {
     AlignmentType,
+    convertInchesToTwip,
     Document,
     Footer,
     HeadingLevel,
-    Media,
+    ImageRun,
     Packer,
     Paragraph,
     Table,
@@ -14,9 +15,58 @@ import {
     TableRow,
     TabStopPosition,
     UnderlineType,
-} from "../build";
+    LevelFormat,
+} from "docx";
+
+const table = new Table({
+    rows: [
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("Test cell 1.")],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("Test cell 2.")],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("Test cell 3.")],
+                }),
+            ],
+        }),
+        new TableRow({
+            children: [
+                new TableCell({
+                    children: [new Paragraph("Test cell 4.")],
+                }),
+            ],
+        }),
+    ],
+});
 
 const doc = new Document({
+    numbering: {
+        config: [
+            {
+                reference: "ref1",
+                levels: [
+                    {
+                        level: 0,
+                        format: LevelFormat.DECIMAL,
+                        text: "%1)",
+                        start: 50,
+                    },
+                ],
+            },
+        ],
+    },
     styles: {
         default: {
             heading1: {
@@ -110,7 +160,7 @@ const doc = new Document({
                 },
                 paragraph: {
                     spacing: { line: 276 },
-                    indent: { left: 720 },
+                    indent: { left: convertInchesToTwip(0.5) },
                 },
             },
             {
@@ -121,116 +171,143 @@ const doc = new Document({
                     spacing: { line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 },
                 },
             },
+            {
+                id: "numberedPara",
+                name: "Numbered Para",
+                basedOn: "Normal",
+                next: "Normal",
+                quickFormat: true,
+                run: {
+                    font: "Calibri",
+                    size: 26,
+                    bold: true,
+                },
+                paragraph: {
+                    spacing: { line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 },
+                    rightTabStop: TabStopPosition.MAX,
+                    leftTabStop: 453.543307087,
+                    numbering: {
+                        reference: "ref1",
+                        instance: 0,
+                        level: 0,
+                    },
+                },
+            },
         ],
     },
-});
+    sections: [
-
+        {
-const image = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
+            properties: {
-
+                page: {
-const table = new Table({
+                    margin: {
-    rows: [
+                        top: 700,
-        new TableRow({
+                        right: 700,
-            children: [
+                        bottom: 700,
-                new TableCell({
+                        left: 700,
-                    children: [new Paragraph("Test cell 1.")],
+                    },
+                },
+            },
+            footers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            text: "1",
+                            style: "normalPara",
+                            alignment: AlignmentType.RIGHT,
+                        }),
+                    ],
                 }),
-            ],
+            },
-        }),
-        new TableRow({
-            children: [
-                new TableCell({
-                    children: [new Paragraph("Test cell 2.")],
-                }),
-            ],
-        }),
-        new TableRow({
-            children: [
-                new TableCell({
-                    children: [new Paragraph("Test cell 3.")],
-                }),
-            ],
-        }),
-        new TableRow({
-            children: [
-                new TableCell({
-                    children: [new Paragraph("Test cell 4.")],
-                }),
-            ],
-        }),
-    ],
-});
-
-const image1 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
-const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
-
-doc.addSection({
-    properties: {
-        top: 700,
-        right: 700,
-        bottom: 700,
-        left: 700,
-    },
-    footers: {
-        default: new Footer({
             children: [
                 new Paragraph({
-                    text: "1",
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    text: "HEADING",
+                    heading: HeadingLevel.HEADING_1,
+                    alignment: AlignmentType.CENTER,
+                }),
+                new Paragraph({
+                    text: "Ref. :",
                     style: "normalPara",
-                    alignment: AlignmentType.RIGHT,
+                }),
+                new Paragraph({
+                    text: "Date :",
+                    style: "normalPara",
+                }),
+                new Paragraph({
+                    text: "To,",
+                    style: "normalPara",
+                }),
+                new Paragraph({
+                    text: "The Superindenting Engineer,(O &M)",
+                    style: "normalPara",
+                }),
+                new Paragraph({
+                    text: "Sub : ",
+                    style: "normalPara",
+                }),
+                new Paragraph({
+                    text: "Ref. : ",
+                    style: "normalPara",
+                }),
+                new Paragraph({
+                    text: "Sir,",
+                    style: "normalPara",
+                }),
+                new Paragraph({
+                    text: "BRIEF DESCRIPTION",
+                    style: "normalPara",
+                }),
+                table,
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    text: "Test",
+                    style: "normalPara2",
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    text: "Test 2",
+                    style: "normalPara2",
+                }),
+                new Paragraph({
+                    text: "Numbered paragraph that has numbering attached to custom styles",
+                    style: "numberedPara",
+                }),
+                new Paragraph({
+                    text: "Numbered para would show up in the styles pane at Word",
+                    style: "numberedPara",
                 }),
             ],
-        }),
+        },
-    },
-    children: [
-        new Paragraph(image),
-        new Paragraph({
-            text: "HEADING",
-            heading: HeadingLevel.HEADING_1,
-            alignment: AlignmentType.CENTER,
-        }),
-        new Paragraph({
-            text: "Ref. :",
-            style: "normalPara",
-        }),
-        new Paragraph({
-            text: "Date :",
-            style: "normalPara",
-        }),
-        new Paragraph({
-            text: "To,",
-            style: "normalPara",
-        }),
-        new Paragraph({
-            text: "The Superindenting Engineer,(O &M)",
-            style: "normalPara",
-        }),
-        new Paragraph({
-            text: "Sub : ",
-            style: "normalPara",
-        }),
-        new Paragraph({
-            text: "Ref. : ",
-            style: "normalPara",
-        }),
-        new Paragraph({
-            text: "Sir,",
-            style: "normalPara",
-        }),
-        new Paragraph({
-            text: "BRIEF DESCRIPTION",
-            style: "normalPara",
-        }),
-        table,
-        new Paragraph(image1),
-        new Paragraph({
-            text: "Test",
-            style: "normalPara2",
-        }),
-        new Paragraph(image2),
-        new Paragraph({
-            text: "Test 2",
-            style: "normalPara2",
-        }),
     ],
 });
 

demo/12-scaling-images.ts

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

demo/13-xml-styles.ts

@@ -1,29 +1,30 @@
 // 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({
     title: "Title",
     externalStyles: styles,
-});
+    sections: [
-
+        {
-doc.addSection({
+            children: [
-    children: [
+                new Paragraph({
-        new Paragraph({
+                    text: "Cool Heading Text",
-            text: "Cool Heading Text",
+                    heading: HeadingLevel.HEADING_1,
-            heading: HeadingLevel.HEADING_1,
+                }),
-        }),
+                new Paragraph({
-        new Paragraph({
+                    text: 'This is a custom named style from the template "MyFancyStyle"',
-            text: 'This is a custom named style from the template "MyFancyStyle"',
+                    style: "MyFancyStyle",
-            style: "MyFancyStyle",
+                }),
-        }),
+                new Paragraph("Some normal text"),
-        new Paragraph("Some normal text"),
+                new Paragraph({
-        new Paragraph({
+                    text: "MyFancyStyle again",
-            text: "MyFancyStyle again",
+                    style: "MyFancyStyle",
-            style: "MyFancyStyle",
+                }),
-        }),
+            ],
+        },
     ],
 });
 

demo/14-page-numbers.ts

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

demo/15-page-break-before.ts

@@ -1,17 +1,19 @@
 // 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();
+const doc = new Document({
-
+    sections: [
-doc.addSection({
+        {
-    children: [
+            children: [
-        new Paragraph("Hello World"),
+                new Paragraph("Hello World"),
-        new Paragraph({
+                new Paragraph({
-            text: "Hello World on another page",
+                    text: "Hello World on another page",
-            pageBreakBefore: true,
+                    pageBreakBefore: true,
-        }),
+                }),
+            ],
+        },
     ],
 });
 

demo/16-multiple-sections.ts

@@ -1,121 +1,144 @@
 // Multiple sections and headers
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, Footer, Header, Packer, PageNumber, PageNumberFormat, PageOrientation, Paragraph, TextRun } from "../build";
+import { Document, Footer, Header, Packer, PageNumber, NumberFormat, PageOrientation, Paragraph, TextRun } from "docx";
 
-const doc = new Document();
+const doc = new Document({
+    sections: [
+        {
+            children: [new Paragraph("Hello World")],
+        },
+        {
+            properties: {
+                page: {
+                    pageNumbers: {
+                        start: 1,
+                        formatType: NumberFormat.DECIMAL,
+                    },
+                },
+            },
+            headers: {
+                default: new Header({
+                    children: [new Paragraph("First Default Header on another page")],
+                }),
+            },
+            footers: {
+                default: new Footer({
+                    children: [new Paragraph("Footer on another page")],
+                }),
+            },
 
-doc.addSection({
+            children: [new Paragraph("hello")],
-    children: [new Paragraph("Hello World")],
+        },
-});
+        {
-
+            properties: {
-doc.addSection({
+                page: {
-    headers: {
+                    size: {
-        default: new Header({
+                        orientation: PageOrientation.LANDSCAPE,
-            children: [new Paragraph("First Default Header on another page")],
+                    },
-        }),
+                    pageNumbers: {
-    },
+                        start: 1,
-    footers: {
+                        formatType: NumberFormat.DECIMAL,
-        default: new Footer({
+                    },
-            children: [new Paragraph("Footer on another page")],
+                },
-        }),
+            },
-    },
+            headers: {
-    properties: {
+                default: new Header({
-        pageNumberStart: 1,
+                    children: [new Paragraph("Second Default Header on another page")],
-        pageNumberFormatType: PageNumberFormat.DECIMAL,
+                }),
-    },
+            },
-    children: [new Paragraph("hello")],
+            footers: {
-});
+                default: new Footer({
-
+                    children: [new Paragraph("Footer on another page")],
-doc.addSection({
+                }),
-    headers: {
+            },
-        default: new Header({
+            children: [new Paragraph("hello in landscape")],
-            children: [new Paragraph("Second Default Header on another page")],
+        },
-        }),
+        {
-    },
+            properties: {
-    footers: {
+                page: {
-        default: new Footer({
+                    size: {
-            children: [new Paragraph("Footer on another page")],
+                        orientation: PageOrientation.PORTRAIT,
-        }),
+                    },
-    },
+                },
-    size: {
+            },
-        orientation: PageOrientation.LANDSCAPE,
+            headers: {
-    },
+                default: new Header({
-    properties: {
-        pageNumberStart: 1,
-        pageNumberFormatType: PageNumberFormat.DECIMAL,
-    },
-    children: [new Paragraph("hello in landscape")],
-});
-
-doc.addSection({
-    headers: {
-        default: new Header({
-            children: [
-                new Paragraph({
                     children: [
-                        new TextRun({
+                        new Paragraph({
-                            children: ["Page number: ", PageNumber.CURRENT],
+                            children: [
+                                new TextRun({
+                                    children: ["Page number: ", PageNumber.CURRENT],
+                                }),
+                            ],
                         }),
                     ],
                 }),
-            ],
+            },
-        }),
-    },
-    size: {
-        orientation: PageOrientation.PORTRAIT,
-    },
-    children: [new Paragraph("Page number in the header must be 2, because it continues from the previous section.")],
-});
 
-doc.addSection({
+            children: [new Paragraph("Page number in the header must be 2, because it continues from the previous section.")],
-    headers: {
+        },
-        default: new Header({
+        {
-            children: [
+            properties: {
-                new Paragraph({
+                page: {
+                    size: {
+                        orientation: PageOrientation.PORTRAIT,
+                    },
+                    pageNumbers: {
+                        formatType: NumberFormat.UPPER_ROMAN,
+                    },
+                },
+            },
+            headers: {
+                default: new Header({
                     children: [
-                        new TextRun({
+                        new Paragraph({
-                            children: ["Page number: ", PageNumber.CURRENT],
+                            children: [
+                                new TextRun({
+                                    children: ["Page number: ", PageNumber.CURRENT],
+                                }),
+                            ],
                         }),
                     ],
                 }),
-            ],
+            },
-        }),
-    },
-    properties: {
-        pageNumberFormatType: PageNumberFormat.UPPER_ROMAN,
-        orientation: PageOrientation.PORTRAIT,
-    },
-    children: [
-        new Paragraph(
-            "Page number in the header must be III, because it continues from the previous section, but is defined as upper roman.",
-        ),
-    ],
-});
-
-doc.addSection({
-    headers: {
-        default: new Header({
             children: [
-                new Paragraph({
+                new Paragraph(
+                    "Page number in the header must be III, because it continues from the previous section, but is defined as upper roman.",
+                ),
+            ],
+        },
+        {
+            properties: {
+                page: {
+                    size: {
+                        orientation: PageOrientation.PORTRAIT,
+                    },
+                    pageNumbers: {
+                        start: 25,
+                        formatType: NumberFormat.DECIMAL,
+                    },
+                },
+            },
+            headers: {
+                default: new Header({
                     children: [
-                        new TextRun({
+                        new Paragraph({
-                            children: ["Page number: ", PageNumber.CURRENT],
+                            children: [
+                                new TextRun({
+                                    children: ["Page number: ", PageNumber.CURRENT],
+                                }),
+                            ],
                         }),
                     ],
                 }),
+            },
+            children: [
+                new Paragraph(
+                    "Page number in the header must be 25, because it is defined to start at 25 and to be decimal in this section.",
+                ),
             ],
-        }),
+        },
-    },
-    size: {
-        orientation: PageOrientation.PORTRAIT,
-    },
-    properties: {
-        pageNumberFormatType: PageNumberFormat.DECIMAL,
-        pageNumberStart: 25,
-    },
-    children: [
-        new Paragraph("Page number in the header must be 25, because it is defined to start at 25 and to be decimal in this section."),
     ],
 });
 

demo/17-footnotes.ts

@@ -1,52 +1,59 @@
 // 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: [
+    footnotes: {
-        new Paragraph("Foo"),
+        1: { children: [new Paragraph("Foo"), new Paragraph("Bar")] },
-        new Paragraph("Test"),
+        2: { children: [new Paragraph("Test")] },
-        new Paragraph("My amazing reference"),
+        3: { children: [new Paragraph("My amazing reference")] },
-        new Paragraph("Foo1"),
+        4: { children: [new Paragraph("Foo1")] },
-        new Paragraph("Test1"),
+        5: { children: [new Paragraph("Test1")] },
-        new Paragraph("My amazing reference1"),
+        6: { children: [new Paragraph("My amazing reference1")] },
-    ],
+    },
-});
+    sections: [
-
+        {
-doc.addSection({
-    children: [
-        new Paragraph({
             children: [
-                new TextRun({
+                new Paragraph({
-                    children: ["Hello", new FootnoteReferenceRun(1)],
+                    children: [
+                        new TextRun({
+                            children: ["Hello"],
+                        }),
+                        new FootnoteReferenceRun(1),
+                        new TextRun({
+                            children: [" World!"],
+                        }),
+                        new FootnoteReferenceRun(2),
+                        new TextRun({
+                            children: [" GitHub!"],
+                        }),
+                    ],
                 }),
-                new TextRun({
+                new Paragraph({
-                    children: [" World!", new FootnoteReferenceRun(2)],
+                    children: [new TextRun("Hello World"), new FootnoteReferenceRun(3)],
                 }),
             ],
-        }),
+        },
-        new Paragraph({
+        {
-            children: [new TextRun("Hello World"), new FootnoteReferenceRun(3)],
-        }),
-    ],
-});
-
-doc.addSection({
-    children: [
-        new Paragraph({
             children: [
-                new TextRun({
+                new Paragraph({
-                    children: ["Hello", new FootnoteReferenceRun(4)],
+                    children: [
+                        new TextRun({
+                            children: ["Hello"],
+                        }),
+                        new FootnoteReferenceRun(4),
+                        new TextRun({
+                            children: [" World!"],
+                        }),
+                        new FootnoteReferenceRun(5),
+                    ],
                 }),
-                new TextRun({
+                new Paragraph({
-                    children: [" World!", new FootnoteReferenceRun(5)],
+                    children: [new TextRun("Hello World Again"), new FootnoteReferenceRun(6)],
                 }),
             ],
-        }),
+        },
-        new Paragraph({
-            children: [new TextRun("Hello World"), new FootnoteReferenceRun(6)],
-        }),
     ],
 });
 

demo/18-image-from-buffer.ts

@@ -1,19 +1,27 @@
 // Insert image from a buffer
-// Import from 'docx' rather than '../build' if you install from npm
-import * as fs from "fs";
-import { Document, Media, Packer, Paragraph } from "../build";
 
-const doc = new Document();
+import * as fs from "fs";
+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`;
 
-const image = Media.addImage(doc, Buffer.from(imageBase64Data, "base64"), 100, 100);
+const doc = new Document({
-
+    sections: [
-doc.addSection({
+        {
-    children: [
+            children: [
-        new Paragraph({
+                new Paragraph({
-            children: [image],
+                    children: [
-        }),
+                        new ImageRun({
+                            data: Buffer.from(imageBase64Data, "base64"),
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                        }),
+                    ],
+                }),
+            ],
+        },
     ],
 });
 

demo/19-export-to-base64.ts

@@ -1,25 +1,27 @@
 // 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();
+const doc = new Document({
-
+    sections: [
-doc.addSection({
+        {
-    children: [
-        new Paragraph({
             children: [
-                new TextRun("Hello World"),
+                new Paragraph({
-                new TextRun({
+                    children: [
-                    text: "Foo",
+                        new TextRun("Hello World"),
-                    bold: true,
+                        new TextRun({
-                }),
+                            text: "Foo",
-                new TextRun({
+                            bold: true,
-                    text: "\tBar",
+                        }),
-                    bold: true,
+                        new TextRun({
+                            children: [new Tab(), "Bar"],
+                            bold: true,
+                        }),
+                    ],
                 }),
             ],
-        }),
+        },
     ],
 });
 

demo/2-declaritive-styles.ts

@@ -1,7 +1,7 @@
-// Example on how to customise the look at feel using Styles
+// Example on how to customize the look at feel using Styles
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { AlignmentType, Document, HeadingLevel, Packer, Paragraph, TextRun, UnderlineType } from "../build";
+import { AlignmentType, convertInchesToTwip, Document, HeadingLevel, LevelFormat, Packer, Paragraph, TextRun, UnderlineType } from "docx";
 
 const doc = new Document({
     creator: "Clippy",
@@ -14,7 +14,7 @@ const doc = new Document({
                     size: 28,
                     bold: true,
                     italics: true,
-                    color: "red",
+                    color: "FF0000",
                 },
                 paragraph: {
                     spacing: {
@@ -40,9 +40,18 @@ const doc = new Document({
             },
             listParagraph: {
                 run: {
-                    color: '#FF0000'
+                    color: "#FF0000",
-                }
+                },
-            }
+            },
+            document: {
+                run: {
+                    size: "11pt",
+                    font: "Calibri",
+                },
+                paragraph: {
+                    alignment: AlignmentType.RIGHT,
+                },
+            },
         },
         paragraphStyles: [
             {
@@ -56,7 +65,7 @@ const doc = new Document({
                 },
                 paragraph: {
                     indent: {
-                        left: 720,
+                        left: convertInchesToTwip(0.5),
                     },
                     spacing: {
                         line: 276,
@@ -72,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: {
@@ -81,7 +116,7 @@ const doc = new Document({
                 levels: [
                     {
                         level: 0,
-                        format: "lowerLetter",
+                        format: LevelFormat.LOWER_LETTER,
                         text: "%1)",
                         alignment: AlignmentType.LEFT,
                     },
@@ -89,78 +124,142 @@ const doc = new Document({
             },
         ],
     },
-});
+    sections: [
-
+        {
-doc.addSection({
-    children: [
-        new Paragraph({
-            text: "Test heading1, bold and italicized",
-            heading: HeadingLevel.HEADING_1,
-        }),
-        new Paragraph("Some simple content"),
-        new Paragraph({
-            text: "Test heading2 with double red underline",
-            heading: HeadingLevel.HEADING_2,
-        }),
-        new Paragraph({
-            text: "Option1",
-            numbering: {
-                reference: "my-crazy-numbering",
-                level: 0,
-            },
-        }),
-        new Paragraph({
-            text: "Option5 -- override 2 to 5",
-            numbering: {
-                reference: "my-crazy-numbering",
-                level: 0,
-            },
-        }),
-        new Paragraph({
-            text: "Option3",
-            numbering: {
-                reference: "my-crazy-numbering",
-                level: 0,
-            },
-        }),
-        new Paragraph({
             children: [
-                new TextRun({
+                new Paragraph({
-                    text: "Some monospaced content",
+                    text: "Test heading1, bold and italicized",
-                    font: {
+                    heading: HeadingLevel.HEADING_1,
-                        name: "Monospace",
+                }),
+                new Paragraph("Some simple content"),
+                new Paragraph({
+                    text: "Test heading2 with double red underline",
+                    heading: HeadingLevel.HEADING_2,
+                }),
+                new Paragraph({
+                    text: "Option1",
+                    numbering: {
+                        reference: "my-crazy-numbering",
+                        level: 0,
+                    },
+                    style: "aside",
+                }),
+                new Paragraph({
+                    text: "Option5 -- override 2 to 5",
+                    numbering: {
+                        reference: "my-crazy-numbering",
+                        level: 0,
                     },
                 }),
-            ],
+                new Paragraph({
-        }),
+                    text: "Option3",
-        new Paragraph({
+                    numbering: {
-            text: "An aside, in light gray italics and indented",
+                        reference: "my-crazy-numbering",
-            style: "aside",
+                        level: 0,
-        }),
+                    },
-        new Paragraph({
-            text: "This is normal, but well-spaced text",
-            style: "wellSpaced",
-        }),
-        new Paragraph({
-            children: [
-                new TextRun({
-                    text: "This is a bold run,",
-                    bold: true,
                 }),
-                new TextRun(" switching to normal "),
+                new Paragraph({
-                new TextRun({
+                    children: [
-                    text: "and then underlined ",
+                        new TextRun({
-                    underline: {},
+                            text: "Some monospaced content",
+                            font: {
+                                name: "Monospace",
+                            },
+                        }),
+                    ],
                 }),
-                new TextRun({
+                new Paragraph({
-                    text: "and then emphasis-mark ",
+                    text: "An aside, in light gray italics and indented",
-                    emphasisMark: {},
+                    style: "aside",
                 }),
-                new TextRun({
+                new Paragraph({
-                    text: "and back to normal.",
+                    text: "This is normal, but well-spaced text",
+                    style: "wellSpaced",
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "This is a bold run,",
+                            bold: true,
+                        }),
+                        new TextRun(" switching to normal "),
+                        new TextRun({
+                            text: "and then underlined ",
+                            underline: {},
+                        }),
+                        new TextRun({
+                            text: "and then emphasis-mark ",
+                            emphasisMark: {},
+                        }),
+                        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({
+                    style: "Strong",
+                    children: [
+                        new TextRun({
+                            text: "Strong Style",
+                        }),
+                        new TextRun({
+                            text: " - Very strong.",
+                        }),
+                    ],
+                }),
+                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,103 +1,107 @@
 // 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();
+const doc = new Document({
-
+    sections: [
-const table = new Table({
+        {
-    rows: [
-        new TableRow({
             children: [
-                new TableCell({
+                new Table({
-                    children: [],
+                    rows: [
-                }),
+                        new TableRow({
-                new TableCell({
+                            children: [
-                    children: [],
+                                new TableCell({
-                }),
+                                    children: [],
-                new TableCell({
+                                }),
-                    children: [],
+                                new TableCell({
-                }),
+                                    children: [],
-                new TableCell({
+                                }),
-                    children: [],
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                            ],
+                        }),
+                        new TableRow({
+                            children: [
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [new Paragraph("Hello")],
+                                    borders: {
+                                        top: {
+                                            style: BorderStyle.DASH_DOT_STROKED,
+                                            size: 3,
+                                            color: "FF0000",
+                                        },
+                                        bottom: {
+                                            style: BorderStyle.DOUBLE,
+                                            size: 3,
+                                            color: "0000FF",
+                                        },
+                                        left: {
+                                            style: BorderStyle.DASH_DOT_STROKED,
+                                            size: 3,
+                                            color: "00FF00",
+                                        },
+                                        right: {
+                                            style: BorderStyle.DASH_DOT_STROKED,
+                                            size: 3,
+                                            color: "#ff8000",
+                                        },
+                                    },
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                            ],
+                        }),
+                        new TableRow({
+                            children: [
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                            ],
+                        }),
+                        new TableRow({
+                            children: [
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                                new TableCell({
+                                    children: [],
+                                }),
+                            ],
+                        }),
+                    ],
                 }),
             ],
-        }),
+        },
-        new TableRow({
-            children: [
-                new TableCell({
-                    children: [],
-                }),
-                new TableCell({
-                    children: [new Paragraph("Hello")],
-                    borders: {
-                        top: {
-                            style: BorderStyle.DASH_DOT_STROKED,
-                            size: 3,
-                            color: "red",
-                        },
-                        bottom: {
-                            style: BorderStyle.DOUBLE,
-                            size: 3,
-                            color: "blue",
-                        },
-                        left: {
-                            style: BorderStyle.DASH_DOT_STROKED,
-                            size: 3,
-                            color: "green",
-                        },
-                        right: {
-                            style: BorderStyle.DASH_DOT_STROKED,
-                            size: 3,
-                            color: "#ff8000",
-                        },
-                    },
-                }),
-                new TableCell({
-                    children: [],
-                }),
-                new TableCell({
-                    children: [],
-                }),
-            ],
-        }),
-        new TableRow({
-            children: [
-                new TableCell({
-                    children: [],
-                }),
-                new TableCell({
-                    children: [],
-                }),
-                new TableCell({
-                    children: [],
-                }),
-                new TableCell({
-                    children: [],
-                }),
-            ],
-        }),
-        new TableRow({
-            children: [
-                new TableCell({
-                    children: [],
-                }),
-                new TableCell({
-                    children: [],
-                }),
-                new TableCell({
-                    children: [],
-                }),
-                new TableCell({
-                    children: [],
-                }),
-            ],
-        }),
     ],
 });
 
-doc.addSection({ children: [table] });
-
 Packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

demo/21-bookmarks.ts

@@ -1,37 +1,75 @@
 // This demo shows how to create bookmarks then link to them with internal hyperlinks
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Bookmark, Document, HeadingLevel, HyperlinkRef, HyperlinkType, Packer, PageBreak, Paragraph } from "../build";
+import { Bookmark, Document, Footer, HeadingLevel, InternalHyperlink, Packer, PageBreak, Paragraph, TextRun, PageReference } from "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({
     creator: "Clippy",
     title: "Sample Document",
     description: "A brief example of using docx with bookmarks and internal hyperlinks",
-    hyperlinks: {
+    sections: [
-        myAnchorId: {
+        {
-            text: "Hyperlink",
+            footers: {
-            type: HyperlinkType.INTERNAL,
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new InternalHyperlink({
+                                    children: [
+                                        new TextRun({
+                                            text: "Click here!",
+                                            style: "Hyperlink",
+                                        }),
+                                    ],
+                                    anchor: "myAnchorId",
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            children: [
+                new Paragraph({
+                    heading: HeadingLevel.HEADING_1,
+                    children: [
+                        new Bookmark({
+                            id: "myAnchorId",
+                            children: [new TextRun("Lorem Ipsum")],
+                        }),
+                    ],
+                }),
+                new Paragraph("\n"),
+                new Paragraph(LOREM_IPSUM),
+                new Paragraph({
+                    children: [new PageBreak()],
+                }),
+                new Paragraph({
+                    children: [
+                        new InternalHyperlink({
+                            children: [
+                                new TextRun({
+                                    text: "Styled",
+                                    bold: true,
+                                    style: "Hyperlink",
+                                }),
+                                new TextRun({
+                                    text: " Anchor Text",
+                                    style: "Hyperlink",
+                                }),
+                            ],
+                            anchor: "myAnchorId",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [new TextRun("The bookmark can be seen on page "), new PageReference("myAnchorId")],
+                }),
+            ],
         },
-    },
-});
-
-doc.addSection({
-    children: [
-        new Paragraph({
-            heading: HeadingLevel.HEADING_1,
-            children: [new Bookmark("myAnchorId", "Lorem Ipsum")],
-        }),
-        new Paragraph("\n"),
-        new Paragraph(LOREM_IPSUM),
-        new Paragraph({
-            children: [new PageBreak()],
-        }),
-        new Paragraph({
-            children: [new HyperlinkRef("myAnchorId")],
-        }),
     ],
 });
 

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

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

demo/23-base64-images.ts

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

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

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

demo/25-table-xml-styles.ts

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

demo/26-paragraph-borders.ts

@@ -1,30 +1,62 @@
 // Creates two paragraphs, one with a border and one without
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, Packer, Paragraph } from "../build";
+import { BorderStyle, Document, Packer, Paragraph, TextRun } from "docx";
 
-const doc = new Document();
+const doc = new Document({
-
+    sections: [
-doc.addSection({
+        {
-    children: [
+            children: [
-        new Paragraph("No border!"),
+                new Paragraph("No border!"),
-        new Paragraph({
+                new Paragraph({
-            text: "I have borders on my top and bottom sides!",
+                    text: "I have borders on my top and bottom sides!",
-            border: {
+                    border: {
-                top: {
+                        top: {
-                    color: "auto",
+                            color: "auto",
-                    space: 1,
+                            space: 1,
-                    value: "single",
+                            style: BorderStyle.SINGLE,
-                    size: 6,
+                            size: 6,
-                },
+                        },
-                bottom: {
+                        bottom: {
-                    color: "auto",
+                            color: "auto",
-                    space: 1,
+                            space: 1,
-                    value: "single",
+                            style: BorderStyle.SINGLE,
-                    size: 6,
+                            size: 6,
-                },
+                        },
-            },
+                    },
-        }),
+                }),
+                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, HeadingLevel, Packer, Paragraph, UnderlineType } from "../build";
+import { Document, convertInchesToTwip, HeadingLevel, Packer, Paragraph, UnderlineType } from "docx";
 
 const doc = new Document({
     styles: {
@@ -17,7 +17,7 @@ const doc = new Document({
                 },
                 paragraph: {
                     indent: {
-                        left: 720,
+                        left: convertInchesToTwip(0.5),
                     },
                     spacing: {
                         line: 276,
@@ -47,18 +47,19 @@ const doc = new Document({
             },
         ],
     },
-});
+    sections: [
-
+        {
-doc.addSection({
+            children: [
-    children: [
+                new Paragraph({
-        new Paragraph({
+                    text: "Hello",
-            text: "Hello",
+                    style: "myWonkyStyle",
-            style: "myWonkyStyle",
+                }),
-        }),
+                new Paragraph({
-        new Paragraph({
+                    text: "World",
-            text: "World",
+                    heading: HeadingLevel.HEADING_2,
-            heading: HeadingLevel.HEADING_2,
+                }),
-        }),
+            ],
+        },
     ],
 });
 

demo/28-table-of-contents.ts

@@ -1,9 +1,17 @@
 // 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 * as fs from "fs";
+import { File, HeadingLevel, Packer, Paragraph, StyleLevel, TableOfContents } from "docx";
+
+// WordprocessingML docs for TableOfContents can be found here:
+// http://officeopenxml.com/WPtableOfContents.php
+
+// Let's define the properties for generate a TOC for heading 1-5 and MySpectacularStyle,
+// making the entries be hyperlinks for the paragraph
 const doc = new File({
+    features: {
+        updateFields: true,
+    },
     styles: {
         paragraphStyles: [
             {
@@ -19,43 +27,38 @@ const doc = new File({
             },
         ],
     },
-});
+    sections: [
-
+        {
-// WordprocessingML docs for TableOfContents can be found here:
+            children: [
-// http://officeopenxml.com/WPtableOfContents.php
+                new TableOfContents("Summary", {
-
+                    hyperlink: true,
-// Let's define the properties for generate a TOC for heading 1-5 and MySpectacularStyle,
+                    headingStyleRange: "1-5",
-// making the entries be hyperlinks for the paragraph
+                    stylesWithLevels: [new StyleLevel("MySpectacularStyle", 1)],
-
+                }),
-doc.addSection({
+                new Paragraph({
-    children: [
+                    text: "Header #1",
-        new TableOfContents("Summary", {
+                    heading: HeadingLevel.HEADING_1,
-            hyperlink: true,
+                    pageBreakBefore: true,
-            headingStyleRange: "1-5",
+                }),
-            stylesWithLevels: [new StyleLevel("MySpectacularStyle", 1)],
+                new Paragraph("I'm a little text very nicely written.'"),
-        }),
+                new Paragraph({
-        new Paragraph({
+                    text: "Header #2",
-            text: "Header #1",
+                    heading: HeadingLevel.HEADING_1,
-            heading: HeadingLevel.HEADING_1,
+                    pageBreakBefore: true,
-            pageBreakBefore: true,
+                }),
-        }),
+                new Paragraph("I'm a other text very nicely written.'"),
-        new Paragraph("I'm a little text very nicely written.'"),
+                new Paragraph({
-        new Paragraph({
+                    text: "Header #2.1",
-            text: "Header #2",
+                    heading: HeadingLevel.HEADING_2,
-            heading: HeadingLevel.HEADING_1,
+                }),
-            pageBreakBefore: true,
+                new Paragraph("I'm a another text very nicely written.'"),
-        }),
+                new Paragraph({
-        new Paragraph("I'm a other text very nicely written.'"),
+                    text: "My Spectacular Style #1",
-        new Paragraph({
+                    style: "MySpectacularStyle",
-            text: "Header #2.1",
+                    pageBreakBefore: true,
-            heading: HeadingLevel.HEADING_2,
+                }),
-        }),
+            ],
-        new Paragraph("I'm a another text very nicely written.'"),
+        },
-        new Paragraph({
-            text: "My Spectacular Style #1",
-            style: "MySpectacularStyle",
-            pageBreakBefore: true,
-        }),
     ],
 });
 

demo/29-numbered-lists.ts

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

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

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

demo/30-template-document.ts

@@ -1,30 +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(undefined, {
-            template: templateDocument,
-        });
-
-        doc.addSection({
-            properties: {
-                titlePage: templateDocument.titlePageIsDefined,
-            },
-            children: [new Paragraph("Hello World")],
-        });
-
-        Packer.toBuffer(doc).then((buffer) => {
-            fs.writeFileSync("My Document.docx", buffer);
-        });
-    });
-});

demo/31-tables.ts

@@ -1,76 +1,77 @@
 // 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();
+const doc = new Document({
-
+    sections: [
-const table = new Table({
+        {
-    rows: [
-        new TableRow({
             children: [
-                new TableCell({
+                new Table({
-                    children: [new Paragraph({}), new Paragraph({})],
+                    rows: [
-                    verticalAlign: VerticalAlign.CENTER,
+                        new TableRow({
-                }),
+                            children: [
-                new TableCell({
+                                new TableCell({
-                    children: [new Paragraph({}), new Paragraph({})],
+                                    children: [new Paragraph({}), new Paragraph({})],
-                    verticalAlign: VerticalAlign.CENTER,
+                                    verticalAlign: VerticalAlign.CENTER,
-                }),
+                                }),
-                new TableCell({
+                                new TableCell({
-                    children: [new Paragraph({ text: "bottom to top" }), new Paragraph({})],
+                                    children: [new Paragraph({}), new Paragraph({})],
-                    textDirection: TextDirection.BOTTOM_TO_TOP_LEFT_TO_RIGHT,
+                                    verticalAlign: VerticalAlign.CENTER,
-                }),
+                                }),
-                new TableCell({
+                                new TableCell({
-                    children: [new Paragraph({ text: "top to bottom" }), new Paragraph({})],
+                                    children: [new Paragraph({ text: "bottom to top" }), new Paragraph({})],
-                    textDirection: TextDirection.TOP_TO_BOTTOM_RIGHT_TO_LEFT,
+                                    textDirection: TextDirection.BOTTOM_TO_TOP_LEFT_TO_RIGHT,
+                                }),
+                                new TableCell({
+                                    children: [new Paragraph({ text: "top to bottom" }), new Paragraph({})],
+                                    textDirection: TextDirection.TOP_TO_BOTTOM_RIGHT_TO_LEFT,
+                                }),
+                            ],
+                        }),
+                        new TableRow({
+                            children: [
+                                new TableCell({
+                                    children: [
+                                        new Paragraph({
+                                            text: "Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah",
+                                            heading: HeadingLevel.HEADING_1,
+                                        }),
+                                    ],
+                                }),
+                                new TableCell({
+                                    children: [
+                                        new Paragraph({
+                                            text: "This text should be in the middle of the cell",
+                                        }),
+                                    ],
+                                    verticalAlign: VerticalAlign.CENTER,
+                                }),
+                                new TableCell({
+                                    children: [
+                                        new Paragraph({
+                                            text: "Text above should be vertical from bottom to top",
+                                        }),
+                                    ],
+                                    verticalAlign: VerticalAlign.CENTER,
+                                }),
+                                new TableCell({
+                                    children: [
+                                        new Paragraph({
+                                            text: "Text above should be vertical from top to bottom",
+                                        }),
+                                    ],
+                                    verticalAlign: VerticalAlign.CENTER,
+                                }),
+                            ],
+                        }),
+                    ],
                 }),
             ],
-        }),
+        },
-        new TableRow({
-            children: [
-                new TableCell({
-                    children: [
-                        new Paragraph({
-                            text:
-                                "Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah Blah",
-                            heading: HeadingLevel.HEADING_1,
-                        }),
-                    ],
-                }),
-                new TableCell({
-                    children: [
-                        new Paragraph({
-                            text: "This text should be in the middle of the cell",
-                        }),
-                    ],
-                    verticalAlign: VerticalAlign.CENTER,
-                }),
-                new TableCell({
-                    children: [
-                        new Paragraph({
-                            text: "Text above should be vertical from bottom to top",
-                        }),
-                    ],
-                    verticalAlign: VerticalAlign.CENTER,
-                }),
-                new TableCell({
-                    children: [
-                        new Paragraph({
-                            text: "Text above should be vertical from top to bottom",
-                        }),
-                    ],
-                    verticalAlign: VerticalAlign.CENTER,
-                }),
-            ],
-        }),
     ],
 });
 
-doc.addSection({
-    children: [table],
-});
-
 Packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });

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

@@ -1,10 +1,21 @@
 // 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, BorderStyle, Document, HeadingLevel, Packer, Paragraph, ShadingType, Table, TableCell, TableRow, WidthType } from "../build";
 
-const doc = new Document();
+import * as fs from "fs";
+import {
+    AlignmentType,
+    BorderStyle,
+    convertInchesToTwip,
+    Document,
+    HeadingLevel,
+    Packer,
+    Paragraph,
+    ShadingType,
+    Table,
+    TableCell,
+    TableRow,
+    WidthType,
+} from "docx";
 
 const table = new Table({
     rows: [
@@ -37,10 +48,10 @@ const table2 = new Table({
                 new TableCell({
                     children: [new Paragraph("World")],
                     margins: {
-                        top: 1000,
+                        top: convertInchesToTwip(0.69),
-                        bottom: 1000,
+                        bottom: convertInchesToTwip(0.69),
-                        left: 1000,
+                        left: convertInchesToTwip(0.69),
-                        right: 1000,
+                        right: convertInchesToTwip(0.69),
                     },
                     columnSpan: 3,
                 }),
@@ -64,7 +75,7 @@ const table2 = new Table({
         size: 100,
         type: WidthType.AUTO,
     },
-    columnWidths: [1000, 1000, 1000],
+    columnWidths: [convertInchesToTwip(0.69), convertInchesToTwip(0.69), convertInchesToTwip(0.69)],
 });
 
 const table3 = new Table({
@@ -87,7 +98,7 @@ const table3 = new Table({
                     children: [new Paragraph("Bar1")],
                     shading: {
                         fill: "b79c2f",
-                        val: ShadingType.REVERSE_DIAGONAL_STRIPE,
+                        type: ShadingType.REVERSE_DIAGONAL_STRIPE,
                         color: "auto",
                     },
                 }),
@@ -95,7 +106,7 @@ const table3 = new Table({
                     children: [new Paragraph("Bar2")],
                     shading: {
                         fill: "42c5f4",
-                        val: ShadingType.PERCENT_95,
+                        type: ShadingType.PERCENT_95,
                         color: "auto",
                     },
                 }),
@@ -103,7 +114,7 @@ const table3 = new Table({
                     children: [new Paragraph("Bar3")],
                     shading: {
                         fill: "880aa8",
-                        val: ShadingType.PERCENT_10,
+                        type: ShadingType.PERCENT_10,
                         color: "e2df0b",
                     },
                 }),
@@ -111,7 +122,7 @@ const table3 = new Table({
                     children: [new Paragraph("Bar4")],
                     shading: {
                         fill: "FF0000",
-                        val: ShadingType.CLEAR,
+                        type: ShadingType.CLEAR,
                         color: "auto",
                     },
                 }),
@@ -119,14 +130,14 @@ const table3 = new Table({
         }),
     ],
     width: {
-        size: 7000,
+        size: convertInchesToTwip(4.86),
         type: WidthType.DXA,
     },
     margins: {
-        top: 400,
+        top: convertInchesToTwip(0.27),
-        bottom: 400,
+        bottom: convertInchesToTwip(0.27),
-        right: 400,
+        right: convertInchesToTwip(0.27),
-        left: 400,
+        left: convertInchesToTwip(0.27),
     },
 });
 
@@ -213,22 +224,22 @@ const borders = {
     top: {
         style: BorderStyle.DASH_SMALL_GAP,
         size: 1,
-        color: "red",
+        color: "FF0000",
     },
     bottom: {
         style: BorderStyle.DASH_SMALL_GAP,
         size: 1,
-        color: "red",
+        color: "FF0000",
     },
     left: {
         style: BorderStyle.DASH_SMALL_GAP,
         size: 1,
-        color: "red",
+        color: "FF0000",
     },
     right: {
         style: BorderStyle.DASH_SMALL_GAP,
         size: 1,
-        color: "red",
+        color: "FF0000",
     },
 };
 
@@ -355,9 +366,7 @@ const table8 = new Table({
             ],
         }),
         new TableRow({
-            children: [
+            children: [new TableCell({ children: [new Paragraph("4,1")] })],
-                new TableCell({ children: [new Paragraph("4,1")] }),
-            ],
         }),
     ],
     width: {
@@ -365,30 +374,33 @@ const table8 = new Table({
         type: WidthType.PERCENTAGE,
     },
 });
-
+const doc = new Document({
-doc.addSection({
+    sections: [
-    children: [
+        {
-        table,
+            children: [
-        new Paragraph({
+                table,
-            text: "Another table",
+                new Paragraph({
-            heading: HeadingLevel.HEADING_2,
+                    text: "Another table",
-        }),
+                    heading: HeadingLevel.HEADING_2,
-        table2,
+                }),
-        new Paragraph({
+                table2,
-            text: "Another table",
+                new Paragraph({
-            heading: HeadingLevel.HEADING_2,
+                    text: "Another table",
-        }),
+                    heading: HeadingLevel.HEADING_2,
-        table3,
+                }),
-        new Paragraph("Merging columns 1"),
+                table3,
-        table4,
+                new Paragraph("Merging columns 1"),
-        new Paragraph("Merging columns 2"),
+                table4,
-        table5,
+                new Paragraph("Merging columns 2"),
-        new Paragraph("Merging columns 3"),
+                table5,
-        table6,
+                new Paragraph("Merging columns 3"),
-        new Paragraph("Merging columns 4"),
+                table6,
-        table7,
+                new Paragraph("Merging columns 4"),
-        new Paragraph("Merging columns 5"),
+                table7,
-        table8,
+                new Paragraph("Merging columns 5"),
+                table8,
+            ],
+        },
     ],
 });
 

demo/33-sequential-captions.ts

@@ -1,44 +1,46 @@
 // 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();
+const doc = new Document({
-
+    sections: [
-doc.addSection({
+        {
-    children: [
-        new Paragraph({
             children: [
-                new TextRun("Hello World 1->"),
+                new Paragraph({
-                new SequentialIdentifier("Caption"),
+                    children: [
-                new TextRun(" text after sequencial caption 2->"),
+                        new TextRun("Hello World 1->"),
-                new SequentialIdentifier("Caption"),
+                        new SequentialIdentifier("Caption"),
+                        new TextRun(" text after sequencial caption 2->"),
+                        new SequentialIdentifier("Caption"),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World 1->"),
+                        new SequentialIdentifier("Label"),
+                        new TextRun(" text after sequencial caption 2->"),
+                        new SequentialIdentifier("Label"),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World 1->"),
+                        new SequentialIdentifier("Another"),
+                        new TextRun(" text after sequencial caption 3->"),
+                        new SequentialIdentifier("Label"),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World 2->"),
+                        new SequentialIdentifier("Another"),
+                        new TextRun(" text after sequencial caption 4->"),
+                        new SequentialIdentifier("Label"),
+                    ],
+                }),
             ],
-        }),
+        },
-        new Paragraph({
-            children: [
-                new TextRun("Hello World 1->"),
-                new SequentialIdentifier("Label"),
-                new TextRun(" text after sequencial caption 2->"),
-                new SequentialIdentifier("Label"),
-            ],
-        }),
-        new Paragraph({
-            children: [
-                new TextRun("Hello World 1->"),
-                new SequentialIdentifier("Another"),
-                new TextRun(" text after sequencial caption 3->"),
-                new SequentialIdentifier("Label"),
-            ],
-        }),
-        new Paragraph({
-            children: [
-                new TextRun("Hello World 2->"),
-                new SequentialIdentifier("Another"),
-                new TextRun(" text after sequencial caption 4->"),
-                new SequentialIdentifier("Label"),
-            ],
-        }),
     ],
 });
 

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

demo/35-hyperlinks.ts

@@ -1,33 +1,160 @@
 // Example on how to add hyperlinks to websites
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, HyperlinkRef, HyperlinkType, Packer, Paragraph, Media } from "../build";
+import { Document, ExternalHyperlink, Footer, FootnoteReferenceRun, ImageRun, Packer, Paragraph, TextRun } from "docx";
 
 const doc = new Document({
-    hyperlinks: {
+    styles: {
-        myCoolLink: {
+        default: {
-            link: "http://www.example.com",
+            hyperlink: {
-            text: "Hyperlink",
+                run: {
-            type: HyperlinkType.EXTERNAL,
+                    color: "FF0000",
-        },
+                    underline: {
-        myOtherLink: {
+                        color: "0000FF",
-            link: "http://www.google.com",
+                    },
-            text: "Google Link",
+                },
-            type: HyperlinkType.EXTERNAL,
+            },
         },
     },
-});
+    footnotes: {
-
+        1: {
-const image1 = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
+            children: [
-
+                new Paragraph({
-doc.addSection({
+                    children: [
-    children: [
+                        new TextRun("Click here for the "),
-        new Paragraph({
+                        new ExternalHyperlink({
-            children: [new HyperlinkRef("myCoolLink")],
+                            children: [
-        }),
+                                new TextRun({
-        new Paragraph({
+                                    text: "Footnotes external hyperlink",
-            children: [image1, new HyperlinkRef("myOtherLink")],
+                                    style: "Hyperlink",
-        }),
+                                }),
+                            ],
+                            link: "http://www.example.com",
+                        }),
+                    ],
+                }),
+            ],
+        },
+    },
+    sections: [
+        {
+            footers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new TextRun("Click here for the "),
+                                new ExternalHyperlink({
+                                    children: [
+                                        new TextRun({
+                                            text: "Footer external hyperlink",
+                                            style: "Hyperlink",
+                                        }),
+                                    ],
+                                    link: "http://www.example.com",
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            headers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            children: [
+                                new TextRun("Click here for the "),
+                                new ExternalHyperlink({
+                                    children: [
+                                        new TextRun({
+                                            text: "Header external hyperlink",
+                                            style: "Hyperlink",
+                                        }),
+                                    ],
+                                    link: "http://www.google.com",
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+            children: [
+                new Paragraph({
+                    children: [
+                        new ExternalHyperlink({
+                            children: [
+                                new TextRun({
+                                    text: "Anchor Text",
+                                    style: "Hyperlink",
+                                }),
+                            ],
+                            link: "http://www.example.com",
+                        }),
+                        new FootnoteReferenceRun(1),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ExternalHyperlink({
+                            children: [
+                                new ImageRun({
+                                    data: fs.readFileSync("./demo/images/image1.jpeg"),
+                                    transformation: {
+                                        width: 100,
+                                        height: 100,
+                                    },
+                                }),
+                            ],
+                            link: "http://www.google.com",
+                        }),
+                        new ExternalHyperlink({
+                            children: [
+                                new TextRun({
+                                    text: "BBC News Link",
+                                    style: "Hyperlink",
+                                }),
+                            ],
+                            link: "https://www.bbc.co.uk/news",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "This is a hyperlink with formatting: ",
+                        }),
+                        new ExternalHyperlink({
+                            children: [
+                                new TextRun({
+                                    text: "A ",
+                                    style: "Hyperlink",
+                                }),
+                                new TextRun({
+                                    text: "single ",
+                                    bold: true,
+                                    style: "Hyperlink",
+                                }),
+                                new TextRun({
+                                    text: "link",
+                                    doubleStrike: true,
+                                    style: "Hyperlink",
+                                }),
+                                new TextRun({
+                                    text: "1",
+                                    superScript: true,
+                                    style: "Hyperlink",
+                                }),
+                                new TextRun({
+                                    text: "!",
+                                    style: "Hyperlink",
+                                }),
+                            ],
+                            link: "http://www.example.com",
+                        }),
+                    ],
+                }),
+            ],
+        },
     ],
 });
 

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

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

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

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

demo/38-text-wrapping.ts

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

demo/39-page-numbers.ts

@@ -1,66 +1,72 @@
 // Example how to display page numbers
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { AlignmentType, Document, Footer, Header, Packer, PageBreak, PageNumber, PageNumberFormat, Paragraph, TextRun } from "../build";
+import { AlignmentType, Document, Footer, Header, Packer, PageBreak, PageNumber, NumberFormat, Paragraph, TextRun } from "docx";
 
-const doc = new Document({});
+const doc = new Document({
-
+    sections: [
-doc.addSection({
+        {
-    headers: {
+            properties: {
-        default: new Header({
+                page: {
-            children: [
+                    pageNumbers: {
-                new Paragraph({
+                        start: 1,
+                        formatType: NumberFormat.DECIMAL,
+                    },
+                },
+            },
+            headers: {
+                default: new Header({
                     children: [
-                        new TextRun("Foo Bar corp. "),
+                        new Paragraph({
-                        new TextRun({
+                            children: [
-                            children: ["Page Number ", PageNumber.CURRENT],
+                                new TextRun("Foo Bar corp. "),
-                        }),
+                                new TextRun({
-                        new TextRun({
+                                    children: ["Page Number ", PageNumber.CURRENT],
-                            children: [" to ", PageNumber.TOTAL_PAGES],
+                                }),
+                                new TextRun({
+                                    children: [" to ", PageNumber.TOTAL_PAGES],
+                                }),
+                            ],
                         }),
                     ],
                 }),
-            ],
+            },
-        }),
+            footers: {
-    },
+                default: new Footer({
-    footers: {
-        default: new Footer({
-            children: [
-                new Paragraph({
-                    alignment: AlignmentType.CENTER,
                     children: [
-                        new TextRun("Foo Bar corp. "),
+                        new Paragraph({
-                        new TextRun({
+                            alignment: AlignmentType.CENTER,
-                            children: ["Page Number: ", PageNumber.CURRENT],
+                            children: [
-                        }),
+                                new TextRun("Foo Bar corp. "),
-                        new TextRun({
+                                new TextRun({
-                            children: [" to ", PageNumber.TOTAL_PAGES],
+                                    children: ["Page Number: ", PageNumber.CURRENT],
+                                }),
+                                new TextRun({
+                                    children: [" to ", PageNumber.TOTAL_PAGES],
+                                }),
+                            ],
                         }),
                     ],
                 }),
+            },
+            children: [
+                new Paragraph({
+                    children: [new TextRun("Hello World 1"), new PageBreak()],
+                }),
+                new Paragraph({
+                    children: [new TextRun("Hello World 2"), new PageBreak()],
+                }),
+                new Paragraph({
+                    children: [new TextRun("Hello World 3"), new PageBreak()],
+                }),
+                new Paragraph({
+                    children: [new TextRun("Hello World 4"), new PageBreak()],
+                }),
+                new Paragraph({
+                    children: [new TextRun("Hello World 5"), new PageBreak()],
+                }),
             ],
-        }),
+        },
-    },
-    properties: {
-        pageNumberStart: 1,
-        pageNumberFormatType: PageNumberFormat.DECIMAL,
-    },
-    children: [
-        new Paragraph({
-            children: [new TextRun("Hello World 1"), new PageBreak()],
-        }),
-        new Paragraph({
-            children: [new TextRun("Hello World 2"), new PageBreak()],
-        }),
-        new Paragraph({
-            children: [new TextRun("Hello World 3"), new PageBreak()],
-        }),
-        new Paragraph({
-            children: [new TextRun("Hello World 4"), new PageBreak()],
-        }),
-        new Paragraph({
-            children: [new TextRun("Hello World 5"), new PageBreak()],
-        }),
     ],
 });
 

demo/4-basic-table.ts

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

demo/40-line-numbers.ts

@@ -1,26 +1,30 @@
 // 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();
+const doc = new Document({
-
+    sections: [
-doc.addSection({
+        {
-    properties: {
+            properties: {
-        lineNumberCountBy: 1,
+                lineNumbers: {
-        lineNumberRestart: LineNumberRestartFormat.CONTINUOUS,
+                    countBy: 1,
-    },
+                    restart: LineNumberRestartFormat.CONTINUOUS,
-    children: [
+                },
-        new Paragraph({
+            },
-            text: "Hello",
+            children: [
-            heading: HeadingLevel.HEADING_1,
+                new Paragraph({
-        }),
+                    text: "Hello",
-        new Paragraph(
+                    heading: HeadingLevel.HEADING_1,
-            "Himenaeos duis luctus nullam fermentum lobortis potenti vivamus non dis, sed facilisis ultricies scelerisque aenean risus hac senectus. Adipiscing id venenatis justo ante gravida placerat, ac curabitur dis pellentesque proin bibendum risus, aliquam porta taciti vulputate primis. Tortor ipsum fermentum quam vel convallis primis nisl praesent tincidunt, lobortis quisque felis vitae condimentum class ut sem nam, aenean potenti pretium ac amet lacinia himenaeos mi. Aliquam nisl turpis hendrerit est morbi malesuada, augue interdum mus inceptos curabitur tristique, parturient feugiat sodales nulla facilisi. Aliquam non pulvinar purus nulla ex integer, velit faucibus vitae at bibendum quam, risus elit aenean adipiscing posuere.",
+                }),
-        ),
+                new Paragraph(
-        new Paragraph(
+                    "Himenaeos duis luctus nullam fermentum lobortis potenti vivamus non dis, sed facilisis ultricies scelerisque aenean risus hac senectus. Adipiscing id venenatis justo ante gravida placerat, ac curabitur dis pellentesque proin bibendum risus, aliquam porta taciti vulputate primis. Tortor ipsum fermentum quam vel convallis primis nisl praesent tincidunt, lobortis quisque felis vitae condimentum class ut sem nam, aenean potenti pretium ac amet lacinia himenaeos mi. Aliquam nisl turpis hendrerit est morbi malesuada, augue interdum mus inceptos curabitur tristique, parturient feugiat sodales nulla facilisi. Aliquam non pulvinar purus nulla ex integer, velit faucibus vitae at bibendum quam, risus elit aenean adipiscing posuere.",
-            "Sed laoreet id mattis egestas nam mollis elit lacinia convallis dui tincidunt ultricies habitant, pharetra per maximus interdum neque tempor risus efficitur morbi imperdiet senectus. Lectus laoreet senectus finibus inceptos donec potenti fermentum, ultrices eleifend odio suscipit magnis tellus maximus nibh, ac sit nullam eget felis himenaeos. Diam class sem magnis aenean commodo faucibus id proin mi, nullam sodales nec mus parturient ornare ad inceptos velit hendrerit, bibendum placerat eleifend integer facilisis urna dictumst suspendisse.",
+                ),
-        ),
+                new Paragraph(
+                    "Sed laoreet id mattis egestas nam mollis elit lacinia convallis dui tincidunt ultricies habitant, pharetra per maximus interdum neque tempor risus efficitur morbi imperdiet senectus. Lectus laoreet senectus finibus inceptos donec potenti fermentum, ultrices eleifend odio suscipit magnis tellus maximus nibh, ac sit nullam eget felis himenaeos. Diam class sem magnis aenean commodo faucibus id proin mi, nullam sodales nec mus parturient ornare ad inceptos velit hendrerit, bibendum placerat eleifend integer facilisis urna dictumst suspendisse.",
+                ),
+            ],
+        },
     ],
 });
 

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

@@ -1,9 +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";
 
-const doc = new Document();
+import * as fs from "fs";
+import { Document, Packer, Paragraph, Table, TableCell, TableRow } from "docx";
 
 const table = new Table({
     rows: [
@@ -252,8 +250,12 @@ const table2 = new Table({
     ],
 });
 
-doc.addSection({
+const doc = new Document({
-    children: [table, new Paragraph(""), table2],
+    sections: [
+        {
+            children: [table, new Paragraph(""), table2],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/42-restart-page-numbers.ts

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

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

@@ -1,11 +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";
 
-const doc = new Document();
+import * as fs from "fs";
+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: [
@@ -19,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,
+                                    },
+                                }),
+                            ],
+                        }),
+                    ],
                 }),
             ],
         }),
@@ -29,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: [],
@@ -75,8 +103,12 @@ const table = new Table({
     ],
 });
 
-doc.addSection({
+const doc = new Document({
-    children: [table],
+    sections: [
+        {
+            children: [table],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/44-multiple-columns.ts

@@ -1,37 +1,53 @@
 // 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();
+const doc = new Document({
-
+    sections: [
-doc.addSection({
+        {
-    properties: {
+            properties: {
-        column: {
+                column: {
-            space: 708,
+                    space: 708,
-            count: 2,
+                    count: 2,
+                },
+            },
+            children: [
+                new Paragraph("This text will be split into 2 columns on a page."),
+                new Paragraph(
+                    "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
+                ),
+            ],
         },
-    },
+        {
-    children: [
+            properties: {
-        new Paragraph("This text will be split into 2 columns on a page."),
+                column: {
-        new Paragraph(
+                    space: 708,
-            "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
+                    count: 3,
-        ),
+                },
-    ],
+            },
-});
+            children: [
-
+                new Paragraph("This text will be split into 3 columns on a page."),
-doc.addSection({
+                new Paragraph(
-    properties: {
+                    "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
-        column: {
+                ),
-            space: 708,
+            ],
-            count: 3,
+        },
+        {
+            properties: {
+                column: {
+                    space: 708,
+                    count: 2,
+                    separate: true,
+                },
+            },
+            children: [
+                new Paragraph("This text will be split into 2 columns on a page."),
+                new Paragraph(
+                    "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
+                ),
+            ],
         },
-    },
-    children: [
-        new Paragraph("This text will be split into 3 columns on a page."),
-        new Paragraph(
-            "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.",
-        ),
     ],
 });
 

demo/45-highlighting-text.ts

@@ -1,33 +1,35 @@
 // 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();
+const doc = new Document({
-
+    sections: [
-doc.addSection({
+        {
-    headers: {
+            headers: {
-        default: new Header({
+                default: new Header({
-            children: [
-                new Paragraph({
-                    alignment: AlignmentType.RIGHT,
                     children: [
-                        new TextRun({
+                        new Paragraph({
-                            text: "Hello World",
+                            alignment: AlignmentType.RIGHT,
-                            color: "red",
+                            children: [
-                            bold: true,
+                                new TextRun({
-                            size: 24,
+                                    text: "Hello World",
-                            font: {
+                                    color: "FF0000",
-                                name: "Garamond",
+                                    bold: true,
-                            },
+                                    size: 24,
-                            highlight: "yellow",
+                                    font: {
+                                        name: "Garamond",
+                                    },
+                                    highlight: "yellow",
+                                }),
+                            ],
                         }),
                     ],
                 }),
-            ],
+            },
-        }),
+            children: [],
-    },
+        },
-    children: [],
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/46-shading-text.ts

@@ -1,49 +1,64 @@
 // 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();
+const doc = new Document({
-
+    sections: [
-doc.addSection({
+        {
-    headers: {
+            headers: {
-        default: new Header({
+                default: new Header({
-            children: [
-                new Paragraph({
-                    alignment: AlignmentType.RIGHT,
                     children: [
-                        new TextRun({
+                        new Paragraph({
-                            text: "Hello World",
+                            alignment: AlignmentType.RIGHT,
-                            color: "red",
+                            children: [
-                            bold: true,
+                                new TextRun({
-                            size: 24,
+                                    text: "Hello World",
-                            font: {
+                                    color: "FF0000",
-                                name: "Garamond",
+                                    bold: true,
-                            },
+                                    size: 24,
+                                    font: {
+                                        name: "Garamond",
+                                    },
+                                    shading: {
+                                        type: ShadingType.REVERSE_DIAGONAL_STRIPE,
+                                        color: "00FFFF",
+                                        fill: "FF0000",
+                                    },
+                                }),
+                            ],
+                        }),
+                        new Paragraph({
                             shading: {
-                                type: ShadingType.REVERSE_DIAGONAL_STRIPE,
+                                type: ShadingType.DIAGONAL_CROSS,
                                 color: "00FFFF",
                                 fill: "FF0000",
                             },
+                            children: [
+                                new TextRun({
+                                    text: "Hello World for entire paragraph",
+                                }),
+                            ],
                         }),
                     ],
                 }),
+            },
+            children: [
                 new Paragraph({
-                    shading: {
-                        type: ShadingType.DIAGONAL_CROSS,
-                        color: "00FFFF",
-                        fill: "FF0000",
-                    },
                     children: [
                         new TextRun({
-                            text: "Hello World for entire paragraph",
+                            emboss: true,
+                            text: "Embossed text - hello world",
+                        }),
+                        new TextRun({
+                            imprint: true,
+                            text: "Imprinted text - hello world",
                         }),
                     ],
                 }),
             ],
-        }),
+        },
-    },
+    ],
-    children: [],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

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

@@ -1,9 +1,7 @@
 // Multiple sections with total number of pages in each section
-// Import from 'docx' rather than '../build' if you install from npm
-import * as fs from "fs";
-import { AlignmentType, Document, Footer, Header, Packer, PageBreak, PageNumber, PageNumberFormat, Paragraph, TextRun } from "../build";
 
-const doc = new Document();
+import * as fs from "fs";
+import { AlignmentType, Document, Footer, Header, Packer, PageBreak, PageNumber, NumberFormat, Paragraph, TextRun } from "docx";
 
 const header = new Header({
     children: [
@@ -26,39 +24,50 @@ const footer = new Footer({
     children: [new Paragraph("Foo Bar corp. ")],
 });
 
-doc.addSection({
+const doc = new Document({
-    headers: {
+    sections: [
-        default: header,
+        {
-    },
+            properties: {
-    footers: {
+                page: {
-        default: footer,
+                    pageNumbers: {
-    },
+                        start: 1,
-    properties: {
+                        formatType: NumberFormat.DECIMAL,
-        pageNumberStart: 1,
+                    },
-        pageNumberFormatType: PageNumberFormat.DECIMAL,
+                },
-    },
+            },
-    children: [
+            headers: {
-        new Paragraph({
+                default: header,
-            children: [new TextRun("Section 1"), new PageBreak(), new TextRun("Section 1"), new PageBreak()],
+            },
-        }),
+            footers: {
-    ],
+                default: footer,
-});
+            },
-
+            children: [
-doc.addSection({
+                new Paragraph({
-    headers: {
+                    children: [new TextRun("Section 1"), new PageBreak(), new TextRun("Section 1"), new PageBreak()],
-        default: header,
+                }),
-    },
+            ],
-    footers: {
+        },
-        default: footer,
+        {
-    },
+            properties: {
-    properties: {
+                page: {
-        pageNumberStart: 1,
+                    pageNumbers: {
-        pageNumberFormatType: PageNumberFormat.DECIMAL,
+                        start: 1,
-    },
+                        formatType: NumberFormat.DECIMAL,
-    children: [
+                    },
-        new Paragraph({
+                },
-            children: [new TextRun("Section 2"), new PageBreak(), new TextRun("Section 2"), new PageBreak()],
+            },
-        }),
+            headers: {
+                default: header,
+            },
+            footers: {
+                default: footer,
+            },
+            children: [
+                new Paragraph({
+                    children: [new TextRun("Section 2"), new PageBreak(), new TextRun("Section 2"), new PageBreak()],
+                }),
+            ],
+        },
     ],
 });
 

demo/48-vertical-align.ts

@@ -1,28 +1,30 @@
 // Example of making content of section vertically aligned
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, Packer, Paragraph, SectionVerticalAlignValue, TextRun } from "../build";
+import { Document, Packer, Paragraph, VerticalAlign, TextRun, Tab } from "docx";
 
-const doc = new Document();
+const doc = new Document({
-
+    sections: [
-doc.addSection({
+        {
-    properties: {
+            properties: {
-        verticalAlign: SectionVerticalAlignValue.CENTER,
+                verticalAlign: VerticalAlign.CENTER,
-    },
+            },
-    children: [
-        new Paragraph({
             children: [
-                new TextRun("Hello World"),
+                new Paragraph({
-                new TextRun({
+                    children: [
-                    text: "Foo Bar",
+                        new TextRun("Hello World"),
-                    bold: true,
+                        new TextRun({
-                }),
+                            text: "Foo Bar",
-                new TextRun({
+                            bold: true,
-                    text: "\tGithub is the best",
+                        }),
-                    bold: true,
+                        new TextRun({
+                            children: [new Tab(), "Github is the best"],
+                            bold: true,
+                        }),
+                    ],
                 }),
             ],
-        }),
+        },
     ],
 });
 

demo/49-table-borders.ts

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

demo/5-images.ts

@@ -1,59 +1,173 @@
 // Example of how to add images to the document - You can use Buffers, UInt8Arrays or Base64 strings
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-// import { Document, Packer, Paragraph } from "../build";
 import {
+    convertMillimetersToTwip,
     Document,
     HorizontalPositionAlign,
     HorizontalPositionRelativeFrom,
-    Media,
+    ImageRun,
     Packer,
     Paragraph,
     VerticalPositionAlign,
     VerticalPositionRelativeFrom,
-} from "../build";
+} from "docx";
 
-const doc = new Document();
+const doc = new Document({
-
+    sections: [
-const image1 = Media.addImage(doc, fs.readFileSync("./demo/images/image1.jpeg"));
+        {
-const image2 = Media.addImage(doc, fs.readFileSync("./demo/images/dog.png").toString("base64"));
+            children: [
-const image3 = Media.addImage(doc, fs.readFileSync("./demo/images/cat.jpg"));
+                new Paragraph("Hello World"),
-const image4 = Media.addImage(doc, fs.readFileSync("./demo/images/parrots.bmp"));
+                new Paragraph({
-const image5 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"));
+                    children: [
-const image6 = Media.addImage(doc, fs.readFileSync("./demo/images/pizza.gif"), 200, 200, {
+                        new ImageRun({
-    floating: {
+                            type: "jpg",
-        horizontalPosition: {
+                            data: fs.readFileSync("./demo/images/image1.jpeg"),
-            offset: 1014400,
+                            transformation: {
+                                width: 100,
+                                height: 100,
+                            },
+                            altText: {
+                                title: "This is an ultimate title",
+                                description: "This is an ultimate image",
+                                name: "My Ultimate Image",
+                            },
+                        }),
+                    ],
+                }),
+                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,
+                                height: 100,
+                                flip: {
+                                    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,
+                                height: 150,
+                                flip: {
+                                    horizontal: true,
+                                },
+                                rotation: 225,
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            type: "gif",
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 200,
+                                height: 200,
+                                flip: {
+                                    horizontal: true,
+                                    vertical: true,
+                                },
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            type: "gif",
+                            data: fs.readFileSync("./demo/images/pizza.gif"),
+                            transformation: {
+                                width: 200,
+                                height: 200,
+                                rotation: 45,
+                            },
+                            floating: {
+                                zIndex: 10,
+                                horizontalPosition: {
+                                    offset: 1014400,
+                                },
+                                verticalPosition: {
+                                    offset: 1014400,
+                                },
+                            },
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new ImageRun({
+                            type: "jpg",
+                            data: fs.readFileSync("./demo/images/cat.jpg"),
+                            transformation: {
+                                width: 200,
+                                height: 200,
+                            },
+                            floating: {
+                                zIndex: 5,
+                                horizontalPosition: {
+                                    relative: HorizontalPositionRelativeFrom.PAGE,
+                                    align: HorizontalPositionAlign.RIGHT,
+                                },
+                                verticalPosition: {
+                                    relative: VerticalPositionRelativeFrom.PAGE,
+                                    align: VerticalPositionAlign.BOTTOM,
+                                },
+                            },
+                        }),
+                    ],
+                }),
+                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"),
+                            },
+                        }),
+                    ],
+                }),
+            ],
         },
-        verticalPosition: {
-            offset: 1014400,
-        },
-    },
-});
-
-const image7 = Media.addImage(doc, fs.readFileSync("./demo/images/cat.jpg"), 200, 200, {
-    floating: {
-        horizontalPosition: {
-            relative: HorizontalPositionRelativeFrom.PAGE,
-            align: HorizontalPositionAlign.RIGHT,
-        },
-        verticalPosition: {
-            relative: VerticalPositionRelativeFrom.PAGE,
-            align: VerticalPositionAlign.BOTTOM,
-        },
-    },
-});
-
-doc.addSection({
-    children: [
-        new Paragraph("Hello World"),
-        new Paragraph(image1),
-        new Paragraph(image2),
-        new Paragraph(image3),
-        new Paragraph(image4),
-        new Paragraph(image5),
-        new Paragraph(image6),
-        new Paragraph(image7),
     ],
 });
 

demo/50-readme-demo.ts

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

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: {
@@ -15,20 +15,40 @@ const doc = new Document({
                     italics: true,
                 },
             },
+            {
+                id: "strong",
+                name: "Strong",
+                basedOn: "Normal",
+                run: {
+                    bold: true,
+                },
+            },
         ],
     },
-});
+    sections: [
-
+        {
-doc.addSection({
-    children: [
-        new Paragraph({
             children: [
-                new TextRun({
+                new Paragraph({
-                    text: "Foo bar",
+                    children: [
-                    style: "myRedStyle",
+                        new TextRun({
+                            text: "Foo bar",
+                            style: "myRedStyle",
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun({
+                            text: "First Word",
+                            style: "strong",
+                        }),
+                        new TextRun({
+                            text: " - Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.",
+                        }),
+                    ],
                 }),
             ],
-        }),
+        },
     ],
 });
 

demo/52-japanese.ts

@@ -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: {
@@ -18,17 +18,18 @@ const doc = new Document({
             },
         ],
     },
-});
+    sections: [
-
+        {
-doc.addSection({
+            children: [
-    children: [
+                new Paragraph({
-        new Paragraph({
+                    text: "KFCを食べるのが好き",
-            text: "KFCを食べるのが好き",
+                    heading: HeadingLevel.HEADING_1,
-            heading: HeadingLevel.HEADING_1,
+                }),
-        }),
+                new Paragraph({
-        new Paragraph({
+                    text: "こんにちは",
-            text: "こんにちは",
+                }),
-        }),
+            ],
+        },
     ],
 });
 

demo/53-chinese.ts

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

demo/54-custom-properties.ts

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

demo/54-track-revisions.ts

@@ -1,145 +0,0 @@
-// Track Revisions aka. "Track Changes"
-// Import from 'docx' rather than '../build' if you install from npm
-import * as fs from "fs";
-import {
-    AlignmentType,
-    DeletedTextRun,
-    Document,
-    Footer,
-    FootnoteReferenceRun,
-    InsertedTextRun,
-    Packer,
-    PageNumber,
-    Paragraph,
-    ShadingType,
-    TextRun,
-} from "../build";
-
-/*
-    For reference, see
-    - https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.wordprocessing.insertedrun
-    - https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.wordprocessing.deletedrun
-
-    The method `addTrackRevisions()` adds an element `<w:trackRevisions />` to the `settings.xml` file. This specifies that the application shall track *new* revisions made to the existing document.
-    See also https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.wordprocessing.trackrevisions
-
-    Note that this setting enables to track *new changes* after teh file is generated, so this example will still show inserted and deleted text runs when you remove it.
-*/
-
-const doc = new Document({
-    footnotes: [
-        new Paragraph({
-            children: [
-                new TextRun("This is a footnote"),
-                new DeletedTextRun({
-                    text: " with some extra text which was deleted",
-                    id: 0,
-                    author: "Firstname Lastname",
-                    date: "2020-10-06T09:05:00Z",
-                }),
-                new InsertedTextRun({
-                    text: " and new content",
-                    id: 1,
-                    author: "Firstname Lastname",
-                    date: "2020-10-06T09:05:00Z",
-                }),
-            ],
-        }),
-    ],
-    features: {
-        trackRevisions: true,
-    },
-});
-
-const paragraph = new Paragraph({
-    children: [
-        new TextRun("This is a simple demo "),
-        new TextRun({
-            text: "on how to ",
-        }),
-        new InsertedTextRun({
-            text: "mark a text as an insertion ",
-            id: 0,
-            author: "Firstname Lastname",
-            date: "2020-10-06T09:00:00Z",
-        }),
-        new DeletedTextRun({
-            text: "or a deletion.",
-            id: 1,
-            author: "Firstname Lastname",
-            date: "2020-10-06T09:00:00Z",
-        }),
-    ],
-});
-
-doc.addSection({
-    properties: {},
-    children: [
-        paragraph,
-        new Paragraph({
-            children: [
-                new TextRun("This is a demo "),
-                new DeletedTextRun({
-                    text: "in order",
-                    color: "red",
-                    bold: true,
-                    size: 24,
-                    font: {
-                        name: "Garamond",
-                    },
-                    shading: {
-                        type: ShadingType.REVERSE_DIAGONAL_STRIPE,
-                        color: "00FFFF",
-                        fill: "FF0000",
-                    },
-                    id: 2,
-                    author: "Firstname Lastname",
-                    date: "2020-10-06T09:00:00Z",
-                }).break(),
-                new InsertedTextRun({
-                    text: "to show how to ",
-                    bold: false,
-                    id: 3,
-                    author: "Firstname Lastname",
-                    date: "2020-10-06T09:05:00Z",
-                }),
-                new TextRun({
-                    bold: true,
-                    children: ["\tuse Inserted and Deleted TextRuns.", new FootnoteReferenceRun(1)],
-                }),
-            ],
-        }),
-    ],
-    footers: {
-        default: new Footer({
-            children: [
-                new Paragraph({
-                    alignment: AlignmentType.CENTER,
-                    children: [
-                        new TextRun("Awesome LLC"),
-                        new TextRun({
-                            children: ["Page Number: ", PageNumber.CURRENT],
-                        }),
-                        new DeletedTextRun({
-                            children: [" to ", PageNumber.TOTAL_PAGES],
-                            id: 4,
-                            author: "Firstname Lastname",
-                            date: "2020-10-06T09:05:00Z",
-                        }),
-                        new InsertedTextRun({
-                            children: [" from ", PageNumber.TOTAL_PAGES],
-                            bold: true,
-                            id: 5,
-                            author: "Firstname Lastname",
-                            date: "2020-10-06T09:05:00Z",
-                        }),
-                    ],
-                }),
-            ],
-        }),
-    },
-});
-
-Packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/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,276 +16,327 @@ import {
     MathSubScript,
     MathSubSuperScript,
     MathSum,
+    MathIntegral,
     MathSuperScript,
     Packer,
     Paragraph,
     TextRun,
-} from "../build";
+    MathLimitLower,
+    MathLimitUpper,
+} from "docx";
 
-const doc = new Document();
+const doc = new Document({
-
+    sections: [
-doc.addSection({
+        {
-    properties: {},
+            properties: {},
-    children: [
-        new Paragraph({
             children: [
-                new Math({
+                new Paragraph({
                     children: [
-                        new MathRun("2+2"),
+                        new Math({
-                        new MathFraction({
-                            numerator: [new MathRun("hi")],
-                            denominator: [new MathRun("2")],
-                        }),
-                    ],
-                }),
-                new TextRun({
-                    text: "Foo Bar",
-                    bold: true,
-                }),
-            ],
-        }),
-        new Paragraph({
-            children: [
-                new Math({
-                    children: [
-                        new MathFraction({
-                            numerator: [
-                                new MathRun("1"),
-                                new MathRadical({
-                                    children: [new MathRun("2")],
-                                }),
-                            ],
-                            denominator: [new MathRun("2")],
-                        }),
-                    ],
-                }),
-            ],
-        }),
-        new Paragraph({
-            children: [
-                new Math({
-                    children: [
-                        new MathSum({
-                            children: [new MathRun("test")],
-                        }),
-                        new MathSum({
-                            children: [
-                                new MathSuperScript({
-                                    children: [new MathRun("e")],
-                                    superScript: [new MathRun("2")],
-                                }),
-                            ],
-                            subScript: [new MathRun("i")],
-                        }),
-                        new MathSum({
-                            children: [
-                                new MathRadical({
-                                    children: [new MathRun("i")],
-                                }),
-                            ],
-                            subScript: [new MathRun("i")],
-                            superScript: [new MathRun("10")],
-                        }),
-                    ],
-                }),
-            ],
-        }),
-        new Paragraph({
-            children: [
-                new Math({
-                    children: [
-                        new MathSuperScript({
-                            children: [new MathRun("test")],
-                            superScript: [new MathRun("hello")],
-                        }),
-                    ],
-                }),
-            ],
-        }),
-        new Paragraph({
-            children: [
-                new Math({
-                    children: [
-                        new MathSubScript({
-                            children: [new MathRun("test")],
-                            subScript: [new MathRun("hello")],
-                        }),
-                    ],
-                }),
-            ],
-        }),
-        new Paragraph({
-            children: [
-                new Math({
-                    children: [
-                        new MathSubScript({
-                            children: [new MathRun("x")],
-                            subScript: [
-                                new MathSuperScript({
-                                    children: [new MathRun("y")],
-                                    superScript: [new MathRun("2")],
-                                }),
-                            ],
-                        }),
-                    ],
-                }),
-            ],
-        }),
-        new Paragraph({
-            children: [
-                new Math({
-                    children: [
-                        new MathSubSuperScript({
-                            children: [new MathRun("test")],
-                            superScript: [new MathRun("hello")],
-                            subScript: [new MathRun("world")],
-                        }),
-                    ],
-                }),
-            ],
-        }),
-        new Paragraph({
-            children: [
-                new Math({
-                    children: [
-                        new MathPreSubSuperScript({
-                            children: [new MathRun("test")],
-                            superScript: [new MathRun("hello")],
-                            subScript: [new MathRun("world")],
-                        }),
-                    ],
-                }),
-            ],
-        }),
-        new Paragraph({
-            children: [
-                new Math({
-                    children: [
-                        new MathSubScript({
                             children: [
+                                new MathRun("2+2"),
                                 new MathFraction({
-                                    numerator: [new MathRun("1")],
+                                    numerator: [new MathRun("hi")],
                                     denominator: [new MathRun("2")],
                                 }),
                             ],
-                            subScript: [new MathRun("4")],
+                        }),
+                        new TextRun({
+                            text: "Foo Bar",
+                            bold: true,
                         }),
                     ],
                 }),
-            ],
+                new Paragraph({
-        }),
-        new Paragraph({
-            children: [
-                new Math({
                     children: [
-                        new MathSubScript({
+                        new Math({
                             children: [
-                                new MathRadical({
+                                new MathFraction({
+                                    numerator: [
+                                        new MathRun("1"),
+                                        new MathRadical({
+                                            children: [new MathRun("2")],
+                                        }),
+                                    ],
+                                    denominator: [new MathRun("2")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathSum({
+                                    children: [new MathRun("test")],
+                                }),
+                                new MathSum({
+                                    children: [
+                                        new MathSuperScript({
+                                            children: [new MathRun("e")],
+                                            superScript: [new MathRun("2")],
+                                        }),
+                                    ],
+                                    subScript: [new MathRun("i")],
+                                }),
+                                new MathSum({
+                                    children: [
+                                        new MathRadical({
+                                            children: [new MathRun("i")],
+                                        }),
+                                    ],
+                                    subScript: [new MathRun("i")],
+                                    superScript: [new MathRun("10")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new 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({
+                            children: [
+                                new MathSuperScript({
+                                    children: [new MathRun("test")],
+                                    superScript: [new MathRun("hello")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathSubScript({
+                                    children: [new MathRun("test")],
+                                    subScript: [new MathRun("hello")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathSubScript({
+                                    children: [new MathRun("x")],
+                                    subScript: [
+                                        new MathSuperScript({
+                                            children: [new MathRun("y")],
+                                            superScript: [new MathRun("2")],
+                                        }),
+                                    ],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathSubSuperScript({
+                                    children: [new MathRun("test")],
+                                    superScript: [new MathRun("hello")],
+                                    subScript: [new MathRun("world")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathPreSubSuperScript({
+                                    children: [new MathRun("test")],
+                                    superScript: [new MathRun("hello")],
+                                    subScript: [new MathRun("world")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathSubScript({
                                     children: [
                                         new MathFraction({
                                             numerator: [new MathRun("1")],
                                             denominator: [new MathRun("2")],
                                         }),
                                     ],
-                                    degree: [new MathRun("4")],
+                                    subScript: [new MathRun("4")],
-                                }),
-                            ],
-                            subScript: [new MathRun("x")],
-                        }),
-                    ],
-                }),
-            ],
-        }),
-        new Paragraph({
-            children: [
-                new Math({
-                    children: [
-                        new MathRadical({
-                            children: [new MathRun("4")],
-                        }),
-                    ],
-                }),
-            ],
-        }),
-        new Paragraph({
-            children: [
-                new Math({
-                    children: [
-                        new MathFunction({
-                            name: [
-                                new MathSuperScript({
-                                    children: [new MathRun("cos")],
-                                    superScript: [new MathRun("-1")],
-                                }),
-                            ],
-                            children: [new MathRun("100")],
-                        }),
-                        new MathRun("×"),
-                        new MathFunction({
-                            name: [new MathRun("sin")],
-                            children: [new MathRun("360")],
-                        }),
-                        new MathRun("= x"),
-                    ],
-                }),
-            ],
-        }),
-        new Paragraph({
-            children: [
-                new Math({
-                    children: [
-                        new MathRoundBrackets({
-                            children: [
-                                new MathFraction({
-                                    numerator: [new MathRun("1")],
-                                    denominator: [new MathRun("2")],
-                                }),
-                            ],
-                        }),
-                        new MathSquareBrackets({
-                            children: [
-                                new MathFraction({
-                                    numerator: [new MathRun("1")],
-                                    denominator: [new MathRun("2")],
-                                }),
-                            ],
-                        }),
-                        new MathCurlyBrackets({
-                            children: [
-                                new MathFraction({
-                                    numerator: [new MathRun("1")],
-                                    denominator: [new MathRun("2")],
-                                }),
-                            ],
-                        }),
-                        new MathAngledBrackets({
-                            children: [
-                                new MathFraction({
-                                    numerator: [new MathRun("1")],
-                                    denominator: [new MathRun("2")],
                                 }),
                             ],
                         }),
                     ],
                 }),
-            ],
+                new Paragraph({
-        }),
-        new Paragraph({
-            children: [
-                new Math({
                     children: [
-                        new MathFraction({
+                        new Math({
-                            numerator: [
+                            children: [
+                                new MathSubScript({
+                                    children: [
+                                        new MathRadical({
+                                            children: [
+                                                new MathFraction({
+                                                    numerator: [new MathRun("1")],
+                                                    denominator: [new MathRun("2")],
+                                                }),
+                                            ],
+                                            degree: [new MathRun("4")],
+                                        }),
+                                    ],
+                                    subScript: [new MathRun("x")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
                                 new MathRadical({
                                     children: [new MathRun("4")],
                                 }),
                             ],
-                            denominator: [new MathRun("2a")],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathFunction({
+                                    name: [
+                                        new MathSuperScript({
+                                            children: [new MathRun("cos")],
+                                            superScript: [new MathRun("-1")],
+                                        }),
+                                    ],
+                                    children: [new MathRun("100")],
+                                }),
+                                new MathRun("×"),
+                                new MathFunction({
+                                    name: [new MathRun("sin")],
+                                    children: [new MathRun("360")],
+                                }),
+                                new MathRun("= x"),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathRoundBrackets({
+                                    children: [
+                                        new MathFraction({
+                                            numerator: [new MathRun("1")],
+                                            denominator: [new MathRun("2")],
+                                        }),
+                                    ],
+                                }),
+                                new MathSquareBrackets({
+                                    children: [
+                                        new MathFraction({
+                                            numerator: [new MathRun("1")],
+                                            denominator: [new MathRun("2")],
+                                        }),
+                                    ],
+                                }),
+                                new MathCurlyBrackets({
+                                    children: [
+                                        new MathFraction({
+                                            numerator: [new MathRun("1")],
+                                            denominator: [new MathRun("2")],
+                                        }),
+                                    ],
+                                }),
+                                new MathAngledBrackets({
+                                    children: [
+                                        new MathFraction({
+                                            numerator: [new MathRun("1")],
+                                            denominator: [new MathRun("2")],
+                                        }),
+                                    ],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new Math({
+                            children: [
+                                new MathFraction({
+                                    numerator: [
+                                        new MathRadical({
+                                            children: [new MathRun("4")],
+                                        }),
+                                    ],
+                                    denominator: [new MathRun("2a")],
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+                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,30 +1,31 @@
 // 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: {
         color: "C45911",
     },
-});
+    sections: [
-
+        {
-doc.addSection({
+            properties: {},
-    properties: {},
-    children: [
-        new Paragraph({
             children: [
-                new TextRun("Hello World"),
+                new Paragraph({
-                new TextRun({
+                    children: [
-                    text: "Foo Bar",
+                        new TextRun("Hello World"),
-                    bold: true,
+                        new TextRun({
-                }),
+                            text: "Foo Bar",
-                new TextRun({
+                            bold: true,
-                    text: "\tGithub is the best",
+                        }),
-                    bold: true,
+                        new TextRun({
+                            children: [new Tab(), "Github is the best"],
+                            bold: true,
+                        }),
+                    ],
                 }),
             ],
-        }),
+        },
     ],
 });
 

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

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

demo/57-paragraph-run-styles.ts

@@ -1,31 +0,0 @@
-// Add Run styles across the whole Paragraph
-// Import from 'docx' rather than '../build' if you install from npm
-import * as fs from "fs";
-import { Document, Packer, Paragraph, TextRun } from "../build";
-
-const doc = new Document();
-
-doc.addSection({
-    children: [
-        new Paragraph({
-            runStyle: {
-                size: 100,
-            },
-            children: [
-                new TextRun("Hello World"),
-                new TextRun({
-                    text: "Foo Bar",
-                    bold: true,
-                }),
-                new TextRun({
-                    text: "\tGithub is the best",
-                    bold: true,
-                }),
-            ],
-        }),
-    ],
-});
-
-Packer.toBuffer(doc).then((buffer) => {
-    fs.writeFileSync("My Document.docx", buffer);
-});

demo/58-section-types.ts

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

demo/59-header-footer-margins.ts

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

demo/6-page-borders.ts

@@ -1,37 +1,43 @@
 // 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();
+const doc = new Document({
-
+    sections: [
-doc.addSection({
+        {
-    margins: {
+            properties: {
-        top: 0,
+                page: {
-        right: 0,
+                    margin: {
-        bottom: 0,
+                        top: 0,
-        left: 0,
+                        right: 0,
-    },
+                        bottom: 0,
-    children: [
+                        left: 0,
-        new Paragraph({
+                    },
+                },
+            },
             children: [
-                new TextRun("Hello World"),
+                new Paragraph({
-                new TextRun({
+                    children: [
-                    text: "Foo bar",
+                        new TextRun("Hello World"),
-                    bold: true,
+                        new TextRun({
+                            text: "Foo bar",
+                            bold: true,
+                        }),
+                        new TextRun({
+                            children: [new Tab(), "Github is the best"],
+                            bold: true,
+                        }),
+                    ],
                 }),
-                new TextRun({
+                new Paragraph({
-                    text: "\tGithub is the best",
+                    text: "Hello World",
-                    bold: true,
+                    heading: HeadingLevel.HEADING_1,
                 }),
+                new Paragraph("Foo bar"),
+                new Paragraph("Github is the best"),
             ],
-        }),
+        },
-        new Paragraph({
-            text: "Hello World",
-            heading: HeadingLevel.HEADING_1,
-        }),
-        new Paragraph("Foo bar"),
-        new Paragraph("Github is the best"),
     ],
 });
 

demo/60-track-revisions.ts

@@ -0,0 +1,164 @@
+// Track Revisions aka. "Track Changes"
+
+import * as fs from "fs";
+import {
+    AlignmentType,
+    DeletedTextRun,
+    Document,
+    Footer,
+    FootnoteReferenceRun,
+    InsertedTextRun,
+    Packer,
+    PageNumber,
+    Paragraph,
+    ShadingType,
+    Tab,
+    TextRun,
+} from "docx";
+
+/*
+    For reference, see
+    - https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.wordprocessing.insertedrun
+    - https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.wordprocessing.deletedrun
+
+    The setting `features: { trackRevisions: true }` adds an element `<w:trackRevisions />` to the `settings.xml` file.
+    This specifies that the application shall track *new* revisions made to the existing document.
+    See also https://docs.microsoft.com/en-us/dotnet/api/documentformat.openxml.wordprocessing.trackrevisions
+
+    Note that this setting enables to track *new changes* after teh file is generated, so this example will still
+    show inserted and deleted text runs when you remove it.
+*/
+
+const paragraph = new Paragraph({
+    children: [
+        new TextRun("This is a simple demo "),
+        new TextRun({
+            text: "on how to ",
+        }),
+        new InsertedTextRun({
+            text: "mark a text as an insertion ",
+            id: 0,
+            author: "Firstname Lastname",
+            date: "2020-10-06T09:00:00Z",
+        }),
+        new DeletedTextRun({
+            text: "or a deletion.",
+            id: 1,
+            author: "Firstname Lastname",
+            date: "2020-10-06T09:00:00Z",
+        }),
+    ],
+});
+
+const doc = new Document({
+    footnotes: {
+        1: {
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("This is a footnote"),
+                        new DeletedTextRun({
+                            text: " with some extra text which was deleted",
+                            id: 0,
+                            author: "Firstname Lastname",
+                            date: "2020-10-06T09:05:00Z",
+                        }),
+                        new InsertedTextRun({
+                            text: " and new content",
+                            id: 1,
+                            author: "Firstname Lastname",
+                            date: "2020-10-06T09:05:00Z",
+                        }),
+                    ],
+                }),
+            ],
+        },
+    },
+    features: {
+        trackRevisions: true,
+    },
+    sections: [
+        {
+            properties: {},
+            children: [
+                paragraph,
+                new Paragraph({
+                    children: [
+                        new TextRun("This is a demo "),
+                        new DeletedTextRun({
+                            break: 1,
+                            text: "in order",
+                            color: "ff0000",
+                            bold: true,
+                            size: 24,
+                            font: {
+                                name: "Garamond",
+                            },
+                            shading: {
+                                type: ShadingType.REVERSE_DIAGONAL_STRIPE,
+                                color: "00FFFF",
+                                fill: "FF0000",
+                            },
+                            id: 2,
+                            author: "Firstname Lastname",
+                            date: "2020-10-06T09:00:00Z",
+                        }),
+                        new InsertedTextRun({
+                            text: "to show how to ",
+                            bold: false,
+                            id: 3,
+                            author: "Firstname Lastname",
+                            date: "2020-10-06T09:05:00Z",
+                        }),
+                        new TextRun({
+                            bold: true,
+                            children: [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,
+                            },
+                        }),
+                    ],
+                }),
+            ],
+            footers: {
+                default: new Footer({
+                    children: [
+                        new Paragraph({
+                            alignment: AlignmentType.CENTER,
+                            children: [
+                                new TextRun("Awesome LLC"),
+                                new TextRun({
+                                    children: ["Page Number: ", PageNumber.CURRENT],
+                                }),
+                                new DeletedTextRun({
+                                    children: [" to ", PageNumber.TOTAL_PAGES],
+                                    id: 4,
+                                    author: "Firstname Lastname",
+                                    date: "2020-10-06T09:05:00Z",
+                                }),
+                                new InsertedTextRun({
+                                    children: [" from ", PageNumber.TOTAL_PAGES],
+                                    bold: true,
+                                    id: 5,
+                                    author: "Firstname Lastname",
+                                    date: "2020-10-06T09:05:00Z",
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            },
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/61-text-frame.ts

@@ -0,0 +1,186 @@
+// Text Frame (Text Box) example
+
+import * as fs from "fs";
+import {
+    AlignmentType,
+    BorderStyle,
+    Document,
+    FrameAnchorType,
+    HorizontalPositionAlign,
+    Packer,
+    Paragraph,
+    Tab,
+    TextRun,
+    VerticalPositionAlign,
+} from "docx";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {},
+            children: [
+                new Paragraph({
+                    frame: {
+                        type: "absolute",
+                        position: {
+                            x: 1000,
+                            y: 3000,
+                        },
+                        width: 4000,
+                        height: 1000,
+                        anchor: {
+                            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,
+                        },
+                    },
+                    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.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,
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/62-paragraph-spacing.ts

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

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

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

demo/64-complex-numbering-text.ts

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

demo/65-page-sizes.ts

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

demo/66-fields.ts

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

demo/67-column-break.ts

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

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

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

demo/69-different-width-columns.ts

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

demo/7-landscape.ts

@@ -1,15 +1,21 @@
 // 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();
+const doc = new Document({
-
+    sections: [
-doc.addSection({
+        {
-    size: {
+            properties: {
-        orientation: PageOrientation.LANDSCAPE,
+                page: {
-    },
+                    size: {
-    children: [new Paragraph("Hello World")],
+                        orientation: PageOrientation.LANDSCAPE,
+                    },
+                },
+            },
+            children: [new Paragraph("Hello World")],
+        },
+    ],
 });
 
 Packer.toBuffer(doc).then((buffer) => {

demo/70-line-numbers-suppression.ts

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

demo/71-page-borders-2.ts

@@ -0,0 +1,63 @@
+// Example demonstrating page borders with style, colors and size
+
+import * as fs from "fs";
+import { Document, Packer, TextRun, Paragraph, BorderStyle, PageBorderDisplay, PageBorderOffsetFrom, PageBorderZOrder } from "docx";
+
+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,138 @@
+// Simple example to add comments to a document
+
+import * as fs from "fs";
+import { Document, Packer, Paragraph, TextRun, CommentRangeStart, CommentRangeEnd, CommentReference } 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 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"));