docx 7.3.0 → 7.4.0

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

@@ -1,8 +1,8 @@
 import { expect } from "chai";
 import { SinonStub, stub } from "sinon";
 
-import * as convenienceFunctions from "convenience-functions";
-import { Formatter } from "export/formatter";
+import { Formatter } from "@export/formatter";
+import * as convenienceFunctions from "@util/convenience-functions";
 
 import { Numbering } from "./numbering";
 

package/src/file/numbering/numbering.ts

@@ -1,8 +1,8 @@
 // http://officeopenxml.com/WPnumbering.php
 // https://stackoverflow.com/questions/58622437/purpose-of-abstractnum-and-numberinginstance
-import { convertInchesToTwip, uniqueNumericId } from "convenience-functions";
-import { AlignmentType } from "file/paragraph";
-import { IContext, IXmlableObject, XmlComponent } from "file/xml-components";
+import { AlignmentType } from "@file/paragraph";
+import { IContext, IXmlableObject, XmlComponent } from "@file/xml-components";
+import { convertInchesToTwip, uniqueNumericId } from "@util/convenience-functions";
 
 import { DocumentAttributes } from "../document/document-attributes";
 import { AbstractNumbering } from "./abstract-numbering";

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

@@ -1,6 +1,6 @@
 import { expect } from "chai";
 
