docx 7.8.2 → 8.0.1

package/src/file/paragraph/run/comment-run.spec.ts

@@ -1,193 +0,0 @@
-import { expect } from "chai";
-import * as sinon from "sinon";
-
-import { Formatter } from "@export/formatter";
-import { Comment, CommentRangeEnd, CommentRangeStart, CommentReference, Comments } from "./comment-run";
-
-describe("CommentRangeStart", () => {
-    describe("#constructor()", () => {
-        it("should create", () => {
-            const component = new CommentRangeStart(0);
-            const tree = new Formatter().format(component);
-            expect(tree).to.deep.equal({
-                "w:commentRangeStart": { _attr: { "w:id": 0 } },
-            });
-        });
-    });
-});
-
-describe("CommentRangeEnd", () => {
-    describe("#constructor()", () => {
-        it("should create", () => {
-            const component = new CommentRangeEnd(0);
-            const tree = new Formatter().format(component);
-            expect(tree).to.deep.equal({
-                "w:commentRangeEnd": { _attr: { "w:id": 0 } },
-            });
-        });
-    });
-});
-
-describe("CommentReference", () => {
-    describe("#constructor()", () => {
-        it("should create", () => {
-            const component = new CommentReference(0);
-            const tree = new Formatter().format(component);
-            expect(tree).to.deep.equal({
-                "w:commentReference": { _attr: { "w:id": 0 } },
-            });
-        });
-    });
-});
-
-describe("Comment", () => {
-    let clock: sinon.SinonFakeTimers;
-
-    beforeEach(() => {
-        const now = new Date(1999, 0, 1);
-        clock = sinon.useFakeTimers(now.getTime());
-    });
-
-    afterEach(() => {
-        clock.restore();
-    });
-
-    describe("#constructor()", () => {
-        it("should create", () => {
-            const component = new Comment({
-                id: 0,
-                text: "test-comment",
-                date: new Date(1999, 0, 1),
-            });
-            const tree = new Formatter().format(component);
-            expect(tree).to.deep.equal({
-                "w:comment": [
-                    { _attr: { "w:id": 0, "w:date": "1999-01-01T00:00:00.000Z" } },
-                    {
-                        "w:p": [
-                            {
-                                "w:r": [
-                                    {
-                                        "w:t": [
-                                            {
-                                                _attr: {
-                                                    "xml:space": "preserve",
-                                                },
-                                            },
-                                            "test-comment",
-                                        ],
-                                    },
-                                ],
-                            },
-                        ],
-                    },
-                ],
-            });
-        });
-
-        it("should create by using default date", () => {
-            const component = new Comment({
-                id: 0,
-                text: "test-comment",
-            });
-            const tree = new Formatter().format(component);
-            expect(tree).to.deep.equal({
-                "w:comment": [
-                    { _attr: { "w:id": 0, "w:date": "1999-01-01T00:00:00.000Z" } },
-                    {
-                        "w:p": [
-                            {
-                                "w:r": [
-                                    {
-                                        "w:t": [
-                                            {
-                                                _attr: {
-                                                    "xml:space": "preserve",
-                                                },
-                                            },
-                                            "test-comment",
-                                        ],
-                                    },
-                                ],
-                            },
-                        ],
-                    },
-                ],
-            });
-        });
-    });
-});
-
-describe("Comments", () => {
-    describe("#constructor()", () => {
-        it("should create", () => {
-            const component = new Comments({
-                children: [
-                    {
-                        id: 0,
-                        text: "test-comment",
-                        date: new Date(1999, 0, 1),
-                    },
-                    {
-                        id: 1,
-                        text: "test-comment-2",
-                        date: new Date(1999, 0, 1),
-                    },
-                ],
-            });
-            const tree = new Formatter().format(component);
-
-            expect(tree).to.deep.equal({
-                "w:comments": [
-                    {
-                        _attr: {
-                            "xmlns:cx": "http://schemas.microsoft.com/office/drawing/2014/chartex",
-                            "xmlns:cx1": "http://schemas.microsoft.com/office/drawing/2015/9/8/chartex",
-                            "xmlns:cx2": "http://schemas.microsoft.com/office/drawing/2015/10/21/chartex",
-                            "xmlns:cx3": "http://schemas.microsoft.com/office/drawing/2016/5/9/chartex",
-                            "xmlns:cx4": "http://schemas.microsoft.com/office/drawing/2016/5/10/chartex",
-                            "xmlns:cx5": "http://schemas.microsoft.com/office/drawing/2016/5/11/chartex",
-                            "xmlns:cx6": "http://schemas.microsoft.com/office/drawing/2016/5/12/chartex",
-                            "xmlns:cx7": "http://schemas.microsoft.com/office/drawing/2016/5/13/chartex",
-                            "xmlns:cx8": "http://schemas.microsoft.com/office/drawing/2016/5/14/chartex",
-                            "xmlns:mc": "http://schemas.openxmlformats.org/markup-compatibility/2006",
-                            "xmlns:aink": "http://schemas.microsoft.com/office/drawing/2016/ink",
-                            "xmlns:am3d": "http://schemas.microsoft.com/office/drawing/2017/model3d",
-                            "xmlns:o": "urn:schemas-microsoft-com:office:office",
-                            "xmlns:r": "http://schemas.openxmlformats.org/officeDocument/2006/relationships",
-                            "xmlns:m": "http://schemas.openxmlformats.org/officeDocument/2006/math",
-                            "xmlns:v": "urn:schemas-microsoft-com:vml",
-                            "xmlns:wp14": "http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing",
-                            "xmlns:wp": "http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing",
-                            "xmlns:w10": "urn:schemas-microsoft-com:office:word",
-                            "xmlns:w": "http://schemas.openxmlformats.org/wordprocessingml/2006/main",
-                            "xmlns:w14": "http://schemas.microsoft.com/office/word/2010/wordml",
-                            "xmlns:w15": "http://schemas.microsoft.com/office/word/2012/wordml",
-                            "xmlns:w16cex": "http://schemas.microsoft.com/office/word/2018/wordml/cex",
-                            "xmlns:w16cid": "http://schemas.microsoft.com/office/word/2016/wordml/cid",
-                            "xmlns:w16": "http://schemas.microsoft.com/office/word/2018/wordml",
-                            "xmlns:w16sdtdh": "http://schemas.microsoft.com/office/word/2020/wordml/sdtdatahash",
-                            "xmlns:w16se": "http://schemas.microsoft.com/office/word/2015/wordml/symex",
-                            "xmlns:wpg": "http://schemas.microsoft.com/office/word/2010/wordprocessingGroup",
-                            "xmlns:wpi": "http://schemas.microsoft.com/office/word/2010/wordprocessingInk",
-                            "xmlns:wne": "http://schemas.microsoft.com/office/word/2006/wordml",
-                            "xmlns:wps": "http://schemas.microsoft.com/office/word/2010/wordprocessingShape",
-                        },
-                    },
-                    {
-                        "w:comment": [
-                            { _attr: { "w:id": 0, "w:date": "1999-01-01T00:00:00.000Z" } },
-                            { "w:p": [{ "w:r": [{ "w:t": [{ _attr: { "xml:space": "preserve" } }, "test-comment"] }] }] },
-                        ],
-                    },
-                    {
-                        "w:comment": [
-                            { _attr: { "w:id": 1, "w:date": "1999-01-01T00:00:00.000Z" } },
-                            { "w:p": [{ "w:r": [{ "w:t": [{ _attr: { "xml:space": "preserve" } }, "test-comment-2"] }] }] },
-                        ],
-                    },
-                ],
-            });
-        });
-    });
-});

