docx 7.5.0 → 7.6.0

package/build/tests/utility.d.ts

@@ -1,3 +1,3 @@
-export declare class Utility {
-    static jsonify(obj: object): any;
-}
+export declare class Utility {
+    static jsonify(obj: object): any;
+}

package/build/util/convenience-functions.d.ts

@@ -1,4 +1,4 @@
-export declare const convertMillimetersToTwip: (millimeters: number) => number;
-export declare const convertInchesToTwip: (inches: number) => number;
-export declare const uniqueNumericId: () => number;
-export declare const uniqueId: () => string;
+export declare const convertMillimetersToTwip: (millimeters: number) => number;
+export declare const convertInchesToTwip: (inches: number) => number;
+export declare const uniqueNumericId: () => number;
+export declare const uniqueId: () => string;

package/build/util/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./convenience-functions";
-export * from "./values";
+export * from "./convenience-functions";
+export * from "./values";

package/build/util/values.d.ts

@@ -1,17 +1,17 @@
-export declare const decimalNumber: (val: number) => number;
-export declare const unsignedDecimalNumber: (val: number) => number;
-export declare const longHexNumber: (val: string) => string;
-export declare const shortHexNumber: (val: string) => string;
-export declare const uCharHexNumber: (val: string) => string;
-export declare const universalMeasureValue: (val: string) => string;
-export declare const positiveUniversalMeasureValue: (val: string) => string;
-export declare const hexColorValue: (val: string) => string;
-export declare const signedTwipsMeasureValue: (val: string | number) => string | number;
-export declare const hpsMeasureValue: (val: string | number) => string | number;
-export declare const signedHpsMeasureValue: (val: string | number) => string | number;
-export declare const twipsMeasureValue: (val: string | number) => string | number;
-export declare const percentageValue: (val: string) => string;
-export declare const measurementOrPercentValue: (val: number | string) => number | string;
-export declare const eighthPointMeasureValue: (val: number) => number;
-export declare const pointMeasureValue: (val: number) => number;
-export declare const dateTimeValue: (val: Date) => string;
+export declare const decimalNumber: (val: number) => number;
+export declare const unsignedDecimalNumber: (val: number) => number;
+export declare const longHexNumber: (val: string) => string;
+export declare const shortHexNumber: (val: string) => string;
+export declare const uCharHexNumber: (val: string) => string;
+export declare const universalMeasureValue: (val: string) => string;
+export declare const positiveUniversalMeasureValue: (val: string) => string;
+export declare const hexColorValue: (val: string) => string;
+export declare const signedTwipsMeasureValue: (val: string | number) => string | number;
+export declare const hpsMeasureValue: (val: string | number) => string | number;
+export declare const signedHpsMeasureValue: (val: string | number) => string | number;
+export declare const twipsMeasureValue: (val: string | number) => string | number;
+export declare const percentageValue: (val: string) => string;
+export declare const measurementOrPercentValue: (val: number | string) => number | string;
+export declare const eighthPointMeasureValue: (val: number) => number;
+export declare const pointMeasureValue: (val: number) => number;
+export declare const dateTimeValue: (val: Date) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docx",
-  "version": "7.5.0",
+  "version": "7.6.0",
   "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": {
@@ -65,7 +65,7 @@
   "devDependencies": {
     "@types/chai": "^4.2.15",
     "@types/glob": "^8.0.0",
-    "@types/mocha": "^9.0.0",
+    "@types/mocha": "^10.0.0",
     "@types/prompt": "^1.1.1",
     "@types/request-promise": "^4.1.42",
     "@types/shelljs": "^0.8.9",
@@ -84,7 +84,7 @@
     "eslint-plugin-jsdoc": "^39.3.6",
     "eslint-plugin-no-null": "^1.0.2",
     "eslint-plugin-prefer-arrow": "^1.2.3",
-    "eslint-plugin-unicorn": "^43.0.2",
+    "eslint-plugin-unicorn": "^44.0.0",
     "glob": "^8.0.1",
     "jszip": "^3.1.5",
     "mocha": "^10.0.0",
@@ -105,7 +105,7 @@
     "tsconfig-paths": "^4.0.0",
     "tsconfig-paths-webpack-plugin": "^4.0.0",
     "typedoc": "^0.23.2",
-    "typescript": "4.7.4",
+    "typescript": "4.8.4",
     "unzipper": "^0.10.11",
     "webpack": "^5.28.0",
     "webpack-cli": "^4.6.0"

package/src/file/paragraph/formatting/tab-stop.spec.ts

@@ -8,7 +8,7 @@ describe("LeftTabStop", () => {
     let tabStop: TabStop;
 
     beforeEach(() => {
-        tabStop = new TabStop(TabStopType.LEFT, 100);
+        tabStop = new TabStop([{ type: TabStopType.LEFT, position: 100 }]);
     });
 
     describe("#constructor()", () => {
@@ -32,7 +32,7 @@ describe("RightTabStop", () => {
     let tabStop: TabStop;
 
     beforeEach(() => {
-        tabStop = new TabStop(TabStopType.RIGHT, 100, LeaderType.DOT);
+        tabStop = new TabStop([{ type: TabStopType.RIGHT, position: 100, leader: LeaderType.DOT }]);
     });
 
     describe("#constructor()", () => {

package/src/file/paragraph/formatting/tab-stop.ts

@@ -1,10 +1,19 @@
 // http://officeopenxml.com/WPtab.php
 import { XmlAttributeComponent, XmlComponent } from "@file/xml-components";
 
+export interface TabStopDefinition {
+    readonly type: TabStopType;
+    readonly position: number | TabStopPosition;
+    readonly leader?: LeaderType;
+}
+
 export class TabStop extends XmlComponent {
-    public constructor(type: TabStopType, position: number, leader?: LeaderType) {
+    public constructor(tabDefinitions: readonly TabStopDefinition[]) {
         super("w:tabs");
-        this.root.push(new TabStopItem(type, position, leader));
+
+        for (const tabDefinition of tabDefinitions) {
+            this.root.push(new TabStopItem(tabDefinition));
+        }
     }
 }
 
@@ -41,13 +50,13 @@ export class TabAttributes extends XmlAttributeComponent<{
 }
 
 export class TabStopItem extends XmlComponent {
-    public constructor(value: TabStopType, position: string | number, leader?: LeaderType) {
+    public constructor({ type, position, leader }: TabStopDefinition) {
         super("w:tab");
         this.root.push(
             new TabAttributes({
-                val: value,
+                val: type,
                 pos: position,
-                leader,
+                leader: leader,
             }),
         );
     }

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

@@ -2,7 +2,7 @@ import { MathAngledBrackets, MathCurlyBrackets, MathRoundBrackets, MathSquareBra
 import { MathFraction } from "./fraction";
 import { MathFunction } from "./function";
 import { MathRun } from "./math-run";
-import { MathSum } from "./n-ary";
+import { MathSum, MathIntegral } from "./n-ary";
 import { MathRadical } from "./radical";
 import { MathSubScript, MathSubSuperScript, MathSuperScript } from "./script";
 
@@ -10,6 +10,7 @@ export type MathComponent =
     | MathRun
     | MathFraction
     | MathSum
+    | MathIntegral
     | MathSuperScript
     | MathSubScript
     | MathSubSuperScript

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

@@ -4,4 +4,5 @@ export * from "./math-limit-location";
 export * from "./math-n-ary-properties";
 export * from "./math-sub-script";
 export * from "./math-sum";
+export * from "./math-integral";
 export * from "./math-super-script";

package/src/file/paragraph/math/n-ary/math-integral.spec.ts

@@ -0,0 +1,116 @@
+import { expect } from "chai";
+
+import { Formatter } from "@export/formatter";
+
+import { MathRun } from "../math-run";
+import { MathIntegral } from "./math-integral";
+
+describe("MathIntegral", () => {
+    describe("#constructor()", () => {
+        it("should create a MathIntegral with correct root key", () => {
+            const mathIntegral = new MathIntegral({
+                children: [new MathRun("1")],
+                subScript: [new MathRun("2")],
+                superScript: [new MathRun("3")],
+            });
+
+            const tree = new Formatter().format(mathIntegral);
+            expect(tree).to.deep.equal({
+                "m:nary": [
+                    {
+                        "m:naryPr": [
+                            {
+                                "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"],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                ],
+            });
+        });
+
+        it("should create a MathIntegral with correct root key without sub-script and super-scripts", () => {
+            const mathIntegral = new MathIntegral({
+                children: [new MathRun("1")],
+            });
+
+            const tree = new Formatter().format(mathIntegral);
+            expect(tree).to.deep.equal({
+                "m:nary": [
+                    {
+                        "m:naryPr": [
+                            {
+                                "m:limLoc": {
+                                    _attr: {
+                                        "m:val": "undOvr",
+                                    },
+                                },
+                            },
+                            {
+                                "m:supHide": {
+                                    _attr: {
+                                        "m:val": 1,
+                                    },
+                                },
+                            },
+                            {
+                                "m:subHide": {
+                                    _attr: {
+                                        "m:val": 1,
+                                    },
+                                },
+                            },
+                        ],
+                    },
+                    {
+                        "m:e": [
+                            {
+                                "m:r": [
+                                    {
+                                        "m:t": ["1"],
+                                    },
+                                ],
+                            },
+                        ],
+                    },
+                ],
+            });
+        });
+    });
+});

package/src/file/paragraph/math/n-ary/math-integral.ts

@@ -0,0 +1,31 @@
+import { XmlComponent } from "@file/xml-components";
+
+import { MathComponent } from "../math-component";
+import { MathBase } from "./math-base";
+import { MathNAryProperties } from "./math-n-ary-properties";
+import { MathSubScriptElement } from "./math-sub-script";
+import { MathSuperScriptElement } from "./math-super-script";
+
+export interface IMathIntegralOptions {
+    readonly children: readonly MathComponent[];
+    readonly subScript?: readonly MathComponent[];
+    readonly superScript?: readonly MathComponent[];
+}
+
+export class MathIntegral extends XmlComponent {
+    public constructor(options: IMathIntegralOptions) {
+        super("m:nary");
+
+        this.root.push(new MathNAryProperties("", !!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));
+    }
+}

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

@@ -10,7 +10,9 @@ export class MathNAryProperties extends XmlComponent {
     public constructor(accent: string, hasSuperScript: boolean, hasSubScript: boolean) {
         super("m:naryPr");
 
-        this.root.push(new MathAccentCharacter(accent));
+        if (!!accent) {
+            this.root.push(new MathAccentCharacter(accent));
+        }
         this.root.push(new MathLimitLocation());
 
         if (!hasSuperScript) {

package/src/file/paragraph/properties.ts

@@ -9,7 +9,7 @@ import { PageBreakBefore } from "./formatting/break";
 import { IIndentAttributesProperties, Indent } from "./formatting/indent";
 import { ISpacingProperties, Spacing } from "./formatting/spacing";
 import { HeadingLevel, Style } from "./formatting/style";
-import { LeaderType, TabStop, TabStopPosition, TabStopType } from "./formatting/tab-stop";
+import { TabStop, TabStopDefinition, TabStopType } from "./formatting/tab-stop";
 import { NumberProperties } from "./formatting/unordered-list";
 import { FrameProperties, IFrameOptions } from "./frame/frame-properties";
 import { OutlineLevel } from "./links";
@@ -41,11 +41,7 @@ export interface IParagraphPropertiesOptions extends IParagraphStylePropertiesOp
     readonly heading?: HeadingLevel;
     readonly bidirectional?: boolean;
     readonly pageBreakBefore?: boolean;
-    readonly tabStops?: readonly {
-        readonly position: number | TabStopPosition;
-        readonly type: TabStopType;
-        readonly leader?: LeaderType;
-    }[];
+    readonly tabStops?: readonly TabStopDefinition[];
     readonly style?: string;
     readonly bullet?: {
         readonly level: number;
@@ -132,19 +128,22 @@ export class ParagraphProperties extends IgnoreIfEmptyXmlComponent {
             this.push(new Shading(options.shading));
         }
 
-        if (options.rightTabStop) {
-            this.push(new TabStop(TabStopType.RIGHT, options.rightTabStop));
-        }
-
-        if (options.tabStops) {
-            for (const tabStop of options.tabStops) {
-                this.push(new TabStop(tabStop.type, tabStop.position, tabStop.leader));
-            }
-        }
+        /**
+         * FIX: Multitab support for Libre Writer
+         * Ensure there is only one w:tabs tag with multiple w:tab
+         */
+        const tabDefinitions: readonly TabStopDefinition[] = [
+            ...(options.rightTabStop ? [{ type: TabStopType.RIGHT, position: options.rightTabStop }] : []),
+            ...(options.tabStops ? options.tabStops : []),
+            ...(options.leftTabStop ? [{ type: TabStopType.LEFT, position: options.leftTabStop }] : []),
+        ];
 
-        if (options.leftTabStop) {
-            this.push(new TabStop(TabStopType.LEFT, options.leftTabStop));
+        if (tabDefinitions.length > 0) {
+            this.push(new TabStop(tabDefinitions));
         }
+        /**
+         *  FIX - END
+         */
 
         if (options.bidirectional !== undefined) {
             this.push(new OnOffElement("w:bidi", options.bidirectional));