docx 8.0.0 → 8.0.1

package/src/file/track-revision/track-revision-components/deleted-text-run.spec.ts

@@ -1,367 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-import { FootnoteReferenceRun } from "@file/footnotes";
-import { PageNumber } from "@file/paragraph";
-
-import { DeletedTextRun } from "./deleted-text-run";
-
-describe("DeletedTextRun", () => {
-    describe("#constructor", () => {
-        it("should create a deleted text run", () => {
-            const deletedTextRun = new DeletedTextRun({ text: "some text", id: 0, date: "123", author: "Author" });
-            const tree = new Formatter().format(deletedTextRun);
-            expect(tree).to.deep.equal({
-                "w:del": [
-                    {
-                        _attr: {
-                            "w:author": "Author",
-                            "w:date": "123",
-                            "w:id": 0,
-                        },
-                    },
-                    {
-                        "w:r": [
-                            {
-                                "w:delText": [
-                                    {
-                                        _attr: {
-                                            "xml:space": "preserve",
-                                        },
-                                    },
-                                    "some text",
-                                ],
-                            },
-                        ],
-                    },
-                ],
-            });
-        });
-    });
-
-    describe("#constructor with formatting", () => {
-        it("should create a deleted text run", () => {
-            const deletedTextRun = new DeletedTextRun({ text: "some text", bold: true, id: 0, date: "123", author: "Author" });
-            const tree = new Formatter().format(deletedTextRun);
-            expect(tree).to.deep.equal({
-                "w:del": [
-                    {
-                        _attr: {
-                            "w:author": "Author",
-                            "w:date": "123",
-                            "w:id": 0,
-                        },
-                    },
-                    {
-                        "w:r": [
-                            {
-                                "w:rPr": [
-                                    {
-                                        "w:b": {},
-                                    },
-                                    {
-                                        "w:bCs": {},
-                                    },
-                                ],
-                            },
-                            {
-                                "w:delText": [
-                                    {
-                                        _attr: {
-                                            "xml:space": "preserve",
-                                        },
-                                    },
-                                    "some text",
-                                ],
-                            },
-                        ],
-                    },
-                ],
-            });
-        });
-    });
-
-    describe("#break()", () => {
-        it("should add a break", () => {
-            const deletedTextRun = new DeletedTextRun({
-                break: 1,
-                children: ["some text"],
-                id: 0,
-                date: "123",
-                author: "Author",
-            });
-            const tree = new Formatter().format(deletedTextRun);
-            expect(tree).to.deep.equal({
-                "w:del": [
-                    {
-                        _attr: {
-                            "w:author": "Author",
-                            "w:date": "123",
-                            "w:id": 0,
-                        },
-                    },
-                    {
-                        "w:r": [
-                            {
-                                "w:br": {},
-                            },
-                            {
-                                "w:delText": [
-                                    {
-                                        _attr: {
-                                            "xml:space": "preserve",
-                                        },
-                                    },
-                                    "some text",
-                                ],
-                            },
-                        ],
-                    },
-                ],
-            });
-        });
-    });
-
-    describe("page numbering", () => {
-        it("should be able to delete the total pages", () => {
-            const deletedTextRun = new DeletedTextRun({
-                children: [" to ", PageNumber.TOTAL_PAGES],
-                id: 0,
-                date: "123",
-                author: "Author",
-            });
-            const tree = new Formatter().format(deletedTextRun);
-            expect(tree).to.deep.equal({
-                "w:del": [
-                    {
-                        _attr: {
-                            "w:author": "Author",
-                            "w:date": "123",
-                            "w:id": 0,
-                        },
-                    },
-                    {
-                        "w:r": [
-                            {
-                                "w:delText": [
-                                    {
-                                        _attr: {
-                                            "xml:space": "preserve",
-                                        },
-                                    },
-                                    " to ",
-                                ],
-                            },
-                            {
-                                "w:fldChar": {
-                                    _attr: {
-                                        "w:fldCharType": "begin",
-                                    },
-                                },
-                            },
-                            {
-                                "w:delInstrText": [
-                                    {
-                                        _attr: {
-                                            "xml:space": "preserve",
-                                        },
-                                    },
-                                    "NUMPAGES",
-                                ],
-                            },
-                            {
-                                "w:fldChar": {
-                                    _attr: {
-                                        "w:fldCharType": "separate",
-                                    },
-                                },
-                            },
-                            {
-                                "w:fldChar": {
-                                    _attr: {
-                                        "w:fldCharType": "end",
-                                    },
-                                },
-                            },
-                        ],
-                    },
-                ],
-            });
-        });
-
-        it("should be able to delete the total pages in section", () => {
-            const deletedTextRun = new DeletedTextRun({
-                children: [" to ", PageNumber.TOTAL_PAGES_IN_SECTION],
-                id: 0,
-                date: "123",
-                author: "Author",
-            });
-            const tree = new Formatter().format(deletedTextRun);
-            expect(tree).to.deep.equal({
-                "w:del": [
-                    {
-                        _attr: {
-                            "w:author": "Author",
-                            "w:date": "123",
-                            "w:id": 0,
-                        },
-                    },
-                    {
-                        "w:r": [
-                            {
-                                "w:delText": [
-                                    {
-                                        _attr: {
-                                            "xml:space": "preserve",
-                                        },
-                                    },
-                                    " to ",
-                                ],
-                            },
-                            {
-                                "w:fldChar": {
-                                    _attr: {
-                                        "w:fldCharType": "begin",
-                                    },
-                                },
-                            },
-                            {
-                                "w:delInstrText": [
-                                    {
-                                        _attr: {
-                                            "xml:space": "preserve",
-                                        },
-                                    },
-                                    "SECTIONPAGES",
-                                ],
-                            },
-                            {
-                                "w:fldChar": {
-                                    _attr: {
-                                        "w:fldCharType": "separate",
-                                    },
-                                },
-                            },
-                            {
-                                "w:fldChar": {
-                                    _attr: {
-                                        "w:fldCharType": "end",
-                                    },
-                                },
-                            },
-                        ],
-                    },
-                ],
-            });
-        });
-
-        it("should be able to delete the current page", () => {
-            const deletedTextRun = new DeletedTextRun({
-                children: [" to ", PageNumber.CURRENT],
-                id: 0,
-                date: "123",
-                author: "Author",
-            });
-            const tree = new Formatter().format(deletedTextRun);
-            expect(tree).to.deep.equal({
-                "w:del": [
-                    {
-                        _attr: {
-                            "w:author": "Author",
-                            "w:date": "123",
-                            "w:id": 0,
-                        },
-                    },
-                    {
-                        "w:r": [
-                            {
-                                "w:delText": [
-                                    {
-                                        _attr: {
-                                            "xml:space": "preserve",
-                                        },
-                                    },
-                                    " to ",
-                                ],
-                            },
-                            {
-                                "w:fldChar": {
-                                    _attr: {
-                                        "w:fldCharType": "begin",
-                                    },
-                                },
-                            },
-                            {
-                                "w:delInstrText": [
-                                    {
-                                        _attr: {
-                                            "xml:space": "preserve",
-                                        },
-                                    },
-                                    "PAGE",
-                                ],
-                            },
-                            {
-                                "w:fldChar": {
-                                    _attr: {
-                                        "w:fldCharType": "separate",
-                                    },
-                                },
-                            },
-                            {
-                                "w:fldChar": {
-                                    _attr: {
-                                        "w:fldCharType": "end",
-                                    },
-                                },
-                            },
-                        ],
-                    },
-                ],
-            });
-        });
-    });
-
-    describe("footnote references", () => {
-        it("should add a valid footnote reference", () => {
-            const deletedTextRun = new DeletedTextRun({
-                children: ["some text", new FootnoteReferenceRun(1)],
-                id: 0,
-                date: "123",
-                author: "Author",
-            });
-            const tree = new Formatter().format(deletedTextRun);
-            expect(tree).to.deep.equal({
-                "w:del": [
-                    {
-                        _attr: {
-                            "w:author": "Author",
-                            "w:date": "123",
-                            "w:id": 0,
-                        },
-                    },
-                    {
-                        "w:r": [
-                            {
-                                "w:delText": [
-                                    {
-                                        _attr: {
-                                            "xml:space": "preserve",
-                                        },
-                                    },
-                                    "some text",
-                                ],
-                            },
-                            {
-                                "w:r": [
-                                    { "w:rPr": [{ "w:rStyle": { _attr: { "w:val": "FootnoteReference" } } }] },
-                                    { "w:footnoteReference": { _attr: { "w:id": 1 } } },
-                                ],
-                            },
-                        ],
-                    },
-                ],
-            });
-        });
-    });
-});