package/src/file/paragraph/run/comment-run.ts

@@ -1,182 +0,0 @@
-import { Paragraph } from "@file/paragraph";
-import { XmlAttributeComponent, XmlComponent } from "@file/xml-components";
-
-import { TextRun } from "./text-run";
-
-export interface ICommentOptions {
-    readonly id: number;
-    readonly text: string;
-    readonly initials?: string;
-    readonly author?: string;
-    readonly date?: Date;
-}
-
-export interface ICommentsOptions {
-    readonly children: readonly ICommentOptions[];
-}
-
-class CommentAttributes extends XmlAttributeComponent<{
-    readonly id: number;
-    readonly initials?: string;
-    readonly author?: string;
-    readonly date?: string;
-}> {
-    protected readonly xmlKeys = { id: "w:id", initials: "w:initials", author: "w:author", date: "w:date" };
-}
-
-class CommentRangeAttributes extends XmlAttributeComponent<{ readonly id: number }> {
-    protected readonly xmlKeys = { id: "w:id" };
-}
-class RootCommentsAttributes extends XmlAttributeComponent<{
-    readonly "xmlns:cx"?: string;
-    readonly "xmlns:cx1"?: string;
-    readonly "xmlns:cx2"?: string;
-    readonly "xmlns:cx3"?: string;
-    readonly "xmlns:cx4"?: string;
-    readonly "xmlns:cx5"?: string;
-    readonly "xmlns:cx6"?: string;
-    readonly "xmlns:cx7"?: string;
-    readonly "xmlns:cx8"?: string;
-    readonly "xmlns:mc"?: string;
-    readonly "xmlns:aink"?: string;
-    readonly "xmlns:am3d"?: string;
-    readonly "xmlns:o"?: string;
-    readonly "xmlns:r"?: string;
-    readonly "xmlns:m"?: string;
-    readonly "xmlns:v"?: string;
-    readonly "xmlns:wp14"?: string;
-    readonly "xmlns:wp"?: string;
-    readonly "xmlns:w10"?: string;
-    readonly "xmlns:w"?: string;
-    readonly "xmlns:w14"?: string;
-    readonly "xmlns:w15"?: string;
-    readonly "xmlns:w16cex"?: string;
-    readonly "xmlns:w16cid"?: string;
-    readonly "xmlns:w16"?: string;
-    readonly "xmlns:w16sdtdh"?: string;
-    readonly "xmlns:w16se"?: string;
-    readonly "xmlns:wpg": string;
-    readonly "xmlns:wpi"?: string;
-    readonly "xmlns:wne"?: string;
-    readonly "xmlns:wps"?: string;
-}> {
-    protected readonly xmlKeys = {
-        "xmlns:cx": "xmlns:cx",
-        "xmlns:cx1": "xmlns:cx1",
-        "xmlns:cx2": "xmlns:cx2",
-        "xmlns:cx3": "xmlns:cx3",
-        "xmlns:cx4": "xmlns:cx4",
-        "xmlns:cx5": "xmlns:cx5",
-        "xmlns:cx6": "xmlns:cx6",
-        "xmlns:cx7": "xmlns:cx7",
-        "xmlns:cx8": "xmlns:cx8",
-        "xmlns:mc": "xmlns:mc",
-        "xmlns:aink": "xmlns:aink",
-        "xmlns:am3d": "xmlns:am3d",
-        "xmlns:o": "xmlns:o",
-        "xmlns:r": "xmlns:r",
-        "xmlns:m": "xmlns:m",
-        "xmlns:v": "xmlns:v",
-        "xmlns:wp14": "xmlns:wp14",
-        "xmlns:wp": "xmlns:wp",
-        "xmlns:w10": "xmlns:w10",
-        "xmlns:w": "xmlns:w",
-        "xmlns:w14": "xmlns:w14",
-        "xmlns:w15": "xmlns:w15",
-        "xmlns:w16cex": "xmlns:w16cex",
-        "xmlns:w16cid": "xmlns:w16cid",
-        "xmlns:w16": "xmlns:w16",
-        "xmlns:w16sdtdh": "xmlns:w16sdtdh",
-        "xmlns:w16se": "xmlns:w16se",
-        "xmlns:wpg": "xmlns:wpg",
-        "xmlns:wpi": "xmlns:wpi",
-        "xmlns:wne": "xmlns:wne",
-        "xmlns:wps": "xmlns:wps",
-    };
-}
-
-export class CommentRangeStart extends XmlComponent {
-    public constructor(id: number) {
-        super("w:commentRangeStart");
-
-        this.root.push(new CommentRangeAttributes({ id }));
-    }
-}
-
-export class CommentRangeEnd extends XmlComponent {
-    public constructor(id: number) {
-        super("w:commentRangeEnd");
-
-        this.root.push(new CommentRangeAttributes({ id }));
-    }
-}
-
-export class CommentReference extends XmlComponent {
-    public constructor(id: number) {
-        super("w:commentReference");
-
-        this.root.push(new CommentRangeAttributes({ id }));
-    }
-}
-
-export class Comment extends XmlComponent {
-    public constructor({ id, initials, author, date = new Date(), text }: ICommentOptions) {
-        super("w:comment");
-
-        this.root.push(
-            new CommentAttributes({
-                id,
-                initials,
-                author,
-                date: date.toISOString(),
-            }),
-        );
-
-        this.root.push(new Paragraph({ children: [new TextRun(text)] }));
-    }
-}
-export class Comments extends XmlComponent {
-    public constructor({ children }: ICommentsOptions) {
-        super("w:comments");
-
-        this.root.push(
-            new RootCommentsAttributes({
-                "xmlns:cx": "http://schemas.microsoft.com/office/drawing/2014/chartex",
-                "xmlns:cx1": "http://schemas.microsoft.com/office/drawing/2015/9/8/chartex",
-                "xmlns:cx2": "http://schemas.microsoft.com/office/drawing/2015/10/21/chartex",
-                "xmlns:cx3": "http://schemas.microsoft.com/office/drawing/2016/5/9/chartex",
-                "xmlns:cx4": "http://schemas.microsoft.com/office/drawing/2016/5/10/chartex",
-                "xmlns:cx5": "http://schemas.microsoft.com/office/drawing/2016/5/11/chartex",
-                "xmlns:cx6": "http://schemas.microsoft.com/office/drawing/2016/5/12/chartex",
-                "xmlns:cx7": "http://schemas.microsoft.com/office/drawing/2016/5/13/chartex",
-                "xmlns:cx8": "http://schemas.microsoft.com/office/drawing/2016/5/14/chartex",
-                "xmlns:mc": "http://schemas.openxmlformats.org/markup-compatibility/2006",
-                "xmlns:aink": "http://schemas.microsoft.com/office/drawing/2016/ink",
-                "xmlns:am3d": "http://schemas.microsoft.com/office/drawing/2017/model3d",
-                "xmlns:o": "urn:schemas-microsoft-com:office:office",
-                "xmlns:r": "http://schemas.openxmlformats.org/officeDocument/2006/relationships",
-                "xmlns:m": "http://schemas.openxmlformats.org/officeDocument/2006/math",
-                "xmlns:v": "urn:schemas-microsoft-com:vml",
-                "xmlns:wp14": "http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing",
-                "xmlns:wp": "http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing",
-                "xmlns:w10": "urn:schemas-microsoft-com:office:word",
-                "xmlns:w": "http://schemas.openxmlformats.org/wordprocessingml/2006/main",
-                "xmlns:w14": "http://schemas.microsoft.com/office/word/2010/wordml",
-                "xmlns:w15": "http://schemas.microsoft.com/office/word/2012/wordml",
-                "xmlns:w16cex": "http://schemas.microsoft.com/office/word/2018/wordml/cex",
-                "xmlns:w16cid": "http://schemas.microsoft.com/office/word/2016/wordml/cid",
-                "xmlns:w16": "http://schemas.microsoft.com/office/word/2018/wordml",
-                "xmlns:w16sdtdh": "http://schemas.microsoft.com/office/word/2020/wordml/sdtdatahash",
-                "xmlns:w16se": "http://schemas.microsoft.com/office/word/2015/wordml/symex",
-                "xmlns:wpg": "http://schemas.microsoft.com/office/word/2010/wordprocessingGroup",
-                "xmlns:wpi": "http://schemas.microsoft.com/office/word/2010/wordprocessingInk",
-                "xmlns:wne": "http://schemas.microsoft.com/office/word/2006/wordml",
-                "xmlns:wps": "http://schemas.microsoft.com/office/word/2010/wordprocessingShape",
-            }),
-        );
-
-        for (const child of children) {
-            this.root.push(new Comment(child));
-        }
-    }
-}

