docx 8.0.0 → 8.0.1

package/src/file/core-properties/properties.ts

@@ -1,116 +0,0 @@
-import { ICommentsOptions } from "@file/paragraph/run/comment-run";
-import { ICompatibilityOptions } from "@file/settings/compatibility";
-import { StringContainer, XmlComponent } from "@file/xml-components";
-import { dateTimeValue } from "@util/values";
-
-import { ICustomPropertyOptions } from "../custom-properties";
-import { IDocumentBackgroundOptions } from "../document";
-
-import { DocumentAttributes } from "../document/document-attributes";
-import { ISectionOptions } from "../file";
-import { INumberingOptions } from "../numbering";
-import { Paragraph } from "../paragraph";
-import { IStylesOptions } from "../styles";
-
-export interface IPropertiesOptions {
-    readonly sections: readonly ISectionOptions[];
-    readonly title?: string;
-    readonly subject?: string;
-    readonly creator?: string;
-    readonly keywords?: string;
-    readonly description?: string;
-    readonly lastModifiedBy?: string;
-    readonly revision?: number;
-    readonly externalStyles?: string;
-    readonly styles?: IStylesOptions;
-    readonly numbering?: INumberingOptions;
-    readonly comments?: ICommentsOptions;
-    readonly footnotes?: {
-        readonly [key: string]: {
-            readonly children: readonly Paragraph[];
-        };
-    };
-    readonly background?: IDocumentBackgroundOptions;
-    readonly features?: {
-        readonly trackRevisions?: boolean;
-        readonly updateFields?: boolean;
-    };
-    readonly compatabilityModeVersion?: number;
-    readonly compatibility?: ICompatibilityOptions;
-    readonly customProperties?: readonly ICustomPropertyOptions[];
-    readonly evenAndOddHeaderAndFooters?: boolean;
-}
-
-// <xs:element name="coreProperties" type="CT_CoreProperties"/>
-
-/* cSpell:disable */
-// <xs:complexType name="CT_CoreProperties">
-//   <xs:all>
-//     <xs:element name="category" minOccurs="0" maxOccurs="1" type="xs:string"/>
-//     <xs:element name="contentStatus" minOccurs="0" maxOccurs="1" type="xs:string"/>
-//     <xs:element ref="dcterms:created" minOccurs="0" maxOccurs="1"/>
-//     <xs:element ref="dc:creator" minOccurs="0" maxOccurs="1"/>
-//     <xs:element ref="dc:description" minOccurs="0" maxOccurs="1"/>
-//     <xs:element ref="dc:identifier" minOccurs="0" maxOccurs="1"/>
-//     <xs:element name="keywords" minOccurs="0" maxOccurs="1" type="CT_Keywords"/>
-//     <xs:element ref="dc:language" minOccurs="0" maxOccurs="1"/>
-//     <xs:element name="lastModifiedBy" minOccurs="0" maxOccurs="1" type="xs:string"/>
-//     <xs:element name="lastPrinted" minOccurs="0" maxOccurs="1" type="xs:dateTime"/>
-//     <xs:element ref="dcterms:modified" minOccurs="0" maxOccurs="1"/>
-//     <xs:element name="revision" minOccurs="0" maxOccurs="1" type="xs:string"/>
-//     <xs:element ref="dc:subject" minOccurs="0" maxOccurs="1"/>
-//     <xs:element ref="dc:title" minOccurs="0" maxOccurs="1"/>
-//     <xs:element name="version" minOccurs="0" maxOccurs="1" type="xs:string"/>
-//   </xs:all>
-// </xs:complexType>
-/* cSpell:enable */
-
-export class CoreProperties extends XmlComponent {
-    public constructor(options: Omit<IPropertiesOptions, "sections">) {
-        super("cp:coreProperties");
-        this.root.push(
-            new DocumentAttributes({
-                cp: "http://schemas.openxmlformats.org/package/2006/metadata/core-properties",
-                dc: "http://purl.org/dc/elements/1.1/",
-                dcterms: "http://purl.org/dc/terms/",
-                dcmitype: "http://purl.org/dc/dcmitype/",
-                xsi: "http://www.w3.org/2001/XMLSchema-instance",
-            }),
-        );
-        if (options.title) {
-            this.root.push(new StringContainer("dc:title", options.title));
-        }
-        if (options.subject) {
-            this.root.push(new StringContainer("dc:subject", options.subject));
-        }
-        if (options.creator) {
-            this.root.push(new StringContainer("dc:creator", options.creator));
-        }
-        if (options.keywords) {
-            this.root.push(new StringContainer("cp:keywords", options.keywords));
-        }
-        if (options.description) {
-            this.root.push(new StringContainer("dc:description", options.description));
-        }
-        if (options.lastModifiedBy) {
-            this.root.push(new StringContainer("cp:lastModifiedBy", options.lastModifiedBy));
-        }
-        if (options.revision) {
-            this.root.push(new StringContainer("cp:revision", String(options.revision)));
-        }
-        this.root.push(new TimestampElement("dcterms:created"));
-        this.root.push(new TimestampElement("dcterms:modified"));
-    }
-}
-
-class TimestampElement extends XmlComponent {
-    public constructor(name: string) {
-        super(name);
-        this.root.push(
-            new DocumentAttributes({
-                type: "dcterms:W3CDTF",
-            }),
-        );
-        this.root.push(dateTimeValue(new Date()));
-    }
-}