package/src/file/track-revision/track-revision-components/deleted-text-run.ts

@@ -1,76 +0,0 @@
-import { XmlComponent } from "@file/xml-components";
-
-import { IRunOptions, RunProperties } from "../../index";
-import { Break } from "../../paragraph/run/break";
-import { Begin, End, Separate } from "../../paragraph/run/field";
-import { PageNumber } from "../../paragraph/run/run";
-import { ChangeAttributes, IChangedAttributesProperties } from "../track-revision";
-import { DeletedNumberOfPages, DeletedNumberOfPagesSection, DeletedPage } from "./deleted-page-number";
-import { DeletedText } from "./deleted-text";
-
-interface IDeletedRunOptions extends IRunOptions, IChangedAttributesProperties {}
-
-export class DeletedTextRun extends XmlComponent {
-    protected readonly deletedTextRunWrapper: DeletedTextRunWrapper;
-
-    public constructor(options: IDeletedRunOptions) {
-        super("w:del");
-        this.root.push(
-            new ChangeAttributes({
-                id: options.id,
-                author: options.author,
-                date: options.date,
-            }),
-        );
-        this.deletedTextRunWrapper = new DeletedTextRunWrapper(options);
-        this.addChildElement(this.deletedTextRunWrapper);
-    }
-}
-
-class DeletedTextRunWrapper extends XmlComponent {
-    public constructor(options: IRunOptions) {
-        super("w:r");
-        this.root.push(new RunProperties(options));
-
-        if (options.children) {
-            for (const child of options.children) {
-                if (typeof child === "string") {
-                    switch (child) {
-                        case PageNumber.CURRENT:
-                            this.root.push(new Begin());
-                            this.root.push(new DeletedPage());
-                            this.root.push(new Separate());
-                            this.root.push(new End());
-                            break;
-                        case PageNumber.TOTAL_PAGES:
-                            this.root.push(new Begin());
-                            this.root.push(new DeletedNumberOfPages());
-                            this.root.push(new Separate());
-                            this.root.push(new End());
-                            break;
-                        case PageNumber.TOTAL_PAGES_IN_SECTION:
-                            this.root.push(new Begin());
-                            this.root.push(new DeletedNumberOfPagesSection());
-                            this.root.push(new Separate());
-                            this.root.push(new End());
-                            break;
-                        default:
-                            this.root.push(new DeletedText(child));
-                            break;
-                    }
-                    continue;
-                }
-
-                this.root.push(child);
-            }
-        } else if (options.text) {
-            this.root.push(new DeletedText(options.text));
-        }
-
-        if (options.break) {
-            for (let i = 0; i < options.break; i++) {
-                this.root.splice(1, 0, new Break());
-            }
-        }
-    }
-}

