docx 6.0.3 → 7.1.2

package/src/file/paragraph/properties.ts

@@ -1,23 +1,20 @@
 // http://officeopenxml.com/WPparagraphProperties.php
-import { IContext, IgnoreIfEmptyXmlComponent, IXmlableObject, XmlComponent } from "file/xml-components";
+// https://c-rex.net/projects/samples/ooxml/e1/Part4/OOXML_P4_DOCX_suppressLineNumbers_topic_ID0ECJAO.html
+import { IContext, IgnoreIfEmptyXmlComponent, IXmlableObject, OnOffElement, XmlComponent } from "file/xml-components";
 import { DocumentWrapper } from "../document-wrapper";
-import { ShadingType } from "../table/shading";
+import { IShadingAttributesProperties, Shading } from "../shading";
 import { Alignment, AlignmentType } from "./formatting/alignment";
-import { Bidirectional } from "./formatting/bidirectional";
-import { Border, IBorderOptions, ThematicBreak } from "./formatting/border";
+import { Border, IBordersOptions, ThematicBreak } from "./formatting/border";
+import { PageBreakBefore } from "./formatting/break";
 import { IIndentAttributesProperties, Indent } from "./formatting/indent";
-import { KeepLines, KeepNext } from "./formatting/keep";
-import { PageBreakBefore } from "./formatting/page-break";
-import { ContextualSpacing, ISpacingProperties, Spacing } from "./formatting/spacing";
+import { ISpacingProperties, Spacing } from "./formatting/spacing";
 import { HeadingLevel, Style } from "./formatting/style";
 import { LeaderType, TabStop, TabStopPosition, TabStopType } from "./formatting/tab-stop";
 import { NumberProperties } from "./formatting/unordered-list";
-import { WidowControl } from "./formatting/widow-control";
 import { FrameProperties, IFrameOptions } from "./frame/frame-properties";
 import { OutlineLevel } from "./links";
-import { Shading } from "./run/formatting";
 
