docx 7.4.0 → 7.4.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docx",
-  "version": "7.4.0",
+  "version": "7.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": {
@@ -14,8 +14,9 @@
     "webpack": "rimraf ./build && webpack --config ./webpack.config.ts",
     "demo": "npm run build && npm run ts-node --skip-project ./demo",
     "typedoc": "rimraf ./build && typedoc src/index.ts --tsconfig tsconfig.typedoc.json",
-    "style": "prettier -l \"src/**/*.ts\"",
+    "style": "prettier -l \"{src,scripts,demo}/**/*.{ts,html}\"",
     "style.fix": "npm run style -- --write",
+    "cspell": "cspell \"{src,demo,docs,scripts}/**/*.{ts,scss,html,md}\" && cspell \"./*.*\"",
     "fix-types": "ts-node --skip-project scripts/types-absolute-fixer.ts",
     "e2e": "ts-node scripts/e2e.ts",
     "serve.docs": "cd docs && docsify serve",
@@ -73,6 +74,7 @@
     "@types/webpack": "^5.0.0",
     "buffer": "^6.0.3",
     "chai": "^3.5.0",
+    "cspell": "^6.2.2",
     "docsify-cli": "^4.3.0",
     "glob": "^8.0.1",
     "jszip": "^3.1.5",

package/src/export/packer/next-compiler.spec.ts

@@ -4,7 +4,8 @@ import * as sinon from "sinon";
 
 import { File } from "@file/file";
 import { Footer, Header } from "@file/header";
-import { Paragraph } from "@file/paragraph";
+import { ImageRun, Paragraph } from "@file/paragraph";
+import * as convenienceFunctions from "@util/convenience-functions";
 
 import { Compiler } from "./next-compiler";
 
@@ -15,6 +16,14 @@ describe("Compiler", () => {
         compiler = new Compiler();
     });
 
+    before(() => {
+        sinon.stub(convenienceFunctions, "uniqueId").callsFake(() => "test");
+    });
+
+    after(() => {
+        (convenienceFunctions.uniqueId as sinon.SinonStub).restore();
+    });
+
     describe("#compile()", () => {
         it("should pack all the content", async function () {
             this.timeout(99999999);
@@ -111,18 +120,38 @@ describe("Compiler", () => {
             const spy = sinon.spy(compiler["formatter"], "format");
 
             compiler.compile(file);
-            expect(spy.callCount).to.equal(12);
+            expect(spy.callCount).to.equal(13);
         });
 
         it("should work with media datas", () => {
             // This test is required because before, there was a case where Document was formatted twice, which was inefficient
             // This also caused issues such as running prepForXml multiple times as format() was ran multiple times.
-            const paragraph = new Paragraph("");
             const file = new File({
                 sections: [
                     {
-                        properties: {},
-                        children: [paragraph],
+                        headers: {
+                            default: new Header({
+                                children: [new Paragraph("test")],
+                            }),
+                        },
+                        footers: {
+                            default: new Footer({
+                                children: [new Paragraph("test")],
+                            }),
+                        },
+                        children: [
+                            new Paragraph({
+                                children: [
+                                    new ImageRun({
+                                        data: Buffer.from("", "base64"),
+                                        transformation: {
+                                            width: 100,
+                                            height: 100,
+                                        },
+                                    }),
+                                ],
+                            }),
+                        ],
                     },
                 ],
             });

package/src/export/packer/next-compiler.ts

@@ -6,7 +6,7 @@ import { File } from "@file/file";
 import { Formatter } from "../formatter";
 import { ImageReplacer } from "./image-replacer";
 import { NumberingReplacer } from "./numbering-replacer";
-import { PrettityType } from "./packer";
+import { PrettifyType } from "./packer";
 
 interface IXmlifyedFile {
     readonly data: string;
@@ -44,7 +44,7 @@ export class Compiler {
         this.numberingReplacer = new NumberingReplacer();
     }
 
-    public compile(file: File, prettifyXml?: boolean | PrettityType): JSZip {
+    public compile(file: File, prettifyXml?: boolean | PrettifyType): JSZip {
         const zip = new JSZip();
         const xmlifiedFileMapping = this.xmlifyFile(file, prettifyXml);
         const map = new Map<string, IXmlifyedFile | IXmlifyedFile[]>(Object.entries(xmlifiedFileMapping));
@@ -67,7 +67,7 @@ export class Compiler {
         return zip;
     }
 
-    private xmlifyFile(file: File, prettify?: boolean | PrettityType): IXmlifyedFileMapping {
+    private xmlifyFile(file: File, prettify?: boolean | PrettifyType): IXmlifyedFileMapping {
         const documentRelationshipCount = file.Document.Relationships.RelationshipCount + 1;
 
         const documentXmlData = xml(
@@ -406,26 +406,19 @@ export class Compiler {
                 path: "word/settings.xml",
             },
             Comments: {
-                data: (() => {
-                    if (!file.Comments) {
-                        return;
-                    }
-
-                    const data = xml(
-                        this.formatter.format(file.Comments, {
-                            viewWrapper: file.Document,
-                            file,
-                        }),
-                        {
-                            indent: prettify,
-                            declaration: {
-                                standalone: "yes",
-                                encoding: "UTF-8",
-                            },
+                data: xml(
+                    this.formatter.format(file.Comments, {
+                        viewWrapper: file.Document,
+                        file,
+                    }),
+                    {
+                        indent: prettify,
+                        declaration: {
+                            standalone: "yes",
+                            encoding: "UTF-8",
                         },
-                    );
-                    return data;
-                })(),
+                    },
+                ),
                 path: "word/comments.xml",
             },
         };

package/src/export/packer/packer.ts

@@ -5,7 +5,7 @@ import { Compiler } from "./next-compiler";
 /**
  * Use blanks to prettify
  */
-export enum PrettityType {
+export enum PrettifyType {
     NONE = "",
     WITH_2_BLANKS = "  ",
     WITH_4_BLANKS = "    ",
@@ -13,7 +13,7 @@ export enum PrettityType {
 }
 
 export class Packer {
-    public static async toBuffer(file: File, prettify?: boolean | PrettityType): Promise<Buffer> {
+    public static async toBuffer(file: File, prettify?: boolean | PrettifyType): Promise<Buffer> {
         const zip = this.compiler.compile(file, prettify);
         const zipData = await zip.generateAsync({
             type: "nodebuffer",
@@ -24,7 +24,7 @@ export class Packer {
         return zipData;
     }
 
-    public static async toBase64String(file: File, prettify?: boolean | PrettityType): Promise<string> {
+    public static async toBase64String(file: File, prettify?: boolean | PrettifyType): Promise<string> {
         const zip = this.compiler.compile(file, prettify);
         const zipData = await zip.generateAsync({
             type: "base64",
@@ -35,7 +35,7 @@ export class Packer {
         return zipData;
     }
 
-    public static async toBlob(file: File, prettify?: boolean | PrettityType): Promise<Blob> {
+    public static async toBlob(file: File, prettify?: boolean | PrettifyType): Promise<Blob> {
         const zip = this.compiler.compile(file, prettify);
         const zipData = await zip.generateAsync({
             type: "blob",

package/src/file/core-properties/properties.ts

@@ -41,6 +41,7 @@ export interface IPropertiesOptions {
 
 // <xs:element name="coreProperties" type="CT_CoreProperties"/>
 
+/* cSpell:disable */
 // <xs:complexType name="CT_CoreProperties">
 //   <xs:all>
 //     <xs:element name="category" minOccurs="0" maxOccurs="1" type="xs:string"/>
@@ -60,6 +61,7 @@ export interface IPropertiesOptions {
 //     <xs:element name="version" minOccurs="0" maxOccurs="1" type="xs:string"/>
 //   </xs:all>
 // </xs:complexType>
+/* cSpell:enable */
 
 export class CoreProperties extends XmlComponent {
     constructor(options: Omit<IPropertiesOptions, "sections">) {

package/src/file/document/document-attributes.ts

@@ -1,5 +1,6 @@
 import { XmlAttributeComponent } from "@file/xml-components";
 
+/* cSpell:disable */
 export interface IDocumentAttributesProperties {
     readonly wpc?: string;
     readonly mc?: string;
@@ -41,6 +42,7 @@ export interface IDocumentAttributesProperties {
     readonly w16sdtdh?: string;
     readonly w16se?: string;
 }
+/* cSpell:enable */
 
 export class DocumentAttributes extends XmlAttributeComponent<IDocumentAttributesProperties> {
     protected readonly xmlKeys = {

package/src/file/file.ts

@@ -71,10 +71,7 @@ export class File {
                   },
         );
 
-        if (options.comments) {
-            this.comments = new Comments(options.comments);
-        }
-
+        this.comments = new Comments(options.comments ?? { children: [] });
         this.fileRelationships = new Relationships();
         this.customProperties = new CustomProperties(options.customProperties ?? []);
         this.appProperties = new AppProperties();

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

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

package/src/file/paragraph/math/n-ary/{math-naray-properties.spec.ts → math-n-ary-properties.spec.ts}

@@ -2,14 +2,14 @@ import { expect } from "chai";
 
 import { Formatter } from "@export/formatter";
 
-import { MathNArayProperties } from "./math-naray-properties";
+import { MathNAryProperties } from "./math-n-ary-properties";
 
-describe("MathNArayProperties", () => {
+describe("MathNAryProperties", () => {
     describe("#constructor()", () => {
-        it("should create a MathNArayProperties with correct root key", () => {
-            const mathNArayProperties = new MathNArayProperties("∑", true, true);
+        it("should create a MathNAryProperties with correct root key", () => {
+            const mathNAryProperties = new MathNAryProperties("∑", true, true);
 
-            const tree = new Formatter().format(mathNArayProperties);
+            const tree = new Formatter().format(mathNAryProperties);
             expect(tree).to.deep.equal({
                 "m:naryPr": [
                     {
@@ -31,9 +31,9 @@ describe("MathNArayProperties", () => {
         });
 
         it("should add super-script hide attributes", () => {
-            const mathNArayProperties = new MathNArayProperties("∑", false, true);
+            const mathNAryProperties = new MathNAryProperties("∑", false, true);
 
-            const tree = new Formatter().format(mathNArayProperties);
+            const tree = new Formatter().format(mathNAryProperties);
             expect(tree).to.deep.equal({
                 "m:naryPr": [
                     {
@@ -62,9 +62,9 @@ describe("MathNArayProperties", () => {
         });
 
         it("should add sub-script hide attributes", () => {
-            const mathNArayProperties = new MathNArayProperties("∑", true, false);
+            const mathNAryProperties = new MathNAryProperties("∑", true, false);
 
-            const tree = new Formatter().format(mathNArayProperties);
+            const tree = new Formatter().format(mathNAryProperties);
             expect(tree).to.deep.equal({
                 "m:naryPr": [
                     {
@@ -93,9 +93,9 @@ describe("MathNArayProperties", () => {
         });
 
         it("should add both super-script and sub-script hide attributes", () => {
-            const mathNArayProperties = new MathNArayProperties("∑", false, false);
+            const mathNAryProperties = new MathNAryProperties("∑", false, false);
 
-            const tree = new Formatter().format(mathNArayProperties);
+            const tree = new Formatter().format(mathNAryProperties);
             expect(tree).to.deep.equal({
                 "m:naryPr": [
                     {

package/src/file/paragraph/math/n-ary/{math-naray-properties.ts → math-n-ary-properties.ts}

@@ -6,7 +6,7 @@ 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 {
+export class MathNAryProperties extends XmlComponent {
     constructor(accent: string, hasSuperScript: boolean, hasSubScript: boolean) {
         super("m:naryPr");
 

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

@@ -3,7 +3,7 @@ import { XmlComponent } from "@file/xml-components";
 
 import { MathComponent } from "../math-component";
 import { MathBase } from "./math-base";
-import { MathNArayProperties } from "./math-naray-properties";
+import { MathNAryProperties } from "./math-n-ary-properties";
 import { MathSubScriptElement } from "./math-sub-script";
 import { MathSuperScriptElement } from "./math-super-script";
 
@@ -17,7 +17,7 @@ export class MathSum extends XmlComponent {
     constructor(options: IMathSumOptions) {
         super("m:nary");
 
-        this.root.push(new MathNArayProperties("∑", !!options.superScript, !!options.subScript));
+        this.root.push(new MathNAryProperties("∑", !!options.superScript, !!options.subScript));
 
         if (!!options.subScript) {
             this.root.push(new MathSubScriptElement(options.subScript));

package/src/file/table/table-properties/table-float-properties.ts

@@ -27,6 +27,7 @@ export enum RelativeVerticalPosition {
 }
 
 export interface ITableFloatOptions {
+    /* cSpell:disable */
     /**
      * Specifies the horizontal anchor or the base object from which the horizontal positioning in the
      * tblpX or tblpXSpec attribute should be determined.
@@ -35,6 +36,7 @@ export interface ITableFloatOptions {
      * text - relative to the vertical edge of the text margin for the column in which the anchor paragraph is located
      * If omitted, the value is assumed to be page.
      */
+    /* cSpell:enable */
     readonly horizontalAnchor?: TableAnchorType;
 
     /**
@@ -90,25 +92,25 @@ export interface ITableFloatOptions {
     readonly relativeVerticalPosition?: RelativeVerticalPosition;
 
     /**
-     * Specifies the minimun distance to be maintained between the table and the top of text in the paragraph
+     * Specifies the minimum distance to be maintained between the table and the top of text in the paragraph
      * below the table. The value is in twentieths of a point. If omitted, the value is assumed to be zero.
      */
     readonly bottomFromText?: number | string;
 
     /**
-     * Specifies the minimun distance to be maintained between the table and the bottom edge of text in the paragraph
+     * Specifies the minimum distance to be maintained between the table and the bottom edge of text in the paragraph
      * above the table. The value is in twentieths of a point. If omitted, the value is assumed to be zero.
      */
     readonly topFromText?: number | string;
 
     /**
-     * Specifies the minimun distance to be maintained between the table and the edge of text in the paragraph
+     * Specifies the minimum distance to be maintained between the table and the edge of text in the paragraph
      * to the left of the table. The value is in twentieths of a point. If omitted, the value is assumed to be zero.
      */
     readonly leftFromText?: number | string;
 
     /**
-     * Specifies the minimun distance to be maintained between the table and the edge of text in the paragraph
+     * Specifies the minimum distance to be maintained between the table and the edge of text in the paragraph
      * to the right of the table. The value is in twentieths of a point. If omitted, the value is assumed to be zero.
      */
     readonly rightFromText?: number | string;

package/src/file/track-revision/track-revision-components/deleted-page-number.spec.ts

@@ -13,7 +13,7 @@ describe("Deleted Page", () => {
     });
 });
 
-describe("Delted NumberOfPages", () => {
+describe("Deleted NumberOfPages", () => {
     describe("#constructor()", () => {
         it("uses the font name for both ascii and hAnsi", () => {
             const tree = new Formatter().format(new DeletedNumberOfPages());

package/src/file/xml-components/imported-xml-component.ts

@@ -13,8 +13,8 @@ export function convertToXmlComponent(element: XmlElement): ImportedXmlComponent
         case undefined:
         case "element":
             const xmlComponent = new ImportedXmlComponent(element.name as string, element.attributes);
-            const childElments = element.elements || [];
-            for (const childElm of childElments) {
+            const childElements = element.elements || [];
+            for (const childElm of childElements) {
                 const child = convertToXmlComponent(childElm);
                 if (child !== undefined) {
                     xmlComponent.push(child);

package/src/import-dotx/import-dotx.ts

@@ -141,12 +141,12 @@ export class ImportDotx {
     }
 
     private async addRelationshipToWrapper(
-        relationhipFile: IRelationshipFileInfo,
+        relationshipFile: IRelationshipFileInfo,
         zipContent: JSZip,
         wrapper: HeaderWrapper | FooterWrapper,
         media: Media,
     ): Promise<void> {
-        const refFile = zipContent.files[`word/_rels/${relationhipFile.target}.rels`];
+        const refFile = zipContent.files[`word/_rels/${relationshipFile.target}.rels`];
 
         if (!refFile) {
             return;

package/src/util/convenience-functions.spec.ts

@@ -4,13 +4,13 @@ import { convertInchesToTwip, convertMillimetersToTwip, uniqueId, uniqueNumericI
 
 describe("Utility", () => {
     describe("#convertMillimetersToTwip", () => {
-        it("should call the underlying header's addChildElement for Paragraph", () => {
+        it("should convert millimeters to TWIP", () => {
             expect(convertMillimetersToTwip(1000)).to.equal(56692);
         });
     });
 
     describe("#convertInchesToTwip", () => {
-        it("should call the underlying header's addChildElement", () => {
+        it("should convert inches to TWIP", () => {
             expect(convertInchesToTwip(1)).to.equal(1440);
             expect(convertInchesToTwip(0.5)).to.equal(720);
             expect(convertInchesToTwip(0.25)).to.equal(360);

package/src/util/values.spec.ts

@@ -73,6 +73,7 @@ describe("values", () => {
         it("should throw on invalid values", () => {
             expect(() => shortHexNumber("11")).to.throw();
             expect(() => shortHexNumber("112233")).to.throw();
+            /* cspell:disable-next-line */
             expect(() => shortHexNumber("FFFG")).to.throw();
         });
     });

package/src/util/values.ts

@@ -208,6 +208,7 @@ export const pointMeasureValue = unsignedDecimalNumber;
 //
 // http://www.datypic.com/sc/xsd/t-xsd_dateTime.html
 // The type xsd:dateTime represents a specific date and time in the format
+/* cspell:disable-next-line */
 // CCYY-MM-DDThh:mm:ss.sss, which is a concatenation of the date and time forms,
 // separated by a literal letter "T". All of the same rules that apply to the date
 // and time types are applicable to xsd:dateTime as well.