Version bump

build(deps-dev): bump vite-plugin-dts from 2.3.0 to 3.3.1

.cspell.json

@@ -7,31 +7,35 @@
     "dictionaries": ["en_US", "typescript", "softwareTerms", "fonts", "npm"],
     // words - list of words to be always considered correct
     "words": [
-        "Xmlable",
+        "Abjad",
+        "aiueo",
+        "ATLEAST",
+        "chosung",
+        "clippy",
+        "datas",
+        "docsify",
+        "dolan",
+        "execa",
+        "falsey",
+        "iife",
+        "Initializable",
+        "iroha",
+        "jsonify",
+        "jszip",
+        "NUMPAGES",
+        "odttf",
+        "ondata",
+        "onfile",
+        "ooxml",
+        "panose",
+        "rels",
+        "rsid",
         "twip",
         "twips",
-        "jsonify",
-        "falsey",
-        "aiueo",
-        "iroha",
-        "aiueo",
-        "iroha",
-        "chosung",
-        "Abjad",
-        "Initializable",
-        "rels",
-        "dolan",
-        "xmlify",
-        "Xmlifyed",
+        "Xmlable",
         "xmlified",
-        "datas",
-        "jszip",
-        "rsid",
-        "NUMPAGES",
-        "ATLEAST",
-        "ooxml",
-        "clippy",
-        "docsify"
+        "xmlify",
+        "Xmlifyed"
     ],
     "ignoreRegExpList": [
         "/\"w:.+\"/",
@@ -47,9 +51,11 @@
         "/xmlKeys = {[^}]+}/g",
         "/\\.to\\.deep\\.equal\\({[^)]+}\\)/g",
         "\\.to\\.include\\.members\\(\\[[^\\]]+]\\)",
-        "/new [a-zA-Z]+\\({[^£]+}\\)/g"
+        "/new [a-zA-Z]+\\({[^£]+}\\)/g",
+        "/<element name=\"[a-z]+\"/gi",
+        "/<attribute name=\"[a-z]+\"/gi"
     ],
-    "ignorePaths": ["package.json", "docs/api"],
+    "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.

.eslintrc.js

@@ -1,270 +0,0 @@
-/*
-👋 Hi! This file was autogenerated by tslint-to-eslint-config.
-https://github.com/typescript-eslint/tslint-to-eslint-config
-
-It represents the closest reasonable ESLint configuration to this
-project's original TSLint configuration.
-
-We recommend eventually switching this configuration to extend from
-the recommended rulesets in typescript-eslint.
-https://github.com/typescript-eslint/tslint-to-eslint-config/blob/master/docs/FAQs.md
-
-Happy linting! 💖
-*/
-module.exports = {
-    extends: "eslint:recommended",
-    env: {
-        browser: true,
-        es6: true,
-        node: true,
-    },
-    parser: "@typescript-eslint/parser",
-    parserOptions: {
-        project: "tsconfig.json",
-        sourceType: "module",
-    },
-    plugins: [
-        "eslint-plugin-import",
-        "eslint-plugin-no-null",
-        "eslint-plugin-unicorn",
-        "eslint-plugin-jsdoc",
-        "eslint-plugin-prefer-arrow",
-        "@typescript-eslint",
-        "functional",
-    ],
-    root: true,
-    rules: {
-        "no-undef": "off",
-        "no-extra-boolean-cast": "off",
-        "no-alert": "error",
-        "no-self-compare": "error",
-        "no-unreachable-loop": "error",
-        "no-template-curly-in-string": "error",
-        "no-unused-private-class-members": "error",
-        "no-extend-native": "error",
-        "no-floating-decimal": "error",
-        "no-implied-eval": "error",
-        "no-iterator": "error",
-        "no-lone-blocks": "error",
-        "no-loop-func": "error",
-        "no-new-object": "error",
-        "no-proto": "error",
-        "no-useless-catch": "error",
-        "one-var-declaration-per-line": "error",
-        "prefer-arrow-callback": "error",
-        "prefer-destructuring": "error",
-        "prefer-exponentiation-operator": "error",
-        "prefer-promise-reject-errors": "error",
-        "prefer-regex-literals": "error",
-        "prefer-spread": "error",
-        "prefer-template": "error",
-        "require-await": "error",
-        "@typescript-eslint/adjacent-overload-signatures": "error",
-        "@typescript-eslint/array-type": [
-            "error",
-            {
-                default: "array",
-            },
-        ],
-        "@typescript-eslint/ban-types": [
-            "error",
-            {
-                types: {
-                    Object: {
-                        message: "Avoid using the `Object` type. Did you mean `object`?",
-                    },
-                    Function: {
-                        message: "Avoid using the `Function` type. Prefer a specific function type, like `() => void`.",
-                    },
-                    Boolean: {
-                        message: "Avoid using the `Boolean` type. Did you mean `boolean`?",
-                    },
-                    Number: {
-                        message: "Avoid using the `Number` type. Did you mean `number`?",
-                    },
-                    String: {
-                        message: "Avoid using the `String` type. Did you mean `string`?",
-                    },
-                    Symbol: {
-                        message: "Avoid using the `Symbol` type. Did you mean `symbol`?",
-                    },
-                },
-            },
-        ],
-        "@typescript-eslint/consistent-type-assertions": "error",
-        "@typescript-eslint/dot-notation": "error",
-        "@typescript-eslint/explicit-function-return-type": [
-            "error",
-            {
-                allowExpressions: false,
-                allowTypedFunctionExpressions: false,
-                allowHigherOrderFunctions: false,
-                allowDirectConstAssertionInArrowFunctions: true,
-                allowConciseArrowFunctionExpressionsStartingWithVoid: true,
-            },
-        ],
-        "@typescript-eslint/explicit-member-accessibility": [
-            "error",
-            {
-                accessibility: "explicit",
-                overrides: {
-                    accessors: "explicit",
-                },
-            },
-        ],
-        "@typescript-eslint/explicit-module-boundary-types": [
-            "error",
-            {
-                allowArgumentsExplicitlyTypedAsAny: true,
-                allowDirectConstAssertionInArrowFunctions: true,
-                allowHigherOrderFunctions: false,
-                allowTypedFunctionExpressions: false,
-            },
-        ],
-        "@typescript-eslint/naming-convention": [
-            "error",
-            {
-                selector: ["objectLiteralProperty"],
-                leadingUnderscore: "allow",
-                format: ["camelCase", "PascalCase"],
-                filter: {
-                    regex: "(^[a-z]+:.+)|_attr|[0-9]",
-                    match: false,
-                },
-            },
-        ],
-        "@typescript-eslint/no-empty-function": "error",
-        "@typescript-eslint/no-empty-interface": "error",
-        "@typescript-eslint/no-explicit-any": "error",
-        "@typescript-eslint/no-misused-new": "error",
-        "@typescript-eslint/no-namespace": "error",
-        "@typescript-eslint/no-parameter-properties": "off",
-        "@typescript-eslint/no-require-imports": "error",
-        "@typescript-eslint/no-shadow": [
-            "error",
-            {
-                hoist: "all",
-            },
-        ],
-        "@typescript-eslint/no-this-alias": "error",
-        "@typescript-eslint/no-unused-expressions": "error",
-        "@typescript-eslint/no-use-before-define": "off",
-        "@typescript-eslint/no-var-requires": "error",
-        "@typescript-eslint/prefer-for-of": "error",
-        "@typescript-eslint/prefer-function-type": "error",
-        "@typescript-eslint/prefer-namespace-keyword": "error",
-        "@typescript-eslint/prefer-readonly": "error",
-        "@typescript-eslint/triple-slash-reference": [
-            "error",
-            {
-                path: "always",
-                types: "prefer-import",
-                lib: "always",
-            },
-        ],
-        "@typescript-eslint/typedef": [
-            "error",
-            {
-                parameter: true,
-                propertyDeclaration: true,
-            },
-        ],
-        "@typescript-eslint/unified-signatures": "error",
-        "arrow-body-style": "error",
-        complexity: "off",
-        "consistent-return": "error",
-        "constructor-super": "error",
-        curly: "error",
-        "dot-notation": "off",
-        eqeqeq: ["error", "smart"],
-        "guard-for-in": "error",
-        "id-denylist": ["error", "any", "Number", "number", "String", "string", "Boolean", "boolean", "Undefined", "undefined"],
-        "id-match": "error",
-        "import/no-default-export": "error",
-        "import/no-extraneous-dependencies": "off",
-        "import/no-internal-modules": "off",
-        "import/order": "error",
-        indent: "off",
-        "jsdoc/check-alignment": "error",
-        "jsdoc/check-indentation": "off",
-        "jsdoc/newline-after-description": "error",
-        "max-classes-per-file": "off",
-        "max-len": "off",
-        "new-parens": "error",
-        "no-bitwise": "error",
-        "no-caller": "error",
-        "no-cond-assign": "error",
-        "no-console": "error",
-        "no-debugger": "error",
-        "no-duplicate-case": "error",
-        "no-duplicate-imports": "error",
-        "no-empty": "error",
-        "no-empty-function": "off",
-        "no-eval": "error",
-        "no-extra-bind": "error",
-        "no-fallthrough": "off",
-        "no-invalid-this": "off",
-        "no-multiple-empty-lines": "error",
-        "no-new-func": "error",
-        "no-new-wrappers": "error",
-        "no-null/no-null": "error",
-        "no-param-reassign": "error",
-        "no-redeclare": "error",
-        "no-return-await": "error",
-        "no-sequences": "error",
-        "no-shadow": "off",
-        "no-sparse-arrays": "error",
-        "no-template-curly-in-string": "error",
-        "no-throw-literal": "error",
-        "no-trailing-spaces": "error",
-        "no-undef-init": "error",
-        "no-underscore-dangle": ["error", { allow: ["_attr"] }],
-        "no-unsafe-finally": "error",
-        "no-unused-expressions": "off",
-        "no-unused-labels": "error",
-        "no-use-before-define": "off",
-        "no-useless-constructor": "error",
-        "no-var": "error",
-        "object-shorthand": "off",
-        "one-var": ["error", "never"],
-        "prefer-arrow/prefer-arrow-functions": "error",
-        "prefer-const": "error",
-        "prefer-object-spread": "error",
-        radix: "error",
-        "space-in-parens": ["error", "never"],
-        "spaced-comment": [
-            "error",
-            "always",
-            {
-                markers: ["/"],
-            },
-        ],
-        "unicorn/filename-case": "error",
-        "unicorn/prefer-ternary": "error",
-        "use-isnan": "error",
-        "valid-typeof": "off",
-        "@typescript-eslint/explicit-function-return-type": "off",
-        "functional/immutable-data": [
-            "error",
-            {
-                assumeTypes: true,
-                ignoreImmediateMutation: true,
-                ignoreAccessorPattern: ["**.root*", "**.numberingReferences*", "**.sections*", "**.properties*"],
-            },
-        ],
-        "functional/no-method-signature": "error",
-        "functional/no-mixed-type": "error",
-        "functional/prefer-readonly-type": "error",
-        "no-unused-vars": ["error", { argsIgnorePattern: "^[_]+$" }],
-    },
-    overrides: [
-        {
-            files: ["*.spec.ts"],
-            rules: {
-                "@typescript-eslint/no-unused-expressions": "off",
-                "@typescript-eslint/dot-notation": "off",
-                "prefer-destructuring": "off",
-            },
-        },
-    ],
-};

