docx 7.4.1 → 7.6.0

package/src/file/numbering/numbering.ts

@@ -10,8 +10,8 @@ import { ILevelsOptions, LevelFormat } from "./level";
 import { ConcreteNumbering } from "./num";
 
 export interface INumberingOptions {
-    readonly config: {
-        readonly levels: ILevelsOptions[];
+    readonly config: readonly {
+        readonly levels: readonly ILevelsOptions[];
         readonly reference: string;
     }[];
 }
@@ -31,7 +31,7 @@ export class Numbering extends XmlComponent {
     private readonly concreteNumberingMap = new Map<string, ConcreteNumbering>();
     private readonly referenceConfigMap = new Map<string, object>();
 
-    constructor(options: INumberingOptions) {
+    public constructor(options: INumberingOptions) {
         super("w:numbering");
         this.root.push(
             new DocumentAttributes({
@@ -203,33 +203,33 @@ export class Numbering extends XmlComponent {
             return;
         }
 
+        const referenceConfigLevels = this.referenceConfigMap.get(reference);
+        const firstLevelStartNumber = referenceConfigLevels && referenceConfigLevels[0].start;
+
         const concreteNumberingSettings = {
             numId: uniqueNumericId(),
             abstractNumId: abstractNumbering.id,
             reference,
             instance,
-            overrideLevel: {
-                num: 0,
-                start: 1,
-            },
+            overrideLevel:
+                firstLevelStartNumber && Number.isInteger(firstLevelStartNumber)
+                    ? {
+                          num: 0,
+                          start: firstLevelStartNumber,
+                      }
+                    : {
+                          num: 0,
+                          start: 1,
+                      },
         };
 
-        const referenceConfigLevels = this.referenceConfigMap.get(reference);
-        const firstLevelStartNumber = referenceConfigLevels && referenceConfigLevels[0].start;
-        if (firstLevelStartNumber && Number.isInteger(firstLevelStartNumber)) {
-            concreteNumberingSettings.overrideLevel = {
-                num: 0,
-                start: firstLevelStartNumber,
-            };
-        }
-
         this.concreteNumberingMap.set(fullReference, new ConcreteNumbering(concreteNumberingSettings));
     }
 
-    public get ConcreteNumbering(): ConcreteNumbering[] {
+    public get ConcreteNumbering(): readonly ConcreteNumbering[] {
         return Array.from(this.concreteNumberingMap.values());
     }
-    public get ReferenceConfig(): object[] {
+    public get ReferenceConfig(): readonly object[] {
         return Array.from(this.referenceConfigMap.values());
     }
 }

package/src/file/paragraph/formatting/alignment.ts

@@ -18,7 +18,7 @@ export class AlignmentAttributes extends XmlAttributeComponent<{ readonly val: A
 }
 
 export class Alignment extends XmlComponent {
-    constructor(type: AlignmentType) {
+    public constructor(type: AlignmentType) {
         super("w:jc");
         this.root.push(new AlignmentAttributes({ val: type }));
     }

package/src/file/paragraph/formatting/border.ts

@@ -10,7 +10,7 @@ export interface IBordersOptions {
 }
 
 export class Border extends IgnoreIfEmptyXmlComponent {
-    constructor(options: IBordersOptions) {
+    public constructor(options: IBordersOptions) {
         super("w:pBdr");
 
         if (options.top) {
@@ -32,7 +32,7 @@ export class Border extends IgnoreIfEmptyXmlComponent {
 }
 
 export class ThematicBreak extends XmlComponent {
-    constructor() {
+    public constructor() {
         super("w:pBdr");
         const bottom = new BorderElement("w:bottom", {
             color: "auto",

package/src/file/paragraph/formatting/break.ts

@@ -9,7 +9,7 @@ enum BreakType {
 }
 
 class Break extends XmlComponent {
-    constructor(type: BreakType) {
+    public constructor(type: BreakType) {
         super("w:br");
         this.root.push(
             new Attributes({
@@ -20,14 +20,14 @@ class Break extends XmlComponent {
 }
 
 export class PageBreak extends Run {
-    constructor() {
+    public constructor() {
         super({});
         this.root.push(new Break(BreakType.PAGE));
     }
 }
 
 export class ColumnBreak extends Run {
-    constructor() {
+    public constructor() {
         super({});
         this.root.push(new Break(BreakType.COLUMN));
     }
@@ -37,7 +37,7 @@ export class ColumnBreak extends Run {
  * Add page break before the paragraph if there is no one added before.
  */
 export class PageBreakBefore extends XmlComponent {
-    constructor() {
+    public constructor() {
         super("w:pageBreakBefore");
     }
 }

package/src/file/paragraph/formatting/indent.ts

@@ -41,7 +41,7 @@ class IndentAttributes extends XmlAttributeComponent<IIndentAttributesProperties
 //     ...
 //     <xsd:element name="ind" type="CT_Ind" minOccurs="0"/>
 export class Indent extends XmlComponent {
-    constructor({ start, end, left, right, hanging, firstLine }: IIndentAttributesProperties) {
+    public constructor({ start, end, left, right, hanging, firstLine }: IIndentAttributesProperties) {
         super("w:ind");
         this.root.push(
             new IndentAttributes({

package/src/file/paragraph/formatting/spacing.ts

@@ -25,7 +25,7 @@ class SpacingAttributes extends XmlAttributeComponent<ISpacingProperties> {
 }
 
 export class Spacing extends XmlComponent {
-    constructor(options: ISpacingProperties) {
+    public constructor(options: ISpacingProperties) {
         super("w:spacing");
         this.root.push(new SpacingAttributes(options));
     }

package/src/file/paragraph/formatting/style.ts

@@ -11,7 +11,7 @@ export enum HeadingLevel {
 }
 
 export class Style extends XmlComponent {
-    constructor(styleId: string) {
+    public constructor(styleId: string) {
         super("w:pStyle");
         this.root.push(
             new Attributes({

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 {
-    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 {
-    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/formatting/unordered-list.ts

@@ -1,7 +1,7 @@
 import { Attributes, XmlComponent } from "@file/xml-components";
 
 export class NumberProperties extends XmlComponent {
-    constructor(numberId: number | string, indentLevel: number) {
+    public constructor(numberId: number | string, indentLevel: number) {
         super("w:numPr");
         this.root.push(new IndentLevel(indentLevel));
         this.root.push(new NumberId(numberId));
@@ -9,7 +9,7 @@ export class NumberProperties extends XmlComponent {
 }
 
 class IndentLevel extends XmlComponent {
-    constructor(level: number) {
+    public constructor(level: number) {
         super("w:ilvl");
 
         if (level > 9) {
@@ -27,7 +27,7 @@ class IndentLevel extends XmlComponent {
 }
 
 class NumberId extends XmlComponent {
-    constructor(id: number | string) {
+    public constructor(id: number | string) {
         super("w:numId");
         this.root.push(
             new Attributes({

package/src/file/paragraph/frame/frame-properties.ts

@@ -97,7 +97,7 @@ export class FramePropertiesAttributes extends XmlAttributeComponent<{
 }
 
 export class FrameProperties extends XmlComponent {
-    constructor(options: IFrameOptions) {
+    public constructor(options: IFrameOptions) {
         super("w:framePr");
         this.root.push(
             new FramePropertiesAttributes({

package/src/file/paragraph/links/bookmark.ts

@@ -7,10 +7,10 @@ import { BookmarkEndAttributes, BookmarkStartAttributes } from "./bookmark-attri
 
 export class Bookmark {
     public readonly start: BookmarkStart;
-    public readonly children: ParagraphChild[];
+    public readonly children: readonly ParagraphChild[];
     public readonly end: BookmarkEnd;
 
-    constructor(options: { readonly id: string; readonly children: ParagraphChild[] }) {
+    public constructor(options: { readonly id: string; readonly children: readonly ParagraphChild[] }) {
         const linkId = uniqueNumericId();
 
         this.start = new BookmarkStart(options.id, linkId);
@@ -52,7 +52,7 @@ export class Bookmark {
 // </xsd:complexType>
 
 export class BookmarkStart extends XmlComponent {
-    constructor(id: string, linkId: number) {
+    public constructor(id: string, linkId: number) {
         super("w:bookmarkStart");
 
         const attributes = new BookmarkStartAttributes({
@@ -64,7 +64,7 @@ export class BookmarkStart extends XmlComponent {
 }
 
 export class BookmarkEnd extends XmlComponent {
-    constructor(linkId: number) {
+    public constructor(linkId: number) {
         super("w:bookmarkEnd");
 
         const attributes = new BookmarkEndAttributes({

package/src/file/paragraph/links/hyperlink.ts

@@ -13,7 +13,7 @@ export enum HyperlinkType {
 export class ConcreteHyperlink extends XmlComponent {
     public readonly linkId: string;
 
-    constructor(children: ParagraphChild[], relationshipId: string, anchor?: string) {
+    public constructor(children: readonly ParagraphChild[], relationshipId: string, anchor?: string) {
         super("w:hyperlink");
 
         this.linkId = relationshipId;
@@ -33,11 +33,13 @@ export class ConcreteHyperlink extends XmlComponent {
 }
 
 export class InternalHyperlink extends ConcreteHyperlink {
-    constructor(options: { readonly children: ParagraphChild[]; readonly anchor: string }) {
+    public constructor(options: { readonly children: readonly ParagraphChild[]; readonly anchor: string }) {
         super(options.children, uniqueId(), options.anchor);
     }
 }
 
-export class ExternalHyperlink {
-    constructor(public readonly options: { readonly children: ParagraphChild[]; readonly link: string }) {}
+export class ExternalHyperlink extends XmlComponent {
+    public constructor(public readonly options: { readonly children: readonly ParagraphChild[]; readonly link: string }) {
+        super("w:externalHyperlink");
+    }
 }

package/src/file/paragraph/links/outline-level.ts

@@ -2,7 +2,7 @@
 import { Attributes, XmlComponent } from "@file/xml-components";
 
 export class OutlineLevel extends XmlComponent {
-    constructor(public readonly level: number) {
+    public constructor(public readonly level: number) {
         super("w:outlineLvl");
 
         this.root.push(

package/src/file/paragraph/links/pageref-field-instruction.ts

@@ -5,7 +5,7 @@ import { TextAttributes } from "../run/text-attributes";
 import { IPageReferenceOptions } from "./pageref-properties";
 
 export class PageReferenceFieldInstruction extends XmlComponent {
-    constructor(bookmarkId: string, options: IPageReferenceOptions = {}) {
+    public constructor(bookmarkId: string, options: IPageReferenceOptions = {}) {
         super("w:instrText");
         this.root.push(new TextAttributes({ space: SpaceType.PRESERVE }));
 

package/src/file/paragraph/links/pageref.ts

@@ -5,7 +5,7 @@ import { PageReferenceFieldInstruction } from "./pageref-field-instruction";
 import type { IPageReferenceOptions } from "./pageref-properties";
 
 export class PageReference extends Run {
-    constructor(bookmarkId: string, options: IPageReferenceOptions = {}) {
+    public constructor(bookmarkId: string, options: IPageReferenceOptions = {}) {
         super({
             children: [new Begin(true), new PageReferenceFieldInstruction(bookmarkId, options), new End()],
         });

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

@@ -6,7 +6,7 @@ import { MathBase } from "../n-ary";
 import { MathBracketProperties } from "./math-bracket-properties";
 
 export class MathAngledBrackets extends XmlComponent {
-    constructor(options: { readonly children: MathComponent[] }) {
+    public constructor(options: { readonly children: readonly MathComponent[] }) {
         super("m:d");
 
         this.root.push(

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

@@ -6,7 +6,7 @@ class MathBeginningCharacterAttributes extends XmlAttributeComponent<{ readonly
 }
 
 export class MathBeginningCharacter extends XmlComponent {
-    constructor(character: string) {
+    public constructor(character: string) {
         super("m:begChr");
 
         this.root.push(new MathBeginningCharacterAttributes({ character }));

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

@@ -5,7 +5,7 @@ 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 }) {
+    public constructor(options?: { readonly beginningCharacter: string; readonly endingCharacter: string }) {
         super("m:dPr");
 
         if (!!options) {

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

@@ -6,7 +6,7 @@ import { MathBase } from "../n-ary";
 import { MathBracketProperties } from "./math-bracket-properties";
 
 export class MathCurlyBrackets extends XmlComponent {
-    constructor(options: { readonly children: MathComponent[] }) {
+    public constructor(options: { readonly children: readonly MathComponent[] }) {
         super("m:d");
 
         this.root.push(

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

@@ -6,7 +6,7 @@ class MathEndingCharacterAttributes extends XmlAttributeComponent<{ readonly cha
 }
 
 export class MathEndingCharacter extends XmlComponent {
-    constructor(character: string) {
+    public constructor(character: string) {
         super("m:endChr");
 
         this.root.push(new MathEndingCharacterAttributes({ character }));

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

@@ -6,7 +6,7 @@ import { MathBase } from "../n-ary";
 import { MathBracketProperties } from "./math-bracket-properties";
 
 export class MathRoundBrackets extends XmlComponent {
-    constructor(options: { readonly children: MathComponent[] }) {
+    public constructor(options: { readonly children: readonly MathComponent[] }) {
         super("m:d");
 
         this.root.push(new MathBracketProperties());

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

@@ -6,7 +6,7 @@ import { MathBase } from "../n-ary";
 import { MathBracketProperties } from "./math-bracket-properties";
 
 export class MathSquareBrackets extends XmlComponent {
-    constructor(options: { readonly children: MathComponent[] }) {
+    public constructor(options: { readonly children: readonly MathComponent[] }) {
         super("m:d");
 
         this.root.push(

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

@@ -3,7 +3,7 @@ import { XmlComponent } from "@file/xml-components";
 import { MathComponent } from "../math-component";
 
 export class MathDenominator extends XmlComponent {
-    constructor(children: MathComponent[]) {
+    public constructor(children: readonly MathComponent[]) {
         super("m:den");
 
         for (const child of children) {

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

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

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

@@ -3,7 +3,7 @@ import { XmlComponent } from "@file/xml-components";
 import { MathComponent } from "../math-component";
 
 export class MathNumerator extends XmlComponent {
-    constructor(children: MathComponent[]) {
+    public constructor(children: readonly MathComponent[]) {
         super("m:num");
 
         for (const child of children) {

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

@@ -3,7 +3,7 @@ import { XmlComponent } from "@file/xml-components";
 import { MathComponent } from "../math-component";
 
 export class MathFunctionName extends XmlComponent {
-    constructor(children: MathComponent[]) {
+    public constructor(children: readonly MathComponent[]) {
         super("m:fName");
 
         for (const child of children) {

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

@@ -2,7 +2,7 @@
 import { XmlComponent } from "@file/xml-components";
 
 export class MathFunctionProperties extends XmlComponent {
-    constructor() {
+    public constructor() {
         super("m:funcPr");
     }
 }

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

@@ -7,12 +7,12 @@ import { MathFunctionName } from "./math-function-name";
 import { MathFunctionProperties } from "./math-function-properties";
 
 export interface IMathFunctionOptions {
-    readonly children: MathComponent[];
-    readonly name: MathComponent[];
+    readonly children: readonly MathComponent[];
+    readonly name: readonly MathComponent[];
 }
 
 export class MathFunction extends XmlComponent {
-    constructor(options: IMathFunctionOptions) {
+    public constructor(options: IMathFunctionOptions) {
         super("m:func");
 
         this.root.push(new MathFunctionProperties());

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/math-run.ts

@@ -4,7 +4,7 @@ import { XmlComponent } from "@file/xml-components";
 import { MathText } from "./math-text";
 
 export class MathRun extends XmlComponent {
-    constructor(text: string) {
+    public constructor(text: string) {
         super("m:r");
 
         this.root.push(new MathText(text));

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

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

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

@@ -4,11 +4,11 @@ import { XmlComponent } from "@file/xml-components";
 import { MathComponent } from "./math-component";
 
 export interface IMathOptions {
-    readonly children: MathComponent[];
+    readonly children: readonly MathComponent[];
 }
 
 export class Math extends XmlComponent {
-    constructor(options: IMathOptions) {
+    public constructor(options: IMathOptions) {
         super("m:oMath");
 
         for (const child of options.children) {

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-accent-character.ts

@@ -6,7 +6,7 @@ class MathAccentCharacterAttributes extends XmlAttributeComponent<{ readonly acc
 }
 
 export class MathAccentCharacter extends XmlComponent {
-    constructor(accent: string) {
+    public constructor(accent: string) {
         super("m:chr");
 
         this.root.push(new MathAccentCharacterAttributes({ accent }));

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

@@ -4,7 +4,7 @@ import { XmlComponent } from "@file/xml-components";
 import { MathComponent } from "../math-component";
 
 export class MathBase extends XmlComponent {
-    constructor(children: MathComponent[]) {
+    public constructor(children: readonly MathComponent[]) {
         super("m:e");
 
         for (const child of children) {