docx 7.8.2 → 8.0.1

package/src/file/styles/style/paragraph-style.ts

@@ -1,28 +0,0 @@
-import { IParagraphStylePropertiesOptions, IRunStylePropertiesOptions, ParagraphProperties } from "@file/paragraph";
-import { RunProperties } from "@file/paragraph/run/properties";
-import { IStyleOptions, Style } from "./style";
-
-export interface IBaseParagraphStyleOptions extends IStyleOptions {
-    readonly paragraph?: IParagraphStylePropertiesOptions;
-    readonly run?: IRunStylePropertiesOptions;
-}
-
-export interface IParagraphStyleOptions extends IBaseParagraphStyleOptions {
-    readonly id: string;
-    readonly name?: string;
-}
-
-export class StyleForParagraph extends Style {
-    private readonly paragraphProperties: ParagraphProperties;
-    private readonly runProperties: RunProperties;
-
-    public constructor(options: IParagraphStyleOptions) {
-        super({ type: "paragraph", styleId: options.id }, options);
-
-        this.paragraphProperties = new ParagraphProperties(options.paragraph);
-        this.runProperties = new RunProperties(options.run);
-
-        this.root.push(this.paragraphProperties);
-        this.root.push(this.runProperties);
-    }
-}

package/src/file/styles/style/style.spec.ts

@@ -1,41 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-
-import { Style } from "./style";
-
-describe("Style", () => {
-    describe("#constructor()", () => {
-        it("should set the given properties", () => {
-            const style = new Style(
-                {
-                    type: "paragraph",
-                    styleId: "myStyleId",
-                    default: true,
-                },
-                {},
-            );
-            const tree = new Formatter().format(style);
-            expect(tree).to.deep.equal({
-                "w:style": { _attr: { "w:type": "paragraph", "w:styleId": "myStyleId", "w:default": true } },
-            });
-        });
-
-        it("should set the name of the style, if given", () => {
-            const style = new Style(
-                {
-                    type: "paragraph",
-                    styleId: "myStyleId",
-                },
-                { name: "Style Name" },
-            );
-            const tree = new Formatter().format(style);
-            expect(tree).to.deep.equal({
-                "w:style": [
-                    { _attr: { "w:type": "paragraph", "w:styleId": "myStyleId" } },
-                    { "w:name": { _attr: { "w:val": "Style Name" } } },
-                ],
-            });
-        });
-    });
-});

package/src/file/styles/style/style.ts