package/src/file/paragraph/run/emphasis-mark.spec.ts

@@ -1,29 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-
-import * as em from "./emphasis-mark";
-
-describe("EmphasisMark", () => {
-    describe("#constructor()", () => {
-        it("should create a new EmphasisMark object with w:em as the rootKey", () => {
-            const emphasisMark = new em.EmphasisMark();
-            const tree = new Formatter().format(emphasisMark);
-            expect(tree).to.deep.equal({
-                "w:em": { _attr: { "w:val": "dot" } },
-            });
-        });
-    });
-});
-
-describe("DotEmphasisMark", () => {
-    describe("#constructor()", () => {
-        it("should put value in attribute", () => {
-            const emphasisMark = new em.DotEmphasisMark();
-            const tree = new Formatter().format(emphasisMark);
-            expect(tree).to.deep.equal({
-                "w:em": { _attr: { "w:val": "dot" } },
-            });
-        });
-    });
-});

package/src/file/paragraph/run/emphasis-mark.ts

@@ -1,28 +0,0 @@
-import { Attributes, XmlComponent } from "@file/xml-components";
-
-export enum EmphasisMarkType {
-    DOT = "dot",
-}
-
-export abstract class BaseEmphasisMark extends XmlComponent {
-    protected constructor(emphasisMarkType: EmphasisMarkType) {
-        super("w:em");
-        this.root.push(
-            new Attributes({
-                val: emphasisMarkType,
-            }),
-        );
-    }
-}
-
-export class EmphasisMark extends BaseEmphasisMark {
-    public constructor(emphasisMarkType: EmphasisMarkType = EmphasisMarkType.DOT) {
-        super(emphasisMarkType);
-    }
-}
-
-export class DotEmphasisMark extends BaseEmphasisMark {
-    public constructor() {
-        super(EmphasisMarkType.DOT);
-    }
-}