package/src/file/track-revision/track-revision-components/deleted-text.spec.ts

@@ -1,17 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-
-import { DeletedText } from "./deleted-text";
-
-describe("Deleted Text", () => {
-    describe("#constructor", () => {
-        it("adds the passed in text to the component", () => {
-            const t = new DeletedText(" this is\n text");
-            const f = new Formatter().format(t);
-            expect(f).to.deep.equal({
-                "w:delText": [{ _attr: { "xml:space": "preserve" } }, " this is\n text"],
-            });
-        });
-    });
-});

package/src/file/track-revision/track-revision-components/deleted-text.ts

@@ -1,12 +0,0 @@
-import { TextAttributes } from "@file/paragraph/run/text-attributes";
-import { SpaceType } from "@file/shared";
-import { XmlComponent } from "@file/xml-components";
-
-export class DeletedText extends XmlComponent {
-    public constructor(text: string) {
-        super("w:delText");
-        this.root.push(new TextAttributes({ space: SpaceType.PRESERVE }));
-
-        this.root.push(text);
-    }
-}

package/src/file/track-revision/track-revision-components/inserted-text-run.spec.ts

@@ -1,39 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-
-import { InsertedTextRun } from "./inserted-text-run";
-
-describe("InsertedTextRun", () => {
-    describe("#constructor", () => {
-        it("should create a inserted text run", () => {
-            const insertedTextRun = new InsertedTextRun({ text: "some text", id: 0, date: "123", author: "Author" });
-            const tree = new Formatter().format(insertedTextRun);
-            expect(tree).to.deep.equal({
-                "w:ins": [
-                    {
-                        _attr: {
-                            "w:author": "Author",
-                            "w:date": "123",
-                            "w:id": 0,
-                        },
-                    },
-                    {
-                        "w:r": [
-                            {
-                                "w:t": [
-                                    {
-                                        _attr: {
-                                            "xml:space": "preserve",
-                                        },
-                                    },
-                                    "some text",
-                                ],
-                            },
-                        ],
-                    },
-                ],
-            });
-        });
-    });
-});