@@ -1,98 +0,0 @@
-import { OnOffElement, StringValueElement, XmlAttributeComponent, XmlComponent } from "@file/xml-components";
-import { Name, UiPriority } from "./components";
-
-// <xsd:complexType name="CT_Style">
-//     <xsd:sequence>
-//         <xsd:element name="name" type="CT_String" minOccurs="0" maxOccurs="1"/>
-//         <xsd:element name="aliases" type="CT_String" minOccurs="0"/>
-//         <xsd:element name="basedOn" type="CT_String" minOccurs="0"/>
-//         <xsd:element name="next" type="CT_String" minOccurs="0"/>
-//         <xsd:element name="link" type="CT_String" minOccurs="0"/>
-//         <xsd:element name="autoRedefine" type="CT_OnOff" minOccurs="0"/>
-//         <xsd:element name="hidden" type="CT_OnOff" minOccurs="0"/>
-//         <xsd:element name="uiPriority" type="CT_DecimalNumber" minOccurs="0"/>
-//         <xsd:element name="semiHidden" type="CT_OnOff" minOccurs="0"/>
-//         <xsd:element name="unhideWhenUsed" type="CT_OnOff" minOccurs="0"/>
-//         <xsd:element name="qFormat" type="CT_OnOff" minOccurs="0"/>
-//         <xsd:element name="locked" type="CT_OnOff" minOccurs="0"/>
-//         <xsd:element name="personal" type="CT_OnOff" minOccurs="0"/>
-//         <xsd:element name="personalCompose" type="CT_OnOff" minOccurs="0"/>
-//         <xsd:element name="personalReply" type="CT_OnOff" minOccurs="0"/>
-//         <xsd:element name="rsid" type="CT_LongHexNumber" minOccurs="0"/>
-//         <xsd:element name="pPr" type="CT_PPrGeneral" minOccurs="0" maxOccurs="1"/>
-//         <xsd:element name="rPr" type="CT_RPr" minOccurs="0" maxOccurs="1"/>
-//         <xsd:element name="tblPr" type="CT_TblPrBase" minOccurs="0" maxOccurs="1"/>
-//         <xsd:element name="trPr" type="CT_TrPr" minOccurs="0" maxOccurs="1"/>
-//         <xsd:element name="tcPr" type="CT_TcPr" minOccurs="0" maxOccurs="1"/>
-//         <xsd:element name="tblStylePr" type="CT_TblStylePr" minOccurs="0" maxOccurs="unbounded"/>
-//     </xsd:sequence>
-//     <xsd:attribute name="type" type="ST_StyleType" use="optional"/>
-//     <xsd:attribute name="styleId" type="s:ST_String" use="optional"/>
-//     <xsd:attribute name="default" type="s:ST_OnOff" use="optional"/>
-//     <xsd:attribute name="customStyle" type="s:ST_OnOff" use="optional"/>
-// </xsd:complexType>
-
-export interface IStyleAttributes {
-    readonly type?: string;
-    readonly styleId?: string;
-    readonly default?: boolean;
-    readonly customStyle?: string;
-}
-
-export interface IStyleOptions {
-    readonly name?: string;
-    readonly basedOn?: string;
-    readonly next?: string;
-    readonly link?: string;
-    readonly uiPriority?: number;
-    readonly semiHidden?: boolean;
-    readonly unhideWhenUsed?: boolean;
-    readonly quickFormat?: boolean;
-}
-
-class StyleAttributes extends XmlAttributeComponent<IStyleAttributes> {
-    protected readonly xmlKeys = {
-        type: "w:type",
-        styleId: "w:styleId",
-        default: "w:default",
-        customStyle: "w:customStyle",
-    };
-}
-
-export class Style extends XmlComponent {
-    public constructor(attributes: IStyleAttributes, options: IStyleOptions) {
-        super("w:style");
-        this.root.push(new StyleAttributes(attributes));
-        if (options.name) {
-            this.root.push(new Name(options.name));
-        }
-
-        if (options.basedOn) {
-            this.root.push(new StringValueElement("w:basedOn", options.basedOn));
-        }
-
-        if (options.next) {
-            this.root.push(new StringValueElement("w:next", options.next));
-        }
-
-        if (options.link) {
-            this.root.push(new StringValueElement("w:link", options.link));
-        }
-
-        if (options.uiPriority !== undefined) {
-            this.root.push(new UiPriority(options.uiPriority));
-        }
-
-        if (options.semiHidden !== undefined) {
-            this.root.push(new OnOffElement("w:semiHidden", options.semiHidden));
-        }
-
-        if (options.unhideWhenUsed !== undefined) {
-            this.root.push(new OnOffElement("w:unhideWhenUsed", options.unhideWhenUsed));
-        }
-
-        if (options.quickFormat !== undefined) {
-            this.root.push(new OnOffElement("w:qFormat", options.quickFormat));
-        }
-    }
-}

package/src/file/styles/styles.spec.ts

