feature: add support to add mutiple sections to the document inc. headers and footers

- write missing tests

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

@@ -1,39 +1,42 @@
-// import { assert } from "chai";
+import { expect } from "chai";
 
-// import { Utility } from "../../../tests/utility";
-// import { Body } from "./";
+import { Formatter } from "../../../export/formatter";
+import { Body } from "./body";
 
 describe("Body", () => {
-    // let body: Body;
+    let body: Body;
 
     beforeEach(() => {
-        // body = new Body();
+        body = new Body();
     });
 
-    // describe("#constructor()", () => {
-    //     it("should create the Section Properties", () => {
-    //         const newJson = Utility.jsonify(body);
-    //         assert.equal(newJson.root[0].rootKey, "w:sectPr");
-    //     });
+    describe("#constructor()", () => {
+        it("should create default section", () => {
+            const formatted = new Formatter().format(body)["w:body"][0];
+            expect(formatted)
+                .to.have.property("w:sectPr")
+                .and.to.be.an.instanceof(Array);
+            expect(formatted["w:sectPr"]).to.have.length(7);
+        });
+    });
 
-    //     it("should create the Page Size", () => {
-    //         const newJson = Utility.jsonify(body);
-    //         assert.equal(newJson.root[1].rootKey, "w:pgSz");
-    //     });
+    describe("addSection", () => {
+        it("should add section with options", () => {
+            body.addSection({
+                width: 10000,
+                height: 10000,
+            });
 
-    //     it("should create the Page Margin", () => {
-    //         const newJson = Utility.jsonify(body);
-    //         assert.equal(newJson.root[2].rootKey, "w:pgMar");
-    //     });
+            const formatted = new Formatter().format(body)["w:body"];
+            expect(formatted).to.be.an.instanceof(Array);
+            const defaultSectionPr = formatted[0]["w:p"][1]["w:pPr"][0]["w:sectPr"];
 
-    //     it("should create the Columns", () => {
-    //         const newJson = Utility.jsonify(body);
-    //         assert.equal(newJson.root[3].rootKey, "w:cols");
-    //     });
+            // check that this is the default section and added first in paragraph
+            expect(defaultSectionPr[0]).to.deep.equal({ "w:pgSz": [{ _attr: { "w:h": 16838, "w:w": 11906, "w:orient": "portrait" } }] });
 
-    //     it("should create the Document Grid", () => {
-    //         const newJson = Utility.jsonify(body);
-    //         assert.equal(newJson.root[4].rootKey, "w:docGrid");
-    //     });
-    // });
+            // check for new section (since it's the last one, it's direct child of body)
+            const newSection = formatted[1]["w:sectPr"];
+            expect(newSection[0]).to.deep.equal({ "w:pgSz": [{ _attr: { "w:h": 10000, "w:w": 10000, "w:orient": "portrait" } }] });
+        });
+    });
 });

src/file/document/body/body.ts

@@ -1,14 +1,59 @@
-import { XmlComponent } from "file/xml-components";
+import { XmlComponent, IXmlableObject } from "file/xml-components";
 import { SectionProperties, SectionPropertiesOptions } from "./section-properties/section-properties";
+import { Paragraph, ParagraphProperties } from "../..";
 
 export class Body extends XmlComponent {
+    private defaultSection: SectionProperties;
+
+    private sections: SectionProperties[] = [];
+
     constructor(sectionPropertiesOptions?: SectionPropertiesOptions) {
         super("w:body");
 
-        this.root.push(new SectionProperties(sectionPropertiesOptions));
+        this.defaultSection = new SectionProperties(sectionPropertiesOptions);
+        this.sections.push(this.defaultSection);
+    }
+
+    /**
+     * 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 section new section
+     */
+    addSection(section: SectionPropertiesOptions | SectionProperties) {
+        const currentSection = this.sections.pop() as SectionProperties;
+        this.root.push(this.createSectionParagraph(currentSection));
+        if (section instanceof SectionProperties) {
+            this.sections.push(section);
+        } else {
+            this.sections.push(new SectionProperties(section));
+        }
+    }
+    public prepForXml(): IXmlableObject {
+        if (this.sections.length === 1) {
+            this.root.push(this.sections[0]);
+        } else if (this.sections.length > 1) {
+            throw new Error("Invalid usage of sections. At the end of the body element there must be ONE section.");
+        }
+
+        return super.prepForXml();
     }
 
     public push(component: XmlComponent): void {
         this.root.push(component);
     }
+
+    get DefaultSection() {
+        return this.defaultSection;
+    }
+
+    private createSectionParagraph(section: SectionProperties) {
+        const paragraph = new Paragraph();
+        const properties = new ParagraphProperties();
+        properties.addChildElement(section);
+        paragraph.addChildElement(properties);
+        return paragraph;
+    }
 }

