docx 8.0.0 → 8.0.1

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

@@ -1,71 +0,0 @@
-// http://officeopenxml.com/WPindentation.php
-import { NextAttributeComponent, XmlComponent } from "@file/xml-components";
-import { PositiveUniversalMeasure, signedTwipsMeasureValue, twipsMeasureValue, UniversalMeasure } from "@util/values";
-
-export interface IIndentAttributesProperties {
-    readonly start?: number | UniversalMeasure;
-    readonly end?: number | UniversalMeasure;
-    readonly left?: number | UniversalMeasure;
-    readonly right?: number | UniversalMeasure;
-    readonly hanging?: number | PositiveUniversalMeasure;
-    readonly firstLine?: number | PositiveUniversalMeasure;
-}
-
-// <xsd:complexType name="CT_PPrBase">
-// <xsd:sequence>
-//     ...
-//     <xsd:element name="ind" type="CT_Ind" minOccurs="0"/>
-export class Indent extends XmlComponent {
-    public constructor({ start, end, left, right, hanging, firstLine }: IIndentAttributesProperties) {
-        super("w:ind");
-        // <xsd:complexType name="CT_Ind">
-        //     <xsd:attribute name="start" type="ST_SignedTwipsMeasure" use="optional"/>
-        //     <xsd:attribute name="startChars" type="ST_DecimalNumber" use="optional"/>
-        //     <xsd:attribute name="end" type="ST_SignedTwipsMeasure" use="optional"/>
-        //     <xsd:attribute name="endChars" type="ST_DecimalNumber" use="optional"/>
-        //     <xsd:attribute name="left" type="ST_SignedTwipsMeasure" use="optional"/>
-        //     <xsd:attribute name="leftChars" type="ST_DecimalNumber" use="optional"/>
-        //     <xsd:attribute name="right" type="ST_SignedTwipsMeasure" use="optional"/>
-        //     <xsd:attribute name="rightChars" type="ST_DecimalNumber" use="optional"/>
-        //     <xsd:attribute name="hanging" type="s:ST_TwipsMeasure" use="optional"/>
-        //     <xsd:attribute name="hangingChars" type="ST_DecimalNumber" use="optional"/>
-        //     <xsd:attribute name="firstLine" type="s:ST_TwipsMeasure" use="optional"/>
-        //     <xsd:attribute name="firstLineChars" type="ST_DecimalNumber" use="optional"/>
-        // </xsd:complexType>
-        this.root.push(
-            new NextAttributeComponent<{
-                readonly start?: number | UniversalMeasure;
-                readonly end?: number | UniversalMeasure;
-                readonly left?: number | UniversalMeasure;
-                readonly right?: number | UniversalMeasure;
-                readonly hanging?: number | PositiveUniversalMeasure;
-                readonly firstLine?: number | PositiveUniversalMeasure;
-            }>({
-                start: {
-                    key: "w:start",
-                    value: start === undefined ? undefined : signedTwipsMeasureValue(start),
-                },
-                end: {
-                    key: "w:end",
-                    value: end === undefined ? undefined : signedTwipsMeasureValue(end),
-                },
-                left: {
-                    key: "w:left",
-                    value: left === undefined ? undefined : signedTwipsMeasureValue(left),
-                },
-                right: {
-                    key: "w:right",
-                    value: right === undefined ? undefined : signedTwipsMeasureValue(right),
-                },
-                hanging: {
-                    key: "w:hanging",
-                    value: hanging === undefined ? undefined : twipsMeasureValue(hanging),
-                },
-                firstLine: {
-                    key: "w:firstLine",
-                    value: firstLine === undefined ? undefined : twipsMeasureValue(firstLine),
-                },
-            }),
-        );
-    }
-}

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

@@ -1,8 +0,0 @@
-export * from "./alignment";
-export * from "./border";
-export * from "./indent";
-export * from "./break";
-export * from "./spacing";
-export * from "./style";
-export * from "./tab-stop";
-export * from "./unordered-list";

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