.eslintrc.yml

@@ -0,0 +1,239 @@
+extends: eslint:recommended
+env:
+    browser: true
+    es6: true
+    node: true
+parser: "@typescript-eslint/parser"
+parserOptions:
+    project:
+        - tsconfig.json
+        - demo/tsconfig.json
+    sourceType: module
+plugins:
+    - eslint-plugin-import
+    - eslint-plugin-no-null
+    - eslint-plugin-unicorn
+    - eslint-plugin-jsdoc
+    - eslint-plugin-prefer-arrow
+    - "@typescript-eslint"
+    - eslint-plugin-functional
+root: true
+rules:
+    no-undef: "off"
+    no-extra-boolean-cast: "off"
+    no-alert: error
+    no-self-compare: error
+    no-unreachable-loop: error
+    no-template-curly-in-string: error
+    no-unused-private-class-members: error
+    no-extend-native: error
+    no-floating-decimal: error
+    no-implied-eval: error
+    no-iterator: error
+    no-lone-blocks: error
+    no-loop-func: error
+    no-new-object: error
+    no-proto: error
+    no-useless-catch: error
+    one-var-declaration-per-line: error
+    prefer-arrow-callback: error
+    prefer-destructuring: error
+    prefer-exponentiation-operator: error
+    prefer-promise-reject-errors: error
+    prefer-regex-literals: error
+    prefer-spread: error
+    prefer-template: error
+    require-await: error
+    "@typescript-eslint/adjacent-overload-signatures": error
+    "@typescript-eslint/array-type":
+        - error
+        - default: array
+    "@typescript-eslint/ban-types":
+        - error
+        - types:
+              Object:
+                  message: Avoid using the `Object` type. Did you mean `object`?
+              Function:
+                  message: >-
+                      Avoid using the `Function` type. Prefer a specific function type,
+                      like `() => void`.
+              Boolean:
+                  message: Avoid using the `Boolean` type. Did you mean `boolean`?
+              Number:
+                  message: Avoid using the `Number` type. Did you mean `number`?
+              String:
+                  message: Avoid using the `String` type. Did you mean `string`?
+              Symbol:
+                  message: Avoid using the `Symbol` type. Did you mean `symbol`?
+    "@typescript-eslint/consistent-type-assertions": error
+    "@typescript-eslint/dot-notation": error
+    "@typescript-eslint/explicit-function-return-type":
+        - error
+        - allowExpressions: true
+          allowTypedFunctionExpressions: true
+          allowHigherOrderFunctions: false
+          allowDirectConstAssertionInArrowFunctions: true
+          allowConciseArrowFunctionExpressionsStartingWithVoid: true
+    "@typescript-eslint/explicit-member-accessibility":
+        - error
+        - accessibility: explicit
+          overrides:
+              accessors: explicit
+    "@typescript-eslint/explicit-module-boundary-types":
+        - error
+        - allowArgumentsExplicitlyTypedAsAny: true
+          allowDirectConstAssertionInArrowFunctions: true
+          allowHigherOrderFunctions: false
+          allowTypedFunctionExpressions: false
+    "@typescript-eslint/naming-convention":
+        - error
+        - selector:
+              - objectLiteralProperty
+          leadingUnderscore: allow
+          format:
+              - camelCase
+              - PascalCase
+          filter:
+              regex: (^[a-z]+:.+)|_attr|[0-9]
+              match: false
+    "@typescript-eslint/no-empty-function": error
+    "@typescript-eslint/no-empty-interface": error
+    "@typescript-eslint/no-explicit-any": error
+    "@typescript-eslint/no-misused-new": error
+    "@typescript-eslint/no-namespace": error
+    "@typescript-eslint/no-parameter-properties": "off"
+    "@typescript-eslint/no-require-imports": error
+    "@typescript-eslint/no-shadow":
+        - error
+        - hoist: all
+    "@typescript-eslint/no-this-alias": error
+    "@typescript-eslint/no-unused-expressions": error
+    "@typescript-eslint/no-use-before-define": "off"
+    "@typescript-eslint/no-var-requires": error
+    "@typescript-eslint/prefer-for-of": error
+    "@typescript-eslint/prefer-function-type": error
+    "@typescript-eslint/prefer-namespace-keyword": error
+    "@typescript-eslint/prefer-readonly": error
+    "@typescript-eslint/triple-slash-reference":
+        - error
+        - path: always
+          types: prefer-import
+          lib: always
+    "@typescript-eslint/typedef":
+        - error
+        - parameter: true
+          propertyDeclaration: true
+    "@typescript-eslint/unified-signatures": error
+    arrow-body-style: error
+    complexity: "off"
+    consistent-return: error
+    constructor-super: error
+    curly: error
+    dot-notation: "off"
+    eqeqeq:
+        - error
+        - smart
+    guard-for-in: error
+    id-denylist:
+        - error
+        - any
+        - Number
+        - number
+        - String
+        - string
+        - Boolean
+        - boolean
+        - Undefined
+        - undefined
+    id-match: error
+    import/no-default-export: error
+    import/no-extraneous-dependencies: "off"
+    import/no-internal-modules: "off"
+    import/order: error
+    indent: "off"
+    jsdoc/check-alignment: error
+    jsdoc/check-indentation: "off"
+    max-classes-per-file: "off"
+    max-len: "off"
+    new-parens: error
+    no-bitwise: error
+    no-caller: error
+    no-cond-assign: error
+    no-console: error
+    no-debugger: error
+    no-duplicate-case: error
+    no-duplicate-imports: error
+    no-empty: error
+    no-empty-function: "off"
+    no-eval: error
+    no-extra-bind: error
+    no-fallthrough: "off"
+    no-invalid-this: "off"
+    no-multiple-empty-lines: error
+    no-new-func: error
+    no-new-wrappers: error
+    no-null/no-null: error
+    no-param-reassign: error
+    no-redeclare: error
+    no-return-await: error
+    no-sequences: error
+    no-shadow: "off"
+    no-sparse-arrays: error
+    no-throw-literal: error
+    no-trailing-spaces: error
+    no-undef-init: error
+    no-underscore-dangle:
+        - error
+        - allow:
+              - _attr
+    no-unsafe-finally: error
+    no-unused-expressions: "off"
+    no-unused-labels: error
+    no-use-before-define: "off"
+    no-useless-constructor: error
+    no-var: error
+    object-shorthand: "off"
+    one-var:
+        - error
+        - never
+    prefer-arrow/prefer-arrow-functions: error
+    prefer-const: error
+    prefer-object-spread: error
+    radix: error
+    space-in-parens:
+        - error
+        - never
+    spaced-comment:
+        - error
+        - always
+        - markers:
+              - /
+    unicorn/filename-case: error
+    unicorn/prefer-ternary: error
+    use-isnan: error
+    valid-typeof: "off"
+    functional/immutable-data:
+        - error
+        - assumeTypes: true
+          ignoreImmediateMutation: true
+          ignoreAccessorPattern:
+              - "**.root*"
+              - "**.numberingReferences*"
+              - "**.sections*"
+              - "**.properties*"
+    functional/prefer-property-signatures: error
+    functional/no-mixed-types: error
+    functional/prefer-readonly-type: error
+    no-unused-vars:
+        - error
+        - argsIgnorePattern: ^[_]+$
+ignorePatterns:
+    - vite.config.ts
+overrides:
+    - files:
+          - "*.spec.ts"
+      rules:
+          "@typescript-eslint/no-unused-expressions": "off"
+          "@typescript-eslint/dot-notation": "off"
+          prefer-destructuring: "off"
+          "@typescript-eslint/explicit-function-return-type": "off"