package/src/file/custom-properties/custom-properties-attributes.ts

@@ -1,11 +0,0 @@
-import { XmlAttributeComponent } from "@file/xml-components";
-
-export class CustomPropertiesAttributes extends XmlAttributeComponent<{
-    readonly xmlns: string;
-    readonly vt: string;
-}> {
-    protected readonly xmlKeys = {
-        xmlns: "xmlns",
-        vt: "xmlns:vt",
-    };
-}

package/src/file/custom-properties/custom-properties.spec.ts

@@ -1,68 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-
-import { CustomProperties } from "./custom-properties";
-
-describe("CustomProperties", () => {
-    describe("#constructor()", () => {
-        it("sets the appropriate attributes on the top-level", () => {
-            const properties = new CustomProperties([]);
-            const tree = new Formatter().format(properties);
-            expect(tree).to.deep.equal({
-                Properties: {
-                    _attr: {
-                        xmlns: "http://schemas.openxmlformats.org/officeDocument/2006/custom-properties",
-                        "xmlns:vt": "http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes",
-                    },
-                },
-            });
-        });
-
-        it("should create custom properties with all the attributes given", () => {
-            const properties = new CustomProperties([
-                { name: "Address", value: "123" },
-                { name: "Author", value: "456" },
-            ]);
-            const tree = new Formatter().format(properties);
-            expect(tree).to.deep.equal({
-                Properties: [
-                    {
-                        _attr: {
-                            xmlns: "http://schemas.openxmlformats.org/officeDocument/2006/custom-properties",
-                            "xmlns:vt": "http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes",
-                        },
-                    },
-                    {
-                        property: [
-                            {
-                                _attr: {
-                                    fmtid: "{D5CDD505-2E9C-101B-9397-08002B2CF9AE}",
-                                    pid: "2",
-                                    name: "Address",
-                                },
-                            },
-                            {
-                                "vt:lpwstr": ["123"],
-                            },
-                        ],
-                    },
-                    {
-                        property: [
-                            {
-                                _attr: {
-                                    fmtid: "{D5CDD505-2E9C-101B-9397-08002B2CF9AE}",
-                                    pid: "3",
-                                    name: "Author",
-                                },
-                            },
-                            {
-                                "vt:lpwstr": ["456"],
-                            },
-                        ],
-                    },
-                ],
-            });
-        });
-    });
-});

package/src/file/custom-properties/custom-properties.ts