@@ -1,25 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-
-import { Spacing } from "./spacing";
-
-describe("Spacing", () => {
-    describe("#constructor", () => {
-        it("should set the properties given", () => {
-            const spacing = new Spacing({ before: 100, after: 120, line: 150 });
-            const tree = new Formatter().format(spacing);
-            expect(tree).to.deep.equal({
-                "w:spacing": { _attr: { "w:after": 120, "w:before": 100, "w:line": 150 } },
-            });
-        });
-
-        it("should only set the given properties", () => {
-            const spacing = new Spacing({ before: 100 });
-            const tree = new Formatter().format(spacing);
-            expect(tree).to.deep.equal({
-                "w:spacing": { _attr: { "w:before": 100 } },
-            });
-        });
-    });
-});

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

@@ -1,33 +0,0 @@
-// http://officeopenxml.com/WPspacing.php
-import { XmlAttributeComponent, XmlComponent } from "@file/xml-components";
-
-export enum LineRuleType {
-    AT_LEAST = "atLeast",
-    EXACTLY = "exactly",
-    EXACT = "exact",
-    AUTO = "auto",
-}
-export interface ISpacingProperties {
-    readonly after?: number;
-    readonly before?: number;
-    readonly line?: number;
-    readonly lineRule?: LineRuleType;
-    readonly beforeAutoSpacing?: boolean;
-    readonly afterAutoSpacing?: boolean;
-}
-
-class SpacingAttributes extends XmlAttributeComponent<ISpacingProperties> {
-    protected readonly xmlKeys = {
-        after: "w:after",
-        before: "w:before",
-        line: "w:line",
-        lineRule: "w:lineRule",
-    };
-}
-
-export class Spacing extends XmlComponent {
-    public constructor(options: ISpacingProperties) {
-        super("w:spacing");
-        this.root.push(new SpacingAttributes(options));
-    }
-}

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

@@ -1,35 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-
-import { Style } from "./style";
-
-describe("ParagraphStyle", () => {
-    let style: Style;
-
-    describe("#constructor()", () => {
-        it("should create a style with given value", () => {
-            style = new Style("test");
-            const tree = new Formatter().format(style);
-            expect(tree).to.deep.equal({
-                "w:pStyle": {
-                    _attr: {
-                        "w:val": "test",
-                    },
-                },
-            });
-        });
-
-        it("should create a style with blank val", () => {
-            style = new Style("");
-            const tree = new Formatter().format(style);
-            expect(tree).to.deep.equal({
-                "w:pStyle": {
-                    _attr: {
-                        "w:val": "",
-                    },
-                },
-            });
-        });
-    });
-});

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

@@ -1,22 +0,0 @@
-import { Attributes, XmlComponent } from "@file/xml-components";
-
-export enum HeadingLevel {
-    HEADING_1 = "Heading1",
-    HEADING_2 = "Heading2",
-    HEADING_3 = "Heading3",
-    HEADING_4 = "Heading4",
-    HEADING_5 = "Heading5",
-    HEADING_6 = "Heading6",
-    TITLE = "Title",
-}
-
-export class Style extends XmlComponent {
-    public constructor(styleId: string) {
-        super("w:pStyle");
-        this.root.push(
-            new Attributes({
-                val: styleId,
-            }),
-        );
-    }
-}

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