package/src/file/track-revision/track-revision-components/inserted-text-run.ts

@@ -1,20 +0,0 @@
-import { XmlComponent } from "@file/xml-components";
-
-import { IRunOptions, TextRun } from "../../index";
-import { ChangeAttributes, IChangedAttributesProperties } from "../track-revision";
-
-interface IInsertedRunOptions extends IChangedAttributesProperties, IRunOptions {}
-
-export class InsertedTextRun extends XmlComponent {
-    public constructor(options: IInsertedRunOptions) {
-        super("w:ins");
-        this.root.push(
-            new ChangeAttributes({
-                id: options.id,
-                author: options.author,
-                date: options.date,
-            }),
-        );
-        this.addChildElement(new TextRun(options as IRunOptions));
-    }
-}

package/src/file/track-revision/track-revision.ts

@@ -1,15 +0,0 @@
-import { XmlAttributeComponent } from "@file/xml-components";
-
-export interface IChangedAttributesProperties {
-    readonly id: number;
-    readonly author: string;
-    readonly date: string;
-}
-
-export class ChangeAttributes extends XmlAttributeComponent<IChangedAttributesProperties> {
-    protected readonly xmlKeys = {
-        id: "w:id",
-        author: "w:author",
-        date: "w:date",
-    };
-}

package/src/file/vertical-align/index.ts

@@ -1 +0,0 @@
-export * from "./vertical-align";

package/src/file/vertical-align/vertical-align.ts

