docx 6.0.3 → 7.1.2

package/src/file/paragraph/run/symbol-run.spec.ts

@@ -43,13 +43,13 @@ describe("SymbolRun", () => {
                 italics: true,
                 bold: true,
                 underline: {
-                    color: "red",
+                    color: "ff0000",
                     type: UnderlineType.DOUBLE,
                 },
                 emphasisMark: {
                     type: EmphasisMarkType.DOT,
                 },
-                color: "green",
+                color: "00FF00",
                 size: 40,
                 highlight: "yellow",
             });
@@ -59,13 +59,13 @@ describe("SymbolRun", () => {
                 "w:r": [
                     {
                         "w:rPr": [
-                            { "w:b": { _attr: { "w:val": true } } },
-                            { "w:bCs": { _attr: { "w:val": true } } },
-                            { "w:i": { _attr: { "w:val": true } } },
-                            { "w:iCs": { _attr: { "w:val": true } } },
-                            { "w:u": { _attr: { "w:val": "double", "w:color": "red" } } },
+                            { "w:b": {} },
+                            { "w:bCs": {} },
+                            { "w:i": {} },
+                            { "w:iCs": {} },
+                            { "w:u": { _attr: { "w:val": "double", "w:color": "ff0000" } } },
                             { "w:em": { _attr: { "w:val": "dot" } } },
-                            { "w:color": { _attr: { "w:val": "green" } } },
+                            { "w:color": { _attr: { "w:val": "00FF00" } } },
                             { "w:sz": { _attr: { "w:val": 40 } } },
                             { "w:szCs": { _attr: { "w:val": 40 } } },
                             { "w:highlight": { _attr: { "w:val": "yellow" } } },

package/src/file/paragraph/run/tab.ts

@@ -1,5 +1,11 @@
 import { XmlComponent } from "file/xml-components";
 
+// <xsd:group name="EG_RunInnerContent">
+//     ...
+//     <xsd:element name="tab" type="CT_Empty" minOccurs="0"/>
+//
+// TODO: this is unused and undocumented currently.
+// I think the intended use was for users to import, and insert as a child of `Run`.
 export class Tab extends XmlComponent {
     constructor() {
         super("w:tab");

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

@@ -6,7 +6,7 @@ export class TextRun extends Run {
         if (typeof options === "string") {
             super({});
             this.root.push(new Text(options));
-            return;
+            return this;
         }
 
         super(options);

package/src/file/paragraph/run/underline.spec.ts

@@ -2,12 +2,12 @@ import { expect } from "chai";
 
 import { Formatter } from "export/formatter";
 
-import * as u from "./underline";
+import { Underline, UnderlineType } from "./underline";
 
 describe("Underline", () => {
     describe("#constructor()", () => {
         it("should create a new Underline object with u:u as the rootKey", () => {
-            const underline = new u.Underline();
+            const underline = new Underline();
             const tree = new Formatter().format(underline);
             expect(tree).to.deep.equal({
                 "w:u": {
@@ -19,7 +19,7 @@ describe("Underline", () => {
         });
 
         it("should default to 'single' and no color", () => {
-            const underline = new u.Underline();
+            const underline = new Underline();
             const tree = new Formatter().format(underline);
             expect(tree).to.deep.equal({
                 "w:u": { _attr: { "w:val": "single" } },
@@ -27,7 +27,7 @@ describe("Underline", () => {
         });
 
         it("should use the given style type and color", () => {
-            const underline = new u.Underline(u.UnderlineType.DOUBLE, "FF00CC");
+            const underline = new Underline(UnderlineType.DOUBLE, "FF00CC");
             const tree = new Formatter().format(underline);
             expect(tree).to.deep.equal({
                 "w:u": { _attr: { "w:val": "double", "w:color": "FF00CC" } },
@@ -35,259 +35,3 @@ describe("Underline", () => {
         });
     });
 });
-
-describe("DashDotDotHeavyUnderline", () => {
-    describe("#constructor()", () => {
-        it("should put value in attribute", () => {
-            const underline = new u.DashDotDotHeavyUnderline();
-            const tree = new Formatter().format(underline);
-            expect(tree).to.deep.equal({
-                "w:u": {
-                    _attr: {
-                        "w:val": "dashDotDotHeavy",
-                    },
-                },
-            });
-        });
-    });
-});
-
-describe("DashDotDotHeavyUnderline", () => {
-    describe("#constructor()", () => {
-        it("should put value in attribute", () => {
-            const underline = new u.DashDotHeavyUnderline();
-            const tree = new Formatter().format(underline);
-            expect(tree).to.deep.equal({
-                "w:u": {
-                    _attr: {
-                        "w:val": "dashDotHeavy",
-                    },
-                },
-            });
-        });
-    });
-});
-
-describe("DashDotDotHeavyUnderline", () => {
-    describe("#constructor()", () => {
-        it("should put value in attribute", () => {
-            const underline = new u.DashLongHeavyUnderline();
-            const tree = new Formatter().format(underline);
-            expect(tree).to.deep.equal({
-                "w:u": {
-                    _attr: {
-                        "w:val": "dashLongHeavy",
-                    },
-                },
-            });
-        });
-    });
-});
-
-describe("DashDotDotHeavyUnderline", () => {
-    describe("#constructor()", () => {
-        it("should put value in attribute", () => {
-            const underline = new u.DashLongUnderline();
-            const tree = new Formatter().format(underline);
-            expect(tree).to.deep.equal({
-                "w:u": {
-                    _attr: {
-                        "w:val": "dashLong",
-                    },
-                },
-            });
-        });
-    });
-});
-
-describe("DashDotDotHeavyUnderline", () => {
-    describe("#constructor()", () => {
-        it("should put value in attribute", () => {
-            const underline = new u.DashUnderline();
-            const tree = new Formatter().format(underline);
-            expect(tree).to.deep.equal({
-                "w:u": {
-                    _attr: {
-                        "w:val": "dash",
-                    },
-                },
-            });
-        });
-    });
-});
-
-describe("DashDotDotHeavyUnderline", () => {
-    describe("#constructor()", () => {
-        it("should put value in attribute", () => {
-            const underline = new u.DotDashUnderline();
-            const tree = new Formatter().format(underline);
-            expect(tree).to.deep.equal({
-                "w:u": {
-                    _attr: {
-                        "w:val": "dotDash",
-                    },
-                },
-            });
-        });
-    });
-});
-
-describe("DashDotDotHeavyUnderline", () => {
-    describe("#constructor()", () => {
-        it("should put value in attribute", () => {
-            const underline = new u.DotDotDashUnderline();
-            const tree = new Formatter().format(underline);
-            expect(tree).to.deep.equal({
-                "w:u": {
-                    _attr: {
-                        "w:val": "dotDotDash",
-                    },
-                },
-            });
-        });
-    });
-});
-
-describe("DashDotDotHeavyUnderline", () => {
-    describe("#constructor()", () => {
-        it("should put value in attribute", () => {
-            const underline = new u.DottedHeavyUnderline();
-            const tree = new Formatter().format(underline);
-            expect(tree).to.deep.equal({
-                "w:u": {
-                    _attr: {
-                        "w:val": "dottedHeavy",
-                    },
-                },
-            });
-        });
-    });
-});
-
-describe("DashDotDotHeavyUnderline", () => {
-    describe("#constructor()", () => {
-        it("should put value in attribute", () => {
-            const underline = new u.DottedUnderline();
-            const tree = new Formatter().format(underline);
-            expect(tree).to.deep.equal({
-                "w:u": {
-                    _attr: {
-                        "w:val": "dotted",
-                    },
-                },
-            });
-        });
-    });
-});
-
-describe("DashDotDotHeavyUnderline", () => {
-    describe("#constructor()", () => {
-        it("should put value in attribute", () => {
-            const underline = new u.DoubleUnderline();
-            const tree = new Formatter().format(underline);
-            expect(tree).to.deep.equal({
-                "w:u": {
-                    _attr: {
-                        "w:val": "double",
-                    },
-                },
-            });
-        });
-    });
-});
-
-describe("DashDotDotHeavyUnderline", () => {
-    describe("#constructor()", () => {
-        it("should put value in attribute", () => {
-            const underline = new u.SingleUnderline();
-            const tree = new Formatter().format(underline);
-            expect(tree).to.deep.equal({
-                "w:u": {
-                    _attr: {
-                        "w:val": "single",
-                    },
-                },
-            });
-        });
-    });
-});
-
-describe("DashDotDotHeavyUnderline", () => {
-    describe("#constructor()", () => {
-        it("should put value in attribute", () => {
-            const underline = new u.ThickUnderline();
-            const tree = new Formatter().format(underline);
-            expect(tree).to.deep.equal({
-                "w:u": {
-                    _attr: {
-                        "w:val": "thick",
-                    },
-                },
-            });
-        });
-    });
-});
-
-describe("DashDotDotHeavyUnderline", () => {
-    describe("#constructor()", () => {
-        it("should put value in attribute", () => {
-            const underline = new u.WaveUnderline();
-            const tree = new Formatter().format(underline);
-            expect(tree).to.deep.equal({
-                "w:u": {
-                    _attr: {
-                        "w:val": "wave",
-                    },
-                },
-            });
-        });
-    });
-});
-
-describe("DashDotDotHeavyUnderline", () => {
-    describe("#constructor()", () => {
-        it("should put value in attribute", () => {
-            const underline = new u.WavyDoubleUnderline();
-            const tree = new Formatter().format(underline);
-            expect(tree).to.deep.equal({
-                "w:u": {
-                    _attr: {
-                        "w:val": "wavyDouble",
-                    },
-                },
-            });
-        });
-    });
-});
-
-describe("DashDotDotHeavyUnderline", () => {
-    describe("#constructor()", () => {
-        it("should put value in attribute", () => {
-            const underline = new u.WavyHeavyUnderline();
-            const tree = new Formatter().format(underline);
-            expect(tree).to.deep.equal({
-                "w:u": {
-                    _attr: {
-                        "w:val": "wavyHeavy",
-                    },
-                },
-            });
-        });
-    });
-});
-
-describe("DashDotDotHeavyUnderline", () => {
-    describe("#constructor()", () => {
-        it("should put value in attribute", () => {
-            const underline = new u.WordsUnderline();
-            const tree = new Formatter().format(underline);
-            expect(tree).to.deep.equal({
-                "w:u": {
-                    _attr: {
-                        "w:val": "words",
-                    },
-                },
-            });
-        });
-    });
-});

package/src/file/paragraph/run/underline.ts

@@ -1,3 +1,4 @@
+import { hexColorValue } from "file/values";
 import { Attributes, XmlComponent } from "file/xml-components";
 
 export enum UnderlineType {
@@ -20,116 +21,14 @@ export enum UnderlineType {
     WAVYDOUBLE = "wavyDouble",
 }
 
-export abstract class BaseUnderline extends XmlComponent {
-    constructor(underlineType: string, color?: string) {
+export class Underline extends XmlComponent {
+    constructor(underlineType: UnderlineType = UnderlineType.SINGLE, color?: string) {
         super("w:u");
         this.root.push(
             new Attributes({
                 val: underlineType,
-                color: color,
+                color: color === undefined ? undefined : hexColorValue(color),
             }),
         );
     }
 }
-
-export class Underline extends BaseUnderline {
-    constructor(underlineType: UnderlineType = UnderlineType.SINGLE, color?: string) {
-        super(underlineType, color);
-    }
-}
-
-export class DashUnderline extends BaseUnderline {
-    constructor() {
-        super("dash");
-    }
-}
-
-export class DashDotDotHeavyUnderline extends BaseUnderline {
-    constructor() {
-        super("dashDotDotHeavy");
-    }
-}
-
-export class DashDotHeavyUnderline extends BaseUnderline {
-    constructor() {
-        super("dashDotHeavy");
-    }
-}
-
-export class DashLongUnderline extends BaseUnderline {
-    constructor() {
-        super("dashLong");
-    }
-}
-
-export class DashLongHeavyUnderline extends BaseUnderline {
-    constructor() {
-        super("dashLongHeavy");
-    }
-}
-
-export class DotDashUnderline extends BaseUnderline {
-    constructor() {
-        super("dotDash");
-    }
-}
-
-export class DotDotDashUnderline extends BaseUnderline {
-    constructor() {
-        super("dotDotDash");
-    }
-}
-
-export class DottedUnderline extends BaseUnderline {
-    constructor() {
-        super("dotted");
-    }
-}
-
-export class DottedHeavyUnderline extends BaseUnderline {
-    constructor() {
-        super("dottedHeavy");
-    }
-}
-
-export class DoubleUnderline extends BaseUnderline {
-    constructor() {
-        super("double");
-    }
-}
-
-export class SingleUnderline extends BaseUnderline {
-    constructor() {
-        super("single");
-    }
-}
-
-export class ThickUnderline extends BaseUnderline {
-    constructor() {
-        super("thick");
-    }
-}
-
-export class WaveUnderline extends BaseUnderline {
-    constructor() {
-        super("wave");
-    }
-}
-
-export class WavyDoubleUnderline extends BaseUnderline {
-    constructor() {
-        super("wavyDouble");
-    }
-}
-
-export class WavyHeavyUnderline extends BaseUnderline {
-    constructor() {
-        super("wavyHeavy");
-    }
-}
-
-export class WordsUnderline extends BaseUnderline {
-    constructor() {
-        super("words");
-    }
-}

package/src/file/settings/compatibility-setting/compatibility-setting.ts

@@ -1,5 +1,15 @@
 import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
 
+// Currently, this is hard-coded for Microsoft word compatSettings.
+// Theoretically, we could add compatSettings for other programs, but
+// currently there isn't a need.
+
+// <xsd:complexType name="CT_CompatSetting">
+//     <xsd:attribute name="name" type="s:ST_String"/>
+//     <xsd:attribute name="uri" type="s:ST_String"/>
+//     <xsd:attribute name="val" type="s:ST_String"/>
+// </xsd:complexType>
+
 export class CompatibilitySettingAttributes extends XmlAttributeComponent<{
     readonly version: number;
     readonly name: string;
@@ -12,6 +22,8 @@ export class CompatibilitySettingAttributes extends XmlAttributeComponent<{
     };
 }
 
+// https://docs.microsoft.com/en-us/openspecs/office_standards/ms-docx/90138c4d-eb18-4edc-aa6c-dfb799cb1d0d
+
 export class CompatibilitySetting extends XmlComponent {
     constructor(version: number) {
         super("w:compatSetting");

package/src/file/settings/compatibility.ts

@@ -1,11 +1,77 @@
-import { XmlComponent } from "file/xml-components";
+import { OnOffElement, XmlComponent } from "file/xml-components";
 import { CompatibilitySetting } from "./compatibility-setting/compatibility-setting";
 
-class DoNotExpandShiftReturn extends XmlComponent {
-    constructor() {
-        super("w:doNotExpandShiftReturn");
-    }
-}
+// <xsd:complexType name="CT_Compat">
+// <xsd:sequence>
+//   <xsd:element name="useSingleBorderforContiguousCells" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="wpJustification" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="noTabHangInd" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="noLeading" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="spaceForUL" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="noColumnBalance" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="balanceSingleByteDoubleByteWidth" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="noExtraLineSpacing" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="doNotLeaveBackslashAlone" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="ulTrailSpace" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="doNotExpandShiftReturn" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="spacingInWholePoints" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="lineWrapLikeWord6" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="printBodyTextBeforeHeader" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="printColBlack" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="wpSpaceWidth" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="showBreaksInFrames" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="subFontBySize" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="suppressBottomSpacing" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="suppressTopSpacing" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="suppressSpacingAtTopOfPage" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="suppressTopSpacingWP" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="suppressSpBfAfterPgBrk" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="swapBordersFacingPages" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="convMailMergeEsc" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="truncateFontHeightsLikeWP6" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="mwSmallCaps" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="usePrinterMetrics" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="doNotSuppressParagraphBorders" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="wrapTrailSpaces" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="footnoteLayoutLikeWW8" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="shapeLayoutLikeWW8" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="alignTablesRowByRow" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="forgetLastTabAlignment" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="adjustLineHeightInTable" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="autoSpaceLikeWord95" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="noSpaceRaiseLower" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="doNotUseHTMLParagraphAutoSpacing" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="layoutRawTableWidth" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="layoutTableRowsApart" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="useWord97LineBreakRules" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="doNotBreakWrappedTables" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="doNotSnapToGridInCell" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="selectFldWithFirstOrLastChar" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="applyBreakingRules" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="doNotWrapTextWithPunct" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="doNotUseEastAsianBreakRules" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="useWord2002TableStyleRules" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="growAutofit" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="useFELayout" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="useNormalStyleForList" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="doNotUseIndentAsNumberingTabStop" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="useAltKinsokuLineBreakRules" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="allowSpaceOfSameStyleInTable" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="doNotSuppressIndentation" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="doNotAutofitConstrainedTables" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="autofitToFirstFixedWidthCell" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="underlineTabInNumList" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="displayHangulFixedWidth" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="splitPgBreakAndParaMark" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="doNotVertAlignCellWithSp" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="doNotBreakConstrainedForcedTable" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="doNotVertAlignInTxbx" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="useAnsiKerningPairs" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="cachedColBalance" type="CT_OnOff" minOccurs="0"/>
+//   <xsd:element name="compatSetting" type="CT_CompatSetting" minOccurs="0" maxOccurs="unbounded"
+//   />
+// </xsd:sequence>
+// </xsd:complexType>
 
 export interface ICompatibilityOptions {
     readonly doNotExpandShiftReturn?: boolean;
@@ -16,8 +82,9 @@ export class Compatibility extends XmlComponent {
     constructor(options: ICompatibilityOptions) {
         super("w:compat");
 
-        if (options.doNotExpandShiftReturn) {
-            this.root.push(new DoNotExpandShiftReturn());
+        // Don't justify lines ending in soft line break setting
+        if (options.doNotExpandShiftReturn !== undefined) {
+            this.root.push(new OnOffElement("w:doNotExpandShiftReturn", options.doNotExpandShiftReturn));
         }
 
         if (options.version) {

package/src/file/settings/index.ts

@@ -1,2 +1 @@
 export * from "./settings";
-export * from "./update-fields";