@@ -1,54 +0,0 @@
-import { assert } from "chai";
-
-import { Utility } from "tests/utility";
-
-import { LeaderType, TabStop, TabStopType } from "./tab-stop";
-
-describe("LeftTabStop", () => {
-    let tabStop: TabStop;
-
-    beforeEach(() => {
-        tabStop = new TabStop([{ type: TabStopType.LEFT, position: 100 }]);
-    });
-
-    describe("#constructor()", () => {
-        it("should create a Tab Stop with correct attributes", () => {
-            const newJson = Utility.jsonify(tabStop);
-            const attributes = {
-                val: "left",
-                pos: 100,
-            };
-            assert.equal(JSON.stringify(newJson.root[0].root[0].root), JSON.stringify(attributes));
-        });
-
-        it("should create a Tab Stop with w:tab", () => {
-            const newJson = Utility.jsonify(tabStop);
-            assert.equal(newJson.root[0].rootKey, "w:tab");
-        });
-    });
-});
-
-describe("RightTabStop", () => {
-    let tabStop: TabStop;
-
-    beforeEach(() => {
-        tabStop = new TabStop([{ type: TabStopType.RIGHT, position: 100, leader: LeaderType.DOT }]);
-    });
-
-    describe("#constructor()", () => {
-        it("should create a Tab Stop with correct attributes", () => {
-            const newJson = Utility.jsonify(tabStop);
-            const attributes = {
-                val: "right",
-                pos: 100,
-                leader: "dot",
-            };
-            assert.equal(JSON.stringify(newJson.root[0].root[0].root), JSON.stringify(attributes));
-        });
-
-        it("should create a Tab Stop with w:tab", () => {
-            const newJson = Utility.jsonify(tabStop);
-            assert.equal(newJson.root[0].rootKey, "w:tab");
-        });
-    });
-});

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

@@ -1,63 +0,0 @@
-// http://officeopenxml.com/WPtab.php
-import { XmlAttributeComponent, XmlComponent } from "@file/xml-components";
-
-export interface TabStopDefinition {
-    readonly type: TabStopType;
-    readonly position: number | TabStopPosition;
-    readonly leader?: LeaderType;
-}
-
-export class TabStop extends XmlComponent {
-    public constructor(tabDefinitions: readonly TabStopDefinition[]) {
-        super("w:tabs");
-
-        for (const tabDefinition of tabDefinitions) {
-            this.root.push(new TabStopItem(tabDefinition));
-        }
-    }
-}
-
-export enum TabStopType {
-    LEFT = "left",
-    RIGHT = "right",
-    CENTER = "center",
-    BAR = "bar",
-    CLEAR = "clear",
-    DECIMAL = "decimal",
-    END = "end",
-    NUM = "num",
-    START = "start",
-}
-
-export enum LeaderType {
-    DOT = "dot",
-    HYPHEN = "hyphen",
-    MIDDLE_DOT = "middleDot",
-    NONE = "none",
-    UNDERSCORE = "underscore",
-}
-
-export enum TabStopPosition {
-    MAX = 9026,
-}
-
-export class TabAttributes extends XmlAttributeComponent<{
-    readonly val: TabStopType;
-    readonly pos: string | number;
-    readonly leader?: LeaderType;
-}> {
-    protected readonly xmlKeys = { val: "w:val", pos: "w:pos", leader: "w:leader" };
-}
-
-export class TabStopItem extends XmlComponent {
-    public constructor({ type, position, leader }: TabStopDefinition) {
-        super("w:tab");
-        this.root.push(
-            new TabAttributes({
-                val: type,
-                pos: position,
-                leader: leader,
-            }),
-        );
-    }
-}

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

@@ -1,37 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-
-import { NumberProperties } from "./unordered-list";
-
-describe("NumberProperties", () => {
-    describe("#constructor()", () => {
-        it("should create a Number Properties with correct root key", () => {
-            const numberProperties = new NumberProperties(5, 9);
-
-            const tree = new Formatter().format(numberProperties);
-            expect(tree).to.deep.equal({
-                "w:numPr": [
-                    {
-                        "w:ilvl": {
-                            _attr: {
-                                "w:val": 9,
-                            },
-                        },
-                    },
-                    {
-                        "w:numId": {
-                            _attr: {
-                                "w:val": 5,
-                            },
-                        },
-                    },
-                ],
-            });
-        });
-
-        it("should throw an error if level exceeds 9", () => {
-            expect(() => new NumberProperties(5, 10)).to.throw();
-        });
-    });
-});

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

