docx 7.8.2 → 8.0.1

package/src/file/document/document-background/document-background.spec.ts

@@ -1,51 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-
-import { DocumentBackground } from "./document-background";
-
-describe("DocumentBackground", () => {
-    describe("#constructor()", () => {
-        it("should create a DocumentBackground with no options", () => {
-            const documentBackground = new DocumentBackground({});
-            const tree = new Formatter().format(documentBackground);
-            expect(tree).to.deep.equal({
-                "w:background": {
-                    _attr: {},
-                },
-            });
-        });
-
-        it("should create a DocumentBackground with no options and set color to value", () => {
-            const documentBackground = new DocumentBackground({ color: "ffff00" });
-            const tree = new Formatter().format(documentBackground);
-            expect(tree).to.deep.equal({
-                "w:background": {
-                    _attr: {
-                        "w:color": "ffff00",
-                    },
-                },
-            });
-        });
-
-        it("should create a DocumentBackground with no options and set other values", () => {
-            const documentBackground = new DocumentBackground({
-                color: "ffff00",
-                themeColor: "test",
-                themeShade: "0A",
-                themeTint: "0B",
-            });
-            const tree = new Formatter().format(documentBackground);
-            expect(tree).to.deep.equal({
-                "w:background": {
-                    _attr: {
-                        "w:color": "ffff00",
-                        "w:themeColor": "test",
-                        "w:themeShade": "0A",
-                        "w:themeTint": "0B",
-                    },
-                },
-            });
-        });
-    });
-});

package/src/file/document/document-background/document-background.ts

@@ -1,78 +0,0 @@
-// http://officeopenxml.com/WPdocument.php
-// http://www.datypic.com/sc/ooxml/e-w_background-1.html
-import { XmlAttributeComponent, XmlComponent } from "@file/xml-components";
-import { hexColorValue, uCharHexNumber } from "@util/values";
-
-// <xsd:simpleType name="ST_ThemeColor">
-// <xsd:restriction base="xsd:string">
-//   <xsd:enumeration value="dark1"/>
-//   <xsd:enumeration value="light1"/>
-//   <xsd:enumeration value="dark2"/>
-//   <xsd:enumeration value="light2"/>
-//   <xsd:enumeration value="accent1"/>
-//   <xsd:enumeration value="accent2"/>
-//   <xsd:enumeration value="accent3"/>
-//   <xsd:enumeration value="accent4"/>
-//   <xsd:enumeration value="accent5"/>
-//   <xsd:enumeration value="accent6"/>
-//   <xsd:enumeration value="hyperlink"/>
-//   <xsd:enumeration value="followedHyperlink"/>
-//   <xsd:enumeration value="none"/>
-//   <xsd:enumeration value="background1"/>
-//   <xsd:enumeration value="text1"/>
-//   <xsd:enumeration value="background2"/>
-//   <xsd:enumeration value="text2"/>
-// </xsd:restriction>
-// </xsd:simpleType>
-
-export class DocumentBackgroundAttributes extends XmlAttributeComponent<{
-    readonly color?: string;
-    readonly themeColor?: string;
-    readonly themeShade?: string;
-    readonly themeTint?: string;
-}> {
-    protected readonly xmlKeys = {
-        color: "w:color",
-        themeColor: "w:themeColor",
-        themeShade: "w:themeShade",
-        themeTint: "w:themeTint",
-    };
-}
-
-export interface IDocumentBackgroundOptions {
-    readonly color?: string;
-    readonly themeColor?: string;
-    readonly themeShade?: string;
-    readonly themeTint?: string;
-}
-
-// <xsd:complexType name="CT_Background">
-//     <xsd:sequence>
-//         <xsd:sequence maxOccurs="unbounded">
-//             <xsd:any processContents="lax" namespace="urn:schemas-microsoft-com:vml" minOccurs="0"
-//             maxOccurs="unbounded"/>
-//             <xsd:any processContents="lax" namespace="urn:schemas-microsoft-com:office:office"
-//             minOccurs="0" maxOccurs="unbounded"/>
-//         </xsd:sequence>
-//         <xsd:element name="drawing" type="CT_Drawing" minOccurs="0"/>
-//     </xsd:sequence>
-//     <xsd:attribute name="color" type="ST_HexColor" use="optional" default="auto"/>
-//     <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 DocumentBackground extends XmlComponent {
-    public constructor(options: IDocumentBackgroundOptions) {
-        super("w:background");
-
-        this.root.push(
-            new DocumentBackgroundAttributes({
-                color: options.color === undefined ? undefined : hexColorValue(options.color),
-                themeColor: options.themeColor,
-                themeShade: options.themeShade === undefined ? undefined : uCharHexNumber(options.themeShade),
-                themeTint: options.themeTint === undefined ? undefined : uCharHexNumber(options.themeTint),
-            }),
-        );
-    }
-}