.github/dependabot.yml

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

.github/workflows/default.yml

@@ -32,9 +32,9 @@ jobs:
             - name: Install Dependencies
               run: npm ci --force
             - name: Test
-              run: npm run test.coverage
+              run: npm run test.ci
             - name: Codecov
-              uses: codecov/codecov-action@v1
+              uses: codecov/codecov-action@v3
               with:
                   fail_ci_if_error: true
                   verbose: true

.github/workflows/demos.yml

@@ -301,15 +301,6 @@ jobs:
               with:
                   xml-file: build/extracted-doc/word/document.xml
                   xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
-            - name: Run Demo
-              run: npm run ts-node -- ./demo/30-template-document.ts
-            - name: Extract Word Document
-              run: npm run extract
-            - name: Validate XML
-              uses: ChristophWurst/xmllint-action@v1
-              with:
-                  xml-file: build/extracted-doc/word/document.xml
-                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
             - name: Run Demo
               run: npm run ts-node -- ./demo/31-tables.ts
             - name: Extract Word Document
@@ -688,4 +679,121 @@ jobs:
               uses: ChristophWurst/xmllint-action@v1
               with:
                   xml-file: build/extracted-doc/word/document.xml
-                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/72-word-wrap.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/73-comments.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/73-comments.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            # - name: Run Demo
+            #   run: npm run ts-node -- ./demo/75-tab-stops.ts
+            # - name: Extract Word Document
+            #   run: npm run extract
+            # - name: Validate XML
+            #   uses: ChristophWurst/xmllint-action@v1
+            #   with:
+            #       xml-file: build/extracted-doc/word/document.xml
+            #       xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/76-compatibility.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/77-side-by-side-tables.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/78-thai-distributed.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/79-table-from-data-source.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/80-thai-distributed.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/81-continuous-header.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/82-new-headers-new-section.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/83-setting-languages.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd
+            - name: Run Demo
+              run: npm run ts-node -- ./demo/84-positional-tabs.ts
+            - name: Extract Word Document
+              run: npm run extract
+            - name: Validate XML
+              uses: ChristophWurst/xmllint-action@v1
+              with:
+                  xml-file: build/extracted-doc/word/document.xml
+                  xml-schema-file: ooxml-schemas/microsoft/wml-2010.xsd

.gitignore

@@ -60,5 +60,5 @@ My Document.docx
 # Temporary folder
 tmp
 
-# nyc
-.nyc_output
+# Exclude Mac .DS_Store files
+.DS_Store

.mocharc.json

@@ -1,13 +0,0 @@
-{
-    "diff": true,
-    "spec": "src/**/*.ts",
-    "extension": ["ts"],
-    "package": "./package.json",
-    "reporter": "spec",
-    "slow": "75",
-    "timeout": "2000",
-    "ui": "bdd",
-    "watch-files": ["src/**/*.ts"],
-    "watch-ignore": ["build", "demo"],
-    "require": ["mocha.env", "ts-node/register", "tsconfig-paths/register"]
-}

.npmignore

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

.npmrc

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

.nycrc

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

.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Run Demo",
+            "type": "node",
+            "request": "launch",
+            "runtimeArgs": [
+                "-r",
+                "${workspaceFolder}/node_modules/ts-node/register",
+                "-r",
+                "${workspaceFolder}/node_modules/tsconfig-paths/register"
+            ],
+            "cwd": "${workspaceRoot}",
+            "program": "${workspaceFolder}/demo/85-template-document.ts"
+        }
+    ]
+}

README.md

@@ -3,7 +3,7 @@
 </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>
 
 ---
@@ -12,7 +12,6 @@
 [![Downloads per month][downloads-image]][downloads-url]
 [![GitHub Action Workflow Status][github-actions-workflow-image]][github-actions-workflow-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]
 
@@ -29,11 +28,12 @@ Here are examples of `docx` being used with basic `HTML/JS` in a browser environ
 -   https://codepen.io/dolanmiu/pen/RwNeObg
 -   https://jsfiddle.net/dolanmiu/onadx1gu/
 
-Here is an example of `docx` working in `Angular`:
+Here are examples of `docx` working in `Angular`:
 
 -   https://stackblitz.com/edit/angular-docx
+-   https://stackblitz.com/edit/angular-wmd6k3
 
-Here is an example of `docx` working in `React`:
+Here are examples of `docx` working in `React`:
 
 -   https://stackblitz.com/edit/react-docx
 -   https://stackblitz.com/edit/react-docx-images (adding images to Word Document)