package/src/file/paragraph/run/field.ts

@@ -1,32 +0,0 @@
-import { XmlAttributeComponent, XmlComponent } from "@file/xml-components";
-
-enum FieldCharacterType {
-    BEGIN = "begin",
-    END = "end",
-    SEPARATE = "separate",
-}
-
-class FidCharAttrs extends XmlAttributeComponent<{ readonly type: FieldCharacterType; readonly dirty?: boolean }> {
-    protected readonly xmlKeys = { type: "w:fldCharType", dirty: "w:dirty" };
-}
-
-export class Begin extends XmlComponent {
-    public constructor(dirty?: boolean) {
-        super("w:fldChar");
-        this.root.push(new FidCharAttrs({ type: FieldCharacterType.BEGIN, dirty }));
-    }
-}
-
-export class Separate extends XmlComponent {
-    public constructor(dirty?: boolean) {
-        super("w:fldChar");
-        this.root.push(new FidCharAttrs({ type: FieldCharacterType.SEPARATE, dirty }));
-    }
-}
-
-export class End extends XmlComponent {
-    public constructor(dirty?: boolean) {
-        super("w:fldChar");
-        this.root.push(new FidCharAttrs({ type: FieldCharacterType.END, dirty }));
-    }
-}

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

@@ -1,39 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-
-import { CharacterSpacing, Color } from "./formatting";
-
-describe("CharacterSpacing", () => {
-    describe("#constructor()", () => {
-        it("should create", () => {
-            const element = new CharacterSpacing(32);
-
-            const tree = new Formatter().format(element);
-            expect(tree).to.deep.equal({
-                "w:spacing": {
-                    _attr: {
-                        "w:val": 32,
-                    },
-                },
-            });
-        });
-    });
-});
-
-describe("Color", () => {
-    describe("#constructor()", () => {
-        it("should create", () => {
-            const element = new Color("#FFFFFF");
-
-            const tree = new Formatter().format(element);
-            expect(tree).to.deep.equal({
-                "w:color": {
-                    _attr: {
-                        "w:val": "FFFFFF",
-                    },
-                },
-            });
-        });
-    });
-});

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