@@ -1,106 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-import { EMPTY_OBJECT } from "@file/xml-components";
-
-import { Styles } from "./styles";
-
-describe("Styles", () => {
-    describe("#createParagraphStyle", () => {
-        it("should create a new paragraph style and push it onto this collection", () => {
-            const styles = new Styles({
-                paragraphStyles: [
-                    {
-                        id: "pStyleId",
-                    },
-                ],
-            });
-            const tree = new Formatter().format(styles)["w:styles"].filter((x) => !x._attr);
-            expect(tree).to.deep.equal([
-                {
-                    "w:style": { _attr: { "w:type": "paragraph", "w:styleId": "pStyleId" } },
-                },
-            ]);
-        });
-
-        it("should set the paragraph name if given", () => {
-            const styles = new Styles({
-                paragraphStyles: [
-                    {
-                        id: "pStyleId",
-                        name: "Paragraph Style",
-                    },
-                ],
-            });
-            const tree = new Formatter().format(styles)["w:styles"].filter((x) => !x._attr);
-            expect(tree).to.deep.equal([
-                {
-                    "w:style": [
-                        { _attr: { "w:type": "paragraph", "w:styleId": "pStyleId" } },
-                        { "w:name": { _attr: { "w:val": "Paragraph Style" } } },
-                    ],
-                },
-            ]);
-        });
-    });
-
-    describe("#createCharacterStyle", () => {
-        it("should create a new character style and push it onto this collection", () => {
-            const styles = new Styles({
-                characterStyles: [
-                    {
-                        id: "pStyleId",
-                    },
-                ],
-            });
-            const tree = new Formatter().format(styles)["w:styles"].filter((x) => !x._attr);
-            expect(tree).to.deep.equal([
-                {
-                    "w:style": [
-                        { _attr: { "w:type": "character", "w:styleId": "pStyleId" } },
-                        {
-                            "w:uiPriority": {
-                                _attr: {
-                                    "w:val": 99,
-                                },
-                            },
-                        },
-                        {
-                            "w:unhideWhenUsed": EMPTY_OBJECT,
-                        },
-                    ],
-                },
-            ]);
-        });
-
-        it("should set the character name if given", () => {
-            const styles = new Styles({
-                characterStyles: [
-                    {
-                        id: "pStyleId",
-                        name: "Character Style",
-                    },
-                ],
-            });
-            const tree = new Formatter().format(styles)["w:styles"].filter((x) => !x._attr);
-            expect(tree).to.deep.equal([
-                {
-                    "w:style": [
-                        { _attr: { "w:type": "character", "w:styleId": "pStyleId" } },
-                        { "w:name": { _attr: { "w:val": "Character Style" } } },
-                        {
-                            "w:uiPriority": {
-                                _attr: {
-                                    "w:val": 99,
-                                },
-                            },
-                        },
-                        {
-                            "w:unhideWhenUsed": EMPTY_OBJECT,
-                        },
-                    ],
-                },
-            ]);
-        });
-    });
-});

package/src/file/styles/styles.ts

@@ -1,48 +0,0 @@
-import { IDefaultStylesOptions } from "@file/styles/factory";
-import { BaseXmlComponent, ImportedXmlComponent, XmlComponent } from "@file/xml-components";
-import { StyleForCharacter, StyleForParagraph } from "./style";
-import { ICharacterStyleOptions } from "./style/character-style";
-import { IParagraphStyleOptions } from "./style/paragraph-style";
-
-export interface IStylesOptions {
-    readonly default?: IDefaultStylesOptions;
-    readonly initialStyles?: BaseXmlComponent;
-    readonly paragraphStyles?: readonly IParagraphStyleOptions[];
-    readonly characterStyles?: readonly ICharacterStyleOptions[];
-    readonly importedStyles?: readonly (XmlComponent | StyleForParagraph | StyleForCharacter | ImportedXmlComponent)[];
-}
-
-// <xsd:complexType name="CT_Styles">
-// <xsd:sequence>
-//   <xsd:element name="docDefaults" type="CT_DocDefaults" minOccurs="0"/>
-//   <xsd:element name="latentStyles" type="CT_LatentStyles" minOccurs="0" maxOccurs="1"/>
-//   <xsd:element name="style" type="CT_Style" minOccurs="0" maxOccurs="unbounded"/>
-// </xsd:sequence>
-// </xsd:complexType>
-export class Styles extends XmlComponent {
-    public constructor(options: IStylesOptions) {
-        super("w:styles");
-
-        if (options.initialStyles) {
-            this.root.push(options.initialStyles);
-        }
-
-        if (options.importedStyles) {
-            for (const style of options.importedStyles) {
-                this.root.push(style);
-            }
-        }
-
-        if (options.paragraphStyles) {
-            for (const style of options.paragraphStyles) {
-                this.root.push(new StyleForParagraph(style));
-            }
-        }
-
-        if (options.characterStyles) {
-            for (const style of options.characterStyles) {
-                this.root.push(new StyleForCharacter(style));
-            }
-        }
-    }
-}

