Add run properties to paragraph

build(deps-dev): bump ts-node from 9.1.0 to 9.1.1

.github/workflows/default.yml

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

README.md

@@ -11,6 +11,7 @@
 [![NPM version][npm-image]][npm-url]
 [![Downloads per month][downloads-image]][downloads-url]
 [![Build Status][travis-image]][travis-url]
+[![GitHub Action Workflow Status][github-actions-workflow-image]][github-actions-workflow-url]
 [![Dependency Status][daviddm-image]][daviddm-url]
 [![Known Vulnerabilities][snky-image]][snky-url]
 [![Chat on Gitter][gitter-image]][gitter-url]
@@ -67,7 +68,7 @@ Please refer to the [documentation at https://docx.js.org/](https://docx.js.org/
 
 # Examples
 
-Check the `examples` section in the [documentation](https://docx.js.org/#/examples) and the [demo folder](https://github.com/dolanmiu/docx/tree/master/demo) for examples.
+Check the [demo folder](https://github.com/dolanmiu/docx/tree/master/demo) for examples.
 
 # Contributing
 
@@ -85,6 +86,7 @@ Read the contribution guidelines [here](https://docx.js.org/#/contribution-guide
 [<img src="https://i.imgur.com/QEZXU5b.png" alt="drawing" height="50"/>](https://www.beekast.com/)
 [<img src="https://imgur.com/XVU6aoi.png" alt="drawing" height="50"/>](https://herraizsoto.com/)
 [<img src="https://i.imgur.com/fn1xccG.png" alt="drawing" height="50"/>](http://www.ativer.com.br/)
+[<img src="https://i.imgur.com/cmykN7c.png" alt="drawing"/>](https://www.arity.co/)
 
 
 ...and many more!
@@ -102,6 +104,8 @@ Made with 💖
 [downloads-url]: https://npmjs.org/package/docx
 [travis-image]: https://travis-ci.org/dolanmiu/docx.svg?branch=master
 [travis-url]: https://travis-ci.org/dolanmiu/docx
+[github-actions-workflow-image]: https://github.com/dolanmiu/docx/workflows/Default/badge.svg
+[github-actions-workflow-url]: https://github.com/dolanmiu/docx/actions
 [daviddm-image]: https://david-dm.org/dolanmiu/docx.svg?theme=shields.io
 [daviddm-url]: https://david-dm.org/dolanmiu/docx
 [snky-image]: https://snyk.io/test/github/dolanmiu/docx/badge.svg

demo/11-declaritive-styles-2.ts

@@ -18,13 +18,8 @@ import {
 
 const doc = new Document({
     styles: {
-        paragraphStyles: [
-            {
-                id: "Heading1",
-                name: "Heading 1",
-                basedOn: "Normal",
-                next: "Normal",
-                quickFormat: true,
+        default: {
+            heading1: {
                 run: {
                     font: "Calibri",
                     size: 52,
@@ -40,12 +35,7 @@ const doc = new Document({
                     spacing: { line: 340 },
                 },
             },
-            {
-                id: "Heading2",
-                name: "Heading 2",
-                basedOn: "Normal",
-                next: "Normal",
-                quickFormat: true,
+            heading2: {
                 run: {
                     font: "Calibri",
                     size: 26,
@@ -55,12 +45,7 @@ const doc = new Document({
                     spacing: { line: 340 },
                 },
             },
-            {
-                id: "Heading3",
-                name: "Heading 3",
-                basedOn: "Normal",
-                next: "Normal",
-                quickFormat: true,
+            heading3: {
                 run: {
                     font: "Calibri",
                     size: 26,
@@ -70,12 +55,7 @@ const doc = new Document({
                     spacing: { line: 276 },
                 },
             },
-            {
-                id: "Heading4",
-                name: "Heading 4",
-                basedOn: "Normal",
-                next: "Normal",
-                quickFormat: true,
+            heading4: {
                 run: {
                     font: "Calibri",
                     size: 26,
@@ -85,6 +65,8 @@ const doc = new Document({
                     alignment: AlignmentType.JUSTIFIED,
                 },
             },
+        },
+        paragraphStyles: [
             {
                 id: "normalPara",
                 name: "Normal Para",
@@ -139,12 +121,6 @@ const doc = new Document({
                     spacing: { line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 },
                 },
             },
-            {
-                id: "ListParagraph",
-                name: "List Paragraph",
-                basedOn: "Normal",
-                quickFormat: true,
-            },
         ],
     },
 });

demo/2-declaritive-styles.ts

@@ -8,13 +8,8 @@ const doc = new Document({
     title: "Sample Document",
     description: "A brief example of using docx",
     styles: {
-        paragraphStyles: [
-            {
-                id: "Heading1",
-                name: "Heading 1",
-                basedOn: "Normal",
-                next: "Normal",
-                quickFormat: true,
+        default: {
+            heading1: {
                 run: {
                     size: 28,
                     bold: true,
@@ -27,12 +22,7 @@ const doc = new Document({
                     },
                 },
             },
-            {
-                id: "Heading2",
-                name: "Heading 2",
-                basedOn: "Normal",
-                next: "Normal",
-                quickFormat: true,
+            heading2: {
                 run: {
                     size: 26,
                     bold: true,
@@ -48,6 +38,13 @@ const doc = new Document({
                     },
                 },
             },
+            listParagraph: {
+                run: {
+                    color: '#FF0000'
+                }
+            }
+        },
+        paragraphStyles: [
             {
                 id: "aside",
                 name: "Aside",
@@ -75,12 +72,6 @@ const doc = new Document({
                     spacing: { line: 276, before: 20 * 72 * 0.1, after: 20 * 72 * 0.05 },
                 },
             },
-            {
-                id: "ListParagraph",
-                name: "List Paragraph",
-                basedOn: "Normal",
-                quickFormat: true,
-            },
         ],
     },
     numbering: {

demo/46-shading-text.ts

@@ -28,6 +28,18 @@ doc.addSection({
                         }),
                     ],
                 }),
+                new Paragraph({
+                    shading: {
+                        type: ShadingType.DIAGONAL_CROSS,
+                        color: "00FFFF",
+                        fill: "FF0000",
+                    },
+                    children: [
+                        new TextRun({
+                            text: "Hello World for entire paragraph",
+                        }),
+                    ],
+                }),
             ],
         }),
     },

demo/54-track-revisions.ts

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

demo/55-math.ts

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

demo/56-background-color.ts

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

demo/57-paragraph-run-styles.ts

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

docs/README.md

@@ -53,11 +53,11 @@ Packer.toBuffer(doc).then((buffer) => {
     fs.writeFileSync("My Document.docx", buffer);
 });
 
-// Done! A file called 'My First Document.docx' will be in your file system.
+// Done! A file called 'My Document.docx' will be in your file system.
 ```
 
 <p align="center">
-    <img alt="clippy the assistant" src="http://i60.tinypic.com/339pvtt.png">
+    <img alt="clippy the assistant" src="./clippy.png">
 </p>
 
 ---

docs/_sidebar.md

@@ -20,6 +20,8 @@
 	* [Tab Stops](usage/tab-stops.md)
     * [Table of Contents](usage/table-of-contents.md)
     * [Page Numbers](usage/page-numbers.md)
+    * [Change Tracking](usage/change-tracking.md)
+    * [Math](usage/math.md)
 	* Styling
         * [Styling with JS](usage/styling-with-js.md)
         * [Styling with XML](usage/styling-with-xml.md)
@@ -28,4 +30,3 @@
     * [Packers](usage/packers.md)
 
 * [Contribution Guidelines](contribution-guidelines.md)
-

docs/usage/change-tracking.md

@@ -0,0 +1,61 @@
+# Change Tracking
+
+> Instead of adding a `TextRun` into a `Paragraph`, you can also add an `InsertedTextRun` or `DeletedTextRun` where you need to supply an `id`, `author` and `date` for the change.
+
+```ts
+import { Paragraph, TextRun, InsertedTextRun, DeletedTextRun } from "docx";
+
+const paragraph = new Paragraph({
+    children: [
+        new TextRun("This is a simple demo "),
+        new TextRun({
+            text: "on how to "
+        }),
+        new InsertedTextRun({
+            text: "mark a text as an insertion ",
+            id: 0,
+            author: "Firstname Lastname",
+            date: "2020-10-06T09:00:00Z",
+        }),
+        new DeletedTextRun({
+            text: "or a deletion.",
+            id: 1,
+            author: "Firstname Lastname",
+            date: "2020-10-06T09:00:00Z",
+        })
+    ],
+});
+```
+
+Note that for a `InsertedTextRun` and `DeletedTextRun`, it is not possible to simply call it with only a text as in `new TextRun("some text")`, since the additonal fields for change tracking need to be provided. Similar to a normal `TextRun` you can add additional text properties.
+
+```ts
+import { Paragraph, TextRun, InsertedTextRun, DeletedTextRun } from "docx";
+
+const paragraph = new Paragraph({
+    children: [
+        new TextRun("This is a simple demo"),
+        new DeletedTextRun({
+            text: "with a deletion.",
+            color: "red",
+            bold: true,
+            size: 24,
+            id: 0,
+            author: "Firstname Lastname",
+            date: "2020-10-06T09:00:00Z",
+        })
+    ],
+});
+```
+
+In addtion to marking text as inserted or deleted, change tracking can also be added via the document settings. This will enable new changes to be tracked as well.
+
+```ts
+import { Document } from "docx";
+
+const doc = new Document({
+    features: {
+        trackRevisions: true,
+    },
+});
+```

docs/usage/document.md

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

docs/usage/math.md

@@ -0,0 +1,265 @@
+# Math
+
+!> Math requires an understanding of [Sections](usage/sections.md) and [Paragraphs](usage/paragraph.md).
+
+## Intro
+
+1.  To add math, create a `Math` object
+2.  Add `MathComponents` inside `Math`
+3.  `MathComponents` can have nested `MathComponents` inside. e.g. A fraction where the numerator is a square root, and the demoninator as another fraction. More on `MathComponents` below
+4.  Make sure to add the `Math` object inside a `Paragraph`
+
+## Example
+
+```ts
+new Math({
+    children: [
+        new MathRun("2+2"),
+        new MathFraction({
+            numerator: [new MathRun("hi")],
+            denominator: [new MathRun("2")],
+        }),
+    ],
+}),
+```
+
+This will produce:
+
+<p align="center">
+    <img alt="clippy the assistant" src="images/math-example.png" width="200">
+</p>
+
+## Math Components
+
+`MathComponents` are the unit sized building blocks of an equation in `docx`. A `MathComponent` takes in more nested `MathComponents` until you reach `MathRun`, which has no children. `MathRun` is similar to a [TextRun](usage/text.md).
+
+### Math Run
+
+`MathRun` is the most basic `MathComponent`.
+
+#### Example
+
+```ts
+new MathRun("2+2");
+```
+
+```ts
+new MathRun("hello");
+```
+
+An example of it being used inside `Math`:
+
+```ts
+new Math({
+    children: [
+        new MathRun("2"),
+        new MathRun("+"),
+        new MathRun("2"),
+    ],
+}),
+```
+
+### Math Fraction
+
+`MathFractions` require a `numerator` and a `demoninator`, which are both a list of `MathComponents`
+
+#### Example
+
+```ts
+new MathFraction({
+    numerator: [new MathRun("1")],
+    denominator: [new MathRun("2")],
+}),
+```
+
+```ts
+new MathFraction({
+    numerator: [
+        new MathRun("1"),
+        new MathRadical({
+            children: [new MathRun("2")],
+        }),
+    ],
+    denominator: [new MathRun("2")],
+}),
+```
+
+An example of it being used inside `Math`:
+
+```ts
+new Math({
+    children: [
+        new MathFraction({
+            numerator: [new MathRun("1")],
+            denominator: [new MathRun("2")],
+        }),
+        new MathText("+"),
+        new MathFraction({
+            numerator: [new MathRun("1")],
+            denominator: [new MathRun("2")],
+        }),
+        new MathText("= 1"),
+    ],
+}),
+```
+
+### Sum
+
+A `MathComponent` for `Σ`. It can take a `superScript` and/or `subScript` as arguments to add `MathComponents` (usually limits) on the top and bottom
+
+```ts
+new MathSum({
+    children: [new MathRun("i")],
+}),
+```
+
+```ts
+new MathSum({
+    children: [
+        new MathSuperScript({
+            children: [new MathRun("e")],
+            superScript: [new MathRun("2")],
+        })
+    ],
+    subScript: [new MathRun("i")],
+    superScript: [new MathRun("10")],
+}),
+```
+
+### Radicals
+
+A `MathComponent` for the `√` symbol. Examples include, square root, cube root etc. There is an optional `degree` parameter to specify the number of times the radicand is multiplied by itself. For example, `3` for cube root.
+
+```ts
+new MathRadical({
+    children: [new MathRun("2")],
+}),
+```
+
+Cube root example:
+
+```ts
+new MathRadical({
+    children: [
+        new MathFraction({
+            numerator: [new MathRun("1")],
+            denominator: [new MathRun("2")],
+        }),
+        new MathRun('+ 1'),
+    ],
+    degree: [new MathRun("3")],
+}),
+```
+
+### Super Script
+
+`MathSuperScripts` are the little numbers written to the top right of numbers or variables. It means the exponent or power if written by itself with the number or variable.
+
+```ts
+new MathSuperScript({
+    children: [new MathRun("x")],
+    superScript: [new MathRun("2")],
+}),
+```
+
+An example with cosine:
+
+```ts
+new MathSuperScript({
+    children: [new MathRun("cos")],
+    superScript: [new MathRun("-1")],
+}),
+```
+
+### Sub Script
+
+`MathSubScripts` are similar to `MathSuperScripts`, except the little number is written below.
+
+```ts
+new MathSubScript({
+    children: [new MathRun("F")],
+    subScript: [new MathRun("n-1")],
+}),
+```
+
+### Sub-Super Script
+
+`MathSubSuperScripts` are a combination of both `MathSuperScript` and `MathSubScript`.
+
+```ts
+new MathSubSuperScript({
+    children: [new MathRun("test")],
+    superScript: [new MathRun("hello")],
+    subScript: [new MathRun("world")],
+}),
+```
+
+### Function
+
+`MathFunctions` are a way of describing what happens to an input variable, in order to get the output result. It takes a `name` parameter to specify the name of the function.
+
+```ts
+new MathFunction({
+    name: [
+        new MathSuperScript({
+            children: [new MathRun("cos")],
+            superScript: [new MathRun("-1")],
+        }),
+    ],
+    children: [new MathRun("100")],
+}),
+```
+
+### Brackets
+
+#### Square brackets
+
+```ts
+new MathSquareBrackets({
+    children: [
+        new MathFraction({
+            numerator: [new MathRun("1")],
+            denominator: [new MathRun("2")],
+        }),
+    ],
+}),
+```
+
+#### Round brackets
+
+```ts
+new MathRoundBrackets({
+    children: [
+        new MathFraction({
+            numerator: [new MathRun("1")],
+            denominator: [new MathRun("2")],
+        }),
+    ],
+}),
+```
+
+#### Curly brackets
+
+```ts
+new MathCurlyBrackets({
+    children: [
+        new MathFraction({
+            numerator: [new MathRun("1")],
+            denominator: [new MathRun("2")],
+        }),
+    ],
+}),
+```
+
+#### Angled brackets
+
+```ts
+new MathAngledBrackets({
+    children: [
+        new MathFraction({
+            numerator: [new MathRun("1")],
+            denominator: [new MathRun("2")],
+        }),
+    ],
+}),
+```

docs/usage/paragraph.md

@@ -142,6 +142,21 @@ const paragraph = new Paragraph({
 });
 ```
 
+## Shading
+
+Add color to an entire paragraph block
+
+```ts
+const paragraph = new Paragraph({
+    text: "shading",
+    shading: {
+        type: ShadingType.REVERSE_DIAGONAL_STRIPE,
+        color: "00FFFF",
+        fill: "FF0000",
+    },
+});
+```
+
 ## Spacing
 
 Adding spacing between paragraphs

docs/usage/tables.md

@@ -51,19 +51,6 @@ const table = new Table({
 });
 ```
 
-### Pagination
-
-#### Prevent row pagination
-
-To prevent breaking contents of a row across multiple pages, call `cantSplit`:
-
-```ts
-const table = new Table({
-    rows: [],
-    cantSplit: true,
-});
-```
-
 ## Table Row
 
 A table consists of multiple `table rows`. Table rows have a list of `children` which accepts a list of `table cells` explained below. You can create a simple `table row` like so:
@@ -103,7 +90,7 @@ Here is a list of options you can add to the `table row`:
 | children    | `Array<TableCell>`                    | Required |
 | cantSplit   | `boolean`                             | Optional |
 | tableHeader | `boolean`                             | Optional |
-| height      | `{ value: number, rule: HeightRule }` | Optional |
+| height      | `{ height: number, rule: HeightRule }` | Optional |
 
 ### Repeat row
 
@@ -116,6 +103,19 @@ const row = new TableRow({
 });
 ```
 
+### Pagination
+
+#### Prevent row pagination
+
+To prevent breaking contents of a row across multiple pages, call `cantSplit`:
+
+```ts
+const row = new Row({
+    ...,
+    cantSplit: true,
+});
+```
+
 ## Table Cells
 
 Cells need to be added in the `table row`, you can create a table cell like:

docs/usage/text.md

@@ -77,40 +77,78 @@ const text = new TextRun({
 });
 ```
 
+### Shading and Highlighting
+
+```ts
+const text = new TextRun({
+    text: "shading",
+    shading: {
+        type: ShadingType.REVERSE_DIAGONAL_STRIPE,
+        color: "00FFFF",
+        fill: "FF0000",
+    },
+});
+```
+
+```ts
+const text = new TextRun({
+    text: "highlighting",
+    highlight: "yellow",
+});
+```
+
 ### Strike through
 
 ```ts
-text.strike();
+const text = new TextRun({
+    text: "strike",
+    strike: true,
+});
 ```
 
 ### Double strike through
 
 ```ts
-text.doubleStrike();
+const text = new TextRun({
+    text: "doubleStrike",
+    doubleStrike: true,
+});
 ```
 
 ### Superscript
 
 ```ts
-text.superScript();
+const text = new TextRun({
+    text: "superScript",
+    superScript: true,
+});
 ```
 
 ### Subscript
 
 ```ts
-text.subScript();
+const text = new TextRun({
+    text: "subScript",
+    subScript: true,
+});
 ```
 
 ### All Capitals
 
 ```ts
-text.allCaps();
+const text = new TextRun({
+    text: "allCaps",
+    allCaps: true,
+});
 ```
 
 ### Small Capitals
 
 ```ts
-text.smallCaps();
+const text = new TextRun({
+    text: "smallCaps",
+    smallCaps: true,
+});
 ```
 
 ## Break
@@ -118,13 +156,8 @@ text.smallCaps();
 Sometimes you would want to put text underneath another line of text but inside the same paragraph.
 
 ```ts
-text.break();
-```
-
-## Chaining
-
-What if you want to create a paragraph which is **_bold_** and **_italic_**?
-
-```ts
-paragraph.bold().italics();
+const text = new TextRun({
+    text: "break",
+    break: true,
+});
 ```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "docx",
-  "version": "5.3.0",
+  "version": "5.4.1",
   "description": "Easily generate .docx files with JS/TS with a nice declarative API. Works for Node and on the Browser.",
   "main": "build/index.js",
   "scripts": {
@@ -79,7 +79,7 @@
     "mocha-webpack": "^1.0.1",
     "nyc": "^15.1.0",
     "pre-commit": "^1.2.2",
-    "prettier": "^2.0.5",
+    "prettier": "^2.1.2",
     "prompt": "^1.0.0",
     "replace-in-file": "^3.1.0",
     "request": "^2.88.0",
@@ -87,9 +87,9 @@
     "rimraf": "^3.0.2",
     "shelljs": "^0.8.4",
     "sinon": "^9.0.2",
-    "ts-node": "^8.10.2",
+    "ts-node": "^9.0.0",
     "tslint": "^6.1.3",
-    "tslint-immutable": "^4.9.0",
+    "tslint-immutable": "^6.0.1",
     "typedoc": "^0.16.11",
     "typescript": "2.9.2",
     "webpack": "^3.10.0"

src/file/core-properties/properties.ts

@@ -1,4 +1,5 @@
 import { XmlComponent } from "file/xml-components";
+import { IDocumentBackgroundOptions } from "../document";
 
 import { DocumentAttributes } from "../document/document-attributes";
 import { INumberingOptions } from "../numbering";
@@ -32,6 +33,10 @@ export interface IPropertiesOptions {
     readonly hyperlinks?: {
         readonly [key: string]: IInternalHyperlinkDefinition | IExternalHyperlinkDefinition;
     };
+    readonly background?: IDocumentBackgroundOptions;
+    readonly features?: {
+        readonly trackRevisions?: boolean;
+    };
 }
 
 export class CoreProperties extends XmlComponent {

src/file/document/document-background/document-background.spec.ts

@@ -0,0 +1,53 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { DocumentBackground } from "./document-background";
+
+describe("DocumentBackground", () => {
+    describe("#constructor()", () => {
+        it("should create a DocumentBackground with no options and set color to auto", () => {
+            const documentBackground = new DocumentBackground({});
+            const tree = new Formatter().format(documentBackground);
+            expect(tree).to.deep.equal({
+                "w:background": {
+                    _attr: {
+                        "w:color": "FFFFFF",
+                    },
+                },
+            });
+        });
+
+        it("should create a DocumentBackground with no options and set color to value", () => {
+            const documentBackground = new DocumentBackground({ color: "ffff00" });
+            const tree = new Formatter().format(documentBackground);
+            expect(tree).to.deep.equal({
+                "w:background": {
+                    _attr: {
+                        "w:color": "ffff00",
+                    },
+                },
+            });
+        });
+
+        it("should create a DocumentBackground with no options and set other values", () => {
+            const documentBackground = new DocumentBackground({
+                color: "ffff00",
+                themeColor: "test",
+                themeShade: "test",
+                themeTint: "test",
+            });
+            const tree = new Formatter().format(documentBackground);
+            expect(tree).to.deep.equal({
+                "w:background": {
+                    _attr: {
+                        "w:color": "ffff00",
+                        "w:themeColor": "test",
+                        "w:themeShade": "test",
+                        "w:themeTint": "test",
+                    },
+                },
+            });
+        });
+    });
+});

src/file/document/document-background/document-background.ts

@@ -0,0 +1,39 @@
+// http://officeopenxml.com/WPdocument.php
+// http://www.datypic.com/sc/ooxml/e-w_background-1.html
+import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+
+export class DocumentBackgroundAttributes extends XmlAttributeComponent<{
+    readonly color: string;
+    readonly themeColor?: string;
+    readonly themeShade?: string;
+    readonly themeTint?: string;
+}> {
+    protected readonly xmlKeys = {
+        color: "w:color",
+        themeColor: "w:themeColor",
+        themeShade: "w:themeShade",
+        themeTint: "w:themeTint",
+    };
+}
+
+export interface IDocumentBackgroundOptions {
+    readonly color?: string;
+    readonly themeColor?: string;
+    readonly themeShade?: string;
+    readonly themeTint?: string;
+}
+
+export class DocumentBackground extends XmlComponent {
+    constructor(options: IDocumentBackgroundOptions) {
+        super("w:background");
+
+        this.root.push(
+            new DocumentBackgroundAttributes({
+                color: options.color ? options.color : "FFFFFF",
+                themeColor: options.themeColor,
+                themeShade: options.themeShade,
+                themeTint: options.themeTint,
+            }),
+        );
+    }
+}

src/file/document/document-background/index.ts

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

src/file/document/document.spec.ts

@@ -8,7 +8,7 @@ describe("Document", () => {
     let document: Document;
 
     beforeEach(() => {
-        document = new Document();
+        document = new Document({ background: {} });
     });
 
     describe("#constructor()", () => {
@@ -38,6 +38,13 @@ describe("Document", () => {
                             "mc:Ignorable": "w14 w15 wp14",
                         },
                     },
+                    {
+                        "w:background": {
+                            _attr: {
+                                "w:color": "FFFFFF",
+                            },
+                        },
+                    },
                     { "w:body": {} },
                 ],
             });

src/file/document/document.ts

@@ -5,11 +5,16 @@ import { Table } from "../table";
 import { TableOfContents } from "../table-of-contents";
 import { Body } from "./body";
 import { DocumentAttributes } from "./document-attributes";
+import { DocumentBackground, IDocumentBackgroundOptions } from "./document-background";
+
+interface IDocumentOptions {
+    readonly background: IDocumentBackgroundOptions;
+}
 
 export class Document extends XmlComponent {
     private readonly body: Body;
 
-    constructor() {
+    constructor(options: IDocumentOptions) {
         super("w:document");
         this.root.push(
             new DocumentAttributes({
@@ -33,6 +38,7 @@ export class Document extends XmlComponent {
             }),
         );
         this.body = new Body();
+        this.root.push(new DocumentBackground(options.background));
         this.root.push(this.body);
     }
 

src/file/document/index.ts

@@ -1,3 +1,4 @@
 export * from "./document";
 export * from "./document-attributes";
 export * from "./body";
+export * from "./document-background";

src/file/drawing/inline/inline.ts

@@ -12,7 +12,7 @@ export class Inline extends XmlComponent {
     private readonly extent: Extent;
     private readonly graphic: Graphic;
 
-    constructor(readonly mediaData: IMediaData, private readonly dimensions: IMediaDataDimensions) {
+    constructor(mediaData: IMediaData, private readonly dimensions: IMediaDataDimensions) {
         super("wp:inline");
 
         this.root.push(

src/file/file.spec.ts

@@ -5,7 +5,7 @@ import { Formatter } from "export/formatter";
 
 import { File } from "./file";
 import { Footer, Header } from "./header";
-import { HyperlinkRef, Paragraph } from "./paragraph";
+import { HyperlinkRef, HyperlinkType, Paragraph } from "./paragraph";
 import { Table, TableCell, TableRow } from "./table";
 import { TableOfContents } from "./table-of-contents";
 
@@ -243,12 +243,40 @@ describe("File", () => {
         });
     });
 
+    describe("#addTrackRevisionsFeature", () => {
+        it("should call the underlying document's add", () => {
+            const file = new File({
+                features: {
+                    trackRevisions: true,
+                },
+            });
+
+            // tslint:disable-next-line: no-unused-expression no-string-literal
+            expect(file.Settings["trackRevisions"]).to.exist;
+        });
+    });
+
     describe("#HyperlinkCache", () => {
         it("should initially have empty hyperlink cache", () => {
             const file = new File();
 
             expect(file.HyperlinkCache).to.deep.equal({});
         });
+
+        it("should have hyperlink cache when option is added", () => {
+            const file = new File({
+                hyperlinks: {
+                    myCoolLink: {
+                        link: "http://www.example.com",
+                        text: "Hyperlink",
+                        type: HyperlinkType.EXTERNAL,
+                    },
+                },
+            });
+
+            // tslint:disable-next-line: no-unused-expression no-string-literal
+            expect(file.HyperlinkCache["myCoolLink"]).to.exist;
+        });
     });
 
     describe("#createFootnote", () => {

src/file/file.ts

@@ -85,7 +85,7 @@ export class File {
         this.appProperties = new AppProperties();
         this.footNotes = new FootNotes();
         this.contentTypes = new ContentTypes();
-        this.document = new Document();
+        this.document = new Document({ background: options.background || {} });
         this.settings = new Settings();
 
         this.media = fileProperties.template && fileProperties.template.media ? fileProperties.template.media : new Media();
@@ -106,7 +106,7 @@ export class File {
             this.styles = stylesFactory.newInstance(options.externalStyles);
         } else if (options.styles) {
             const stylesFactory = new DefaultStylesFactory();
-            const defaultStyles = stylesFactory.newInstance();
+            const defaultStyles = stylesFactory.newInstance(options.styles.default);
             this.styles = new Styles({
                 ...defaultStyles,
                 ...options.styles,
@@ -170,6 +170,12 @@ export class File {
 
             this.hyperlinkCache = cache;
         }
+
+        if (options.features) {
+            if (options.features.trackRevisions) {
+                this.settings.addTrackRevisions();
+            }
+        }
     }
 
     public addSection({

src/file/index.ts

@@ -13,3 +13,4 @@ export * from "./header-wrapper";
 export * from "./footer-wrapper";
 export * from "./header";
 export * from "./footnotes";
+export * from "./track-revision";

src/file/paragraph/index.ts

@@ -3,3 +3,4 @@ export * from "./paragraph";
 export * from "./properties";
 export * from "./run";
 export * from "./links";
+export * from "./math";

src/file/paragraph/math/brackets/index.ts

@@ -0,0 +1,4 @@
+export * from "./math-round-brackets";
+export * from "./math-square-brackets";
+export * from "./math-curly-brackets";
+export * from "./math-angled-brackets";

src/file/paragraph/math/brackets/math-angled-brackets.spec.ts

@@ -0,0 +1,51 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathRun } from "../math-run";
+import { MathAngledBrackets } from "./math-angled-brackets";
+
+describe("MathAngledBrackets", () => {
+    describe("#constructor()", () => {
+        it("should create a MathAngledBrackets with correct root key", () => {
+            const mathAngledBrackets = new MathAngledBrackets({
+                children: [new MathRun("60")],
+            });
+
+            const tree = new Formatter().format(mathAngledBrackets);
+            expect(tree).to.deep.equal({
+                "m:d": [
+                    {
+                        "m:dPr": [
+                            {
+                                "m:begChr": {
+                                    _attr: {
+                                        "m:val": "〈",
+                                    },
+                                },
+                            },
+                            {
+                                "m:endChr": {
+                                    _attr: {
+                                        "m:val": "〉",
+                                    },
+                                },
+                            },
+                        ],
+                    },
+                    {
+                        "m:e": [
+                            {
+                                "m:r": [
+                                    {
+                                        "m:t": ["60"],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                ],
+            });
+        });
+    });
+});

src/file/paragraph/math/brackets/math-angled-brackets.ts

@@ -0,0 +1,20 @@
+// http://www.datypic.com/sc/ooxml/e-m_d-1.html
+import { XmlComponent } from "file/xml-components";
+
+import { MathComponent } from "../math-component";
+import { MathBase } from "../n-ary";
+import { MathBracketProperties } from "./math-bracket-properties";
+
+export class MathAngledBrackets extends XmlComponent {
+    constructor(options: { readonly children: MathComponent[] }) {
+        super("m:d");
+
+        this.root.push(
+            new MathBracketProperties({
+                beginningCharacter: "〈",
+                endingCharacter: "〉",
+            }),
+        );
+        this.root.push(new MathBase(options.children));
+    }
+}

src/file/paragraph/math/brackets/math-beginning-character.spec.ts

@@ -0,0 +1,22 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathBeginningCharacter } from "./math-beginning-character";
+
+describe("MathBeginningCharacter", () => {
+    describe("#constructor()", () => {
+        it("should create a MathBeginningCharacter with correct root key", () => {
+            const mathBeginningCharacter = new MathBeginningCharacter("[");
+
+            const tree = new Formatter().format(mathBeginningCharacter);
+            expect(tree).to.deep.equal({
+                "m:begChr": {
+                    _attr: {
+                        "m:val": "[",
+                    },
+                },
+            });
+        });
+    });
+});

src/file/paragraph/math/brackets/math-beginning-character.ts

@@ -0,0 +1,14 @@
+// http://www.datypic.com/sc/ooxml/e-m_begChr-1.html
+import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+
+class MathBeginningCharacterAttributes extends XmlAttributeComponent<{ readonly character: string }> {
+    protected readonly xmlKeys = { character: "m:val" };
+}
+
+export class MathBeginningCharacter extends XmlComponent {
+    constructor(character: string) {
+        super("m:begChr");
+
+        this.root.push(new MathBeginningCharacterAttributes({ character }));
+    }
+}

src/file/paragraph/math/brackets/math-bracket-properties.spec.ts

@@ -0,0 +1,45 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathBracketProperties } from "./math-bracket-properties";
+
+describe("MathBracketProperties", () => {
+    describe("#constructor()", () => {
+        it("should create a MathBracketProperties with correct root key", () => {
+            const mathBracketProperties = new MathBracketProperties();
+
+            const tree = new Formatter().format(mathBracketProperties);
+            expect(tree).to.deep.equal({
+                "m:dPr": {},
+            });
+        });
+
+        it("should create a MathBracketProperties with correct root key and add brackets", () => {
+            const mathBracketProperties = new MathBracketProperties({
+                beginningCharacter: "[",
+                endingCharacter: "]",
+            });
+
+            const tree = new Formatter().format(mathBracketProperties);
+            expect(tree).to.deep.equal({
+                "m:dPr": [
+                    {
+                        "m:begChr": {
+                            _attr: {
+                                "m:val": "[",
+                            },
+                        },
+                    },
+                    {
+                        "m:endChr": {
+                            _attr: {
+                                "m:val": "]",
+                            },
+                        },
+                    },
+                ],
+            });
+        });
+    });
+});

src/file/paragraph/math/brackets/math-bracket-properties.ts

@@ -0,0 +1,16 @@
+// http://www.datypic.com/sc/ooxml/e-m_dPr-1.html
+import { XmlComponent } from "file/xml-components";
+
+import { MathBeginningCharacter } from "./math-beginning-character";
+import { MathEndingCharacter } from "./math-ending-char";
+
+export class MathBracketProperties extends XmlComponent {
+    constructor(options?: { readonly beginningCharacter: string; readonly endingCharacter: string }) {
+        super("m:dPr");
+
+        if (!!options) {
+            this.root.push(new MathBeginningCharacter(options.beginningCharacter));
+            this.root.push(new MathEndingCharacter(options.endingCharacter));
+        }
+    }
+}

src/file/paragraph/math/brackets/math-curly-brackets.spec.ts

@@ -0,0 +1,51 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathRun } from "../math-run";
+import { MathCurlyBrackets } from "./math-curly-brackets";
+
+describe("MathCurlyBrackets", () => {
+    describe("#constructor()", () => {
+        it("should create a MathCurlyBrackets with correct root key", () => {
+            const mathCurlyBrackets = new MathCurlyBrackets({
+                children: [new MathRun("60")],
+            });
+
+            const tree = new Formatter().format(mathCurlyBrackets);
+            expect(tree).to.deep.equal({
+                "m:d": [
+                    {
+                        "m:dPr": [
+                            {
+                                "m:begChr": {
+                                    _attr: {
+                                        "m:val": "{",
+                                    },
+                                },
+                            },
+                            {
+                                "m:endChr": {
+                                    _attr: {
+                                        "m:val": "}",
+                                    },
+                                },
+                            },
+                        ],
+                    },
+                    {
+                        "m:e": [
+                            {
+                                "m:r": [
+                                    {
+                                        "m:t": ["60"],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                ],
+            });
+        });
+    });
+});

src/file/paragraph/math/brackets/math-curly-brackets.ts

@@ -0,0 +1,20 @@
+// http://www.datypic.com/sc/ooxml/e-m_d-1.html
+import { XmlComponent } from "file/xml-components";
+
+import { MathComponent } from "../math-component";
+import { MathBase } from "../n-ary";
+import { MathBracketProperties } from "./math-bracket-properties";
+
+export class MathCurlyBrackets extends XmlComponent {
+    constructor(options: { readonly children: MathComponent[] }) {
+        super("m:d");
+
+        this.root.push(
+            new MathBracketProperties({
+                beginningCharacter: "{",
+                endingCharacter: "}",
+            }),
+        );
+        this.root.push(new MathBase(options.children));
+    }
+}

src/file/paragraph/math/brackets/math-ending-char.ts

@@ -0,0 +1,14 @@
+// http://www.datypic.com/sc/ooxml/e-m_endChr-1.html
+import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+
+class MathEndingCharacterAttributes extends XmlAttributeComponent<{ readonly character: string }> {
+    protected readonly xmlKeys = { character: "m:val" };
+}
+
+export class MathEndingCharacter extends XmlComponent {
+    constructor(character: string) {
+        super("m:endChr");
+
+        this.root.push(new MathEndingCharacterAttributes({ character }));
+    }
+}

src/file/paragraph/math/brackets/math-ending-character.spec.ts

@@ -0,0 +1,22 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathEndingCharacter } from "./math-ending-char";
+
+describe("MathEndingCharacter", () => {
+    describe("#constructor()", () => {
+        it("should create a MathEndingCharacter with correct root key", () => {
+            const mathEndingCharacter = new MathEndingCharacter("]");
+
+            const tree = new Formatter().format(mathEndingCharacter);
+            expect(tree).to.deep.equal({
+                "m:endChr": {
+                    _attr: {
+                        "m:val": "]",
+                    },
+                },
+            });
+        });
+    });
+});

src/file/paragraph/math/brackets/math-round-brackets.spec.ts

@@ -0,0 +1,36 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathRun } from "../math-run";
+import { MathRoundBrackets } from "./math-round-brackets";
+
+describe("MathRoundBrackets", () => {
+    describe("#constructor()", () => {
+        it("should create a MathRoundBrackets with correct root key", () => {
+            const mathRoundBrackets = new MathRoundBrackets({
+                children: [new MathRun("60")],
+            });
+
+            const tree = new Formatter().format(mathRoundBrackets);
+            expect(tree).to.deep.equal({
+                "m:d": [
+                    {
+                        "m:dPr": {},
+                    },
+                    {
+                        "m:e": [
+                            {
+                                "m:r": [
+                                    {
+                                        "m:t": ["60"],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                ],
+            });
+        });
+    });
+});

src/file/paragraph/math/brackets/math-round-brackets.ts

@@ -0,0 +1,15 @@
+// http://www.datypic.com/sc/ooxml/e-m_d-1.html
+import { XmlComponent } from "file/xml-components";
+
+import { MathComponent } from "../math-component";
+import { MathBase } from "../n-ary";
+import { MathBracketProperties } from "./math-bracket-properties";
+
+export class MathRoundBrackets extends XmlComponent {
+    constructor(options: { readonly children: MathComponent[] }) {
+        super("m:d");
+
+        this.root.push(new MathBracketProperties());
+        this.root.push(new MathBase(options.children));
+    }
+}

src/file/paragraph/math/brackets/math-square-brackets.spec.ts

@@ -0,0 +1,51 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathRun } from "../math-run";
+import { MathSquareBrackets } from "./math-square-brackets";
+
+describe("MathSquareBrackets", () => {
+    describe("#constructor()", () => {
+        it("should create a MathSquareBrackets with correct root key", () => {
+            const mathSquareBrackets = new MathSquareBrackets({
+                children: [new MathRun("60")],
+            });
+
+            const tree = new Formatter().format(mathSquareBrackets);
+            expect(tree).to.deep.equal({
+                "m:d": [
+                    {
+                        "m:dPr": [
+                            {
+                                "m:begChr": {
+                                    _attr: {
+                                        "m:val": "[",
+                                    },
+                                },
+                            },
+                            {
+                                "m:endChr": {
+                                    _attr: {
+                                        "m:val": "]",
+                                    },
+                                },
+                            },
+                        ],
+                    },
+                    {
+                        "m:e": [
+                            {
+                                "m:r": [
+                                    {
+                                        "m:t": ["60"],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                ],
+            });
+        });
+    });
+});

src/file/paragraph/math/brackets/math-square-brackets.ts

@@ -0,0 +1,20 @@
+// http://www.datypic.com/sc/ooxml/e-m_d-1.html
+import { XmlComponent } from "file/xml-components";
+
+import { MathComponent } from "../math-component";
+import { MathBase } from "../n-ary";
+import { MathBracketProperties } from "./math-bracket-properties";
+
+export class MathSquareBrackets extends XmlComponent {
+    constructor(options: { readonly children: MathComponent[] }) {
+        super("m:d");
+
+        this.root.push(
+            new MathBracketProperties({
+                beginningCharacter: "[",
+                endingCharacter: "]",
+            }),
+        );
+        this.root.push(new MathBase(options.children));
+    }
+}

src/file/paragraph/math/fraction/index.ts

@@ -0,0 +1,3 @@
+export * from "./math-fraction";
+export * from "./math-denominator";
+export * from "./math-numerator";

src/file/paragraph/math/fraction/math-denominator.spec.ts

@@ -0,0 +1,26 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathRun } from "../math-run";
+import { MathDenominator } from "./math-denominator";
+
+describe("MathDenominator", () => {
+    describe("#constructor()", () => {
+        it("should create a MathDenominator with correct root key", () => {
+            const mathDenominator = new MathDenominator([new MathRun("2+2")]);
+            const tree = new Formatter().format(mathDenominator);
+            expect(tree).to.deep.equal({
+                "m:den": [
+                    {
+                        "m:r": [
+                            {
+                                "m:t": ["2+2"],
+                            },
+                        ],
+                    },
+                ],
+            });
+        });
+    });
+});

src/file/paragraph/math/fraction/math-denominator.ts

@@ -0,0 +1,13 @@
+import { XmlComponent } from "file/xml-components";
+
+import { MathComponent } from "../math-component";
+
+export class MathDenominator extends XmlComponent {
+    constructor(children: MathComponent[]) {
+        super("m:den");
+
+        for (const child of children) {
+            this.root.push(child);
+        }
+    }
+}

src/file/paragraph/math/fraction/math-fraction.spec.ts

@@ -0,0 +1,44 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathRun } from "../math-run";
+import { MathFraction } from "./math-fraction";
+
+describe("MathFraction", () => {
+    describe("#constructor()", () => {
+        it("should create a MathFraction with correct root key", () => {
+            const mathFraction = new MathFraction({
+                numerator: [new MathRun("2")],
+                denominator: [new MathRun("2")],
+            });
+            const tree = new Formatter().format(mathFraction);
+            expect(tree).to.deep.equal({
+                "m:f": [
+                    {
+                        "m:num": [
+                            {
+                                "m:r": [
+                                    {
+                                        "m:t": ["2"],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                    {
+                        "m:den": [
+                            {
+                                "m:r": [
+                                    {
+                                        "m:t": ["2"],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                ],
+            });
+        });
+    });
+});

src/file/paragraph/math/fraction/math-fraction.ts

@@ -0,0 +1,19 @@
+import { XmlComponent } from "file/xml-components";
+
+import { MathComponent } from "../math-component";
+import { MathDenominator } from "./math-denominator";
+import { MathNumerator } from "./math-numerator";
+
+export interface IMathFractionOptions {
+    readonly numerator: MathComponent[];
+    readonly denominator: MathComponent[];
+}
+
+export class MathFraction extends XmlComponent {
+    constructor(options: IMathFractionOptions) {
+        super("m:f");
+
+        this.root.push(new MathNumerator(options.numerator));
+        this.root.push(new MathDenominator(options.denominator));
+    }
+}

src/file/paragraph/math/fraction/math-numerator.spec.ts

@@ -0,0 +1,26 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathRun } from "../math-run";
+import { MathNumerator } from "./math-numerator";
+
+describe("MathNumerator", () => {
+    describe("#constructor()", () => {
+        it("should create a MathNumerator with correct root key", () => {
+            const mathNumerator = new MathNumerator([new MathRun("2+2")]);
+            const tree = new Formatter().format(mathNumerator);
+            expect(tree).to.deep.equal({
+                "m:num": [
+                    {
+                        "m:r": [
+                            {
+                                "m:t": ["2+2"],
+                            },
+                        ],
+                    },
+                ],
+            });
+        });
+    });
+});

src/file/paragraph/math/fraction/math-numerator.ts

@@ -0,0 +1,13 @@
+import { XmlComponent } from "file/xml-components";
+
+import { MathComponent } from "../math-component";
+
+export class MathNumerator extends XmlComponent {
+    constructor(children: MathComponent[]) {
+        super("m:num");
+
+        for (const child of children) {
+            this.root.push(child);
+        }
+    }
+}

src/file/paragraph/math/function/index.ts

@@ -0,0 +1,3 @@
+export * from "./math-function";
+export * from "./math-function-name";
+export * from "./math-function-properties";

src/file/paragraph/math/function/math-function-name.spec.ts

@@ -0,0 +1,27 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathRun } from "../math-run";
+import { MathFunctionName } from "./math-function-name";
+
+describe("MathFunctionName", () => {
+    describe("#constructor()", () => {
+        it("should create a MathFunctionName with correct root key", () => {
+            const mathFunctionName = new MathFunctionName([new MathRun("2")]);
+
+            const tree = new Formatter().format(mathFunctionName);
+            expect(tree).to.deep.equal({
+                "m:fName": [
+                    {
+                        "m:r": [
+                            {
+                                "m:t": ["2"],
+                            },
+                        ],
+                    },
+                ],
+            });
+        });
+    });
+});

src/file/paragraph/math/function/math-function-name.ts

@@ -0,0 +1,13 @@
+// http://www.datypic.com/sc/ooxml/e-m_fName-1.html
+import { XmlComponent } from "file/xml-components";
+import { MathComponent } from "../math-component";
+
+export class MathFunctionName extends XmlComponent {
+    constructor(children: MathComponent[]) {
+        super("m:fName");
+
+        for (const child of children) {
+            this.root.push(child);
+        }
+    }
+}

src/file/paragraph/math/function/math-function-properties.spec.ts

@@ -0,0 +1,18 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathFunctionProperties } from "./math-function-properties";
+
+describe("MathFunctionProperties", () => {
+    describe("#constructor()", () => {
+        it("should create a MathFunctionProperties with correct root key", () => {
+            const mathFunctionProperties = new MathFunctionProperties();
+
+            const tree = new Formatter().format(mathFunctionProperties);
+            expect(tree).to.deep.equal({
+                "m:funcPr": {},
+            });
+        });
+    });
+});

src/file/paragraph/math/function/math-function-properties.ts

@@ -0,0 +1,8 @@
+// http://www.datypic.com/sc/ooxml/e-m_radPr-1.html
+import { XmlComponent } from "file/xml-components";
+
+export class MathFunctionProperties extends XmlComponent {
+    constructor() {
+        super("m:funcPr");
+    }
+}

src/file/paragraph/math/function/math-function.spec.ts

@@ -0,0 +1,48 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathRun } from "../math-run";
+import { MathFunction } from "./math-function";
+
+describe("MathFunction", () => {
+    describe("#constructor()", () => {
+        it("should create a MathFunction with correct root key", () => {
+            const mathFunction = new MathFunction({
+                name: [new MathRun("sin")],
+                children: [new MathRun("60")],
+            });
+
+            const tree = new Formatter().format(mathFunction);
+            expect(tree).to.deep.equal({
+                "m:func": [
+                    {
+                        "m:funcPr": {},
+                    },
+                    {
+                        "m:fName": [
+                            {
+                                "m:r": [
+                                    {
+                                        "m:t": ["sin"],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                    {
+                        "m:e": [
+                            {
+                                "m:r": [
+                                    {
+                                        "m:t": ["60"],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                ],
+            });
+        });
+    });
+});

src/file/paragraph/math/function/math-function.ts

@@ -0,0 +1,22 @@
+// http://www.datypic.com/sc/ooxml/e-m_func-1.html
+import { XmlComponent } from "file/xml-components";
+
+import { MathComponent } from "../math-component";
+import { MathBase } from "../n-ary";
+import { MathFunctionName } from "./math-function-name";
+import { MathFunctionProperties } from "./math-function-properties";
+
+export interface IMathFunctionOptions {
+    readonly children: MathComponent[];
+    readonly name: MathComponent[];
+}
+
+export class MathFunction extends XmlComponent {
+    constructor(options: IMathFunctionOptions) {
+        super("m:func");
+
+        this.root.push(new MathFunctionProperties());
+        this.root.push(new MathFunctionName(options.name));
+        this.root.push(new MathBase(options.children));
+    }
+}

src/file/paragraph/math/index.ts

@@ -0,0 +1,9 @@
+export * from "./math";
+export * from "./math-run";
+export * from "./fraction";
+export * from "./n-ary";
+export * from "./script";
+export * from "./math-component";
+export * from "./radical";
+export * from "./function";
+export * from "./brackets";

src/file/paragraph/math/math-component.ts

@@ -0,0 +1,27 @@
+import { MathAngledBrackets, MathCurlyBrackets, MathRoundBrackets, MathSquareBrackets } from "./brackets";
+import { MathFraction } from "./fraction";
+import { MathFunction } from "./function";
+import { MathRun } from "./math-run";
+import { MathSum } from "./n-ary";
+import { MathRadical } from "./radical";
+import { MathSubScript, MathSubSuperScript, MathSuperScript } from "./script";
+
+export type MathComponent =
+    | MathRun
+    | MathFraction
+    | MathSum
+    | MathSuperScript
+    | MathSubScript
+    | MathSubSuperScript
+    | MathRadical
+    | MathFunction
+    | MathRoundBrackets
+    | MathCurlyBrackets
+    | MathAngledBrackets
+    | MathSquareBrackets;
+
+// Needed because of: https://github.com/s-panferov/awesome-typescript-loader/issues/432
+/**
+ * @ignore
+ */
+export const WORKAROUND4 = "";

src/file/paragraph/math/math-run.spec.ts

@@ -0,0 +1,21 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathRun } from "./math-run";
+
+describe("MathRun", () => {
+    describe("#constructor()", () => {
+        it("should create a MathRun with correct root key", () => {
+            const mathRun = new MathRun("2+2");
+            const tree = new Formatter().format(mathRun);
+            expect(tree).to.deep.equal({
+                "m:r": [
+                    {
+                        "m:t": ["2+2"],
+                    },
+                ],
+            });
+        });
+    });
+});

src/file/paragraph/math/math-run.ts

@@ -0,0 +1,12 @@
+// http://www.datypic.com/sc/ooxml/e-m_r-1.html
+import { XmlComponent } from "file/xml-components";
+
+import { MathText } from "./math-text";
+
+export class MathRun extends XmlComponent {
+    constructor(text: string) {
+        super("m:r");
+
+        this.root.push(new MathText(text));
+    }
+}

src/file/paragraph/math/math-text.spec.ts

@@ -0,0 +1,17 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathText } from "./math-text";
+
+describe("MathText", () => {
+    describe("#constructor()", () => {
+        it("should create a MathText with correct root key", () => {
+            const mathText = new MathText("2+2");
+            const tree = new Formatter().format(mathText);
+            expect(tree).to.deep.equal({
+                "m:t": ["2+2"],
+            });
+        });
+    });
+});

src/file/paragraph/math/math-text.ts

@@ -0,0 +1,9 @@
+import { XmlComponent } from "file/xml-components";
+
+export class MathText extends XmlComponent {
+    constructor(text: string) {
+        super("m:t");
+
+        this.root.push(text);
+    }
+}

src/file/paragraph/math/math.spec.ts

@@ -0,0 +1,38 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { Math } from "./math";
+import { MathRun } from "./math-run";
+
+describe("Math", () => {
+    describe("#constructor()", () => {
+        it("should create a Math with correct root key", () => {
+            const math = new Math({
+                children: [],
+            });
+            const tree = new Formatter().format(math);
+            expect(tree).to.deep.equal({
+                "m:oMath": {},
+            });
+        });
+
+        it("should be able to add children", () => {
+            const math = new Math({
+                children: [new MathRun("2+2")],
+            });
+            const tree = new Formatter().format(math);
+            expect(tree).to.deep.equal({
+                "m:oMath": [
+                    {
+                        "m:r": [
+                            {
+                                "m:t": ["2+2"],
+                            },
+                        ],
+                    },
+                ],
+            });
+        });
+    });
+});

src/file/paragraph/math/math.ts

@@ -0,0 +1,18 @@
+// http://www.datypic.com/sc/ooxml/e-m_oMath-1.html
+import { XmlComponent } from "file/xml-components";
+
+import { MathComponent } from "./math-component";
+
+export interface IMathOptions {
+    readonly children: MathComponent[];
+}
+
+export class Math extends XmlComponent {
+    constructor(options: IMathOptions) {
+        super("m:oMath");
+
+        for (const child of options.children) {
+            this.root.push(child);
+        }
+    }
+}

src/file/paragraph/math/n-ary/index.ts

@@ -0,0 +1,7 @@
+export * from "./math-accent-character";
+export * from "./math-base";
+export * from "./math-limit-location";
+export * from "./math-naray-properties";
+export * from "./math-sub-script";
+export * from "./math-sum";
+export * from "./math-super-script";

src/file/paragraph/math/n-ary/math-accent-character.spec.ts

@@ -0,0 +1,22 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathAccentCharacter } from "./math-accent-character";
+
+describe("MathAccentCharacter", () => {
+    describe("#constructor()", () => {
+        it("should create a MathAccentCharacter with correct root key", () => {
+            const mathAccentCharacter = new MathAccentCharacter("∑");
+
+            const tree = new Formatter().format(mathAccentCharacter);
+            expect(tree).to.deep.equal({
+                "m:chr": {
+                    _attr: {
+                        "m:val": "∑",
+                    },
+                },
+            });
+        });
+    });
+});

src/file/paragraph/math/n-ary/math-accent-character.ts

@@ -0,0 +1,14 @@
+// http://www.datypic.com/sc/ooxml/e-m_chr-1.html
+import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+
+class MathAccentCharacterAttributes extends XmlAttributeComponent<{ readonly accent: string }> {
+    protected readonly xmlKeys = { accent: "m:val" };
+}
+
+export class MathAccentCharacter extends XmlComponent {
+    constructor(accent: string) {
+        super("m:chr");
+
+        this.root.push(new MathAccentCharacterAttributes({ accent }));
+    }
+}

src/file/paragraph/math/n-ary/math-base.spec.ts

@@ -0,0 +1,27 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathRun } from "../math-run";
+import { MathBase } from "./math-base";
+
+describe("MathBase", () => {
+    describe("#constructor()", () => {
+        it("should create a MathBase with correct root key", () => {
+            const mathBase = new MathBase([new MathRun("2+2")]);
+
+            const tree = new Formatter().format(mathBase);
+            expect(tree).to.deep.equal({
+                "m:e": [
+                    {
+                        "m:r": [
+                            {
+                                "m:t": ["2+2"],
+                            },
+                        ],
+                    },
+                ],
+            });
+        });
+    });
+});

src/file/paragraph/math/n-ary/math-base.ts

@@ -0,0 +1,14 @@
+// http://www.datypic.com/sc/ooxml/e-m_e-1.html
+import { XmlComponent } from "file/xml-components";
+
+import { MathComponent } from "../math-component";
+
+export class MathBase extends XmlComponent {
+    constructor(children: MathComponent[]) {
+        super("m:e");
+
+        for (const child of children) {
+            this.root.push(child);
+        }
+    }
+}

src/file/paragraph/math/n-ary/math-limit-location.spec.ts

@@ -0,0 +1,22 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathLimitLocation } from "./math-limit-location";
+
+describe("MathLimitLocation", () => {
+    describe("#constructor()", () => {
+        it("should create a MathLimitLocation with correct root key", () => {
+            const mathLimitLocation = new MathLimitLocation();
+
+            const tree = new Formatter().format(mathLimitLocation);
+            expect(tree).to.deep.equal({
+                "m:limLoc": {
+                    _attr: {
+                        "m:val": "undOvr",
+                    },
+                },
+            });
+        });
+    });
+});

src/file/paragraph/math/n-ary/math-limit-location.ts

@@ -0,0 +1,14 @@
+// http://www.datypic.com/sc/ooxml/e-m_limLoc-1.html
+import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+
+class MathLimitLocationAttributes extends XmlAttributeComponent<{ readonly value: string }> {
+    protected readonly xmlKeys = { value: "m:val" };
+}
+
+export class MathLimitLocation extends XmlComponent {
+    constructor() {
+        super("m:limLoc");
+
+        this.root.push(new MathLimitLocationAttributes({ value: "undOvr" }));
+    }
+}

src/file/paragraph/math/n-ary/math-naray-properties.spec.ts

@@ -0,0 +1,133 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathNArayProperties } from "./math-naray-properties";
+
+describe("MathNArayProperties", () => {
+    describe("#constructor()", () => {
+        it("should create a MathNArayProperties with correct root key", () => {
+            const mathNArayProperties = new MathNArayProperties("∑", true, true);
+
+            const tree = new Formatter().format(mathNArayProperties);
+            expect(tree).to.deep.equal({
+                "m:naryPr": [
+                    {
+                        "m:chr": {
+                            _attr: {
+                                "m:val": "∑",
+                            },
+                        },
+                    },
+                    {
+                        "m:limLoc": {
+                            _attr: {
+                                "m:val": "undOvr",
+                            },
+                        },
+                    },
+                ],
+            });
+        });
+
+        it("should add super-script hide attributes", () => {
+            const mathNArayProperties = new MathNArayProperties("∑", false, true);
+
+            const tree = new Formatter().format(mathNArayProperties);
+            expect(tree).to.deep.equal({
+                "m:naryPr": [
+                    {
+                        "m:chr": {
+                            _attr: {
+                                "m:val": "∑",
+                            },
+                        },
+                    },
+                    {
+                        "m:limLoc": {
+                            _attr: {
+                                "m:val": "undOvr",
+                            },
+                        },
+                    },
+                    {
+                        "m:supHide": {
+                            _attr: {
+                                "m:val": 1,
+                            },
+                        },
+                    },
+                ],
+            });
+        });
+
+        it("should add sub-script hide attributes", () => {
+            const mathNArayProperties = new MathNArayProperties("∑", true, false);
+
+            const tree = new Formatter().format(mathNArayProperties);
+            expect(tree).to.deep.equal({
+                "m:naryPr": [
+                    {
+                        "m:chr": {
+                            _attr: {
+                                "m:val": "∑",
+                            },
+                        },
+                    },
+                    {
+                        "m:limLoc": {
+                            _attr: {
+                                "m:val": "undOvr",
+                            },
+                        },
+                    },
+                    {
+                        "m:subHide": {
+                            _attr: {
+                                "m:val": 1,
+                            },
+                        },
+                    },
+                ],
+            });
+        });
+
+        it("should add both super-script and sub-script hide attributes", () => {
+            const mathNArayProperties = new MathNArayProperties("∑", false, false);
+
+            const tree = new Formatter().format(mathNArayProperties);
+            expect(tree).to.deep.equal({
+                "m:naryPr": [
+                    {
+                        "m:chr": {
+                            _attr: {
+                                "m:val": "∑",
+                            },
+                        },
+                    },
+                    {
+                        "m:limLoc": {
+                            _attr: {
+                                "m:val": "undOvr",
+                            },
+                        },
+                    },
+                    {
+                        "m:supHide": {
+                            _attr: {
+                                "m:val": 1,
+                            },
+                        },
+                    },
+                    {
+                        "m:subHide": {
+                            _attr: {
+                                "m:val": 1,
+                            },
+                        },
+                    },
+                ],
+            });
+        });
+    });
+});

src/file/paragraph/math/n-ary/math-naray-properties.ts

@@ -0,0 +1,24 @@
+// http://www.datypic.com/sc/ooxml/e-m_naryPr-1.html
+import { XmlComponent } from "file/xml-components";
+
+import { MathAccentCharacter } from "./math-accent-character";
+import { MathLimitLocation } from "./math-limit-location";
+import { MathSubScriptHide } from "./math-sub-script-hide";
+import { MathSuperScriptHide } from "./math-super-script-hide";
+
+export class MathNArayProperties extends XmlComponent {
+    constructor(accent: string, hasSuperScript: boolean, hasSubScript: boolean) {
+        super("m:naryPr");
+
+        this.root.push(new MathAccentCharacter(accent));
+        this.root.push(new MathLimitLocation());
+
+        if (!hasSuperScript) {
+            this.root.push(new MathSuperScriptHide());
+        }
+
+        if (!hasSubScript) {
+            this.root.push(new MathSubScriptHide());
+        }
+    }
+}

src/file/paragraph/math/n-ary/math-sub-script-hide.spec.ts

@@ -0,0 +1,22 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathSubScriptHide } from "./math-sub-script-hide";
+
+describe("MathSubScriptHide", () => {
+    describe("#constructor()", () => {
+        it("should create a MathSubScriptHide with correct root key", () => {
+            const mathSubScriptHide = new MathSubScriptHide();
+
+            const tree = new Formatter().format(mathSubScriptHide);
+            expect(tree).to.deep.equal({
+                "m:subHide": {
+                    _attr: {
+                        "m:val": 1,
+                    },
+                },
+            });
+        });
+    });
+});

src/file/paragraph/math/n-ary/math-sub-script-hide.ts

@@ -0,0 +1,14 @@
+// http://www.datypic.com/sc/ooxml/e-m_subHide-1.html
+import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+
+class MathSubScriptHideAttributes extends XmlAttributeComponent<{ readonly hide: number }> {
+    protected readonly xmlKeys = { hide: "m:val" };
+}
+
+export class MathSubScriptHide extends XmlComponent {
+    constructor() {
+        super("m:subHide");
+
+        this.root.push(new MathSubScriptHideAttributes({ hide: 1 }));
+    }
+}

src/file/paragraph/math/n-ary/math-sub-script.spec.ts

@@ -0,0 +1,27 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathRun } from "../math-run";
+import { MathSubScriptElement } from "./math-sub-script";
+
+describe("MathSubScriptElement", () => {
+    describe("#constructor()", () => {
+        it("should create a MathSubScriptElement with correct root key", () => {
+            const mathSubScriptElement = new MathSubScriptElement([new MathRun("2+2")]);
+
+            const tree = new Formatter().format(mathSubScriptElement);
+            expect(tree).to.deep.equal({
+                "m:sub": [
+                    {
+                        "m:r": [
+                            {
+                                "m:t": ["2+2"],
+                            },
+                        ],
+                    },
+                ],
+            });
+        });
+    });
+});

src/file/paragraph/math/n-ary/math-sub-script.ts

@@ -0,0 +1,14 @@
+// http://www.datypic.com/sc/ooxml/e-m_sub-3.html
+import { XmlComponent } from "file/xml-components";
+
+import { MathComponent } from "../math-component";
+
+export class MathSubScriptElement extends XmlComponent {
+    constructor(children: MathComponent[]) {
+        super("m:sub");
+
+        for (const child of children) {
+            this.root.push(child);
+        }
+    }
+}

src/file/paragraph/math/n-ary/math-sum.spec.ts

@@ -0,0 +1,75 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathRun } from "../math-run";
+import { MathSum } from "./math-sum";
+
+describe("MathSum", () => {
+    describe("#constructor()", () => {
+        it("should create a MathSum with correct root key", () => {
+            const mathSum = new MathSum({
+                children: [new MathRun("1")],
+                subScript: [new MathRun("2")],
+                superScript: [new MathRun("3")],
+            });
+
+            const tree = new Formatter().format(mathSum);
+            expect(tree).to.deep.equal({
+                "m:nary": [
+                    {
+                        "m:naryPr": [
+                            {
+                                "m:chr": {
+                                    _attr: {
+                                        "m:val": "∑",
+                                    },
+                                },
+                            },
+                            {
+                                "m:limLoc": {
+                                    _attr: {
+                                        "m:val": "undOvr",
+                                    },
+                                },
+                            },
+                        ],
+                    },
+                    {
+                        "m:sub": [
+                            {
+                                "m:r": [
+                                    {
+                                        "m:t": ["2"],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                    {
+                        "m:sup": [
+                            {
+                                "m:r": [
+                                    {
+                                        "m:t": ["3"],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                    {
+                        "m:e": [
+                            {
+                                "m:r": [
+                                    {
+                                        "m:t": ["1"],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                ],
+            });
+        });
+    });
+});

src/file/paragraph/math/n-ary/math-sum.ts

@@ -0,0 +1,32 @@
+// http://www.datypic.com/sc/ooxml/e-m_nary-1.html
+import { XmlComponent } from "file/xml-components";
+
+import { MathComponent } from "../math-component";
+import { MathBase } from "./math-base";
+import { MathNArayProperties } from "./math-naray-properties";
+import { MathSubScriptElement } from "./math-sub-script";
+import { MathSuperScriptElement } from "./math-super-script";
+
+export interface IMathSumOptions {
+    readonly children: MathComponent[];
+    readonly subScript?: MathComponent[];
+    readonly superScript?: MathComponent[];
+}
+
+export class MathSum extends XmlComponent {
+    constructor(options: IMathSumOptions) {
+        super("m:nary");
+
+        this.root.push(new MathNArayProperties("∑", !!options.superScript, !!options.subScript));
+
+        if (!!options.subScript) {
+            this.root.push(new MathSubScriptElement(options.subScript));
+        }
+
+        if (!!options.superScript) {
+            this.root.push(new MathSuperScriptElement(options.superScript));
+        }
+
+        this.root.push(new MathBase(options.children));
+    }
+}

src/file/paragraph/math/n-ary/math-super-script-hide.spec.ts

@@ -0,0 +1,22 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathSuperScriptHide } from "./math-super-script-hide";
+
+describe("MathSuperScriptHide", () => {
+    describe("#constructor()", () => {
+        it("should create a MathSuperScriptHide with correct root key", () => {
+            const mathSuperScriptHide = new MathSuperScriptHide();
+
+            const tree = new Formatter().format(mathSuperScriptHide);
+            expect(tree).to.deep.equal({
+                "m:supHide": {
+                    _attr: {
+                        "m:val": 1,
+                    },
+                },
+            });
+        });
+    });
+});

src/file/paragraph/math/n-ary/math-super-script-hide.ts

@@ -0,0 +1,14 @@
+// http://www.datypic.com/sc/ooxml/e-m_subHide-1.html
+import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+
+class MathSuperScriptHideAttributes extends XmlAttributeComponent<{ readonly hide: number }> {
+    protected readonly xmlKeys = { hide: "m:val" };
+}
+
+export class MathSuperScriptHide extends XmlComponent {
+    constructor() {
+        super("m:supHide");
+
+        this.root.push(new MathSuperScriptHideAttributes({ hide: 1 }));
+    }
+}

src/file/paragraph/math/n-ary/math-super-script.spec.ts

@@ -0,0 +1,27 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathRun } from "../math-run";
+import { MathSuperScriptElement } from "./math-super-script";
+
+describe("MathSuperScriptElement", () => {
+    describe("#constructor()", () => {
+        it("should create a MathSuperScriptElement with correct root key", () => {
+            const mathSuperScriptElement = new MathSuperScriptElement([new MathRun("2+2")]);
+
+            const tree = new Formatter().format(mathSuperScriptElement);
+            expect(tree).to.deep.equal({
+                "m:sup": [
+                    {
+                        "m:r": [
+                            {
+                                "m:t": ["2+2"],
+                            },
+                        ],
+                    },
+                ],
+            });
+        });
+    });
+});

src/file/paragraph/math/n-ary/math-super-script.ts

@@ -0,0 +1,14 @@
+// http://www.datypic.com/sc/ooxml/e-m_sup-3.html
+import { XmlComponent } from "file/xml-components";
+
+import { MathComponent } from "../math-component";
+
+export class MathSuperScriptElement extends XmlComponent {
+    constructor(children: MathComponent[]) {
+        super("m:sup");
+
+        for (const child of children) {
+            this.root.push(child);
+        }
+    }
+}

src/file/paragraph/math/radical/index.ts

@@ -0,0 +1,3 @@
+export * from "./math-degree";
+export * from "./math-radical";
+export * from "./math-radical-properties";

src/file/paragraph/math/radical/math-degree-hide.spec.ts

@@ -0,0 +1,22 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathDegreeHide } from "./math-degree-hide";
+
+describe("MathDegreeHide", () => {
+    describe("#constructor()", () => {
+        it("should create a MathDegreeHide with correct root key", () => {
+            const mathDegreeHide = new MathDegreeHide();
+
+            const tree = new Formatter().format(mathDegreeHide);
+            expect(tree).to.deep.equal({
+                "m:degHide": {
+                    _attr: {
+                        "m:val": 1,
+                    },
+                },
+            });
+        });
+    });
+});

src/file/paragraph/math/radical/math-degree-hide.ts

@@ -0,0 +1,14 @@
+// http://www.datypic.com/sc/ooxml/e-m_degHide-1.html
+import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+
+class MathDegreeHideAttributes extends XmlAttributeComponent<{ readonly hide: number }> {
+    protected readonly xmlKeys = { hide: "m:val" };
+}
+
+export class MathDegreeHide extends XmlComponent {
+    constructor() {
+        super("m:degHide");
+
+        this.root.push(new MathDegreeHideAttributes({ hide: 1 }));
+    }
+}

src/file/paragraph/math/radical/math-degree.spec.ts

@@ -0,0 +1,36 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathRun } from "../math-run";
+import { MathDegree } from "./math-degree";
+
+describe("MathDegree", () => {
+    describe("#constructor()", () => {
+        it("should create a MathDegree with correct root key", () => {
+            const mathDegree = new MathDegree();
+
+            const tree = new Formatter().format(mathDegree);
+            expect(tree).to.deep.equal({
+                "m:deg": {},
+            });
+        });
+
+        it("should create a MathDegree with correct root key with child", () => {
+            const mathDegree = new MathDegree([new MathRun("2")]);
+
+            const tree = new Formatter().format(mathDegree);
+            expect(tree).to.deep.equal({
+                "m:deg": [
+                    {
+                        "m:r": [
+                            {
+                                "m:t": ["2"],
+                            },
+                        ],
+                    },
+                ],
+            });
+        });
+    });
+});

src/file/paragraph/math/radical/math-degree.ts

@@ -0,0 +1,15 @@
+// http://www.datypic.com/sc/ooxml/e-m_deg-1.html
+import { XmlComponent } from "file/xml-components";
+import { MathComponent } from "../math-component";
+
+export class MathDegree extends XmlComponent {
+    constructor(children?: MathComponent[]) {
+        super("m:deg");
+
+        if (!!children) {
+            for (const child of children) {
+                this.root.push(child);
+            }
+        }
+    }
+}

src/file/paragraph/math/radical/math-radical-properties.spec.ts

@@ -0,0 +1,35 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathRadicalProperties } from "./math-radical-properties";
+
+describe("MathRadicalProperties", () => {
+    describe("#constructor()", () => {
+        it("should create a MathRadicalProperties with correct root key", () => {
+            const mathRadicalProperties = new MathRadicalProperties(true);
+
+            const tree = new Formatter().format(mathRadicalProperties);
+            expect(tree).to.deep.equal({
+                "m:radPr": {},
+            });
+        });
+
+        it("should create a MathRadicalProperties with correct root key with degree hide", () => {
+            const mathRadicalProperties = new MathRadicalProperties(false);
+
+            const tree = new Formatter().format(mathRadicalProperties);
+            expect(tree).to.deep.equal({
+                "m:radPr": [
+                    {
+                        "m:degHide": {
+                            _attr: {
+                                "m:val": 1,
+                            },
+                        },
+                    },
+                ],
+            });
+        });
+    });
+});

src/file/paragraph/math/radical/math-radical-properties.ts

@@ -0,0 +1,13 @@
+// http://www.datypic.com/sc/ooxml/e-m_radPr-1.html
+import { XmlComponent } from "file/xml-components";
+import { MathDegreeHide } from "./math-degree-hide";
+
+export class MathRadicalProperties extends XmlComponent {
+    constructor(hasDegree: boolean) {
+        super("m:radPr");
+
+        if (!hasDegree) {
+            this.root.push(new MathDegreeHide());
+        }
+    }
+}

src/file/paragraph/math/radical/math-radical.spec.ts

@@ -0,0 +1,48 @@
+import { expect } from "chai";
+
+import { Formatter } from "export/formatter";
+
+import { MathRun } from "../math-run";
+import { MathRadical } from "./math-radical";
+
+describe("MathRadical", () => {
+    describe("#constructor()", () => {
+        it("should create a MathRadical with correct root key", () => {
+            const mathRadical = new MathRadical({
+                children: [new MathRun("e")],
+                degree: [new MathRun("2")],
+            });
+
+            const tree = new Formatter().format(mathRadical);
+            expect(tree).to.deep.equal({
+                "m:rad": [
+                    {
+                        "m:radPr": {},
+                    },
+                    {
+                        "m:deg": [
+                            {
+                                "m:r": [
+                                    {
+                                        "m:t": ["2"],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                    {
+                        "m:e": [
+                            {
+                                "m:r": [
+                                    {
+                                        "m:t": ["e"],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                ],
+            });
+        });
+    });
+});

src/file/paragraph/math/radical/math-radical.ts

@@ -0,0 +1,22 @@
+// http://www.datypic.com/sc/ooxml/e-m_rad-1.html
+import { XmlComponent } from "file/xml-components";
+
+import { MathComponent } from "../math-component";
+import { MathBase } from "../n-ary";
+import { MathDegree } from "./math-degree";
+import { MathRadicalProperties } from "./math-radical-properties";
+
+export interface IMathRadicalOptions {
+    readonly children: MathComponent[];
+    readonly degree?: MathComponent[];
+}
+
+export class MathRadical extends XmlComponent {
+    constructor(options: IMathRadicalOptions) {
+        super("m:rad");
+
+        this.root.push(new MathRadicalProperties(!!options.degree));
+        this.root.push(new MathDegree(options.degree));
+        this.root.push(new MathBase(options.children));
+    }
+}

src/file/paragraph/math/script/index.ts

@@ -0,0 +1,4 @@
+export * from "./super-script";
+export * from "./sub-script";
+export * from "./sub-super-script";
+export * from "./pre-sub-super-script";