-export interface IParagraphStylePropertiesOptions {
+export interface ILevelParagraphStylePropertiesOptions {
     readonly alignment?: AlignmentType;
     readonly thematicBreak?: boolean;
     readonly contextualSpacing?: boolean;
@@ -30,8 +27,17 @@ export interface IParagraphStylePropertiesOptions {
     readonly outlineLevel?: number;
 }
 
+export interface IParagraphStylePropertiesOptions extends ILevelParagraphStylePropertiesOptions {
+    readonly numbering?: {
+        readonly reference: string;
+        readonly level: number;
+        readonly instance?: number;
+        readonly custom?: boolean;
+    };
+}
+
 export interface IParagraphPropertiesOptions extends IParagraphStylePropertiesOptions {
-    readonly border?: IBorderOptions;
+    readonly border?: IBordersOptions;
     readonly heading?: HeadingLevel;
     readonly bidirectional?: boolean;
     readonly pageBreakBefore?: boolean;
@@ -44,19 +50,10 @@ export interface IParagraphPropertiesOptions extends IParagraphStylePropertiesOp
     readonly bullet?: {
         readonly level: number;
     };
-    readonly numbering?: {
-        readonly reference: string;
-        readonly level: number;
-        readonly instance?: number;
-        readonly custom?: boolean;
-    };
-    readonly shading?: {
-        readonly type: ShadingType;
-        readonly fill: string;
-        readonly color: string;
-    };
+    readonly shading?: IShadingAttributesProperties;
     readonly widowControl?: boolean;
     readonly frame?: IFrameOptions;
+    readonly suppressLineNumbers?: boolean;
 }
 
 export class ParagraphProperties extends IgnoreIfEmptyXmlComponent {
@@ -66,78 +63,54 @@ export class ParagraphProperties extends IgnoreIfEmptyXmlComponent {
         super("w:pPr");
 
         if (!options) {
-            return;
-        }
-
-        if (options.border) {
-            this.push(new Border(options.border));
-        }
-
-        if (options.spacing) {
-            this.push(new Spacing(options.spacing));
-        }
-
-        if (options.outlineLevel !== undefined) {
-            this.push(new OutlineLevel(options.outlineLevel));
-        }
-
-        if (options.alignment) {
-            this.push(new Alignment(options.alignment));
+            return this;
         }
 
         if (options.heading) {
             this.push(new Style(options.heading));
         }
 
-        if (options.bidirectional) {
-            this.push(new Bidirectional());
-        }
-
-        if (options.thematicBreak) {
-            this.push(new ThematicBreak());
+        if (options.bullet) {
+            this.push(new Style("ListParagraph"));
         }
 
-        if (options.pageBreakBefore) {
-            this.push(new PageBreakBefore());
+        if (options.numbering) {
+            if (!options.style && !options.heading) {
+                if (!options.numbering.custom) {
+                    this.push(new Style("ListParagraph"));
+                }
+            }
         }
 
-        if (options.contextualSpacing) {
-            this.push(new ContextualSpacing(options.contextualSpacing));
+        if (options.style) {
+            this.push(new Style(options.style));
         }
 
-        if (options.indent) {
-            this.push(new Indent(options.indent));
+        if (options.keepNext !== undefined) {
+            this.push(new OnOffElement("w:keepNext", options.keepNext));
         }
 
-        if (options.keepLines) {
-            this.push(new KeepLines());
+        if (options.keepLines !== undefined) {
+            this.push(new OnOffElement("w:keepLines", options.keepLines));
         }
 
-        if (options.keepNext) {
-            this.push(new KeepNext());
+        if (options.pageBreakBefore) {
+            this.push(new PageBreakBefore());
         }
 
-        if (options.tabStops) {
-            for (const tabStop of options.tabStops) {
-                this.push(new TabStop(tabStop.type, tabStop.position, tabStop.leader));
-            }
+        if (options.frame) {
+            this.push(new FrameProperties(options.frame));
         }
 
-        if (options.style) {
-            this.push(new Style(options.style));
+        if (options.widowControl !== undefined) {
+            this.push(new OnOffElement("w:widowControl", options.widowControl));
         }
 
         if (options.bullet) {
-            this.push(new Style("ListParagraph"));
             this.push(new NumberProperties(1, options.bullet.level));
         }
 
         if (options.numbering) {
-            if (!options.style && !options.heading) {
-                if (!options.numbering.custom) {
-                    this.push(new Style("ListParagraph"));
-                }
-            }
             this.numberingReferences.push({
                 reference: options.numbering.reference,
                 instance: options.numbering.instance ?? 0,
@@ -146,24 +119,58 @@ export class ParagraphProperties extends IgnoreIfEmptyXmlComponent {
             this.push(new NumberProperties(`${options.numbering.reference}-${options.numbering.instance ?? 0}`, options.numbering.level));
         }
 
+        if (options.border) {
+            this.push(new Border(options.border));
+        }
+
+        if (options.thematicBreak) {
+            this.push(new ThematicBreak());
+        }
+
+        if (options.shading) {
+            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));
+            }
+        }
+
         if (options.leftTabStop) {
             this.push(new TabStop(TabStopType.LEFT, options.leftTabStop));
         }
 
-        if (options.shading) {
-            this.push(new Shading(options.shading.type, options.shading.fill, options.shading.color));
+        if (options.bidirectional !== undefined) {
+            this.push(new OnOffElement("w:bidi", options.contextualSpacing));
         }
 
-        if (options.widowControl) {
-            this.push(new WidowControl(options.widowControl));
+        if (options.spacing) {
+            this.push(new Spacing(options.spacing));
         }
 
-        if (options.frame) {
-            this.push(new FrameProperties(options.frame));
+        if (options.indent) {
+            this.push(new Indent(options.indent));
+        }
+
+        if (options.contextualSpacing !== undefined) {
+            this.push(new OnOffElement("w:contextualSpacing", options.contextualSpacing));
+        }
+
+        if (options.alignment) {
+            this.push(new Alignment(options.alignment));
+        }
+
+        if (options.outlineLevel !== undefined) {
+            this.push(new OutlineLevel(options.outlineLevel));
+        }
+
+        if (options.suppressLineNumbers !== undefined) {
+            this.push(new OnOffElement("w:suppressLineNumbers", options.suppressLineNumbers));
         }
     }
 

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

@@ -1,6 +1,30 @@
 // http://officeopenxml.com/WPtextSpecialContent-break.php
 import { XmlComponent } from "file/xml-components";
 
+// <xsd:group name="EG_RunInnerContent">
+//   ...
+//   <xsd:element name="br" type="CT_Br"/>
+
+// <xsd:complexType name="CT_Br">
+//     <xsd:attribute name="type" type="ST_BrType" use="optional"/>
+//     <xsd:attribute name="clear" type="ST_BrClear" use="optional"/>
+// </xsd:complexType>
+
+// <xsd:simpleType name="ST_BrType">
+// <xsd:restriction base="xsd:string">
+//   <xsd:enumeration value="page"/>
+//   <xsd:enumeration value="column"/>
+//   <xsd:enumeration value="textWrapping"/>
+// </xsd:restriction>
+// </xsd:simpleType>
+// <xsd:simpleType name="ST_BrClear">
+// <xsd:restriction base="xsd:string">
+//   <xsd:enumeration value="none"/>
+//   <xsd:enumeration value="left"/>
+//   <xsd:enumeration value="right"/>
+//   <xsd:enumeration value="all"/>
+// </xsd:restriction>
+// </xsd:simpleType>
 export class Break extends XmlComponent {
     constructor() {
         super("w:br");

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

@@ -2,18 +2,35 @@ import { expect } from "chai";
 
 import { Formatter } from "export/formatter";
 
-import { Bold } from "./formatting";
+import { CharacterSpacing, Color } from "./formatting";
 
-describe("Bold", () => {
+describe("CharacterSpacing", () => {
     describe("#constructor()", () => {
         it("should create", () => {
-            const currentBold = new Bold();
+            const element = new CharacterSpacing(32);
 
-            const tree = new Formatter().format(currentBold);
+            const tree = new Formatter().format(element);
             expect(tree).to.deep.equal({
-                "w:b": {
+                "w:spacing": {
                     _attr: {
-                        "w:val": true,
+                        "w:val": 32,
+                    },
+                },
+            });
+        });
+    });
+});
+
+describe("Color", () => {
+    describe("#constructor()", () => {
+        it("should create", () => {
+            const element = new Color("#FFFFFF");
+
+            const tree = new Formatter().format(element);
+            expect(tree).to.deep.equal({
+                "w:color": {
+                    _attr: {
+                        "w:val": "FFFFFF",
                     },
                 },
             });

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

@@ -1,170 +1,55 @@
+import { hexColorValue, signedTwipsMeasureValue } from "file/values";
 import { Attributes, XmlComponent } from "file/xml-components";
 
-export class Bold extends XmlComponent {
-    constructor() {
-        super("w:b");
-        this.root.push(
-            new Attributes({
-                val: true,
-            }),
-        );
-    }
-}
-
-export class BoldComplexScript extends XmlComponent {
-    constructor() {
-        super("w:bCs");
-        this.root.push(
-            new Attributes({
-                val: true,
-            }),
-        );
-    }
-}
-
 export class CharacterSpacing extends XmlComponent {
-    constructor(value: number) {
+    constructor(value: number | string) {
         super("w:spacing");
         this.root.push(
             new Attributes({
-                val: value,
-            }),
-        );
-    }
-}
-
-export class Italics extends XmlComponent {
-    constructor() {
-        super("w:i");
-        this.root.push(
-            new Attributes({
-                val: true,
-            }),
-        );
-    }
-}
-
-export class ItalicsComplexScript extends XmlComponent {
-    constructor() {
-        super("w:iCs");
-        this.root.push(
-            new Attributes({
-                val: true,
-            }),
-        );
-    }
-}
-
-export class Caps extends XmlComponent {
-    constructor() {
-        super("w:caps");
-        this.root.push(
-            new Attributes({
-                val: true,
+                val: signedTwipsMeasureValue(value),
             }),
         );
     }
 }
 
+// <xsd:complexType name="CT_Color">
+//     <xsd:attribute name="val" type="ST_HexColor" use="required"/>
+//     <xsd:attribute name="themeColor" type="ST_ThemeColor" use="optional"/>
+//     <xsd:attribute name="themeTint" type="ST_UcharHexNumber" use="optional"/>
+//     <xsd:attribute name="themeShade" type="ST_UcharHexNumber" use="optional"/>
+// </xsd:complexType>
 export class Color extends XmlComponent {
     constructor(color: string) {
         super("w:color");
         this.root.push(
             new Attributes({
-                val: color,
-            }),
-        );
-    }
-}
-
-export class DoubleStrike extends XmlComponent {
-    constructor() {
-        super("w:dstrike");
-        this.root.push(
-            new Attributes({
-                val: true,
-            }),
-        );
-    }
-}
-
-export class Emboss extends XmlComponent {
-    constructor() {
-        super("w:emboss");
-        this.root.push(
-            new Attributes({
-                val: true,
-            }),
-        );
-    }
-}
-
-export class Imprint extends XmlComponent {
-    constructor() {
-        super("w:imprint");
-        this.root.push(
-            new Attributes({
-                val: true,
-            }),
-        );
-    }
-}
-
-export class SmallCaps extends XmlComponent {
-    constructor() {
-        super("w:smallCaps");
-        this.root.push(
-            new Attributes({
-                val: true,
-            }),
-        );
-    }
-}
-
-export class Strike extends XmlComponent {
-    constructor() {
-        super("w:strike");
-        this.root.push(
-            new Attributes({
-                val: true,
-            }),
-        );
-    }
-}
-
-export class Size extends XmlComponent {
-    constructor(size: number) {
-        super("w:sz");
-        this.root.push(
-            new Attributes({
-                val: size,
-            }),
-        );
-    }
-}
-
-export class SizeComplexScript extends XmlComponent {
-    constructor(size: number) {
-        super("w:szCs");
-        this.root.push(
-            new Attributes({
-                val: size,
-            }),
-        );
-    }
-}
-
-export class RightToLeft extends XmlComponent {
-    constructor() {
-        super("w:rtl");
-        this.root.push(
-            new Attributes({
-                val: true,
+                val: hexColorValue(color),
             }),
         );
     }
 }
 
+// <xsd:simpleType name="ST_HighlightColor">
+//     <xsd:restriction base="xsd:string">
+//         <xsd:enumeration value="black"/>
+//         <xsd:enumeration value="blue"/>
+//         <xsd:enumeration value="cyan"/>
+//         <xsd:enumeration value="green"/>
+//         <xsd:enumeration value="magenta"/>
+//         <xsd:enumeration value="red"/>
+//         <xsd:enumeration value="yellow"/>
+//         <xsd:enumeration value="white"/>
+//         <xsd:enumeration value="darkBlue"/>
+//         <xsd:enumeration value="darkCyan"/>
+//         <xsd:enumeration value="darkGreen"/>
+//         <xsd:enumeration value="darkMagenta"/>
+//         <xsd:enumeration value="darkRed"/>
+//         <xsd:enumeration value="darkYellow"/>
+//         <xsd:enumeration value="darkGray"/>
+//         <xsd:enumeration value="lightGray"/>
+//         <xsd:enumeration value="none"/>
+//     </xsd:restriction>
+// </xsd:simpleType>
 export class Highlight extends XmlComponent {
     constructor(color: string) {
         super("w:highlight");
@@ -186,29 +71,3 @@ export class HighlightComplexScript extends XmlComponent {
         );
     }
 }
-
-export class Shading extends XmlComponent {
-    constructor(value: string, fill: string, color: string) {
-        super("w:shd");
-        this.root.push(
-            new Attributes({
-                val: value,
-                fill: fill,
-                color: color,
-            }),
-        );
-    }
-}
-
-export class ShadowComplexScript extends XmlComponent {
-    constructor(value: string, fill: string, color: string) {
-        super("w:shdCs");
-        this.root.push(
-            new Attributes({
-                val: value,
-                fill: fill,
-                color: color,
-            }),
-        );
-    }
-}