@@ -87,6 +87,7 @@ Read the contribution guidelines [here](https://docx.js.org/#/contribution-guide
 [<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/)
 
 ...and many more!
 
@@ -105,8 +106,6 @@ Made with 💖
 [github-actions-workflow-url]: https://github.com/dolanmiu/docx/actions
 [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

demo/1-basic.ts

@@ -1,7 +1,7 @@
 // Simple example to add text to a document
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, Packer, Paragraph, TextRun } from "../build";
+import { Document, Packer, Paragraph, Tab, TextRun } from "docx";
 
 const doc = new Document({
     sections: [
@@ -14,9 +14,10 @@ const doc = new Document({
                         new TextRun({
                             text: "Foo Bar",
                             bold: true,
+                            size: 40,
                         }),
                         new TextRun({
-                            text: "\tGithub is the best",
+                            children: [new Tab(), "Github is the best"],
                             bold: true,
                         }),
                     ],

demo/10-my-cv.ts

@@ -1,7 +1,7 @@
 // Generate a CV
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { AlignmentType, Document, HeadingLevel, Packer, Paragraph, TabStopPosition, TabStopType, TextRun } from "../build";
+import { AlignmentType, Document, HeadingLevel, Packer, Paragraph, Tab, TabStopPosition, TabStopType, TextRun } from "docx";
 
 // tslint:disable:no-shadowed-variable
 
@@ -284,7 +284,7 @@ class DocumentCreator {
                     bold: true,
                 }),
                 new TextRun({
-                    text: `\t${dateText}`,
+                    children: [new Tab(), dateText],
                     bold: true,
                 }),
             ],

demo/11-declaritive-styles-2.ts

@@ -1,5 +1,5 @@
 // Setting styles with JavaScript configuration
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
 import {
     AlignmentType,
@@ -16,7 +16,7 @@ import {
     TabStopPosition,
     UnderlineType,
     LevelFormat,
-} from "../build";
+} from "docx";
 
 const table = new Table({
     rows: [

demo/12-scaling-images.ts

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

demo/13-xml-styles.ts

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

demo/14-page-numbers.ts

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

demo/15-page-break-before.ts

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

demo/16-multiple-sections.ts

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

demo/17-footnotes.ts

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

demo/18-image-from-buffer.ts

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

demo/19-export-to-base64.ts

@@ -1,7 +1,7 @@
 // Export to base64 string - Useful in a browser environment.
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, Packer, Paragraph, TextRun } from "../build";
+import { Document, Packer, Paragraph, Tab, TextRun } from "docx";
 
 const doc = new Document({
     sections: [
@@ -15,7 +15,7 @@ const doc = new Document({
                             bold: true,
                         }),
                         new TextRun({
-                            text: "\tBar",
+                            children: [new Tab(), "Bar"],
                             bold: true,
                         }),
                     ],

demo/2-declaritive-styles.ts

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

demo/20-table-cell-borders.ts

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

demo/21-bookmarks.ts

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

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

@@ -1,7 +1,7 @@
 // This demo shows right to left for special languages
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, Packer, Paragraph, Table, TableCell, TableRow, TextRun } from "../build";
+import { Document, Packer, Paragraph, Table, TableCell, TableRow, TextRun } from "docx";
 
 const doc = new Document({
     sections: [

demo/23-base64-images.ts

@@ -1,7 +1,7 @@
 // This demo adds an image to the Media cache, and then insert to the document afterwards
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, ImageRun, Packer, Paragraph, TextRun } from "../build";
+import { Document, ImageRun, Packer, Paragraph, TextRun } from "docx";
 
 const imageBase64Data = `iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAMAAAD04JH5AAACzVBMVEUAAAAAAAAAAAAAAAA/AD8zMzMqKiokJCQfHx8cHBwZGRkuFxcqFSonJyckJCQiIiIfHx8eHh4cHBwoGhomGSYkJCQhISEfHx8eHh4nHR0lHBwkGyQjIyMiIiIgICAfHx8mHh4lHh4kHR0jHCMiGyIhISEgICAfHx8lHx8kHh4jHR0hHCEhISEgICAlHx8kHx8jHh4jHh4iHSIhHCEhISElICAkHx8jHx8jHh4iHh4iHSIhHSElICAkICAjHx8jHx8iHh4iHh4hHiEhHSEkICAjHx8iHx8iHx8hHh4hHiEkHSEjHSAjHx8iHx8iHx8hHh4kHiEkHiEjHSAiHx8hHx8hHh4kHiEjHiAjHSAiHx8iHx8hHx8kHh4jHiEjHiAjHiAiICAiHx8kHx8jHh4jHiEjHiAiHiAiHSAiHx8jHx8jHx8jHiAiHiAiHiAiHSAiHx8jHx8jHx8iHiAiHiAiHiAjHx8jHx8jHx8jHx8iHiAiHiAiHiAjHx8jHx8jHx8iHx8iHSAiHiAjHiAjHx8jHx8hHx8iHx8iHyAiHiAjHiAjHiAjHh4hHx8iHx8iHx8iHyAjHSAjHiAjHiAjHh4hHx8iHx8iHx8jHyAjHiAhHh4iHx8iHx8jHyAjHSAjHSAhHiAhHh4iHx8iHx8jHx8jHyAjHSAjHSAiHh4iHh4jHx8jHx8jHyAjHyAhHSAhHSAiHh4iHh4jHx8jHx8jHyAhHyAhHSAiHSAiHh4jHh4jHx8jHx8jHyAhHyAhHSAiHSAjHR4jHh4jHx8jHx8hHyAhHyAiHSAjHSAjHR4jHh4jHx8hHx8hHyAhHyAiHyAjHSAjHR4jHR4hHh4hHx8hHyAiHyAjHyAjHSAjHR4jHR4hHh4hHx8hHyAjHyAjHyAjHSAjHR4hHR4hHR4hHx8iHyAjHyAjHyAjHSAhHR4hHR4hHR4hHx8jHyAjHyAjHyAjHyC9S2xeAAAA7nRSTlMAAQIDBAUGBwgJCgsMDQ4PEBESExQVFxgZGhscHR4fICEiIyQlJicoKSorLS4vMDEyMzQ1Njc4OTo7PD0+P0BBQkNERUZISUpLTE1OUFFSU1RVVllaW1xdXmBhYmNkZWZnaGprbG1ub3Byc3R1dnd4eXp8fn+AgYKDhIWGiImKi4yNj5CRkpOUlZaXmJmam5ydnp+goaKjpKaoqqusra6vsLGys7S1tri5uru8vb6/wMHCw8TFxsfIycrLzM3Oz9DR0tPU1dbX2Nna29zd3t/g4eLj5OXm5+jp6uvs7e7v8PHy8/T19vf4+fr7/P3+fkZpVQAABcBJREFUGBntwftjlQMcBvDnnLNL22qzJjWlKLHFVogyty3SiFq6EZliqZGyhnSxsLlMRahYoZKRFcul5dKFCatYqWZaNKvWtrPz/A2+7/b27qRzec/lPfvl/XxgMplMJpPJZDKZAtA9HJ3ppnIez0KnSdtC0RCNznHdJrbrh85wdSlVVRaEXuoGamYi5K5430HNiTiEWHKJg05eRWgNfKeV7RxbqUhGKPV/207VupQ8is0IoX5vtFC18SqEHaK4GyHTZ2kzVR8PBTCO4oANIZL4ShNVZcOhKKeYg9DoWdhI1ec3os2VFI0JCIUez5+i6st0qJZRrEAIJCw+QdW223BG/EmKwTBc/IJ/qfp2FDrkUnwFo8U9dZyqnaPhxLqfYjyM1S3vb6p+GGOBszsojoTDSDFz6qj66R4LzvYJxVMwUNRjf1H1ywQr/megg2RzLximy8waqvbda8M5iijegVEiHjlM1W/3h+FcXesphsMY4dMOUnUgOxyuPEzxPQwRNvV3qg5Nj4BreyimwADWe/dRVTMjEm6MoGLzGwtystL6RyOY3qSqdlYU3FpLZw1VW0sK5943MvUCKwJ1noNtjs6Ohge76Zq9ZkfpigU5WWkDYuCfbs1U5HWFR8/Qq4a9W0uK5k4ZmdrTCl8spGIePLPlbqqsc1Afe83O0hULc8alDYiBd7ZyitYMeBfR55rR2fOKP6ioPk2dGvZ+UVI0d8rtqT2tcCexlqK2F3wRn5Q+YVbBqrLKOupkr9lZujAOrmS0UpTb4JeIPkNHZ+cXr6uoPk2vyuBSPhWLEKj45PQJuQWryyqP0Z14uGLdROHIRNBEXDR09EP5r62rOHCazhrD4VKPwxTH+sIA3ZPTJ+YuWV22n+IruHFDC8X2CBjnPoolcGc2FYUwzmsUWXDHsoGKLBhmN0VvuBVfTVE/AAbpaid5CB4MbaLY1QXGuIViLTyZQcVyGGMuxWPwaA0Vk2GI9RRp8Ci2iuLkIBjhT5LNUfAspZFiTwyC72KK7+DNg1SsRvCNp3gZXq2k4iEEXSHFJHgVXUlxejCCbTvFAHiXdIJiXxyCK7KJ5FHoMZGK9xBcwyg2QpdlVMxEUM2iyIMuXXZQNF+HswxMsSAAJRQjoE//eoqDCXBSTO6f1xd+O0iyNRY6jaWi1ALNYCocZROj4JdEikroVkjFk9DcStXxpdfCD2MoXodu4RUU9ptxxmXssOfxnvDVcxRTod9FxyhqLoAqis5aPhwTDp9spRgEH2Q6KLbYoKqlaKTm6Isp0C/sJMnjFvhiERXPQvUNRe9p29lhR04CdBpC8Sl8YiuncIxEuzUUg4Dkgj+paVozygY9plPMh28SaymO9kabAopREGF3vt9MzeFFl8G7lRSZ8FFGK8XX4VA8QjEd7XrM3M0OXz8YCy+qKBLgq3wqnofiTorF0Ax56Rg1J1elW+BBAsVe+My6iYq7IK6keBdOIseV2qn5Pb8f3MqkWAXf9ThM8c8lAOIotuFsF875lRrH5klRcG0+xcPwQ1oLxfeRAP4heQTnGL78X2rqlw2DK59SXAV/zKaiGMAuko5InCt68mcOan5+ohf+z1pP8lQY/GHZQMV4YD3FpXDp4qerqbF/lBWBswyi+AL+ia+maLgcRRQj4IYlY/UpauqKBsPJAxQF8NM1TRQ/RudSPAD34rK3scOuR8/HGcspxsJfOVS8NZbiGXiUtPgINU3v3WFDmx8pEuG3EiqKKVbCC1vm2iZqap5LAtCtleQf8F9sFYWDohzeJczYyQ4V2bEZFGsQgJRGqqqhS2phHTWn9lDkIhBTqWqxQZ+IsRvtdHY9AvI2VX2hW68nfqGmuQsCEl3JdjfCF8OW1bPdtwhQ0gm2mQzfRE3a7KCYj0BNZJs8+Kxf/r6WtTEI2FIqlsMfFgRB5A6KUnSe/vUkX0AnuvUIt8SjM1m6wWQymUwmk8lkMgXRf5vi8rLQxtUhAAAAAElFTkSuQmCC`;
 

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

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

demo/25-table-xml-styles.ts

@@ -1,7 +1,7 @@
 // Example of how you would create a table and add data to it
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, Packer, Paragraph, Table, TableCell, TableRow, WidthType } from "../build";
+import { Document, Packer, Paragraph, Table, TableCell, TableRow, WidthType } from "docx";
 
 const styles = fs.readFileSync("./demo/assets/custom-styles.xml", "utf-8");
 

demo/26-paragraph-borders.ts

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

demo/27-declaritive-styles-3.ts

@@ -1,7 +1,7 @@
 // Custom styles using JavaScript configuration
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, convertInchesToTwip, HeadingLevel, Packer, Paragraph, UnderlineType } from "../build";
+import { Document, convertInchesToTwip, HeadingLevel, Packer, Paragraph, UnderlineType } from "docx";
 
 const doc = new Document({
     styles: {

demo/28-table-of-contents.ts

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

demo/29-numbered-lists.ts

@@ -1,8 +1,8 @@
 // Numbered lists
 // The lists can also be restarted by specifying the instance number
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { AlignmentType, convertInchesToTwip, Document, HeadingLevel, LevelFormat, Packer, Paragraph } from "../build";
+import { AlignmentType, convertInchesToTwip, Document, HeadingLevel, LevelFormat, Packer, Paragraph } from "docx";
 
 const doc = new Document({
     numbering: {

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

@@ -1,7 +1,7 @@
 // Numbering and bullet points example
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { AlignmentType, convertInchesToTwip, Document, Footer, Header, HeadingLevel, LevelFormat, Packer, Paragraph } from "../build";
+import { AlignmentType, convertInchesToTwip, Document, Footer, Header, HeadingLevel, LevelFormat, Packer, Paragraph } from "docx";
 
 const doc = new Document({
     numbering: {

demo/30-template-document.ts

@@ -1,35 +0,0 @@
-// Example on how to use a template document
-// Import from 'docx' rather than '../build' if you install from npm
-import * as fs from "fs";
-import { Document, ImportDotx, Packer, Paragraph } from "../build";
-
-const importDotx = new ImportDotx();
-const filePath = "./demo/dotx/template.dotx";
-
-fs.readFile(filePath, (err, data) => {
-    if (err) {
-        throw new Error(`Failed to read file ${filePath}.`);
-    }
-
-    importDotx.extract(data).then((templateDocument) => {
-        const doc = new Document(
-            {
-                sections: [
-                    {
-                        properties: {
-                            titlePage: templateDocument.titlePageIsDefined,
-                        },
-                        children: [new Paragraph("Hello World")],
-                    },
-                ],
-            },
-            {
-                template: templateDocument,
-            },
-        );
-
-        Packer.toBuffer(doc).then((buffer) => {
-            fs.writeFileSync("My Document.docx", buffer);
-        });
-    });
-});

demo/31-tables.ts

@@ -1,7 +1,7 @@
 // Example of how you would create a table and add data to it
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, HeadingLevel, Packer, Paragraph, Table, TableCell, TableRow, VerticalAlign, TextDirection } from "../build";
+import { Document, HeadingLevel, Packer, Paragraph, Table, TableCell, TableRow, VerticalAlign, TextDirection } from "docx";
 
 const doc = new Document({
     sections: [

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

@@ -1,6 +1,6 @@
 // Example of how you would merge cells together (Rows and Columns) and apply shading
 // Also includes an example on how to center tables
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
 import {
     AlignmentType,
@@ -15,7 +15,7 @@ import {
     TableCell,
     TableRow,
     WidthType,
-} from "../build";
+} from "docx";
 
 const table = new Table({
     rows: [

demo/33-sequential-captions.ts

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

demo/34-floating-tables.ts

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

demo/35-hyperlinks.ts

@@ -1,9 +1,21 @@
 // Example on how to add hyperlinks to websites
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, ExternalHyperlink, Footer, FootnoteReferenceRun, ImageRun, Packer, Paragraph, TextRun } from "../build";
+import { Document, ExternalHyperlink, Footer, FootnoteReferenceRun, ImageRun, Packer, Paragraph, TextRun } from "docx";
 
 const doc = new Document({
+    styles: {
+        default: {
+            hyperlink: {
+                run: {
+                    color: "FF0000",
+                    underline: {
+                        color: "0000FF",
+                    },
+                },
+            },
+        },
+    },
     footnotes: {
         1: {
             children: [

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

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

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

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

demo/38-text-wrapping.ts

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

demo/39-page-numbers.ts

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

demo/4-basic-table.ts

@@ -1,7 +1,7 @@
 // Example of how you would create a table and add data to it
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, Packer, Paragraph, Table, TableCell, TableRow, WidthType } from "../build";
+import { Document, Packer, Paragraph, Table, TableCell, TableRow, WidthType } from "docx";
 
 const table = new Table({
     columnWidths: [3505, 5505],

demo/40-line-numbers.ts

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

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

@@ -1,7 +1,7 @@
 // Multiple cells merging in the same table - Rows and Columns
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, Packer, Paragraph, Table, TableCell, TableRow } from "../build";
+import { Document, Packer, Paragraph, Table, TableCell, TableRow } from "docx";
 
 const table = new Table({
     rows: [

demo/42-restart-page-numbers.ts

@@ -1,7 +1,7 @@
 // Page numbers - Start from 0 on a new section
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { AlignmentType, Document, Header, Packer, PageBreak, PageNumber, PageNumberSeparator, Paragraph, TextRun } from "../build";
+import { AlignmentType, Document, Header, Packer, PageBreak, PageNumber, PageNumberSeparator, Paragraph, TextRun } from "docx";
 
 const doc = new Document({
     sections: [

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

@@ -1,7 +1,7 @@
 // Add image to table cell
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, ImageRun, Packer, Paragraph, Table, TableCell, TableRow, WidthType } from "../build";
+import { Document, ImageRun, Packer, Paragraph, Table, TableCell, TableRow, WidthType } from "docx";
 
 const imageBase64Data = `iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAMAAAD04JH5AAACzVBMVEUAAAAAAAAAAAAAAAA/AD8zMzMqKiokJCQfHx8cHBwZGRkuFxcqFSonJyckJCQiIiIfHx8eHh4cHBwoGhomGSYkJCQhISEfHx8eHh4nHR0lHBwkGyQjIyMiIiIgICAfHx8mHh4lHh4kHR0jHCMiGyIhISEgICAfHx8lHx8kHh4jHR0hHCEhISEgICAlHx8kHx8jHh4jHh4iHSIhHCEhISElICAkHx8jHx8jHh4iHh4iHSIhHSElICAkICAjHx8jHx8iHh4iHh4hHiEhHSEkICAjHx8iHx8iHx8hHh4hHiEkHSEjHSAjHx8iHx8iHx8hHh4kHiEkHiEjHSAiHx8hHx8hHh4kHiEjHiAjHSAiHx8iHx8hHx8kHh4jHiEjHiAjHiAiICAiHx8kHx8jHh4jHiEjHiAiHiAiHSAiHx8jHx8jHx8jHiAiHiAiHiAiHSAiHx8jHx8jHx8iHiAiHiAiHiAjHx8jHx8jHx8jHx8iHiAiHiAiHiAjHx8jHx8jHx8iHx8iHSAiHiAjHiAjHx8jHx8hHx8iHx8iHyAiHiAjHiAjHiAjHh4hHx8iHx8iHx8iHyAjHSAjHiAjHiAjHh4hHx8iHx8iHx8jHyAjHiAhHh4iHx8iHx8jHyAjHSAjHSAhHiAhHh4iHx8iHx8jHx8jHyAjHSAjHSAiHh4iHh4jHx8jHx8jHyAjHyAhHSAhHSAiHh4iHh4jHx8jHx8jHyAhHyAhHSAiHSAiHh4jHh4jHx8jHx8jHyAhHyAhHSAiHSAjHR4jHh4jHx8jHx8hHyAhHyAiHSAjHSAjHR4jHh4jHx8hHx8hHyAhHyAiHyAjHSAjHR4jHR4hHh4hHx8hHyAiHyAjHyAjHSAjHR4jHR4hHh4hHx8hHyAjHyAjHyAjHSAjHR4hHR4hHR4hHx8iHyAjHyAjHyAjHSAhHR4hHR4hHR4hHx8jHyAjHyAjHyAjHyC9S2xeAAAA7nRSTlMAAQIDBAUGBwgJCgsMDQ4PEBESExQVFxgZGhscHR4fICEiIyQlJicoKSorLS4vMDEyMzQ1Njc4OTo7PD0+P0BBQkNERUZISUpLTE1OUFFSU1RVVllaW1xdXmBhYmNkZWZnaGprbG1ub3Byc3R1dnd4eXp8fn+AgYKDhIWGiImKi4yNj5CRkpOUlZaXmJmam5ydnp+goaKjpKaoqqusra6vsLGys7S1tri5uru8vb6/wMHCw8TFxsfIycrLzM3Oz9DR0tPU1dbX2Nna29zd3t/g4eLj5OXm5+jp6uvs7e7v8PHy8/T19vf4+fr7/P3+fkZpVQAABcBJREFUGBntwftjlQMcBvDnnLNL22qzJjWlKLHFVogyty3SiFq6EZliqZGyhnSxsLlMRahYoZKRFcul5dKFCatYqWZaNKvWtrPz/A2+7/b27qRzec/lPfvl/XxgMplMJpPJZDKZAtA9HJ3ppnIez0KnSdtC0RCNznHdJrbrh85wdSlVVRaEXuoGamYi5K5430HNiTiEWHKJg05eRWgNfKeV7RxbqUhGKPV/207VupQ8is0IoX5vtFC18SqEHaK4GyHTZ2kzVR8PBTCO4oANIZL4ShNVZcOhKKeYg9DoWdhI1ec3os2VFI0JCIUez5+i6st0qJZRrEAIJCw+QdW223BG/EmKwTBc/IJ/qfp2FDrkUnwFo8U9dZyqnaPhxLqfYjyM1S3vb6p+GGOBszsojoTDSDFz6qj66R4LzvYJxVMwUNRjf1H1ywQr/megg2RzLximy8waqvbda8M5iijegVEiHjlM1W/3h+FcXesphsMY4dMOUnUgOxyuPEzxPQwRNvV3qg5Nj4BreyimwADWe/dRVTMjEm6MoGLzGwtystL6RyOY3qSqdlYU3FpLZw1VW0sK5943MvUCKwJ1noNtjs6Ohge76Zq9ZkfpigU5WWkDYuCfbs1U5HWFR8/Qq4a9W0uK5k4ZmdrTCl8spGIePLPlbqqsc1Afe83O0hULc8alDYiBd7ZyitYMeBfR55rR2fOKP6ioPk2dGvZ+UVI0d8rtqT2tcCexlqK2F3wRn5Q+YVbBqrLKOupkr9lZujAOrmS0UpTb4JeIPkNHZ+cXr6uoPk2vyuBSPhWLEKj45PQJuQWryyqP0Z14uGLdROHIRNBEXDR09EP5r62rOHCazhrD4VKPwxTH+sIA3ZPTJ+YuWV22n+IruHFDC8X2CBjnPoolcGc2FYUwzmsUWXDHsoGKLBhmN0VvuBVfTVE/AAbpaid5CB4MbaLY1QXGuIViLTyZQcVyGGMuxWPwaA0Vk2GI9RRp8Ci2iuLkIBjhT5LNUfAspZFiTwyC72KK7+DNg1SsRvCNp3gZXq2k4iEEXSHFJHgVXUlxejCCbTvFAHiXdIJiXxyCK7KJ5FHoMZGK9xBcwyg2QpdlVMxEUM2iyIMuXXZQNF+HswxMsSAAJRQjoE//eoqDCXBSTO6f1xd+O0iyNRY6jaWi1ALNYCocZROj4JdEikroVkjFk9DcStXxpdfCD2MoXodu4RUU9ptxxmXssOfxnvDVcxRTod9FxyhqLoAqis5aPhwTDp9spRgEH2Q6KLbYoKqlaKTm6Isp0C/sJMnjFvhiERXPQvUNRe9p29lhR04CdBpC8Sl8YiuncIxEuzUUg4Dkgj+paVozygY9plPMh28SaymO9kabAopREGF3vt9MzeFFl8G7lRSZ8FFGK8XX4VA8QjEd7XrM3M0OXz8YCy+qKBLgq3wqnofiTorF0Ax56Rg1J1elW+BBAsVe+My6iYq7IK6keBdOIseV2qn5Pb8f3MqkWAXf9ThM8c8lAOIotuFsF875lRrH5klRcG0+xcPwQ1oLxfeRAP4heQTnGL78X2rqlw2DK59SXAV/zKaiGMAuko5InCt68mcOan5+ohf+z1pP8lQY/GHZQMV4YD3FpXDp4qerqbF/lBWBswyi+AL+ia+maLgcRRQj4IYlY/UpauqKBsPJAxQF8NM1TRQ/RudSPAD34rK3scOuR8/HGcspxsJfOVS8NZbiGXiUtPgINU3v3WFDmx8pEuG3EiqKKVbCC1vm2iZqap5LAtCtleQf8F9sFYWDohzeJczYyQ4V2bEZFGsQgJRGqqqhS2phHTWn9lDkIhBTqWqxQZ+IsRvtdHY9AvI2VX2hW68nfqGmuQsCEl3JdjfCF8OW1bPdtwhQ0gm2mQzfRE3a7KCYj0BNZJs8+Kxf/r6WtTEI2FIqlsMfFgRB5A6KUnSe/vUkX0AnuvUIt8SjM1m6wWQymUwmk8lkMgXRf5vi8rLQxtUhAAAAAElFTkSuQmCC`;
 

demo/44-multiple-columns.ts

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

demo/45-highlighting-text.ts

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

demo/46-shading-text.ts

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

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

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

demo/48-vertical-align.ts

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

demo/49-table-borders.ts

@@ -1,5 +1,5 @@
 // Add custom borders and no-borders to the table itself
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
 import {
     BorderStyle,
@@ -13,7 +13,7 @@ import {
     TableRow,
     TextDirection,
     VerticalAlign,
-} from "../build";
+} from "docx";
 
 const table = new Table({
     rows: [

demo/5-images.ts

@@ -1,5 +1,5 @@
 // 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,
@@ -10,7 +10,7 @@ import {
     Paragraph,
     VerticalPositionAlign,
     VerticalPositionRelativeFrom,
-} from "../build";
+} from "docx";
 
 const doc = new Document({
     sections: [
@@ -25,6 +25,11 @@ const doc = new Document({
                                 width: 100,
                                 height: 100,
                             },
+                            altText: {
+                                title: "This is an ultimate title",
+                                description: "This is an ultimate image",
+                                name: "My Ultimate Image",
+                            },
                         }),
                     ],
                 }),

demo/50-readme-demo.ts

@@ -1,7 +1,7 @@
 // The demo on the README.md
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, HeadingLevel, ImageRun, Packer, Paragraph, Table, TableCell, TableRow, VerticalAlign } from "../build";
+import { Document, HeadingLevel, ImageRun, Packer, Paragraph, Table, TableCell, TableRow, VerticalAlign } from "docx";
 
 const table = new Table({
     rows: [

demo/51-character-styles.ts

@@ -1,7 +1,7 @@
 // Custom character styles using JavaScript configuration
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, Packer, Paragraph, TextRun } from "../build";
+import { Document, Packer, Paragraph, TextRun } from "docx";
 
 const doc = new Document({
     styles: {

demo/52-japanese.ts

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

demo/53-chinese.ts

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

demo/54-custom-properties.ts

@@ -3,9 +3,8 @@
 // to the document in Word after the document has been generated. Standard properties (such as creator, title
 // and subject) cover typical use cases, but sometimes custom properties are required.
 
-// Import from 'docx' rather than '../build' if you install from npm
 import * as fs from "fs";
-import { Document, Packer } from "../build";
+import { Document, Packer } from "docx";
 
 const doc = new Document(
     // Standard properties

demo/55-math.ts

@@ -1,5 +1,5 @@
 // Simple example to add text to a document
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
 import {
     Document,
@@ -21,7 +21,7 @@ import {
     Packer,
     Paragraph,
     TextRun,
-} from "../build";
+} from "docx";
 
 const doc = new Document({
     sections: [

demo/56-background-color.ts

@@ -1,7 +1,7 @@
 // Change background colour of whole document
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, Packer, Paragraph, TextRun } from "../build";
+import { Document, Packer, Paragraph, Tab, TextRun } from "docx";
 
 const doc = new Document({
     background: {
@@ -19,7 +19,7 @@ const doc = new Document({
                             bold: true,
                         }),
                         new TextRun({
-                            text: "\tGithub is the best",
+                            children: [new Tab(), "Github is the best"],
                             bold: true,
                         }),
                     ],

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

@@ -1,7 +1,7 @@
 // Numbered lists - Add parent number in sub number
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { AlignmentType, convertInchesToTwip, Document, HeadingLevel, LevelFormat, Packer, Paragraph } from "../build";
+import { AlignmentType, convertInchesToTwip, Document, HeadingLevel, LevelFormat, Packer, Paragraph } from "docx";
 
 const doc = new Document({
     numbering: {

demo/58-section-types.ts

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

demo/59-header-footer-margins.ts

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

demo/6-page-borders.ts

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

demo/60-track-revisions.ts

@@ -1,5 +1,5 @@
 // Track Revisions aka. "Track Changes"
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
 import {
     AlignmentType,
@@ -12,8 +12,9 @@ import {
     PageNumber,
     Paragraph,
     ShadingType,
+    Tab,
     TextRun,
-} from "../build";
+} from "docx";
 
 /*
     For reference, see
@@ -111,7 +112,7 @@ const doc = new Document({
                         }),
                         new TextRun({
                             bold: true,
-                            children: ["\tuse Inserted and Deleted TextRuns.", new FootnoteReferenceRun(1)],
+                            children: [new Tab(), "use Inserted and Deleted TextRuns.", new FootnoteReferenceRun(1)],
                         }),
                         new TextRun({
                             bold: true,

demo/61-text-frame.ts

@@ -1,5 +1,5 @@
 // Text Frame (Text Box) example
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
 import {
     BorderStyle,
@@ -8,9 +8,10 @@ import {
     HorizontalPositionAlign,
     Packer,
     Paragraph,
+    Tab,
     TextRun,
     VerticalPositionAlign,
-} from "../build";
+} from "docx";
 
 const doc = new Document({
     sections: [
@@ -67,7 +68,7 @@ const doc = new Document({
                             bold: true,
                         }),
                         new TextRun({
-                            text: "\tGithub is the best",
+                            children: [new Tab(), "Github is the best"],
                             bold: true,
                         }),
                     ],

demo/62-paragraph-spacing.ts

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

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

@@ -1,7 +1,7 @@
 // Move + offset header and footer
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, Footer, Header, Packer, PageBreak, Paragraph, TextRun } from "../build";
+import { Document, Footer, Header, Packer, PageBreak, Paragraph, TextRun } from "docx";
 
 const doc = new Document({
     evenAndOddHeaderAndFooters: true,

demo/64-complex-numbering-text.ts

@@ -1,7 +1,7 @@
 // Numbered lists - With complex number text
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, Packer, Paragraph, LevelFormat } from "../build";
+import { Document, Packer, Paragraph, LevelFormat } from "docx";
 
 const doc = new Document({
     numbering: {

demo/65-page-sizes.ts

@@ -1,8 +1,8 @@
 // Example of how to set the document page sizes
 // Reference from https://papersizes.io/a/a3
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { convertMillimetersToTwip, Document, Packer, PageOrientation, Paragraph } from "../build";
+import { convertMillimetersToTwip, Document, Packer, PageOrientation, Paragraph } from "docx";
 
 const doc = new Document({
     sections: [

demo/66-fields.ts

@@ -1,7 +1,7 @@
 // Use fields to include dynamic text
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Bookmark, Document, Packer, Paragraph, SimpleField, TextRun } from "../build";
+import { Bookmark, Document, Packer, Paragraph, SimpleField, TextRun } from "docx";
 
 const doc = new Document({
     creator: "Me",

demo/67-column-break.ts

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

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

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

demo/69-different-width-columns.ts

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

demo/7-landscape.ts

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

demo/70-line-numbers-suppression.ts

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

demo/71-page-borders-2.ts

@@ -1,7 +1,7 @@
 // Example demonstrating page borders with style, colors and size
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, Packer, TextRun, Paragraph, BorderStyle, PageBorderDisplay, PageBorderOffsetFrom, PageBorderZOrder } from "../build";
+import { Document, Packer, TextRun, Paragraph, BorderStyle, PageBorderDisplay, PageBorderOffsetFrom, PageBorderZOrder } from "docx";
 
 const doc = new Document({
     sections: [

demo/72-word-wrap.ts

@@ -1,18 +1,37 @@
 // Example on how to preserve word wrap text. Works with all languages.
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, Packer, Paragraph, TextRun, SpaceType } from "../build";
+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",
-                            space: SpaceType.PRESERVE,
                         }),
                     ],
                 }),
@@ -23,7 +42,6 @@ const doc = new Document({
                         ),
                         new TextRun({
                             text: "456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345456435234523456435564745673456345",
-                            space: SpaceType.PRESERVE,
                         }),
                     ],
                 }),

demo/73-comments.ts

@@ -1,11 +1,87 @@
 // Simple example to add comments to a document
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, Packer, Paragraph, TextRun, CommentRangeStart, CommentRangeEnd, CommentReference } from "../build";
+import { Document, Packer, Paragraph, TextRun, CommentRangeStart, CommentRangeEnd, CommentReference } from "docx";
 
 const doc = new Document({
     comments: {
-        children: [{ id: 0, author: "Ray Chen", date: new Date(), text: "comment text content" }],
+        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: [
         {
@@ -26,6 +102,32 @@ const doc = new Document({
                         }),
                     ],
                 }),
+                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,
+                        }),
+                    ],
+                }),
             ],
         },
     ],

demo/74-nodejs-stream.ts

@@ -1,7 +1,7 @@
 // Exporting the document as a stream
-// Import from 'docx' rather than '../build' if you install from npm
+
 import * as fs from "fs";
-import { Document, Packer, Paragraph, TextRun } from "../build";
+import { Document, Packer, Paragraph, Tab, TextRun } from "docx";
 
 const doc = new Document({
     sections: [
@@ -16,7 +16,7 @@ const doc = new Document({
                             bold: true,
                         }),
                         new TextRun({
-                            text: "\tGithub is the best",
+                            children: [new Tab(), "Github is the best"],
                             bold: true,
                         }),
                     ],

demo/75-tab-stops.ts

@@ -1,21 +1,21 @@
-// Exporting the document as a stream
-// Import from 'docx' rather than '../build' if you install from npm
+// Example of using tab stops
+
 import * as fs from "fs";
-import { Document, HeadingLevel, Packer, Paragraph, TabStopPosition, TabStopType, TextRun } from "../build";
+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
+    // 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 },
-    ],
-    twoTabStops = [{ type: TabStopType.RIGHT, position: TabStopPosition.MAX }];
+    { 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({
     sections: [

demo/76-compatibility.ts

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

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

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

demo/78-thai-distributed.ts

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

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

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

demo/8-header-footer.ts

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

demo/80-thai-distributed.ts

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

demo/81-continuous-header.ts

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

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

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

demo/83-setting-languages.ts

@@ -0,0 +1,69 @@
+// Simple example to add text to a document
+
+import * as fs from "fs";
+import { Document, Packer, Paragraph } from "docx";
+
+const doc = new Document({
+    styles: {
+        default: {
+            document: {
+                run: {
+                    color: "ff0000",
+                    language: {
+                        value: "es-ES",
+                    },
+                },
+            },
+        },
+        paragraphStyles: [
+            {
+                id: "frenchNormal",
+                name: "French Normal",
+                basedOn: "Normal",
+                next: "Normal",
+                run: {
+                    color: "999999",
+                    italics: true,
+                    language: {
+                        value: "fr-FR",
+                    },
+                },
+            },
+            {
+                id: "koreanNormal",
+                name: "Korean Normal",
+                basedOn: "Normal",
+                next: "Normal",
+                run: {
+                    color: "0000ff",
+                    bold: true,
+                    language: {
+                        value: "ko-KR",
+                    },
+                },
+            },
+        ],
+    },
+    sections: [
+        {
+            properties: {},
+            children: [
+                new Paragraph({
+                    text: "Yo vivo en Granada, una ciudad pequeña que tiene monumentos muy importantes como la Alhambra. Aquí la comida es deliciosa y son famosos el gazpacho, el rebujito y el salmorejo.",
+                }),
+                new Paragraph({
+                    text: "Toute personne a droit à l'éducation. L'éducation doit être gratuite, au moins en ce qui concerne l'enseignement élémentaire et fondamental. L'enseignement élémentaire est obligatoire. L'enseignement technique et professionnel doit être généralisé; l'accès aux études supérieures doit être ouvert en pleine égalité à tous en fonction de leur mérite.",
+                    style: "frenchNormal",
+                }),
+                new Paragraph({
+                    text: "대법관은 대법원장의 제청으로 국회의 동의를 얻어 대통령이 임명한다. 강화조약. 국가는 국민 모두의 생산 및 생활의 기반이 되는 국토의 효율적이고 균형있는 이용·개발과 보전을 위하여 법률이 정하는 바에 의하여 그에 관한 필요한 제한과 의무를 과할 수 있다, 국가는 청원에 대하여 심사할 의무를 진다.",
+                    style: "koreanNormal",
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/84-positional-tabs.ts

@@ -0,0 +1,59 @@
+// Simple example apply positional tabs to a document
+
+import * as fs from "fs";
+import {
+    Document,
+    Packer,
+    Paragraph,
+    PositionalTab,
+    TextRun,
+    PositionalTabAlignment,
+    PositionalTabRelativeTo,
+    PositionalTabLeader,
+} from "docx";
+
+const doc = new Document({
+    sections: [
+        {
+            properties: {},
+            children: [
+                new Paragraph({
+                    children: [
+                        new TextRun("Full name"),
+                        new TextRun({
+                            children: [
+                                new PositionalTab({
+                                    alignment: PositionalTabAlignment.RIGHT,
+                                    relativeTo: PositionalTabRelativeTo.MARGIN,
+                                    leader: PositionalTabLeader.DOT,
+                                }),
+                                "John Doe",
+                            ],
+                            bold: true,
+                        }),
+                    ],
+                }),
+                new Paragraph({
+                    children: [
+                        new TextRun("Hello World"),
+                        new TextRun({
+                            children: [
+                                new PositionalTab({
+                                    alignment: PositionalTabAlignment.CENTER,
+                                    relativeTo: PositionalTabRelativeTo.INDENT,
+                                    leader: PositionalTabLeader.HYPHEN,
+                                }),
+                                "Foo bar",
+                            ],
+                            bold: true,
+                        }),
+                    ],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/85-template-document.ts

@@ -0,0 +1,155 @@
+// Patch a document with patches
+
+import * as fs from "fs";
+import {
+    ExternalHyperlink,
+    HeadingLevel,
+    ImageRun,
+    Paragraph,
+    patchDocument,
+    PatchType,
+    Table,
+    TableCell,
+    TableRow,
+    TextDirection,
+    TextRun,
+    VerticalAlign,
+} from "docx";
+
+patchDocument(fs.readFileSync("demo/assets/simple-template.docx"), {
+    patches: {
+        name: {
+            type: PatchType.PARAGRAPH,
+            children: [new TextRun("Sir. "), new TextRun("John Doe"), new TextRun("(The Conqueror)")],
+        },
+        table_heading_1: {
+            type: PatchType.PARAGRAPH,
+            children: [new TextRun("Heading wow!")],
+        },
+        item_1: {
+            type: PatchType.PARAGRAPH,
+            children: [
+                new TextRun("#657"),
+                new ExternalHyperlink({
+                    children: [
+                        new TextRun({
+                            text: "BBC News Link",
+                        }),
+                    ],
+                    link: "https://www.bbc.co.uk/news",
+                }),
+            ],
+        },
+        paragraph_replace: {
+            type: PatchType.DOCUMENT,
+            children: [
+                new Paragraph("Lorem ipsum paragraph"),
+                new Paragraph("Another paragraph"),
+                new Paragraph({
+                    children: [
+                        new TextRun("This is a "),
+                        new ExternalHyperlink({
+                            children: [
+                                new TextRun({
+                                    text: "Google Link",
+                                }),
+                            ],
+                            link: "https://www.google.co.uk",
+                        }),
+                        new ImageRun({ data: fs.readFileSync("./demo/images/dog.png"), transformation: { width: 100, height: 100 } }),
+                    ],
+                }),
+            ],
+        },
+        header_adjective: {
+            type: PatchType.PARAGRAPH,
+            children: [new TextRun("Delightful Header")],
+        },
+        footer_text: {
+            type: PatchType.PARAGRAPH,
+            children: [
+                new TextRun("replaced just as"),
+                new TextRun(" well"),
+                new ExternalHyperlink({
+                    children: [
+                        new TextRun({
+                            text: "BBC News Link",
+                        }),
+                    ],
+                    link: "https://www.bbc.co.uk/news",
+                }),
+            ],
+        },
+        image_test: {
+            type: PatchType.PARAGRAPH,
+            children: [new ImageRun({ data: fs.readFileSync("./demo/images/image1.jpeg"), transformation: { width: 100, height: 100 } })],
+        },
+        table: {
+            type: PatchType.DOCUMENT,
+            children: [
+                new Table({
+                    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,
+                                }),
+                            ],
+                        }),
+                    ],
+                }),
+            ],
+        },
+    },
+}).then((doc) => {
+    fs.writeFileSync("My Document.docx", doc);
+});

demo/86-generate-template.ts

@@ -0,0 +1,20 @@
+// Generate a template document
+
+import * as fs from "fs";
+import { Document, Packer, Paragraph, TextRun } from "docx";
+
+const doc = new Document({
+    sections: [
+        {
+            children: [
+                new Paragraph({
+                    children: [new TextRun("{{template}}")],
+                }),
+            ],
+        },
+    ],
+});
+
+Packer.toBuffer(doc).then((buffer) => {
+    fs.writeFileSync("My Document.docx", buffer);
+});

demo/87-template-document.ts

@@ -0,0 +1,15 @@
+// Patch a document with patches
+
+import * as fs from "fs";
+import { patchDocument, PatchType, TextRun } from "docx";
+
+patchDocument(fs.readFileSync("demo/assets/simple-template-2.docx"), {
+    patches: {
+        name: {
+            type: PatchType.PARAGRAPH,
+            children: [new TextRun("Max")],
+        },
+    },
+}).then((doc) => {
+    fs.writeFileSync("My Document.docx", doc);
+});

demo/88-template-document.ts

@@ -0,0 +1,31 @@
+// Patch a document with patches
+
+import * as fs from "fs";
+import { IPatch, patchDocument, PatchType, TextRun } from "docx";
+
+export const font = "Trebuchet MS";
+export const getPatches = (fields: { [key: string]: string }) => {
+    const patches: { [key: string]: IPatch } = {};
+
+    for (const field in fields) {
+        patches[field] = {
+            type: PatchType.PARAGRAPH,
+            children: [new TextRun({ text: fields[field], font })],
+        };
+    }
+
+    return patches;
+};
+
+const patches = getPatches({
+    name: "Mr",
+    table_heading_1: "John",
+    item_1: "Doe",
+    paragraph_replace: "Lorem ipsum paragraph",
+});
+
+patchDocument(fs.readFileSync("demo/assets/simple-template.docx"), {
+    patches,
+}).then((doc) => {
+    fs.writeFileSync("My Document.docx", doc);
+});