-import { Formatter } from "export/formatter";
+import { Formatter } from "@export/formatter";
 import { Alignment, AlignmentType } from "./alignment";
 
 describe("Alignment", () => {

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

@@ -1,6 +1,6 @@
 // http://officeopenxml.com/WPalignment.php
 // http://officeopenxml.com/WPtableAlignment.php
-import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+import { XmlAttributeComponent, XmlComponent } from "@file/xml-components";
 
 export enum AlignmentType {
     START = "start",

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

@@ -1,8 +1,8 @@
 import { expect } from "chai";
 
-import { Formatter } from "export/formatter";
+import { Formatter } from "@export/formatter";
 
-import { BorderStyle } from "file/border";
+import { BorderStyle } from "@file/border";
 import { Border, ThematicBreak } from "./border";
 
 describe("Border", () => {

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

@@ -1,6 +1,6 @@
 // http://officeopenxml.com/WPborders.php
-import { BorderElement, BorderStyle, IBorderOptions } from "file/border";
-import { IgnoreIfEmptyXmlComponent, XmlComponent } from "file/xml-components";
+import { BorderElement, BorderStyle, IBorderOptions } from "@file/border";
+import { IgnoreIfEmptyXmlComponent, XmlComponent } from "@file/xml-components";
 
 export interface IBordersOptions {
     readonly top?: IBorderOptions;

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

@@ -1,6 +1,6 @@
 import { expect } from "chai";
 
-import { Formatter } from "export/formatter";
+import { Formatter } from "@export/formatter";
 
 import { ColumnBreak, PageBreak, PageBreakBefore } from "./break";
 

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

@@ -1,5 +1,5 @@
 // http://officeopenxml.com/WPtextSpecialContent-break.php
-import { Attributes, XmlComponent } from "file/xml-components";
+import { Attributes, XmlComponent } from "@file/xml-components";
 import { Run } from "../run";
 
 enum BreakType {

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

@@ -0,0 +1,42 @@
+import { expect } from "chai";
+
+import { Formatter } from "@export/formatter";
+
+import { Indent } from "./indent";
+
+describe("Indent", () => {
+    it("should create", () => {
+        const indent = new Indent({
+            start: 10,
+            end: 10,
+            left: 10,
+            right: 10,
+            hanging: 10,
+            firstLine: 10,
+        });
+        const tree = new Formatter().format(indent);
+        expect(tree).to.deep.equal({
+            "w:ind": {
+                _attr: {
+                    "w:start": 10,
+                    "w:end": 10,
+                    "w:firstLine": 10,
+                    "w:hanging": 10,
+                    "w:left": 10,
+                    "w:right": 10,
+                },
+            },
+        });
+    });
+
+    it("should create with no indent values", () => {
+        const indent = new Indent({});
+
+        const tree = new Formatter().format(indent);
+        expect(tree).to.deep.equal({
+            "w:ind": {
+                _attr: {},
+            },
+        });
+    });
+});

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

@@ -1,6 +1,6 @@
 // http://officeopenxml.com/WPindentation.php
-import { signedTwipsMeasureValue, twipsMeasureValue } from "file/values";
-import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+import { XmlAttributeComponent, XmlComponent } from "@file/xml-components";
+import { signedTwipsMeasureValue, twipsMeasureValue } from "@util/values";
 
 export interface IIndentAttributesProperties {
     readonly start?: number | string;

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

@@ -1,6 +1,6 @@
 import { expect } from "chai";
 
-import { Formatter } from "export/formatter";
+import { Formatter } from "@export/formatter";
 
 import { Spacing } from "./spacing";
 

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

@@ -1,5 +1,5 @@
 // http://officeopenxml.com/WPspacing.php
-import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+import { XmlAttributeComponent, XmlComponent } from "@file/xml-components";
 
 export enum LineRuleType {
     AT_LEAST = "atLeast",

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

@@ -1,6 +1,6 @@
 import { expect } from "chai";
 
-import { Formatter } from "export/formatter";
+import { Formatter } from "@export/formatter";
 
 import { Style } from "./style";
 

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

@@ -1,4 +1,4 @@
-import { Attributes, XmlComponent } from "file/xml-components";
+import { Attributes, XmlComponent } from "@file/xml-components";
 
 export enum HeadingLevel {
     HEADING_1 = "Heading1",

package/src/file/paragraph/formatting/tab-stop.ts

@@ -1,5 +1,5 @@
 // http://officeopenxml.com/WPtab.php
-import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+import { XmlAttributeComponent, XmlComponent } from "@file/xml-components";
 
 export class TabStop extends XmlComponent {
     constructor(type: TabStopType, position: number, leader?: LeaderType) {

package/src/file/paragraph/formatting/unordered-list.spec.ts

@@ -1,6 +1,6 @@
 import { expect } from "chai";
 
-import { Formatter } from "export/formatter";
+import { Formatter } from "@export/formatter";
 
 import { NumberProperties } from "./unordered-list";
 

package/src/file/paragraph/formatting/unordered-list.ts

@@ -1,4 +1,4 @@
-import { Attributes, XmlComponent } from "file/xml-components";
+import { Attributes, XmlComponent } from "@file/xml-components";
 
 export class NumberProperties extends XmlComponent {
     constructor(numberId: number | string, indentLevel: number) {

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

@@ -1,7 +1,7 @@
 import { expect } from "chai";
 
-import { Formatter } from "export/formatter";
-import { HorizontalPositionAlign, VerticalPositionAlign } from "file/shared";
+import { Formatter } from "@export/formatter";
+import { HorizontalPositionAlign, VerticalPositionAlign } from "@file/shared";
 
 import { FrameAnchorType, FrameProperties } from "./frame-properties";
 
@@ -82,5 +82,75 @@ describe("FrameProperties", () => {
                 },
             });
         });
+
+        it("should create without x and y", () => {
+            const currentFrameProperties = new FrameProperties({
+                width: 4000,
+                height: 1000,
+                anchor: {
+                    horizontal: FrameAnchorType.MARGIN,
+                    vertical: FrameAnchorType.MARGIN,
+                },
+                alignment: {
+                    x: HorizontalPositionAlign.CENTER,
+                    y: VerticalPositionAlign.TOP,
+                },
+                space: {
+                    horizontal: 100,
+                    vertical: 200,
+                },
+            });
+
+            const tree = new Formatter().format(currentFrameProperties);
+            expect(tree).to.deep.equal({
+                "w:framePr": {
+                    _attr: {
+                        "w:h": 1000,
+                        "w:hAnchor": "margin",
+                        "w:vAnchor": "margin",
+                        "w:w": 4000,
+                        "w:xAlign": "center",
+                        "w:yAlign": "top",
+                        "w:hSpace": 100,
+                        "w:vSpace": 200,
+                    },
+                },
+            });
+        });
+
+        it("should create without alignments", () => {
+            const currentFrameProperties = new FrameProperties({
+                position: {
+                    x: 1000,
+                    y: 3000,
+                },
+                width: 4000,
+                height: 1000,
+                anchor: {
+                    horizontal: FrameAnchorType.MARGIN,
+                    vertical: FrameAnchorType.MARGIN,
+                },
+                space: {
+                    horizontal: 100,
+                    vertical: 200,
+                },
+            });
+
+            const tree = new Formatter().format(currentFrameProperties);
+            expect(tree).to.deep.equal({
+                "w:framePr": {
+                    _attr: {
+                        "w:h": 1000,
+                        "w:hAnchor": "margin",
+                        "w:vAnchor": "margin",
+                        "w:w": 4000,
+                        "w:x": 1000,
+                        "w:y": 3000,
+                        "w:hSpace": 100,
+                        "w:vSpace": 200,
+                    },
+                },
+            });
+        });
     });
 });

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

@@ -1,7 +1,7 @@
 // http://officeopenxml.com/WPparagraph-textFrames.php
-import { HeightRule } from "file";
-import { HorizontalPositionAlign, VerticalPositionAlign } from "file/shared/alignment";
-import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+import { HorizontalPositionAlign, VerticalPositionAlign } from "@file/shared/alignment";
+import { HeightRule } from "@file/table";
+import { XmlAttributeComponent, XmlComponent } from "@file/xml-components";
 
 export enum DropCapType {
     NONE = "none",
@@ -24,15 +24,11 @@ export enum FrameWrap {
     TIGHT = "tight",
 }
 
-export interface IFrameOptions {
+interface IBaseFrameOptions {
     readonly anchorLock?: boolean;
     readonly dropCap?: DropCapType;
     readonly width: number;
     readonly height: number;
-    readonly position: {
-        readonly x: number;
-        readonly y: number;
-    };
     readonly wrap?: FrameWrap;
     readonly lines?: number;
     readonly anchor: {
@@ -44,19 +40,33 @@ export interface IFrameOptions {
         readonly vertical: number;
     };
     readonly rule?: HeightRule;
+}
+
+export interface IXYFrameOptions extends IBaseFrameOptions {
+    readonly position: {
+        readonly x: number;
+        readonly y: number;
+    };
+}
+
+export interface IAlignmentFrameOptions extends IBaseFrameOptions {
     readonly alignment: {
         readonly x: HorizontalPositionAlign;
         readonly y: VerticalPositionAlign;
     };
 }
 
+// Be wary of Typescript's Open types:
+// https://stackoverflow.com/q/46370222/3481582
+export type IFrameOptions = IXYFrameOptions | IAlignmentFrameOptions;
+
 export class FramePropertiesAttributes extends XmlAttributeComponent<{
     readonly anchorLock?: boolean;
     readonly dropCap?: DropCapType;
     readonly width: number;
     readonly height: number;
-    readonly x: number;
-    readonly y: number;
+    readonly x?: number;
+    readonly y?: number;
     readonly wrap?: FrameWrap;
     readonly lines?: number;
     readonly anchorHorizontal?: FrameAnchorType;
@@ -95,15 +105,15 @@ export class FrameProperties extends XmlComponent {
                 dropCap: options.dropCap,
                 width: options.width,
                 height: options.height,
-                x: options.position.x,
-                y: options.position.y,
+                x: (options as IXYFrameOptions).position ? (options as IXYFrameOptions).position.x : undefined,
+                y: (options as IXYFrameOptions).position ? (options as IXYFrameOptions).position.y : undefined,
                 anchorHorizontal: options.anchor.horizontal,
                 anchorVertical: options.anchor.vertical,
                 spaceHorizontal: options.space?.horizontal,
                 spaceVertical: options.space?.vertical,
                 rule: options.rule,
-                alignmentX: options.alignment.x,
-                alignmentY: options.alignment.y,
+                alignmentX: (options as IAlignmentFrameOptions).alignment ? (options as IAlignmentFrameOptions).alignment.x : undefined,
+                alignmentY: (options as IAlignmentFrameOptions).alignment ? (options as IAlignmentFrameOptions).alignment.y : undefined,
                 lines: options.lines,
                 wrap: options.wrap,
             }),

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

@@ -1,4 +1,4 @@
-import { XmlAttributeComponent } from "file/xml-components";
+import { XmlAttributeComponent } from "@file/xml-components";
 
 export class BookmarkStartAttributes extends XmlAttributeComponent<{
     readonly id: number;

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

@@ -1,6 +1,6 @@
 // http://officeopenxml.com/WPbookmark.php
-import { uniqueNumericId } from "convenience-functions";
-import { XmlComponent } from "file/xml-components";
+import { XmlComponent } from "@file/xml-components";
+import { uniqueNumericId } from "@util/convenience-functions";
 
 import { ParagraphChild } from "../paragraph";
 import { BookmarkEndAttributes, BookmarkStartAttributes } from "./bookmark-attributes";

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

@@ -1,4 +1,4 @@
-import { XmlAttributeComponent } from "file/xml-components";
+import { XmlAttributeComponent } from "@file/xml-components";
 
 export interface IHyperlinkAttributesProperties {
     readonly id?: string;

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

@@ -1,6 +1,6 @@
 import { expect } from "chai";
 
-import { Formatter } from "export/formatter";
+import { Formatter } from "@export/formatter";
 
 import { TextRun } from "../run";
 import { ConcreteHyperlink, ExternalHyperlink, InternalHyperlink } from "./hyperlink";

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

@@ -1,6 +1,6 @@
 // http://officeopenxml.com/WPhyperlink.php
-import { uniqueId } from "convenience-functions";
-import { XmlComponent } from "file/xml-components";
+import { XmlComponent } from "@file/xml-components";
+import { uniqueId } from "@util/convenience-functions";
 
 import { ParagraphChild } from "../paragraph";
 import { HyperlinkAttributes, IHyperlinkAttributesProperties } from "./hyperlink-attributes";

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

@@ -1,6 +1,6 @@
 import { expect } from "chai";
 
-import { Formatter } from "export/formatter";
+import { Formatter } from "@export/formatter";
 
 import { OutlineLevel } from "./outline-level";
 

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

@@ -1,5 +1,5 @@
 // http://officeopenxml.com/WPparagraph.php
-import { Attributes, XmlComponent } from "file/xml-components";
+import { Attributes, XmlComponent } from "@file/xml-components";
 
 export class OutlineLevel extends XmlComponent {
     constructor(public readonly level: number) {

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

@@ -1,6 +1,6 @@
 import { expect } from "chai";
 
-import { Formatter } from "export/formatter";
+import { Formatter } from "@export/formatter";
 import { PageReferenceFieldInstruction } from "./pageref-field-instruction";
 
 describe("PageReference field instruction", () => {

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

@@ -1,10 +1,8 @@
-import { SpaceType } from "file/space-type";
-import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
-import { IPageReferenceOptions } from "./pageref-properties";
+import { SpaceType } from "@file/space-type";
+import { XmlComponent } from "@file/xml-components";
 
-class TextAttributes extends XmlAttributeComponent<{ readonly space: SpaceType }> {
-    protected readonly xmlKeys = { space: "xml:space" };
-}
+import { TextAttributes } from "../run/text-attributes";
+import { IPageReferenceOptions } from "./pageref-properties";
 
 export class PageReferenceFieldInstruction extends XmlComponent {
     constructor(bookmarkId: string, options: IPageReferenceOptions = {}) {

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

@@ -1,6 +1,6 @@
 import { expect } from "chai";
 
-import { Formatter } from "export/formatter";
+import { Formatter } from "@export/formatter";
 import { PageReference } from "./pageref";
 
 describe("PageReference", () => {

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

@@ -1,5 +1,5 @@
 // See https://www.ecma-international.org/publications/standards/Ecma-376.htm (at Part 1, Page 1234)
-import { Begin, End } from "file/paragraph/run/field";
+import { Begin, End } from "@file/paragraph/run/field";
 import { Run } from "../run";
 import { PageReferenceFieldInstruction } from "./pageref-field-instruction";
 import type { IPageReferenceOptions } from "./pageref-properties";

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

@@ -1,6 +1,6 @@
 import { expect } from "chai";
 
-import { Formatter } from "export/formatter";
+import { Formatter } from "@export/formatter";
 
 import { MathRun } from "../math-run";
 import { MathAngledBrackets } from "./math-angled-brackets";

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

@@ -1,5 +1,5 @@
 // http://www.datypic.com/sc/ooxml/e-m_d-1.html
-import { XmlComponent } from "file/xml-components";
+import { XmlComponent } from "@file/xml-components";
 
 import { MathComponent } from "../math-component";
 import { MathBase } from "../n-ary";

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

@@ -1,6 +1,6 @@
 import { expect } from "chai";
 
-import { Formatter } from "export/formatter";
+import { Formatter } from "@export/formatter";
 
 import { MathBeginningCharacter } from "./math-beginning-character";
 

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

@@ -1,5 +1,5 @@
 // http://www.datypic.com/sc/ooxml/e-m_begChr-1.html
-import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+import { XmlAttributeComponent, XmlComponent } from "@file/xml-components";
 
 class MathBeginningCharacterAttributes extends XmlAttributeComponent<{ readonly character: string }> {
     protected readonly xmlKeys = { character: "m:val" };

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

@@ -1,6 +1,6 @@
 import { expect } from "chai";
 
-import { Formatter } from "export/formatter";
+import { Formatter } from "@export/formatter";
 
 import { MathBracketProperties } from "./math-bracket-properties";
 

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

@@ -1,5 +1,5 @@
 // http://www.datypic.com/sc/ooxml/e-m_dPr-1.html
-import { XmlComponent } from "file/xml-components";
+import { XmlComponent } from "@file/xml-components";
 
 import { MathBeginningCharacter } from "./math-beginning-character";
 import { MathEndingCharacter } from "./math-ending-char";

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

@@ -1,6 +1,6 @@
 import { expect } from "chai";
 
-import { Formatter } from "export/formatter";
+import { Formatter } from "@export/formatter";
 
 import { MathRun } from "../math-run";
 import { MathCurlyBrackets } from "./math-curly-brackets";

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

@@ -1,5 +1,5 @@
 // http://www.datypic.com/sc/ooxml/e-m_d-1.html
-import { XmlComponent } from "file/xml-components";
+import { XmlComponent } from "@file/xml-components";
 
 import { MathComponent } from "../math-component";
 import { MathBase } from "../n-ary";

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

@@ -1,5 +1,5 @@
 // http://www.datypic.com/sc/ooxml/e-m_endChr-1.html
-import { XmlAttributeComponent, XmlComponent } from "file/xml-components";
+import { XmlAttributeComponent, XmlComponent } from "@file/xml-components";
 
 class MathEndingCharacterAttributes extends XmlAttributeComponent<{ readonly character: string }> {
     protected readonly xmlKeys = { character: "m:val" };

package/src/file/paragraph/math/brackets/math-ending-character.spec.ts

@@ -1,6 +1,6 @@
 import { expect } from "chai";
 
-import { Formatter } from "export/formatter";
+import { Formatter } from "@export/formatter";
 
 import { MathEndingCharacter } from "./math-ending-char";
 

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

@@ -1,6 +1,6 @@
 import { expect } from "chai";
 
-import { Formatter } from "export/formatter";
+import { Formatter } from "@export/formatter";
 
 import { MathRun } from "../math-run";
 import { MathRoundBrackets } from "./math-round-brackets";

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

@@ -1,5 +1,5 @@
 // http://www.datypic.com/sc/ooxml/e-m_d-1.html
-import { XmlComponent } from "file/xml-components";
+import { XmlComponent } from "@file/xml-components";
 
 import { MathComponent } from "../math-component";
 import { MathBase } from "../n-ary";

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

@@ -1,6 +1,6 @@
 import { expect } from "chai";
 
-import { Formatter } from "export/formatter";
+import { Formatter } from "@export/formatter";
 
 import { MathRun } from "../math-run";
 import { MathSquareBrackets } from "./math-square-brackets";

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

@@ -1,5 +1,5 @@
 // http://www.datypic.com/sc/ooxml/e-m_d-1.html
-import { XmlComponent } from "file/xml-components";
+import { XmlComponent } from "@file/xml-components";
 
 import { MathComponent } from "../math-component";
 import { MathBase } from "../n-ary";

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

@@ -1,6 +1,6 @@
 import { expect } from "chai";
 
-import { Formatter } from "export/formatter";
+import { Formatter } from "@export/formatter";
 
 import { MathRun } from "../math-run";
 import { MathDenominator } from "./math-denominator";

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

@@ -1,4 +1,4 @@
-import { XmlComponent } from "file/xml-components";
+import { XmlComponent } from "@file/xml-components";
 
 import { MathComponent } from "../math-component";
 

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

@@ -1,6 +1,6 @@
 import { expect } from "chai";
 
-import { Formatter } from "export/formatter";
+import { Formatter } from "@export/formatter";
 
 import { MathRun } from "../math-run";
 import { MathFraction } from "./math-fraction";

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

@@ -1,4 +1,4 @@
-import { XmlComponent } from "file/xml-components";
+import { XmlComponent } from "@file/xml-components";
 
 import { MathComponent } from "../math-component";
 import { MathDenominator } from "./math-denominator";

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

@@ -1,6 +1,6 @@
 import { expect } from "chai";
 
-import { Formatter } from "export/formatter";
+import { Formatter } from "@export/formatter";
 
 import { MathRun } from "../math-run";
 import { MathNumerator } from "./math-numerator";