@@ -1,39 +0,0 @@
-import { IContext, IXmlableObject, XmlComponent } from "@file/xml-components";
-import { CustomPropertiesAttributes } from "./custom-properties-attributes";
-import { CustomProperty, ICustomPropertyOptions } from "./custom-property";
-
-export class CustomProperties extends XmlComponent {
-    // eslint-disable-next-line functional/prefer-readonly-type
-    private nextId: number;
-    // eslint-disable-next-line functional/prefer-readonly-type
-    private readonly properties: CustomProperty[] = [];
-
-    public constructor(properties: readonly ICustomPropertyOptions[]) {
-        super("Properties");
-
-        this.root.push(
-            new CustomPropertiesAttributes({
-                xmlns: "http://schemas.openxmlformats.org/officeDocument/2006/custom-properties",
-                vt: "http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes",
-            }),
-        );
-
-        // I'm not sure why, but every example I have seen starts with 2
-        // https://docs.microsoft.com/en-us/office/open-xml/how-to-set-a-custom-property-in-a-word-processing-document
-        this.nextId = 2;
-
-        for (const property of properties) {
-            this.addCustomProperty(property);
-        }
-    }
-
-    public prepForXml(context: IContext): IXmlableObject | undefined {
-        this.properties.forEach((x) => this.root.push(x));
-        return super.prepForXml(context);
-    }
-
-    public addCustomProperty(property: ICustomPropertyOptions): void {
-        // eslint-disable-next-line functional/immutable-data
-        this.properties.push(new CustomProperty(this.nextId++, property));
-    }
-}

package/src/file/custom-properties/custom-property-attributes.ts

@@ -1,13 +0,0 @@
-import { XmlAttributeComponent } from "@file/xml-components";
-
-export class CustomPropertyAttributes extends XmlAttributeComponent<{
-    readonly fmtid: string;
-    readonly pid: string;
-    readonly name: string;
-}> {
-    protected readonly xmlKeys = {
-        fmtid: "fmtid",
-        pid: "pid",
-        name: "name",
-    };
-}

package/src/file/custom-properties/custom-property.ts

@@ -1,28 +0,0 @@
-import { XmlComponent } from "@file/xml-components";
-import { CustomPropertyAttributes } from "./custom-property-attributes";
-
-export interface ICustomPropertyOptions {
-    readonly name: string;
-    readonly value: string;
-}
-
-export class CustomProperty extends XmlComponent {
-    public constructor(id: number, properties: ICustomPropertyOptions) {
-        super("property");
-        this.root.push(
-            new CustomPropertyAttributes({
-                fmtid: "{D5CDD505-2E9C-101B-9397-08002B2CF9AE}",
-                pid: id.toString(),
-                name: properties.name,
-            }),
-        );
-        this.root.push(new CustomPropertyValue(properties.value));
-    }
-}
-
-export class CustomPropertyValue extends XmlComponent {
-    public constructor(value: string) {
-        super("vt:lpwstr");
-        this.root.push(value);
-    }
-}

package/src/file/custom-properties/index.ts

@@ -1,2 +0,0 @@
-export * from "./custom-properties";
-export * from "./custom-property";

package/src/file/document/body/body.spec.ts

@@ -1,59 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-
-import { Body } from "./body";
-import { sectionMarginDefaults } from "./section-properties";
-
-describe("Body", () => {
-    let body: Body;
-
-    beforeEach(() => {
-        body = new Body();
-    });
-
-    describe("#addSection", () => {
-        it("should add section with default parameters", () => {
-            body.addSection({
-                page: {
-                    size: {
-                        width: 10000,
-                        height: 10000,
-                    },
-                },
-            });
-
-            const tree = new Formatter().format(body);
-
-            expect(tree).to.deep.equal({
-                "w:body": [
-                    {
-                        "w:sectPr": [
-                            { "w:pgSz": { _attr: { "w:w": 10000, "w:h": 10000, "w:orient": "portrait" } } },
-                            {
-                                "w:pgMar": {
-                                    _attr: {
-                                        "w:top": sectionMarginDefaults.TOP,
-                                        "w:right": sectionMarginDefaults.RIGHT,
-                                        "w:bottom": sectionMarginDefaults.BOTTOM,
-                                        "w:left": sectionMarginDefaults.LEFT,
-                                        "w:header": sectionMarginDefaults.HEADER,
-                                        "w:footer": sectionMarginDefaults.FOOTER,
-                                        "w:gutter": sectionMarginDefaults.GUTTER,
-                                    },
-                                },
-                            },
-                            {
-                                "w:pgNumType": {
-                                    _attr: {},
-                                },
-                            },
-                            // { "w:cols": { _attr: { "w:space": 708, "w:sep": false, "w:num": 1 } } },
-                            { "w:docGrid": { _attr: { "w:linePitch": 360 } } },
-                        ],
-                    },
-                ],
-            });
-        });
-    });
-});