src/file/document/body/index.ts

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

src/file/document/body/section-properties/footer-reference/footer-reference-attributes.ts

@@ -1,5 +1,11 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
+export enum FooterReferenceType {
+    DEFAULT = "default",
+    FIRST = "first",
+    EVEN = "even",
+}
+
 export interface IFooterReferenceAttributes {
     type: string;
     id: string;

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

@@ -1,13 +1,19 @@
 import { XmlComponent } from "file/xml-components";
-import { FooterReferenceAttributes } from "./footer-reference-attributes";
+import { FooterReferenceAttributes, FooterReferenceType } from "./footer-reference-attributes";
+
+export interface FooterOptions {
+    footerType?: FooterReferenceType;
+    footerId?: number;
+}
 
 export class FooterReference extends XmlComponent {
-    constructor() {
+    constructor(options: FooterOptions) {
         super("w:footerReference");
+
         this.root.push(
             new FooterReferenceAttributes({
-                type: "default",
-                id: `rId${4}`,
+                type: options.footerType || FooterReferenceType.DEFAULT,
+                id: `rId${options.footerId}`,
             }),
         );
     }

src/file/document/body/section-properties/footer-reference/index.ts

@@ -0,0 +1,2 @@
+export * from "./footer-reference";
+export * from "./footer-reference-attributes";

src/file/document/body/section-properties/header-reference/header-reference-attributes.ts

@@ -1,5 +1,11 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
+export enum HeaderReferenceType {
+    DEFAULT = "default",
+    FIRST = "first",
+    EVEN = "even",
+}
+
 export interface IHeaderReferenceAttributes {
     type: string;
     id: string;

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

@@ -1,13 +1,18 @@
 import { XmlComponent } from "file/xml-components";
-import { HeaderReferenceAttributes } from "./header-reference-attributes";
+import { HeaderReferenceAttributes, HeaderReferenceType } from "./header-reference-attributes";
+
+export interface HeaderOptions {
+    headerType?: HeaderReferenceType;
+    headerId?: number;
+}
 
 export class HeaderReference extends XmlComponent {
-    constructor() {
+    constructor(options: HeaderOptions) {
         super("w:headerReference");
         this.root.push(
             new HeaderReferenceAttributes({
-                type: "default",
-                id: `rId${3}`,
+                type: options.headerType || HeaderReferenceType.DEFAULT,
+                id: `rId${options.headerId}`,
             }),
         );
     }

src/file/document/body/section-properties/header-reference/index.ts

@@ -0,0 +1,2 @@
+export * from "./header-reference";
+export * from "./header-reference-attributes";

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

@@ -0,0 +1,5 @@
+export * from "./section-properties";
+export * from "./footer-reference";
+export * from "./header-reference";
+export * from "./page-size";
+export * from "./page-number";

src/file/document/body/section-properties/page-number/index.ts

@@ -0,0 +1 @@
+export * from "./page-number";

src/file/document/body/section-properties/page-number/page-number.ts

@@ -0,0 +1,41 @@
+// http://officeopenxml.com/WPSectionPgNumType.php
+import { XmlComponent, XmlAttributeComponent } from "file/xml-components";
+
+export enum PageNumberFormat {
+    CARDINAL_TEXT = "cardinalText",
+    DECIMAL = "decimal",
+    DECIMAL_ENCLOSED_CIRCLE = "decimalEnclosedCircle",
+    DECIMAL_ENCLOSED_FULL_STOP = "decimalEnclosedFullstop",
+    DECIMAL_ENCLOSED_PAREN = "decimalEnclosedParen",
+    DECIMAL_ZERO = "decimalZero",
+    LOWER_LETTER = "lowerLetter",
+    LOWER_ROMAN = "lowerRoman",
+    NONE = "none",
+    ORDINAL_TEXT = "ordinalText",
+    UPPER_LETTER = "upperLetter",
+    UPPER_ROMAN = "upperRoman",
+}
+
+export interface IPageNumberTypeAttributes {
+    pageNumberStart?: number;
+    pageNumberFormatType?: PageNumberFormat;
+}
+
+export class PageNumberTypeAttributes extends XmlAttributeComponent<IPageNumberTypeAttributes> {
+    protected xmlKeys = {
+        pageNumberStart: "w:start",
+        pageNumberFormatType: "w:fmt",
+    };
+}
+
+export class PageNumberType extends XmlComponent {
+    constructor(start?: number, numberFormat?: PageNumberFormat) {
+        super("w:pgNumType");
+        this.root.push(
+            new PageNumberTypeAttributes({
+                pageNumberStart: start,
+                pageNumberFormatType: numberFormat,
+            }),
+        );
+    }
+}

src/file/document/body/section-properties/page-size/index.ts

@@ -0,0 +1,2 @@
+export * from "./page-size";
+export * from "./page-size-attributes";

src/file/document/body/section-properties/page-size/page-size-attributes.ts

@@ -1,9 +1,14 @@
 import { XmlAttributeComponent } from "file/xml-components";
 
+export enum PageOrientation {
+    PORTRAIT = "portrait",
+    LANDSCAPE = "landscape",
+}
+
 export interface IPageSizeAttributes {
     width?: number;
     height?: number;
-    orientation?: string;
+    orientation?: PageOrientation;
 }
 
 export class PageSizeAttributes extends XmlAttributeComponent<IPageSizeAttributes> {

src/file/document/body/section-properties/page-size/page-size.spec.ts

@@ -2,11 +2,12 @@ import { expect } from "chai";
 
 import { Formatter } from "../../../../../export/formatter";
 import { PageSize } from "./page-size";
+import { PageOrientation } from "./page-size-attributes";
 
 describe("PageSize", () => {
     describe("#constructor()", () => {
         it("should create page size with portrait", () => {
-            const properties = new PageSize(100, 200, "portrait");
+            const properties = new PageSize(100, 200, PageOrientation.PORTRAIT);
             const tree = new Formatter().format(properties);
 
             expect(Object.keys(tree)).to.deep.equal(["w:pgSz"]);
@@ -15,7 +16,7 @@ describe("PageSize", () => {
         });
 
         it("should create page size with horizontal and invert the lengths", () => {
-            const properties = new PageSize(100, 200, "landscape");
+            const properties = new PageSize(100, 200, PageOrientation.LANDSCAPE);
             const tree = new Formatter().format(properties);
 
             expect(Object.keys(tree)).to.deep.equal(["w:pgSz"]);

src/file/document/body/section-properties/page-size/page-size.ts

@@ -1,11 +1,11 @@
 import { XmlComponent } from "file/xml-components";
-import { PageSizeAttributes } from "./page-size-attributes";
+import { PageSizeAttributes, PageOrientation } from "./page-size-attributes";
 
 export class PageSize extends XmlComponent {
-    constructor(width: number, height: number, orientation: string) {
+    constructor(width: number, height: number, orientation: PageOrientation) {
         super("w:pgSz");
 
-        const flip = orientation === "landscape";
+        const flip = orientation === PageOrientation.LANDSCAPE;
 
         this.root.push(
             new PageSizeAttributes({

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

@@ -2,6 +2,7 @@ import { expect } from "chai";
 
 import { Formatter } from "../../../../export/formatter";
 import { SectionProperties } from "./section-properties";
+import { FooterReferenceType, PageNumberFormat } from ".";
 
 describe("SectionProperties", () => {
     describe("#constructor()", () => {
@@ -18,6 +19,11 @@ describe("SectionProperties", () => {
                 gutter: 0,
                 space: 708,
                 linePitch: 360,
+                headerId: 100,
+                footerId: 200,
+                footerType: FooterReferenceType.EVEN,
+                pageNumberStart: 10,
+                pageNumberFormatType: PageNumberFormat.CARDINAL_TEXT,
             });
             const tree = new Formatter().format(properties);
             expect(Object.keys(tree)).to.deep.equal(["w:sectPr"]);
@@ -38,6 +44,12 @@ describe("SectionProperties", () => {
                     },
                 ],
             });
+
+            expect(tree["w:sectPr"][2]).to.deep.equal({ "w:cols": [{ _attr: { "w:space": 708 } }] });
+            expect(tree["w:sectPr"][3]).to.deep.equal({ "w:docGrid": [{ _attr: { "w:linePitch": 360 } }] });
+            expect(tree["w:sectPr"][4]).to.deep.equal({ "w:headerReference": [{ _attr: { "r:id": "rId100", "w:type": "default" } }] });
+            expect(tree["w:sectPr"][5]).to.deep.equal({ "w:footerReference": [{ _attr: { "r:id": "rId200", "w:type": "even" } }] });
+            expect(tree["w:sectPr"][6]).to.deep.equal({ "w:pgNumType": [{ _attr: { "w:fmt": "cardinalText", "w:start": 10 } }] });
         });
 
         it("should create section properties with no options", () => {
@@ -61,6 +73,11 @@ describe("SectionProperties", () => {
                     },
                 ],
             });
+            expect(tree["w:sectPr"][2]).to.deep.equal({ "w:cols": [{ _attr: { "w:space": 708 } }] });
+            expect(tree["w:sectPr"][3]).to.deep.equal({ "w:docGrid": [{ _attr: { "w:linePitch": 360 } }] });
+            expect(tree["w:sectPr"][4]).to.deep.equal({ "w:headerReference": [{ _attr: { "r:id": "rId0", "w:type": "default" } }] });
+            expect(tree["w:sectPr"][5]).to.deep.equal({ "w:footerReference": [{ _attr: { "r:id": "rId0", "w:type": "default" } }] });
+            expect(tree["w:sectPr"][6]).to.deep.equal({ "w:pgNumType": [{ _attr: { "w:fmt": "decimal" } }] });
         });
 
         it("should create section properties with changed options", () => {

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

@@ -4,16 +4,25 @@ import { Columns } from "./columns/columns";
 import { IColumnsAttributes } from "./columns/columns-attributes";
 import { DocumentGrid } from "./doc-grid/doc-grid";
 import { IDocGridAttributesProperties } from "./doc-grid/doc-grid-attributes";
-import { FooterReference } from "./footer-reference/footer-reference";
-import { HeaderReference } from "./header-reference/header-reference";
+import { FooterReference, FooterOptions } from "./footer-reference/footer-reference";
+import { HeaderReference, HeaderOptions } from "./header-reference/header-reference";
 import { PageMargin } from "./page-margin/page-margin";
 import { IPageMarginAttributes } from "./page-margin/page-margin-attributes";
 import { PageSize } from "./page-size/page-size";
-import { IPageSizeAttributes } from "./page-size/page-size-attributes";
+import { IPageSizeAttributes, PageOrientation } from "./page-size/page-size-attributes";
+import { FooterReferenceType, IPageNumberTypeAttributes, PageNumberType, PageNumberFormat } from ".";
+import { HeaderReferenceType } from "./header-reference/header-reference-attributes";
 
-export type SectionPropertiesOptions = IPageSizeAttributes & IPageMarginAttributes & IColumnsAttributes & IDocGridAttributesProperties;
+export type SectionPropertiesOptions = IPageSizeAttributes &
+    IPageMarginAttributes &
+    IColumnsAttributes &
+    IDocGridAttributesProperties &
+    HeaderOptions &
+    FooterOptions &
+    IPageNumberTypeAttributes;
 
 export class SectionProperties extends XmlComponent {
+    private options: SectionPropertiesOptions;
     constructor(options?: SectionPropertiesOptions) {
         super("w:sectPr");
 
@@ -29,7 +38,13 @@ export class SectionProperties extends XmlComponent {
             gutter: 0,
             space: 708,
             linePitch: 360,
-            orientation: "portrait",
+            orientation: PageOrientation.PORTRAIT,
+            headerType: HeaderReferenceType.DEFAULT,
+            headerId: 0,
+            footerType: FooterReferenceType.DEFAULT,
+            footerId: 0,
+            pageNumberStart: undefined,
+            pageNumberFormatType: PageNumberFormat.DECIMAL,
         };
 
         const mergedOptions = {
@@ -51,7 +66,25 @@ export class SectionProperties extends XmlComponent {
         );
         this.root.push(new Columns(mergedOptions.space));
         this.root.push(new DocumentGrid(mergedOptions.linePitch));
-        this.root.push(new HeaderReference());
-        this.root.push(new FooterReference());
+        this.root.push(
+            new HeaderReference({
+                headerType: mergedOptions.headerType,
+                headerId: mergedOptions.headerId,
+            }),
+        );
+        this.root.push(
+            new FooterReference({
+                footerType: mergedOptions.footerType,
+                footerId: mergedOptions.footerId,
+            }),
+        );
+
+        this.root.push(new PageNumberType(mergedOptions.pageNumberStart, mergedOptions.pageNumberFormatType));
+
+        this.options = mergedOptions;
+    }
+
+    get Options() {
+        return this.options;
     }
 }