@@ -1,32 +0,0 @@
-import { XmlAttributeComponent, XmlComponent } from "@file/xml-components";
-
-// <xsd:complexType name="CT_VerticalJc">
-//     <xsd:attribute name="val" type="ST_VerticalJc" use="required"/>
-// </xsd:complexType>
-
-// <xsd:simpleType name="ST_VerticalJc">
-// <xsd:restriction base="xsd:string">
-//   <xsd:enumeration value="top"/>
-//   <xsd:enumeration value="center"/>
-//   <xsd:enumeration value="bottom"/>
-// </xsd:restriction>
-// </xsd:simpleType>
-export enum VerticalAlign {
-    BOTTOM = "bottom",
-    CENTER = "center",
-    TOP = "top",
-}
-export class VerticalAlignAttributes extends XmlAttributeComponent<{
-    readonly verticalAlign?: VerticalAlign;
-}> {
-    protected readonly xmlKeys = {
-        verticalAlign: "w:val",
-    };
-}
-
-export class VerticalAlignElement extends XmlComponent {
-    public constructor(value: VerticalAlign) {
-        super("w:vAlign");
-        this.root.push(new VerticalAlignAttributes({ verticalAlign: value }));
-    }
-}

package/src/file/xml-components/attribute.spec.ts

@@ -1,25 +0,0 @@
-import { assert } from "chai";
-
-import { Attributes } from "./";
-
-describe("Attribute", () => {
-    describe("#constructor()", () => {
-        it("should have val as defined with populated constructor", () => {
-            const newAttrs = new Attributes({
-                val: "test",
-            });
-            const stringifiedJson = JSON.stringify(newAttrs);
-            const newJson = JSON.parse(stringifiedJson);
-            assert.equal(newJson.root.val, "test");
-        });
-
-        it("should have space value as defined with populated constructor", () => {
-            const newAttrs = new Attributes({
-                space: "spaceTest",
-            });
-            const stringifiedJson = JSON.stringify(newAttrs);
-            const newJson = JSON.parse(stringifiedJson);
-            assert.equal(newJson.root.space, "spaceTest");
-        });
-    });
-});

package/src/file/xml-components/attributes.ts

@@ -1,47 +0,0 @@
-import { XmlAttributeComponent } from "./default-attributes";
-
-export class Attributes extends XmlAttributeComponent<{
-    readonly val?: string | number | boolean;
-    readonly color?: string;
-    readonly fill?: string;
-    readonly space?: string;
-    readonly sz?: string;
-    readonly type?: string;
-    readonly rsidR?: string;
-    readonly rsidRPr?: string;
-    readonly rsidSect?: string;
-    readonly w?: string;
-    readonly h?: string;
-    readonly top?: string;
-    readonly right?: string;
-    readonly bottom?: string;
-    readonly left?: string;
-    readonly header?: string;
-    readonly footer?: string;
-    readonly gutter?: string;
-    readonly linePitch?: string;
-    readonly pos?: string | number; // Little strange. Perhaps it is normal. Need to clarify in the spec.
-}> {
-    protected readonly xmlKeys = {
-        val: "w:val",
-        color: "w:color",
-        fill: "w:fill",
-        space: "w:space",
-        sz: "w:sz",
-        type: "w:type",
-        rsidR: "w:rsidR",
-        rsidRPr: "w:rsidRPr",
-        rsidSect: "w:rsidSect",
-        w: "w:w",
-        h: "w:h",
-        top: "w:top",
-        right: "w:right",
-        bottom: "w:bottom",
-        left: "w:left",
-        header: "w:header",
-        footer: "w:footer",
-        gutter: "w:gutter",
-        linePitch: "w:linePitch",
-        pos: "w:pos",
-    };
-}

package/src/file/xml-components/base.ts

@@ -1,20 +0,0 @@
-import { IViewWrapper } from "../document-wrapper";
-import { File } from "../file";
-import { IXmlableObject } from "./xmlable-object";
-
-export interface IContext {
-    readonly file: File;
-    readonly viewWrapper: IViewWrapper;
-    // eslint-disable-next-line functional/prefer-readonly-type
-    readonly stack: IXmlableObject[];
-}
-
-export abstract class BaseXmlComponent {
-    protected readonly rootKey: string;
-
-    public constructor(rootKey: string) {
-        this.rootKey = rootKey;
-    }
-
-    public abstract prepForXml(context: IContext): IXmlableObject | undefined;
-}