package/src/file/document/body/body.ts

@@ -1,50 +0,0 @@
-import { Paragraph, ParagraphProperties } from "@file/paragraph";
-import { IContext, IXmlableObject, XmlComponent } from "@file/xml-components";
-
-import { ISectionPropertiesOptions, SectionProperties } from "./section-properties/section-properties";
-
-export class Body extends XmlComponent {
-    // eslint-disable-next-line functional/prefer-readonly-type
-    private readonly sections: SectionProperties[] = [];
-
-    public constructor() {
-        super("w:body");
-    }
-
-    /**
-     * Adds new section properties.
-     * Note: Previous section is created in paragraph after the current element, and then new section will be added.
-     * The spec says:
-     *  - section element should be in the last paragraph of the section
-     *  - last section should be direct child of body
-     *
-     * @param options new section options
-     */
-    public addSection(options: ISectionPropertiesOptions): void {
-        const currentSection = this.sections.pop() as SectionProperties;
-        this.root.push(this.createSectionParagraph(currentSection));
-
-        this.sections.push(new SectionProperties(options));
-    }
-
-    public prepForXml(context: IContext): IXmlableObject | undefined {
-        if (this.sections.length === 1) {
-            this.root.splice(0, 1);
-            this.root.push(this.sections.pop() as SectionProperties);
-        }
-
-        return super.prepForXml(context);
-    }
-
-    public push(component: XmlComponent): void {
-        this.root.push(component);
-    }
-
-    private createSectionParagraph(section: SectionProperties): Paragraph {
-        const paragraph = new Paragraph({});
-        const properties = new ParagraphProperties({});
-        properties.push(section);
-        paragraph.addChildElement(properties);
-        return paragraph;
-    }
-}

package/src/file/document/body/index.ts

@@ -1,2 +0,0 @@
-export * from "./body";
-export * from "./section-properties";

package/src/file/document/body/section-properties/index.ts

@@ -1,2 +0,0 @@
-export * from "./section-properties";
-export * from "./properties";

package/src/file/document/body/section-properties/properties/column.ts

@@ -1,24 +0,0 @@
-import { NextAttributeComponent, XmlComponent } from "@file/xml-components";
-import { PositiveUniversalMeasure, twipsMeasureValue } from "@util/values";
-
-// <xsd:complexType name="CT_Column">
-//     <xsd:attribute name="w" type="s:ST_TwipsMeasure" use="optional" />
-//     <xsd:attribute name="space" type="s:ST_TwipsMeasure" use="optional" default="0" />
-// </xsd:complexType>
-
-type IColumnAttributes = {
-    readonly width: number | PositiveUniversalMeasure;
-    readonly space?: number | PositiveUniversalMeasure;
-};
-
-export class Column extends XmlComponent {
-    public constructor({ width, space }: IColumnAttributes) {
-        super("w:col");
-        this.root.push(
-            new NextAttributeComponent<IColumnAttributes>({
-                width: { key: "w:w", value: twipsMeasureValue(width) },
-                space: { key: "w:space", value: space === undefined ? undefined : twipsMeasureValue(space) },
-            }),
-        );
-    }
-}

package/src/file/document/body/section-properties/properties/columns.spec.ts