@@ -1,73 +0,0 @@
-import { Attributes, XmlComponent } from "@file/xml-components";
-import { hexColorValue, signedTwipsMeasureValue } from "@util/values";
-
-export class CharacterSpacing extends XmlComponent {
-    public constructor(value: number | string) {
-        super("w:spacing");
-        this.root.push(
-            new Attributes({
-                val: signedTwipsMeasureValue(value),
-            }),
-        );
-    }
-}
-
-// <xsd:complexType name="CT_Color">
-//     <xsd:attribute name="val" type="ST_HexColor" use="required"/>
-//     <xsd:attribute name="themeColor" type="ST_ThemeColor" use="optional"/>
-//     <xsd:attribute name="themeTint" type="ST_UcharHexNumber" use="optional"/>
-//     <xsd:attribute name="themeShade" type="ST_UcharHexNumber" use="optional"/>
-// </xsd:complexType>
-export class Color extends XmlComponent {
-    public constructor(color: string) {
-        super("w:color");
-        this.root.push(
-            new Attributes({
-                val: hexColorValue(color),
-            }),
-        );
-    }
-}
-
-// <xsd:simpleType name="ST_HighlightColor">
-//     <xsd:restriction base="xsd:string">
-//         <xsd:enumeration value="black"/>
-//         <xsd:enumeration value="blue"/>
-//         <xsd:enumeration value="cyan"/>
-//         <xsd:enumeration value="green"/>
-//         <xsd:enumeration value="magenta"/>
-//         <xsd:enumeration value="red"/>
-//         <xsd:enumeration value="yellow"/>
-//         <xsd:enumeration value="white"/>
-//         <xsd:enumeration value="darkBlue"/>
-//         <xsd:enumeration value="darkCyan"/>
-//         <xsd:enumeration value="darkGreen"/>
-//         <xsd:enumeration value="darkMagenta"/>
-//         <xsd:enumeration value="darkRed"/>
-//         <xsd:enumeration value="darkYellow"/>
-//         <xsd:enumeration value="darkGray"/>
-//         <xsd:enumeration value="lightGray"/>
-//         <xsd:enumeration value="none"/>
-//     </xsd:restriction>
-// </xsd:simpleType>
-export class Highlight extends XmlComponent {
-    public constructor(color: string) {
-        super("w:highlight");
-        this.root.push(
-            new Attributes({
-                val: color,
-            }),
-        );
-    }
-}
-
-export class HighlightComplexScript extends XmlComponent {
-    public constructor(color: string) {
-        super("w:highlightCs");
-        this.root.push(
-            new Attributes({
-                val: color,
-            }),
-        );
-    }
-}