package/src/file/document/document-background/index.ts

@@ -1 +0,0 @@
-export * from "./document-background";

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

@@ -1,67 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-
-import { Document } from "./document";
-
-describe("Document", () => {
-    let document: Document;
-
-    beforeEach(() => {
-        document = new Document({ background: {} });
-    });
-
-    describe("#constructor()", () => {
-        it("should create valid JSON", () => {
-            const tree = new Formatter().format(document);
-
-            expect(tree).to.deep.equal({
-                "w:document": [
-                    {
-                        _attr: {
-                            "xmlns:wpc": "http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas",
-                            "xmlns:mc": "http://schemas.openxmlformats.org/markup-compatibility/2006",
-                            "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:w16": "http://schemas.microsoft.com/office/word/2018/wordml",
-                            "xmlns:w16cex": "http://schemas.microsoft.com/office/word/2018/wordml/cex",
-                            "xmlns:w16cid": "http://schemas.microsoft.com/office/word/2016/wordml/cid",
-                            "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",
-                            "mc:Ignorable": "w14 w15 wp14",
-                            "xmlns:aink": "http://schemas.microsoft.com/office/drawing/2016/ink",
-                            "xmlns:am3d": "http://schemas.microsoft.com/office/drawing/2017/model3d",
-                            "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",
-                        },
-                    },
-                    {
-                        "w:background": {
-                            _attr: {},
-                        },
-                    },
-                    { "w:body": {} },
-                ],
-            });
-        });
-    });
-});

package/src/file/document/document.ts

@@ -1,90 +0,0 @@
-// http://officeopenxml.com/WPdocument.php
-import { XmlComponent } from "@file/xml-components";
-import { ConcreteHyperlink, Paragraph } from "../paragraph";
-import { Table } from "../table";
-import { TableOfContents } from "../table-of-contents";
-import { Body } from "./body";
-import { DocumentAttributes } from "./document-attributes";
-import { DocumentBackground, IDocumentBackgroundOptions } from "./document-background";
-
-export interface IDocumentOptions {
-    readonly background?: IDocumentBackgroundOptions;
-}
-
-// <xsd:element name="document" type="CT_Document"/>
-//
-// <xsd:complexType name="CT_Document">
-//     <xsd:complexContent>
-//         <xsd:extension base="CT_DocumentBase">
-//             <xsd:sequence>
-//                 <xsd:element name="body" type="CT_Body" minOccurs="0" maxOccurs="1"/>
-//             </xsd:sequence>
-//             <xsd:attribute name="conformance" type="s:ST_ConformanceClass"/>
-//             <xsd:attribute ref="mc:Ignorable" use="optional" />
-//         </xsd:extension>
-//     </xsd:complexContent>
-// </xsd:complexType>
-//
-// <xsd:complexType name="CT_DocumentBase">
-//     <xsd:sequence>
-//         <xsd:element name="background" type="CT_Background" minOccurs="0"/>
-//     </xsd:sequence>
-// </xsd:complexType>
-export class Document extends XmlComponent {
-    private readonly body: Body;
-
-    public constructor(options: IDocumentOptions) {
-        super("w:document");
-        this.root.push(
-            new DocumentAttributes({
-                wpc: "http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas",
-                mc: "http://schemas.openxmlformats.org/markup-compatibility/2006",
-                o: "urn:schemas-microsoft-com:office:office",
-                r: "http://schemas.openxmlformats.org/officeDocument/2006/relationships",
-                m: "http://schemas.openxmlformats.org/officeDocument/2006/math",
-                v: "urn:schemas-microsoft-com:vml",
-                wp14: "http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing",
-                wp: "http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing",
-                w10: "urn:schemas-microsoft-com:office:word",
-                w: "http://schemas.openxmlformats.org/wordprocessingml/2006/main",
-                w14: "http://schemas.microsoft.com/office/word/2010/wordml",
-                w15: "http://schemas.microsoft.com/office/word/2012/wordml",
-                wpg: "http://schemas.microsoft.com/office/word/2010/wordprocessingGroup",
-                wpi: "http://schemas.microsoft.com/office/word/2010/wordprocessingInk",
-                wne: "http://schemas.microsoft.com/office/word/2006/wordml",
-                wps: "http://schemas.microsoft.com/office/word/2010/wordprocessingShape",
-                cx: "http://schemas.microsoft.com/office/drawing/2014/chartex",
-                cx1: "http://schemas.microsoft.com/office/drawing/2015/9/8/chartex",
-                cx2: "http://schemas.microsoft.com/office/drawing/2015/10/21/chartex",
-                cx3: "http://schemas.microsoft.com/office/drawing/2016/5/9/chartex",
-                cx4: "http://schemas.microsoft.com/office/drawing/2016/5/10/chartex",
-                cx5: "http://schemas.microsoft.com/office/drawing/2016/5/11/chartex",
-                cx6: "http://schemas.microsoft.com/office/drawing/2016/5/12/chartex",
-                cx7: "http://schemas.microsoft.com/office/drawing/2016/5/13/chartex",
-                cx8: "http://schemas.microsoft.com/office/drawing/2016/5/14/chartex",
-                aink: "http://schemas.microsoft.com/office/drawing/2016/ink",
-                am3d: "http://schemas.microsoft.com/office/drawing/2017/model3d",
-                w16cex: "http://schemas.microsoft.com/office/word/2018/wordml/cex",
-                w16cid: "http://schemas.microsoft.com/office/word/2016/wordml/cid",
-                w16: "http://schemas.microsoft.com/office/word/2018/wordml",
-                w16sdtdh: "http://schemas.microsoft.com/office/word/2020/wordml/sdtdatahash",
-                w16se: "http://schemas.microsoft.com/office/word/2015/wordml/symex",
-                Ignorable: "w14 w15 wp14",
-            }),
-        );
-        this.body = new Body();
-        if (options.background) {
-            this.root.push(new DocumentBackground(options.background));
-        }
-        this.root.push(this.body);
-    }
-
-    public add(item: Paragraph | Table | TableOfContents | ConcreteHyperlink): Document {
-        this.body.push(item);
-        return this;
-    }
-
-    public get Body(): Body {
-        return this.body;
-    }
-}