@@ -1,45 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-
-import { Column, Columns } from ".";
-
-describe("Columns", () => {
-    describe("#constructor()", () => {
-        it("should create columns of equal width if equalWidth is true", () => {
-            const columns = new Columns({ count: 3, space: 720 });
-            const tree = new Formatter().format(columns);
-
-            expect(tree["w:cols"]).to.deep.equal({ _attr: { "w:num": 3, "w:space": 720 } });
-        });
-
-        it("should create set space and count to undefined if they are undefined", () => {
-            const columns = new Columns({});
-            const tree = new Formatter().format(columns);
-
-            expect(tree["w:cols"]).to.deep.equal({ _attr: {} });
-        });
-
-        it("should ignore individual column attributes if equalWidth is true", () => {
-            const unequalColumns = [new Column({ width: 1000, space: 400 }), new Column({ width: 2000 })];
-            const columns = new Columns({ count: 3, space: 720, equalWidth: true, children: unequalColumns });
-            const tree = new Formatter().format(columns);
-
-            expect(tree).to.deep.equal({ "w:cols": { _attr: { "w:num": 3, "w:space": 720, "w:equalWidth": true } } });
-        });
-
-        it("should have column children if equalWidth is false and individual columns are provided", () => {
-            const unequalColumns = [new Column({ width: 1000, space: 400 }), new Column({ width: 2000 })];
-            const columns = new Columns({ count: 3, space: 720, equalWidth: false, children: unequalColumns });
-            const tree = new Formatter().format(columns);
-
-            expect(tree).to.deep.equal({
-                "w:cols": [
-                    { _attr: { "w:num": 3, "w:space": 720, "w:equalWidth": false } },
-                    { "w:col": { _attr: { "w:space": 400, "w:w": 1000 } } },
-                    { "w:col": { _attr: { "w:w": 2000 } } },
-                ],
-            });
-        });
-    });
-});

package/src/file/document/body/section-properties/properties/columns.ts

@@ -1,39 +0,0 @@
-import { NextAttributeComponent, XmlComponent } from "@file/xml-components";
-import { decimalNumber, PositiveUniversalMeasure, twipsMeasureValue } from "@util/values";
-
-import { Column } from "./column";
-
-// <xsd:complexType name="CT_Columns">
-//     <xsd:sequence minOccurs="0">
-//         <xsd:element name="col" type="CT_Column" maxOccurs="45"/>
-//     </xsd:sequence>
-//     <xsd:attribute name="equalWidth" type="s:ST_OnOff" use="optional"/>
-//     <xsd:attribute name="space" type="s:ST_TwipsMeasure" use="optional" default="720"/>
-//     <xsd:attribute name="num" type="ST_DecimalNumber" use="optional" default="1"/>
-//     <xsd:attribute name="sep" type="s:ST_OnOff" use="optional"/>
-// </xsd:complexType>
-export type IColumnsAttributes = {
-    readonly space?: number | PositiveUniversalMeasure;
-    readonly count?: number;
-    readonly separate?: boolean;
-    readonly equalWidth?: boolean;
-    readonly children?: readonly Column[];
-};
-
-export class Columns extends XmlComponent {
-    public constructor({ space, count, separate, equalWidth, children }: IColumnsAttributes) {
-        super("w:cols");
-        this.root.push(
-            new NextAttributeComponent<Omit<IColumnsAttributes, "children">>({
-                space: { key: "w:space", value: space === undefined ? undefined : twipsMeasureValue(space) },
-                count: { key: "w:num", value: count === undefined ? undefined : decimalNumber(count) },
-                separate: { key: "w:sep", value: separate },
-                equalWidth: { key: "w:equalWidth", value: equalWidth },
-            }),
-        );
-
-        if (!equalWidth && children) {
-            children.forEach((column) => this.addChildElement(column));
-        }
-    }
-}

package/src/file/document/body/section-properties/properties/doc-grid.spec.ts

@@ -1,30 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-
-import { DocumentGrid, DocumentGridType } from ".";
-
-describe("DocumentGrid", () => {
-    describe("#constructor()", () => {
-        it("should create documentGrid with specified linePitch", () => {
-            const docGrid = new DocumentGrid(360);
-            const tree = new Formatter().format(docGrid);
-
-            expect(tree["w:docGrid"]).to.deep.equal({ _attr: { "w:linePitch": 360 } });
-        });
-
-        it("should create documentGrid with specified linePitch and type", () => {
-            const docGrid = new DocumentGrid(360, undefined, DocumentGridType.LINES);
-            const tree = new Formatter().format(docGrid);
-
-            expect(tree["w:docGrid"]).to.deep.equal({ _attr: { "w:linePitch": 360, "w:type": "lines" } });
-        });
-
-        it("should create documentGrid with specified linePitch,charSpace and type", () => {
-            const docGrid = new DocumentGrid(346, -1541, DocumentGridType.LINES_AND_CHARS);
-            const tree = new Formatter().format(docGrid);
-
-            expect(tree["w:docGrid"]).to.deep.equal({ _attr: { "w:linePitch": 346, "w:charSpace": -1541, "w:type": "linesAndChars" } });
-        });
-    });
-});