package/src/file/table/grid.spec.ts

@@ -1,40 +0,0 @@
-import { expect } from "chai";
-
-import { EMPTY_OBJECT } from "@file/xml-components";
-import { Formatter } from "@export/formatter";
-
-import { GridCol, TableGrid } from "./grid";
-
-describe("GridCol", () => {
-    describe("#constructor", () => {
-        it("sets the width attribute to the value given", () => {
-            const grid = new GridCol(1234);
-            const tree = new Formatter().format(grid);
-            expect(tree).to.deep.equal({
-                "w:gridCol": { _attr: { "w:w": 1234 } },
-            });
-        });
-
-        it("does not set a width attribute if not given", () => {
-            const grid = new GridCol();
-            const tree = new Formatter().format(grid);
-            expect(tree).to.deep.equal({ "w:gridCol": EMPTY_OBJECT });
-        });
-    });
-});
-
-describe("TableGrid", () => {
-    describe("#constructor", () => {
-        it("creates a column for each width given", () => {
-            const grid = new TableGrid([1234, 321, 123]);
-            const tree = new Formatter().format(grid);
-            expect(tree).to.deep.equal({
-                "w:tblGrid": [
-                    { "w:gridCol": { _attr: { "w:w": 1234 } } },
-                    { "w:gridCol": { _attr: { "w:w": 321 } } },
-                    { "w:gridCol": { _attr: { "w:w": 123 } } },
-                ],
-            });
-        });
-    });
-});

package/src/file/table/grid.ts

@@ -1,35 +0,0 @@
-// http://officeopenxml.com/WPtableGrid.php
-
-// <xsd:complexType name="CT_TblGridCol">
-//     <xsd:attribute name="w" type="s:ST_TwipsMeasure"/>
-// </xsd:complexType>
-// <xsd:complexType name="CT_TblGridBase">
-//     <xsd:sequence>
-//         <xsd:element name="gridCol" type="CT_TblGridCol" minOccurs="0" maxOccurs="unbounded"/>
-//     </xsd:sequence>
-// </xsd:complexType>
-
-import { XmlAttributeComponent, XmlComponent } from "@file/xml-components";
-import { twipsMeasureValue } from "@util/values";
-
-export class TableGrid extends XmlComponent {
-    public constructor(widths: readonly number[] | readonly string[]) {
-        super("w:tblGrid");
-        for (const width of widths) {
-            this.root.push(new GridCol(width));
-        }
-    }
-}
-
-class GridColAttributes extends XmlAttributeComponent<{ readonly w: number | string }> {
-    protected readonly xmlKeys = { w: "w:w" };
-}
-
-export class GridCol extends XmlComponent {
-    public constructor(width?: number | string) {
-        super("w:gridCol");
-        if (width !== undefined) {
-            this.root.push(new GridColAttributes({ w: twipsMeasureValue(width) }));
-        }
-    }
-}

package/src/file/table/index.ts

@@ -1,5 +0,0 @@
-export * from "./table";
-export * from "./table-cell";
-export * from "./table-properties";
-export * from "./table-row";
-export * from "./table-width";

package/src/file/table/table-cell/index.ts

@@ -1,2 +0,0 @@
-export * from "./table-cell";
-export * from "./table-cell-components";

package/src/file/table/table-cell/table-cell-components.ts