@@ -1,38 +0,0 @@
-import { Attributes, XmlComponent } from "@file/xml-components";
-
-export class NumberProperties extends XmlComponent {
-    public constructor(numberId: number | string, indentLevel: number) {
-        super("w:numPr");
-        this.root.push(new IndentLevel(indentLevel));
-        this.root.push(new NumberId(numberId));
-    }
-}
-
-class IndentLevel extends XmlComponent {
-    public constructor(level: number) {
-        super("w:ilvl");
-
-        if (level > 9) {
-            throw new Error(
-                "Level cannot be greater than 9. Read more here: https://answers.microsoft.com/en-us/msoffice/forum/all/does-word-support-more-than-9-list-levels/d130fdcd-1781-446d-8c84-c6c79124e4d7",
-            );
-        }
-
-        this.root.push(
-            new Attributes({
-                val: level,
-            }),
-        );
-    }
-}
-
-class NumberId extends XmlComponent {
-    public constructor(id: number | string) {
-        super("w:numId");
-        this.root.push(
-            new Attributes({
-                val: typeof id === "string" ? `{${id}}` : id,
-            }),
-        );
-    }
-}

package/src/file/paragraph/formatting/word-wrap.spec.ts

@@ -1,20 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-
-import { WordWrap } from "./word-wrap";
-
-describe("WordWrap", () => {
-    it("should create", () => {
-        const wordWrap = new WordWrap();
-        const tree = new Formatter().format(wordWrap);
-
-        expect(tree).to.deep.equal({
-            "w:wordWrap": {
-                _attr: {
-                    "w:val": 0,
-                },
-            },
-        });
-    });
-});

package/src/file/paragraph/formatting/word-wrap.ts

@@ -1,14 +0,0 @@
-// http://officeopenxml.com/WPalignment.php
-// http://officeopenxml.com/WPtableAlignment.php
-import { XmlAttributeComponent, XmlComponent } from "@file/xml-components";
-
-export class WordWrapAttributes extends XmlAttributeComponent<{ readonly val: 0 }> {
-    protected readonly xmlKeys = { val: "w:val" };
-}
-
-export class WordWrap extends XmlComponent {
-    public constructor() {
-        super("w:wordWrap");
-        this.root.push(new WordWrapAttributes({ val: 0 }));
-    }
-}

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

@@ -1,156 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-import { HorizontalPositionAlign, VerticalPositionAlign } from "@file/shared";
-
-import { FrameAnchorType, FrameProperties } from "./frame-properties";
-
-describe("FrameProperties", () => {
-    describe("#constructor()", () => {
-        it("should create", () => {
-            const currentFrameProperties = new FrameProperties({
-                position: {
-                    x: 1000,
-                    y: 3000,
-                },
-                width: 4000,
-                height: 1000,
-                anchor: {
-                    horizontal: FrameAnchorType.MARGIN,
-                    vertical: FrameAnchorType.MARGIN,
-                },
-                alignment: {
-                    x: HorizontalPositionAlign.CENTER,
-                    y: VerticalPositionAlign.TOP,
-                },
-            });
-
-            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:xAlign": "center",
-                        "w:y": 3000,
-                        "w:yAlign": "top",
-                    },
-                },
-            });
-        });
-
-        it("should create with the space attribute", () => {
-            const currentFrameProperties = new FrameProperties({
-                position: {
-                    x: 1000,
-                    y: 3000,
-                },
-                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:x": 1000,
-                        "w:xAlign": "center",
-                        "w:y": 3000,
-                        "w:yAlign": "top",
-                        "w:hSpace": 100,
-                        "w:vSpace": 200,
-                    },
-                },
-            });
-        });
-
-        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,
-                    },
-                },
-            });
-        });
-    });
-});