package/src/file/document/body/section-properties/properties/doc-grid.ts

@@ -1,52 +0,0 @@
-import { XmlAttributeComponent, XmlComponent } from "@file/xml-components";
-import { decimalNumber } from "@util/values";
-
-// not implemented
-// <xsd:simpleType name="ST_DocGrid">
-// <xsd:restriction base="xsd:string">
-//   <xsd:enumeration value="default"/>
-//   <xsd:enumeration value="lines"/>
-//   <xsd:enumeration value="linesAndChars"/>
-//   <xsd:enumeration value="snapToChars"/>
-// </xsd:restriction>
-// </xsd:simpleType>
-
-// <xsd:complexType name="CT_DocGrid">
-//     <xsd:attribute name="type" type="ST_DocGrid"/>
-//     <xsd:attribute name="linePitch" type="ST_DecimalNumber"/>
-//     <xsd:attribute name="charSpace" type="ST_DecimalNumber"/>
-// </xsd:complexType>
-
-export enum DocumentGridType {
-    DEFAULT = "default",
-    LINES = "lines",
-    LINES_AND_CHARS = "linesAndChars",
-    SNAP_TO_CHARS = "snapToChars",
-}
-export interface IDocGridAttributesProperties {
-    readonly type?: DocumentGridType;
-    readonly linePitch?: number;
-    readonly charSpace?: number;
-}
-
-export class DocGridAttributes extends XmlAttributeComponent<IDocGridAttributesProperties> {
-    protected readonly xmlKeys = {
-        type: "w:type",
-        linePitch: "w:linePitch",
-        charSpace: "w:charSpace",
-    };
-}
-
-export class DocumentGrid extends XmlComponent {
-    public constructor(linePitch: number, charSpace?: number, type?: DocumentGridType) {
-        super("w:docGrid");
-
-        this.root.push(
-            new DocGridAttributes({
-                type: type,
-                linePitch: decimalNumber(linePitch),
-                charSpace: charSpace ? decimalNumber(charSpace) : undefined,
-            }),
-        );
-    }
-}

package/src/file/document/body/section-properties/properties/header-footer-reference.spec.ts

@@ -1,56 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-import { HeaderFooterReference, HeaderFooterReferenceType, HeaderFooterType } from "./header-footer-reference";
-
-describe("HeaderFooterReference", () => {
-    it("#constructor (footer)", () => {
-        const footer = new HeaderFooterReference(HeaderFooterType.FOOTER, {
-            type: HeaderFooterReferenceType.DEFAULT,
-            id: 1,
-        });
-
-        const tree = new Formatter().format(footer);
-        expect(tree).to.deep.equal({
-            "w:footerReference": {
-                _attr: {
-                    "r:id": "rId1",
-                    "w:type": "default",
-                },
-            },
-        });
-    });
-
-    it("#constructor (header)", () => {
-        const header = new HeaderFooterReference(HeaderFooterType.HEADER, {
-            type: HeaderFooterReferenceType.DEFAULT,
-            id: 1,
-        });
-
-        const tree = new Formatter().format(header);
-        expect(tree).to.deep.equal({
-            "w:headerReference": {
-                _attr: {
-                    "r:id": "rId1",
-                    "w:type": "default",
-                },
-            },
-        });
-    });
-
-    it("should create without a type", () => {
-        const footer = new HeaderFooterReference(HeaderFooterType.FOOTER, {
-            id: 1,
-        });
-
-        const tree = new Formatter().format(footer);
-        expect(tree).to.deep.equal({
-            "w:footerReference": {
-                _attr: {
-                    "r:id": "rId1",
-                    "w:type": "default",
-                },
-            },
-        });
-    });
-});