@@ -1,136 +0,0 @@
-import { BorderElement, IBorderOptions } from "@file/border";
-import { IgnoreIfEmptyXmlComponent, XmlAttributeComponent, XmlComponent } from "@file/xml-components";
-import { decimalNumber } from "@util/values";
-
-// <xsd:complexType name="CT_TcBorders">
-// <xsd:sequence>
-//   <xsd:element name="top" type="CT_Border" minOccurs="0"/>
-//   <xsd:element name="start" type="CT_Border" minOccurs="0"/>
-//   <xsd:element name="left" type="CT_Border" minOccurs="0"/>
-//   <xsd:element name="bottom" type="CT_Border" minOccurs="0"/>
-//   <xsd:element name="end" type="CT_Border" minOccurs="0"/>
-//   <xsd:element name="right" type="CT_Border" minOccurs="0"/>
-//   <xsd:element name="insideH" type="CT_Border" minOccurs="0"/>
-//   <xsd:element name="insideV" type="CT_Border" minOccurs="0"/>
-//   <xsd:element name="tl2br" type="CT_Border" minOccurs="0"/>
-//   <xsd:element name="tr2bl" type="CT_Border" minOccurs="0"/>
-// </xsd:sequence>
-// </xsd:complexType>
-
-export interface ITableCellBorders {
-    readonly top?: IBorderOptions;
-    readonly start?: IBorderOptions;
-    readonly left?: IBorderOptions;
-    readonly bottom?: IBorderOptions;
-    readonly end?: IBorderOptions;
-    readonly right?: IBorderOptions;
-}
-
-export class TableCellBorders extends IgnoreIfEmptyXmlComponent {
-    public constructor(options: ITableCellBorders) {
-        super("w:tcBorders");
-
-        if (options.top) {
-            this.root.push(new BorderElement("w:top", options.top));
-        }
-        if (options.start) {
-            this.root.push(new BorderElement("w:start", options.start));
-        }
-        if (options.left) {
-            this.root.push(new BorderElement("w:left", options.left));
-        }
-        if (options.bottom) {
-            this.root.push(new BorderElement("w:bottom", options.bottom));
-        }
-        if (options.end) {
-            this.root.push(new BorderElement("w:end", options.end));
-        }
-        if (options.right) {
-            this.root.push(new BorderElement("w:right", options.right));
-        }
-    }
-}
-
-/**
- * Attributes fot the GridSpan element.
- */
-class GridSpanAttributes extends XmlAttributeComponent<{ readonly val: number }> {
-    protected readonly xmlKeys = { val: "w:val" };
-}
-
-// <xsd:complexType name="CT_TcPrBase">
-//   ...
-//   <xsd:element name="gridSpan" type="CT_DecimalNumber" minOccurs="0"/>
-// </xsd>
-/**
- * GridSpan element. Should be used in a table cell. Pass the number of columns that this cell need to span.
- */
-export class GridSpan extends XmlComponent {
-    public constructor(value: number) {
-        super("w:gridSpan");
-
-        this.root.push(
-            new GridSpanAttributes({
-                val: decimalNumber(value),
-            }),
-        );
-    }
-}
-
-/**
- * Vertical merge types.
- */
-export enum VerticalMergeType {
-    /**
-     * Cell that is merged with upper one.
-     */
-    CONTINUE = "continue",
-    /**
-     * Cell that is starting the vertical merge.
-     */
-    RESTART = "restart",
-}
-
-class VerticalMergeAttributes extends XmlAttributeComponent<{ readonly val: VerticalMergeType }> {
-    protected readonly xmlKeys = { val: "w:val" };
-}
-
-/**
- * Vertical merge element. Should be used in a table cell.
- */
-export class VerticalMerge extends XmlComponent {
-    public constructor(value: VerticalMergeType) {
-        super("w:vMerge");
-
-        this.root.push(
-            new VerticalMergeAttributes({
-                val: value,
-            }),
-        );
-    }
-}
-
-export enum TextDirection {
-    BOTTOM_TO_TOP_LEFT_TO_RIGHT = "btLr",
-    LEFT_TO_RIGHT_TOP_TO_BOTTOM = "lrTb",
-    TOP_TO_BOTTOM_RIGHT_TO_LEFT = "tbRl",
-}
-
-class TDirectionAttributes extends XmlAttributeComponent<{ readonly val: TextDirection }> {
-    protected readonly xmlKeys = { val: "w:val" };
-}
-
-/**
- * Text Direction within a table cell
- */
-export class TDirection extends XmlComponent {
-    public constructor(value: TextDirection) {
-        super("w:textDirection");
-
-        this.root.push(
-            new TDirectionAttributes({
-                val: value,
-            }),
-        );
-    }
-}

package/src/file/table/table-cell/table-cell-properties.spec.ts