package/src/file/document/index.ts

@@ -1,4 +0,0 @@
-export * from "./document";
-export * from "./document-attributes";
-export * from "./body";
-export * from "./document-background";

package/src/file/document-wrapper.spec.ts

@@ -1,14 +0,0 @@
-import { expect } from "chai";
-
-import { DocumentWrapper } from "./document-wrapper";
-
-describe("DocumentWrapper", () => {
-    describe("#constructor", () => {
-        it("should create", () => {
-            const file = new DocumentWrapper({ background: {} });
-
-            expect(file.View).to.be.ok;
-            expect(file.Relationships).to.be.ok;
-        });
-    });
-});

package/src/file/document-wrapper.ts

@@ -1,28 +0,0 @@
-import { Document, IDocumentOptions } from "./document";
-import { Footer } from "./footer/footer";
-import { FootNotes } from "./footnotes";
-import { Header } from "./header/header";
-import { Relationships } from "./relationships";
-
-export interface IViewWrapper {
-    readonly View: Document | Footer | Header | FootNotes;
-    readonly Relationships: Relationships;
-}
-
-export class DocumentWrapper implements IViewWrapper {
-    private readonly document: Document;
-    private readonly relationships: Relationships;
-
-    public constructor(options: IDocumentOptions) {
-        this.document = new Document(options);
-        this.relationships = new Relationships();
-    }
-
-    public get View(): Document {
-        return this.document;
-    }
-
-    public get Relationships(): Relationships {
-        return this.relationships;
-    }
-}

package/src/file/drawing/anchor/anchor-attributes.ts

@@ -1,26 +0,0 @@
-import { XmlAttributeComponent } from "@file/xml-components";
-import { IDistance } from "../drawing";
-
-export interface IAnchorAttributes extends IDistance {
-    readonly allowOverlap?: "0" | "1";
-    readonly behindDoc?: "0" | "1";
-    readonly layoutInCell?: "0" | "1";
-    readonly locked?: "0" | "1";
-    readonly relativeHeight?: number;
-    readonly simplePos?: "0" | "1";
-}
-
-export class AnchorAttributes extends XmlAttributeComponent<IAnchorAttributes> {
-    protected readonly xmlKeys = {
-        distT: "distT",
-        distB: "distB",
-        distL: "distL",
-        distR: "distR",
-        allowOverlap: "allowOverlap",
-        behindDoc: "behindDoc",
-        layoutInCell: "layoutInCell",
-        locked: "locked",
-        relativeHeight: "relativeHeight",
-        simplePos: "simplePos",
-    };
-}