docx 7.4.0 → 7.5.0

package/src/file/drawing/inline/graphic/graphic.ts

@@ -14,7 +14,7 @@ class GraphicAttributes extends XmlAttributeComponent<{
 export class Graphic extends XmlComponent {
     private readonly data: GraphicData;
 
-    constructor(mediaData: IMediaData, transform: IMediaDataTransformation) {
+    public constructor(mediaData: IMediaData, transform: IMediaDataTransformation) {
         super("a:graphic");
         this.root.push(
             new GraphicAttributes({

package/src/file/drawing/inline/inline.ts

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

package/src/file/drawing/text-wrap/wrap-none.ts

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

package/src/file/drawing/text-wrap/wrap-square.ts

@@ -1,8 +1,9 @@
 // http://officeopenxml.com/drwPicFloating-textWrap.php
 import { XmlAttributeComponent, XmlComponent } from "@file/xml-components";
-import { ITextWrapping, TextWrappingSide } from ".";
+
 import { IDistance } from "../drawing";
 import { IMargins } from "../floating";
+import { ITextWrapping, TextWrappingSide } from "./text-wrapping";
 
 interface IWrapSquareAttributes extends IDistance {
     readonly wrapText?: TextWrappingSide;
@@ -19,7 +20,7 @@ class WrapSquareAttributes extends XmlAttributeComponent<IWrapSquareAttributes>
 }
 
 export class WrapSquare extends XmlComponent {
-    constructor(
+    public constructor(
         textWrapping: ITextWrapping,
         margins: IMargins = {
             top: 0,

package/src/file/drawing/text-wrap/wrap-tight.ts

@@ -14,7 +14,7 @@ class WrapTightAttributes extends XmlAttributeComponent<{
 }
 
 export class WrapTight extends XmlComponent {
-    constructor(
+    public constructor(
         margins: IMargins = {
             top: 0,
             bottom: 0,

package/src/file/drawing/text-wrap/wrap-top-and-bottom.ts

@@ -14,7 +14,7 @@ class WrapTopAndBottomAttributes extends XmlAttributeComponent<{
 }
 
 export class WrapTopAndBottom extends XmlComponent {
-    constructor(
+    public constructor(
         margins: IMargins = {
             top: 0,
             bottom: 0,

package/src/file/file.spec.ts

@@ -6,6 +6,7 @@ import { sectionMarginDefaults, sectionPageSizeDefaults } from "./document";
 import { File } from "./file";
 import { Footer, Header } from "./header";
 import { Paragraph } from "./paragraph";
+import { Media } from "./media";
 
 const PAGE_SIZE_DEFAULTS = {
     "w:h": sectionPageSizeDefaults.HEIGHT,
@@ -397,7 +398,6 @@ describe("File", () => {
                 sections: [],
             });
 
-            // tslint:disable-next-line: no-unused-expression
             expect(doc.Comments).to.not.be.undefined;
         });
     });
@@ -409,8 +409,61 @@ describe("File", () => {
                 sections: [],
             });
 
-            // tslint:disable-next-line: no-unused-expression
             expect(doc.Numbering).to.not.be.undefined;
         });
     });
+
+    describe("#getters", () => {
+        it("should have defined getters", () => {
+            const doc = new File({
+                sections: [],
+            });
+
+            expect(doc.CoreProperties).to.not.be.undefined;
+            expect(doc.Media).to.not.be.undefined;
+            expect(doc.FileRelationships).to.not.be.undefined;
+            expect(doc.Headers).to.not.be.undefined;
+            expect(doc.Footers).to.not.be.undefined;
+            expect(doc.ContentTypes).to.not.be.undefined;
+            expect(doc.CustomProperties).to.not.be.undefined;
+            expect(doc.AppProperties).to.not.be.undefined;
+            expect(doc.FootNotes).to.not.be.undefined;
+            expect(doc.Settings).to.not.be.undefined;
+            expect(doc.Comments).to.not.be.undefined;
+        });
+    });
+
+    describe("#templates", () => {
+        // Test will be deprecated when import-dotx and templates are deprecated
+        it("should work with template", () => {
+            const doc = new File(
+                {
+                    sections: [],
+                },
+                {
+                    template: {
+                        currentRelationshipId: 1,
+                        headers: [],
+                        footers: [],
+                        styles: "",
+                        titlePageIsDefined: true,
+                        media: new Media(),
+                    },
+                },
+            );
+
+            expect(doc).to.not.be.undefined;
+        });
+    });
+
+    describe("#externalStyles", () => {
+        it("should work with external styles", () => {
+            const doc = new File({
+                sections: [],
+                externalStyles: "",
+            });
+
+            expect(doc.Styles).to.not.be.undefined;
+        });
+    });
 });

package/src/file/file.ts

@@ -33,15 +33,17 @@ export interface ISectionOptions {
         readonly even?: Footer;
     };
     readonly properties?: ISectionPropertiesOptions;
-    readonly children: (Paragraph | Table | TableOfContents)[];
+    readonly children: readonly (Paragraph | Table | TableOfContents)[];
 }
 
 export class File {
-    // tslint:disable-next-line:readonly-keyword
+    // eslint-disable-next-line functional/prefer-readonly-type
     private currentRelationshipId: number = 1;
 
     private readonly documentWrapper: DocumentWrapper;
+    // eslint-disable-next-line functional/prefer-readonly-type
     private readonly headers: IDocumentHeader[] = [];
+    // eslint-disable-next-line functional/prefer-readonly-type
     private readonly footers: IDocumentFooter[] = [];
     private readonly coreProperties: CoreProperties;
     private readonly numbering: Numbering;
@@ -55,7 +57,7 @@ export class File {
     private readonly styles: Styles;
     private readonly comments: Comments;
 
-    constructor(options: IPropertiesOptions, fileProperties: IFileProperties = {}) {
+    public constructor(options: IPropertiesOptions, fileProperties: IFileProperties = {}) {
         this.coreProperties = new CoreProperties({
             ...options,
             creator: options.creator ?? "Un-named",
@@ -63,18 +65,9 @@ export class File {
             lastModifiedBy: options.lastModifiedBy ?? "Un-named",
         });
 
-        this.numbering = new Numbering(
-            options.numbering
-                ? options.numbering
-                : {
-                      config: [],
-                  },
-        );
-
-        if (options.comments) {
-            this.comments = new Comments(options.comments);
-        }
+        this.numbering = new Numbering(options.numbering ? options.numbering : { config: [] });
 
+        this.comments = new Comments(options.comments ?? { children: [] });
         this.fileRelationships = new Relationships();
         this.customProperties = new CustomProperties(options.customProperties ?? []);
         this.appProperties = new AppProperties();
@@ -135,7 +128,7 @@ export class File {
         }
 
         if (options.footnotes) {
-            // tslint:disable-next-line: forin
+            // eslint-disable-next-line guard-for-in
             for (const key in options.footnotes) {
                 this.footnotesWrapper.View.createFootNote(parseFloat(key), options.footnotes[key].children);
             }
@@ -163,6 +156,7 @@ export class File {
     }
 
     private createHeader(header: Header): HeaderWrapper {
+        // eslint-disable-next-line functional/immutable-data
         const wrapper = new HeaderWrapper(this.media, this.currentRelationshipId++);
 
         for (const child of header.options.children) {
@@ -174,6 +168,7 @@ export class File {
     }
 
     private createFooter(footer: Footer): FooterWrapper {
+        // eslint-disable-next-line functional/immutable-data
         const wrapper = new FooterWrapper(this.media, this.currentRelationshipId++);
 
         for (const child of footer.options.children) {
@@ -185,6 +180,7 @@ export class File {
     }
 
     private addHeaderToDocument(header: HeaderWrapper, type: HeaderFooterReferenceType = HeaderFooterReferenceType.DEFAULT): void {
+        // eslint-disable-next-line functional/immutable-data
         this.headers.push({ header, type });
         this.documentWrapper.Relationships.createRelationship(
             header.View.ReferenceId,
@@ -195,6 +191,7 @@ export class File {
     }
 
     private addFooterToDocument(footer: FooterWrapper, type: HeaderFooterReferenceType = HeaderFooterReferenceType.DEFAULT): void {
+        // eslint-disable-next-line functional/immutable-data
         this.footers.push({ footer, type });
         this.documentWrapper.Relationships.createRelationship(
             footer.View.ReferenceId,
@@ -227,26 +224,31 @@ export class File {
         );
 
         this.documentWrapper.Relationships.createRelationship(
+            // eslint-disable-next-line functional/immutable-data
             this.currentRelationshipId++,
             "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles",
             "styles.xml",
         );
         this.documentWrapper.Relationships.createRelationship(
+            // eslint-disable-next-line functional/immutable-data
             this.currentRelationshipId++,
             "http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering",
             "numbering.xml",
         );
         this.documentWrapper.Relationships.createRelationship(
+            // eslint-disable-next-line functional/immutable-data
             this.currentRelationshipId++,
             "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footnotes",
             "footnotes.xml",
         );
         this.documentWrapper.Relationships.createRelationship(
+            // eslint-disable-next-line functional/immutable-data
             this.currentRelationshipId++,
             "http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings",
             "settings.xml",
         );
         this.documentWrapper.Relationships.createRelationship(
+            // eslint-disable-next-line functional/immutable-data
             this.currentRelationshipId++,
             "http://schemas.openxmlformats.org/officeDocument/2006/relationships/comments",
             "comments.xml",
@@ -277,11 +279,11 @@ export class File {
         return this.fileRelationships;
     }
 
-    public get Headers(): HeaderWrapper[] {
+    public get Headers(): readonly HeaderWrapper[] {
         return this.headers.map((item) => item.header);
     }
 
-    public get Footers(): FooterWrapper[] {
+    public get Footers(): readonly FooterWrapper[] {
         return this.footers.map((item) => item.footer);
     }
 

package/src/file/footer/footer.ts

@@ -7,7 +7,7 @@ import { FooterAttributes } from "./footer-attributes";
 export class Footer extends InitializableXmlComponent {
     private readonly refId: number;
 
-    constructor(referenceNumber: number, initContent?: XmlComponent) {
+    public constructor(referenceNumber: number, initContent?: XmlComponent) {
         super("w:ftr", initContent);
         this.refId = referenceNumber;
         if (!initContent) {

package/src/file/footer-wrapper.spec.ts

@@ -41,7 +41,7 @@ describe("FooterWrapper", () => {
         it("should call the underlying footer's addChildElement", () => {
             const file = new FooterWrapper(new Media(), 1);
             const spy = sinon.spy(file.View, "addChildElement");
-            // tslint:disable-next-line:no-any
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             file.addChildElement({} as any);
 
             expect(spy.called).to.equal(true);

package/src/file/footer-wrapper.ts

@@ -17,7 +17,7 @@ export class FooterWrapper implements IViewWrapper {
     private readonly footer: Footer;
     private readonly relationships: Relationships;
 
-    constructor(private readonly media: Media, referenceId: number, initContent?: XmlComponent) {
+    public constructor(private readonly media: Media, referenceId: number, initContent?: XmlComponent) {
         this.footer = new Footer(referenceId, initContent);
         this.relationships = new Relationships();
     }

package/src/file/footnotes/footnote/footnote.ts

@@ -12,11 +12,11 @@ export enum FootnoteType {
 export interface IFootnoteOptions {
     readonly id: number;
     readonly type?: FootnoteType;
-    readonly children: Paragraph[];
+    readonly children: readonly Paragraph[];
 }
 
 export class Footnote extends XmlComponent {
-    constructor(options: IFootnoteOptions) {
+    public constructor(options: IFootnoteOptions) {
         super("w:footnote");
         this.root.push(
             new FootnoteAttributes({

package/src/file/footnotes/footnote/run/continuation-seperator-run.ts

@@ -2,7 +2,7 @@ import { Run } from "@file/paragraph";
 import { ContinuationSeperator } from "./continuation-seperator";
 
 export class ContinuationSeperatorRun extends Run {
-    constructor() {
+    public constructor() {
         super({});
 
         this.root.push(new ContinuationSeperator());

package/src/file/footnotes/footnote/run/continuation-seperator.ts

@@ -1,7 +1,7 @@
 import { XmlComponent } from "@file/xml-components";
 
 export class ContinuationSeperator extends XmlComponent {
-    constructor() {
+    public constructor() {
         super("w:continuationSeparator");
     }
 }

package/src/file/footnotes/footnote/run/footnote-ref-run.ts

@@ -3,7 +3,7 @@ import { Run } from "@file/paragraph";
 import { FootnoteRef } from "./footnote-ref";
 
 export class FootnoteRefRun extends Run {
-    constructor() {
+    public constructor() {
         super({
             style: "FootnoteReference",
         });

package/src/file/footnotes/footnote/run/footnote-ref.ts

@@ -1,7 +1,7 @@
 import { XmlComponent } from "@file/xml-components";
 
 export class FootnoteRef extends XmlComponent {
-    constructor() {
+    public constructor() {
         super("w:footnoteRef");
     }
 }

package/src/file/footnotes/footnote/run/reference-run.ts

@@ -10,7 +10,7 @@ export class FootNoteReferenceRunAttributes extends XmlAttributeComponent<{
 }
 
 export class FootnoteReference extends XmlComponent {
-    constructor(id: number) {
+    public constructor(id: number) {
         super("w:footnoteReference");
 
         this.root.push(
@@ -22,7 +22,7 @@ export class FootnoteReference extends XmlComponent {
 }
 
 export class FootnoteReferenceRun extends Run {
-    constructor(id: number) {
+    public constructor(id: number) {
         super({ style: "FootnoteReference" });
 
         this.root.push(new FootnoteReference(id));

package/src/file/footnotes/footnote/run/seperator-run.ts

@@ -2,7 +2,7 @@ import { Run } from "@file/paragraph";
 import { Seperator } from "./seperator";
 
 export class SeperatorRun extends Run {
-    constructor() {
+    public constructor() {
         super({});
 
         this.root.push(new Seperator());

package/src/file/footnotes/footnote/run/seperator.ts

@@ -1,7 +1,7 @@
 import { XmlComponent } from "@file/xml-components";
 
 export class Seperator extends XmlComponent {
-    constructor() {
+    public constructor() {
         super("w:separator");
     }
 }

package/src/file/footnotes/footnotes.ts

@@ -7,7 +7,7 @@ import { SeperatorRun } from "./footnote/run/seperator-run";
 import { FootnotesAttributes } from "./footnotes-attributes";
 
 export class FootNotes extends XmlComponent {
-    constructor() {
+    public constructor() {
         super("w:footnotes");
 
         this.root.push(
@@ -67,7 +67,7 @@ export class FootNotes extends XmlComponent {
         this.root.push(spacing);
     }
 
-    public createFootNote(id: number, paragraph: Paragraph[]): void {
+    public createFootNote(id: number, paragraph: readonly Paragraph[]): void {
         const footnote = new Footnote({
             id: id,
             children: paragraph,

package/src/file/footnotes-wrapper.spec.ts

@@ -7,9 +7,7 @@ describe("FootnotesWrapper", () => {
         it("should create", () => {
             const file = new FootnotesWrapper();
 
-            // tslint:disable-next-line: no-unused-expression
             expect(file.View).to.be.ok;
-            // tslint:disable-next-line: no-unused-expression
             expect(file.Relationships).to.be.ok;
         });
     });

package/src/file/footnotes-wrapper.ts

@@ -6,7 +6,7 @@ export class FootnotesWrapper implements IViewWrapper {
     private readonly footnotess: FootNotes;
     private readonly relationships: Relationships;
 
-    constructor() {
+    public constructor() {
         this.footnotess = new FootNotes();
         this.relationships = new Relationships();
     }

package/src/file/header/header.ts

@@ -7,7 +7,7 @@ import { HeaderAttributes } from "./header-attributes";
 export class Header extends InitializableXmlComponent {
     private readonly refId: number;
 
-    constructor(referenceNumber: number, initContent?: XmlComponent) {
+    public constructor(referenceNumber: number, initContent?: XmlComponent) {
         super("w:hdr", initContent);
 
         this.refId = referenceNumber;

package/src/file/header-wrapper.spec.ts

@@ -41,7 +41,7 @@ describe("HeaderWrapper", () => {
         it("should call the underlying header's addChildElement", () => {
             const file = new HeaderWrapper(new Media(), 1);
             const spy = sinon.spy(file.View, "addChildElement");
-            // tslint:disable-next-line:no-any
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
             file.addChildElement({} as any);
 
             expect(spy.called).to.equal(true);

package/src/file/header-wrapper.ts

@@ -17,7 +17,7 @@ export class HeaderWrapper implements IViewWrapper {
     private readonly header: Header;
     private readonly relationships: Relationships;
 
-    constructor(private readonly media: Media, referenceId: number, initContent?: XmlComponent) {
+    public constructor(private readonly media: Media, referenceId: number, initContent?: XmlComponent) {
         this.header = new Header(referenceId, initContent);
         this.relationships = new Relationships();
     }

package/src/file/header.ts

@@ -2,13 +2,21 @@ import { Paragraph } from "./paragraph";
 import { Table } from "./table";
 
 export interface IHeaderOptions {
-    readonly children: (Paragraph | Table)[];
+    readonly children: readonly (Paragraph | Table)[];
 }
 
 export class Header {
-    constructor(public readonly options: IHeaderOptions = { children: [] }) {}
+    public readonly options: IHeaderOptions;
+
+    public constructor(options: IHeaderOptions = { children: [] }) {
+        this.options = options;
+    }
 }
 
 export class Footer {
-    constructor(public readonly options: IHeaderOptions = { children: [] }) {}
+    public readonly options: IHeaderOptions;
+
+    public constructor(options: IHeaderOptions = { children: [] }) {
+        this.options = options;
+    }
 }

package/src/file/media/media.spec.ts

@@ -37,6 +37,7 @@ describe("Media", () => {
         });
 
         it("should return UInt8Array if atob is present", () => {
+            // eslint-disable-next-line functional/immutable-data
             global.atob = () => "atob result";
 
             const image = new Media().addMedia("", {
@@ -45,11 +46,12 @@ describe("Media", () => {
             });
             expect(image.stream).to.be.an.instanceof(Uint8Array);
 
-            // tslint:disable-next-line: no-any
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any, functional/immutable-data
             (global as any).atob = undefined;
         });
 
         it("should use data as is if its not a string", () => {
+            // eslint-disable-next-line  functional/immutable-data
             global.atob = () => "atob result";
 
             const image = new Media().addMedia(Buffer.from(""), {
@@ -58,7 +60,7 @@ describe("Media", () => {
             });
             expect(image.stream).to.be.an.instanceof(Uint8Array);
 
-            // tslint:disable-next-line: no-any
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any, functional/immutable-data
             (global as any).atob = undefined;
         });
     });

package/src/file/media/media.ts

@@ -13,9 +13,10 @@ export interface IMediaTransformation {
 }
 
 export class Media {
+    // eslint-disable-next-line functional/prefer-readonly-type
     private readonly map: Map<string, IMediaData>;
 
-    constructor() {
+    public constructor() {
         this.map = new Map<string, IMediaData>();
     }
 
@@ -68,6 +69,7 @@ export class Media {
                     .map((c) => c.charCodeAt(0)),
             );
         } else {
+            // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires
             const b = require("buf" + "fer");
             return new b.Buffer(dataURI, "base64");
         }

package/src/file/numbering/abstract-numbering.ts

@@ -32,7 +32,7 @@ class AbstractNumberingAttributes extends XmlAttributeComponent<{
 export class AbstractNumbering extends XmlComponent {
     public readonly id: number;
 
-    constructor(id: number, levelOptions: ILevelsOptions[]) {
+    public constructor(id: number, levelOptions: readonly ILevelsOptions[]) {
         super("w:abstractNum");
         this.root.push(
             new AbstractNumberingAttributes({

package/src/file/numbering/level.spec.ts

@@ -1,9 +1,9 @@
 import { expect } from "chai";
 
-import { LevelFormat, LevelSuffix } from ".";
-import { AlignmentType } from "..";
+import { Formatter } from "@export/formatter";
 
-import { Level } from "./level";
+import { AlignmentType } from "..";
+import { Level, LevelFormat, LevelSuffix } from "./level";
 
 describe("Level", () => {
     describe("#constructor", () => {
@@ -22,4 +22,41 @@ describe("Level", () => {
             ).to.throw();
         });
     });
+
+    describe("isLegalNumberingStyle", () => {
+        it("should work", () => {
+            const concreteNumbering = new Level({
+                level: 9,
+                isLegalNumberingStyle: true,
+            });
+            const tree = new Formatter().format(concreteNumbering);
+            expect(tree).to.deep.equal({
+                "w:lvl": [
+                    {
+                        "w:start": {
+                            _attr: {
+                                "w:val": 1,
+                            },
+                        },
+                    },
+                    {
+                        "w:isLgl": {},
+                    },
+                    {
+                        "w:lvlJc": {
+                            _attr: {
+                                "w:val": "start",
+                            },
+                        },
+                    },
+                    {
+                        _attr: {
+                            "w15:tentative": 1,
+                            "w:ilvl": 9,
+                        },
+                    },
+                ],
+            });
+        });
+    });
 });