@@ -1,114 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-import { BorderStyle } from "@file/border";
-import { VerticalAlign } from "@file/vertical-align";
-
-import { WidthType } from "../table-width";
-
-import { VerticalMergeType } from "./table-cell-components";
-import { TableCellProperties } from "./table-cell-properties";
-
-describe("TableCellProperties", () => {
-    describe("#constructor", () => {
-        it("creates an initially empty property object", () => {
-            const properties = new TableCellProperties({});
-            // The TableCellProperties is ignorable if there are no attributes,
-            // which results in prepForXml returning undefined, which causes
-            // the formatter to throw an error if that is the only object it
-            // has been asked to format.
-            expect(() => new Formatter().format(properties)).to.throw("XMLComponent did not format correctly");
-        });
-
-        it("adds grid span", () => {
-            const properties = new TableCellProperties({ columnSpan: 1 });
-            const tree = new Formatter().format(properties);
-            expect(tree).to.deep.equal({ "w:tcPr": [{ "w:gridSpan": { _attr: { "w:val": 1 } } }] });
-        });
-
-        it("adds vertical merge", () => {
-            const properties = new TableCellProperties({ verticalMerge: VerticalMergeType.CONTINUE });
-            const tree = new Formatter().format(properties);
-            expect(tree).to.deep.equal({ "w:tcPr": [{ "w:vMerge": { _attr: { "w:val": "continue" } } }] });
-        });
-
-        it("sets vertical align", () => {
-            const properties = new TableCellProperties({ verticalAlign: VerticalAlign.BOTTOM });
-            const tree = new Formatter().format(properties);
-            expect(tree).to.deep.equal({ "w:tcPr": [{ "w:vAlign": { _attr: { "w:val": "bottom" } } }] });
-        });
-
-        it("should set width", () => {
-            const properties = new TableCellProperties({
-                width: {
-                    size: 1,
-                    type: WidthType.DXA,
-                },
-            });
-            const tree = new Formatter().format(properties);
-            expect(tree).to.deep.equal({ "w:tcPr": [{ "w:tcW": { _attr: { "w:type": "dxa", "w:w": 1 } } }] });
-        });
-
-        it("should set width using default of AUTO", () => {
-            const properties = new TableCellProperties({
-                width: {
-                    size: 1,
-                },
-            });
-            const tree = new Formatter().format(properties);
-            expect(tree).to.deep.equal({ "w:tcPr": [{ "w:tcW": { _attr: { "w:type": "auto", "w:w": 1 } } }] });
-        });
-
-        it("sets shading", () => {
-            const properties = new TableCellProperties({
-                shading: {
-                    fill: "ffffff",
-                    color: "000000",
-                },
-            });
-            const tree = new Formatter().format(properties);
-            expect(tree).to.deep.equal({ "w:tcPr": [{ "w:shd": { _attr: { "w:fill": "ffffff", "w:color": "000000" } } }] });
-        });
-
-        it("should set the TableCellBorders", () => {
-            const properties = new TableCellProperties({
-                borders: {
-                    top: {
-                        style: BorderStyle.DASH_DOT_STROKED,
-                        color: "ff0000",
-                        size: 3,
-                    },
-                },
-            });
-
-            const tree = new Formatter().format(properties);
-
-            expect(tree["w:tcPr"][0]).to.deep.equal({
-                "w:tcBorders": [{ "w:top": { _attr: { "w:val": "dashDotStroked", "w:sz": 3, "w:color": "ff0000" } } }],
-            });
-        });
-
-        it("should set the margins", () => {
-            const properties = new TableCellProperties({
-                margins: {
-                    marginUnitType: WidthType.DXA,
-                    top: 5,
-                    left: 10,
-                    bottom: 15,
-                    right: 20,
-                },
-            });
-
-            const tree = new Formatter().format(properties);
-
-            expect(tree["w:tcPr"][0]).to.deep.equal({
-                "w:tcMar": [
-                    { "w:top": { _attr: { "w:type": "dxa", "w:w": 5 } } },
-                    { "w:left": { _attr: { "w:type": "dxa", "w:w": 10 } } },
-                    { "w:bottom": { _attr: { "w:type": "dxa", "w:w": 15 } } },
-                    { "w:right": { _attr: { "w:type": "dxa", "w:w": 20 } } },
-                ],
-            });
-        });
-    });
-});