docx 7.8.2 → 8.0.1

package/src/file/file.ts

@@ -1,314 +0,0 @@
-import { AppProperties } from "./app-properties/app-properties";
-import { ContentTypes } from "./content-types/content-types";
-import { CoreProperties, IPropertiesOptions } from "./core-properties";
-import { CustomProperties } from "./custom-properties";
-import { DocumentWrapper } from "./document-wrapper";
-import { HeaderFooterReferenceType, ISectionPropertiesOptions } from "./document/body/section-properties";
-import { IFileProperties } from "./file-properties";
-import { FooterWrapper, IDocumentFooter } from "./footer-wrapper";
-import { FootnotesWrapper } from "./footnotes-wrapper";
-import { Footer, Header } from "./header";
-import { HeaderWrapper, IDocumentHeader } from "./header-wrapper";
-import { Media } from "./media";
-import { Numbering } from "./numbering";
-import { Paragraph } from "./paragraph";
-import { Comments } from "./paragraph/run/comment-run";
-import { Relationships } from "./relationships";
-import { Settings } from "./settings";
-import { Styles } from "./styles";
-import { ExternalStylesFactory } from "./styles/external-styles-factory";
-import { DefaultStylesFactory } from "./styles/factory";
-import { Table } from "./table";
-import { TableOfContents } from "./table-of-contents";
-
-export interface ISectionOptions {
-    readonly headers?: {
-        readonly default?: Header;
-        readonly first?: Header;
-        readonly even?: Header;
-    };
-    readonly footers?: {
-        readonly default?: Footer;
-        readonly first?: Footer;
-        readonly even?: Footer;
-    };
-    readonly properties?: ISectionPropertiesOptions;
-    readonly children: readonly (Paragraph | Table | TableOfContents)[];
-}
-
-export class File {
-    // eslint-disable-next-line functional/prefer-readonly-type
-    private currentRelationshipId: number = 1;
-
-    private readonly documentWrapper: DocumentWrapper;
-    // eslint-disable-next-line functional/prefer-readonly-type
-    private readonly headers: IDocumentHeader[] = [];
-    // eslint-disable-next-line functional/prefer-readonly-type
-    private readonly footers: IDocumentFooter[] = [];
-    private readonly coreProperties: CoreProperties;
-    private readonly numbering: Numbering;
-    private readonly media: Media;
-    private readonly fileRelationships: Relationships;
-    private readonly footnotesWrapper: FootnotesWrapper;
-    private readonly settings: Settings;
-    private readonly contentTypes: ContentTypes;
-    private readonly customProperties: CustomProperties;
-    private readonly appProperties: AppProperties;
-    private readonly styles: Styles;
-    private readonly comments: Comments;
-
-    public constructor(options: IPropertiesOptions, fileProperties: IFileProperties = {}) {
-        this.coreProperties = new CoreProperties({
-            ...options,
-            creator: options.creator ?? "Un-named",
-            revision: options.revision ?? 1,
-            lastModifiedBy: options.lastModifiedBy ?? "Un-named",
-        });
-
-        this.numbering = new Numbering(options.numbering ? options.numbering : { config: [] });
-
-        this.comments = new Comments(options.comments ?? { children: [] });
-        this.fileRelationships = new Relationships();
-        this.customProperties = new CustomProperties(options.customProperties ?? []);
-        this.appProperties = new AppProperties();
-        this.footnotesWrapper = new FootnotesWrapper();
-        this.contentTypes = new ContentTypes();
-        this.documentWrapper = new DocumentWrapper({ background: options.background });
-        this.settings = new Settings({
-            compatibilityModeVersion: options.compatabilityModeVersion,
-            compatibility: options.compatibility,
-            evenAndOddHeaders: options.evenAndOddHeaderAndFooters ? true : false,
-            trackRevisions: options.features?.trackRevisions,
-            updateFields: options.features?.updateFields,
-        });
-
-        this.media = fileProperties.template && fileProperties.template.media ? fileProperties.template.media : new Media();
-
-        if (fileProperties.template) {
-            this.currentRelationshipId = fileProperties.template.currentRelationshipId + 1;
-        }
-
-        // set up styles
-        if (fileProperties.template && options.externalStyles) {
-            throw Error("can not use both template and external styles");
-        }
-        if (fileProperties.template && fileProperties.template.styles) {
-            const stylesFactory = new ExternalStylesFactory();
-            this.styles = stylesFactory.newInstance(fileProperties.template.styles);
-        } else if (options.externalStyles) {
-            const stylesFactory = new ExternalStylesFactory();
-            this.styles = stylesFactory.newInstance(options.externalStyles);
-        } else if (options.styles) {
-            const stylesFactory = new DefaultStylesFactory();
-            const defaultStyles = stylesFactory.newInstance(options.styles.default);
-            this.styles = new Styles({
-                ...defaultStyles,
-                ...options.styles,
-            });
-        } else {
-            const stylesFactory = new DefaultStylesFactory();
-            this.styles = new Styles(stylesFactory.newInstance());
-        }
-
-        this.addDefaultRelationships();
-
-        if (fileProperties.template && fileProperties.template.headers) {
-            for (const templateHeader of fileProperties.template.headers) {
-                this.addHeaderToDocument(templateHeader.header, templateHeader.type);
-            }
-        }
-
-        if (fileProperties.template && fileProperties.template.footers) {
-            for (const templateFooter of fileProperties.template.footers) {
-                this.addFooterToDocument(templateFooter.footer, templateFooter.type);
-            }
-        }
-
-        for (const section of options.sections) {
-            this.addSection(section);
-        }
-
-        if (options.footnotes) {
-            // eslint-disable-next-line guard-for-in
-            for (const key in options.footnotes) {
-                this.footnotesWrapper.View.createFootNote(parseFloat(key), options.footnotes[key].children);
-            }
-        }
-    }
-
-    private addSection({ headers = {}, footers = {}, children, properties }: ISectionOptions): void {
-        this.documentWrapper.View.Body.addSection({
-            ...properties,
-            headerWrapperGroup: {
-                default: headers.default ? this.createHeader(headers.default) : undefined,
-                first: headers.first ? this.createHeader(headers.first) : undefined,
-                even: headers.even ? this.createHeader(headers.even) : undefined,
-            },
-            footerWrapperGroup: {
-                default: footers.default ? this.createFooter(footers.default) : undefined,
-                first: footers.first ? this.createFooter(footers.first) : undefined,
-                even: footers.even ? this.createFooter(footers.even) : undefined,
-            },
-        });
-
-        for (const child of children) {
-            this.documentWrapper.View.add(child);
-        }
-    }
-
-    private createHeader(header: Header): HeaderWrapper {
-        // eslint-disable-next-line functional/immutable-data
-        const wrapper = new HeaderWrapper(this.media, this.currentRelationshipId++);
-
-        for (const child of header.options.children) {
-            wrapper.add(child);
-        }
-
-        this.addHeaderToDocument(wrapper);
-        return wrapper;
-    }
-
-    private createFooter(footer: Footer): FooterWrapper {
-        // eslint-disable-next-line functional/immutable-data
-        const wrapper = new FooterWrapper(this.media, this.currentRelationshipId++);
-
-        for (const child of footer.options.children) {
-            wrapper.add(child);
-        }
-
-        this.addFooterToDocument(wrapper);
-        return wrapper;
-    }
-
-    private addHeaderToDocument(header: HeaderWrapper, type: HeaderFooterReferenceType = HeaderFooterReferenceType.DEFAULT): void {
-        // eslint-disable-next-line functional/immutable-data
-        this.headers.push({ header, type });
-        this.documentWrapper.Relationships.createRelationship(
-            header.View.ReferenceId,
-            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/header",
-            `header${this.headers.length}.xml`,
-        );
-        this.contentTypes.addHeader(this.headers.length);
-    }
-
-    private addFooterToDocument(footer: FooterWrapper, type: HeaderFooterReferenceType = HeaderFooterReferenceType.DEFAULT): void {
-        // eslint-disable-next-line functional/immutable-data
-        this.footers.push({ footer, type });
-        this.documentWrapper.Relationships.createRelationship(
-            footer.View.ReferenceId,
-            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer",
-            `footer${this.footers.length}.xml`,
-        );
-        this.contentTypes.addFooter(this.footers.length);
-    }
-
-    private addDefaultRelationships(): void {
-        this.fileRelationships.createRelationship(
-            1,
-            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument",
-            "word/document.xml",
-        );
-        this.fileRelationships.createRelationship(
-            2,
-            "http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties",
-            "docProps/core.xml",
-        );
-        this.fileRelationships.createRelationship(
-            3,
-            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties",
-            "docProps/app.xml",
-        );
-        this.fileRelationships.createRelationship(
-            4,
-            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/custom-properties",
-            "docProps/custom.xml",
-        );
-
-        this.documentWrapper.Relationships.createRelationship(
-            // eslint-disable-next-line functional/immutable-data
-            this.currentRelationshipId++,
-            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles",
-            "styles.xml",
-        );
-        this.documentWrapper.Relationships.createRelationship(
-            // eslint-disable-next-line functional/immutable-data
-            this.currentRelationshipId++,
-            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering",
-            "numbering.xml",
-        );
-        this.documentWrapper.Relationships.createRelationship(
-            // eslint-disable-next-line functional/immutable-data
-            this.currentRelationshipId++,
-            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/footnotes",
-            "footnotes.xml",
-        );
-        this.documentWrapper.Relationships.createRelationship(
-            // eslint-disable-next-line functional/immutable-data
-            this.currentRelationshipId++,
-            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings",
-            "settings.xml",
-        );
-        this.documentWrapper.Relationships.createRelationship(
-            // eslint-disable-next-line functional/immutable-data
-            this.currentRelationshipId++,
-            "http://schemas.openxmlformats.org/officeDocument/2006/relationships/comments",
-            "comments.xml",
-        );
-    }
-
-    public get Document(): DocumentWrapper {
-        return this.documentWrapper;
-    }
-
-    public get Styles(): Styles {
-        return this.styles;
-    }
-
-    public get CoreProperties(): CoreProperties {
-        return this.coreProperties;
-    }
-
-    public get Numbering(): Numbering {
-        return this.numbering;
-    }
-
-    public get Media(): Media {
-        return this.media;
-    }
-
-    public get FileRelationships(): Relationships {
-        return this.fileRelationships;
-    }
-
-    public get Headers(): readonly HeaderWrapper[] {
-        return this.headers.map((item) => item.header);
-    }
-
-    public get Footers(): readonly FooterWrapper[] {
-        return this.footers.map((item) => item.footer);
-    }
-
-    public get ContentTypes(): ContentTypes {
-        return this.contentTypes;
-    }
-
-    public get CustomProperties(): CustomProperties {
-        return this.customProperties;
-    }
-
-    public get AppProperties(): AppProperties {
-        return this.appProperties;
-    }
-
-    public get FootNotes(): FootnotesWrapper {
-        return this.footnotesWrapper;
-    }
-
-    public get Settings(): Settings {
-        return this.settings;
-    }
-
-    public get Comments(): Comments {
-        return this.comments;
-    }
-}

package/src/file/footer/footer-attributes.ts

@@ -1,51 +0,0 @@
-import { XmlAttributeComponent } from "@file/xml-components";
-
-export class FooterAttributes extends XmlAttributeComponent<{
-    readonly wpc?: string;
-    readonly mc?: string;
-    readonly o?: string;
-    readonly r?: string;
-    readonly m?: string;
-    readonly v?: string;
-    readonly wp14?: string;
-    readonly wp?: string;
-    readonly w10?: string;
-    readonly w?: string;
-    readonly w14?: string;
-    readonly w15?: string;
-    readonly wpg?: string;
-    readonly wpi?: string;
-    readonly wne?: string;
-    readonly wps?: string;
-    readonly cp?: string;
-    readonly dc?: string;
-    readonly dcterms?: string;
-    readonly dcmitype?: string;
-    readonly xsi?: string;
-    readonly type?: string;
-}> {
-    protected readonly xmlKeys = {
-        wpc: "xmlns:wpc",
-        mc: "xmlns:mc",
-        o: "xmlns:o",
-        r: "xmlns:r",
-        m: "xmlns:m",
-        v: "xmlns:v",
-        wp14: "xmlns:wp14",
-        wp: "xmlns:wp",
-        w10: "xmlns:w10",
-        w: "xmlns:w",
-        w14: "xmlns:w14",
-        w15: "xmlns:w15",
-        wpg: "xmlns:wpg",
-        wpi: "xmlns:wpi",
-        wne: "xmlns:wne",
-        wps: "xmlns:wps",
-        cp: "xmlns:cp",
-        dc: "xmlns:dc",
-        dcterms: "xmlns:dcterms",
-        dcmitype: "xmlns:dcmitype",
-        xsi: "xmlns:xsi",
-        type: "xsi:type",
-    };
-}

package/src/file/footer/footer.spec.ts

@@ -1,47 +0,0 @@
-import { expect } from "chai";
-
-import { Formatter } from "@export/formatter";
-
-import { Paragraph } from "../paragraph";
-import { Footer } from "./footer";
-
-describe("Footer", () => {
-    it("should create", () => {
-        const footer = new Footer(1);
-
-        const tree = new Formatter().format(footer);
-
-        expect(tree).to.deep.equal({
-            "w:ftr": {
-                _attr: {
-                    "xmlns:m": "http://schemas.openxmlformats.org/officeDocument/2006/math",
-                    "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:v": "urn:schemas-microsoft-com:vml",
-                    "xmlns:w": "http://schemas.openxmlformats.org/wordprocessingml/2006/main",
-                    "xmlns:w10": "urn:schemas-microsoft-com:office:word",
-                    "xmlns:w14": "http://schemas.microsoft.com/office/word/2010/wordml",
-                    "xmlns:w15": "http://schemas.microsoft.com/office/word/2012/wordml",
-                    "xmlns:wne": "http://schemas.microsoft.com/office/word/2006/wordml",
-                    "xmlns:wp": "http://schemas.openxmlformats.org/drawingml/2006/wordprocessingDrawing",
-                    "xmlns:wp14": "http://schemas.microsoft.com/office/word/2010/wordprocessingDrawing",
-                    "xmlns:wpc": "http://schemas.microsoft.com/office/word/2010/wordprocessingCanvas",
-                    "xmlns:wpg": "http://schemas.microsoft.com/office/word/2010/wordprocessingGroup",
-                    "xmlns:wpi": "http://schemas.microsoft.com/office/word/2010/wordprocessingInk",
-                    "xmlns:wps": "http://schemas.microsoft.com/office/word/2010/wordprocessingShape",
-                },
-            },
-        });
-    });
-
-    it("should create with initContent", () => {
-        const header = new Footer(1, new Paragraph({}));
-
-        const tree = new Formatter().format(header);
-
-        expect(tree).to.deep.equal({
-            "w:ftr": {},
-        });
-    });
-});

package/src/file/footer/footer.ts

@@ -1,44 +0,0 @@
-// http://officeopenxml.com/WPfooters.php
-import { InitializableXmlComponent, XmlComponent } from "@file/xml-components";
-import { Paragraph } from "../paragraph";
-import { Table } from "../table";
-import { FooterAttributes } from "./footer-attributes";
-
-export class Footer extends InitializableXmlComponent {
-    private readonly refId: number;
-
-    public constructor(referenceNumber: number, initContent?: XmlComponent) {
-        super("w:ftr", initContent);
-        this.refId = referenceNumber;
-        if (!initContent) {
-            this.root.push(
-                new FooterAttributes({
-                    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",
-                }),
-            );
-        }
-    }
-
-    public get ReferenceId(): number {
-        return this.refId;
-    }
-
-    public add(item: Paragraph | Table): void {
-        this.root.push(item);
-    }
-}

package/src/file/footer/index.ts

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

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

@@ -1,58 +0,0 @@
-import { expect } from "chai";
-import * as sinon from "sinon";
-
-import { FooterWrapper } from "./footer-wrapper";
-import { Media } from "./media";
-import { Paragraph } from "./paragraph";
-import { Table, TableCell, TableRow } from "./table";
-
-describe("FooterWrapper", () => {
-    describe("#add", () => {
-        it("should call the underlying footer's addParagraph", () => {
-            const file = new FooterWrapper(new Media(), 1);
-            const spy = sinon.spy(file.View, "add");
-            file.add(new Paragraph({}));
-
-            expect(spy.called).to.equal(true);
-        });
-
-        it("should call the underlying footer's addParagraph", () => {
-            const file = new FooterWrapper(new Media(), 1);
-            const spy = sinon.spy(file.View, "add");
-            file.add(
-                new Table({
-                    rows: [
-                        new TableRow({
-                            children: [
-                                new TableCell({
-                                    children: [new Paragraph("hello")],
-                                }),
-                            ],
-                        }),
-                    ],
-                }),
-            );
-
-            expect(spy.called).to.equal(true);
-        });
-    });
-
-    describe("#addChildElement", () => {
-        it("should call the underlying footer's addChildElement", () => {
-            const file = new FooterWrapper(new Media(), 1);
-            const spy = sinon.spy(file.View, "addChildElement");
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            file.addChildElement({} as any);
-
-            expect(spy.called).to.equal(true);
-        });
-    });
-
-    describe("#Media", () => {
-        it("should get Media", () => {
-            const media = new Media();
-            const file = new FooterWrapper(media, 1);
-            expect(file.Media).to.equal(media);
-        });
-    });
-});

package/src/file/footer-wrapper.ts

@@ -1,44 +0,0 @@
-import { XmlComponent } from "@file/xml-components";
-
-import { HeaderFooterReferenceType } from "./document";
-import { IViewWrapper } from "./document-wrapper";
-import { Footer } from "./footer/footer";
-import { Media } from "./media";
-import { Paragraph } from "./paragraph";
-import { Relationships } from "./relationships";
-import { Table } from "./table";
-
-export interface IDocumentFooter {
-    readonly footer: FooterWrapper;
-    readonly type: HeaderFooterReferenceType;
-}
-
-export class FooterWrapper implements IViewWrapper {
-    private readonly footer: Footer;
-    private readonly relationships: Relationships;
-
-    public constructor(private readonly media: Media, referenceId: number, initContent?: XmlComponent) {
-        this.footer = new Footer(referenceId, initContent);
-        this.relationships = new Relationships();
-    }
-
-    public add(item: Paragraph | Table): void {
-        this.footer.add(item);
-    }
-
-    public addChildElement(childElement: XmlComponent): void {
-        this.footer.addChildElement(childElement);
-    }
-
-    public get View(): Footer {
-        return this.footer;
-    }
-
-    public get Relationships(): Relationships {
-        return this.relationships;
-    }
-
-    public get Media(): Media {
-        return this.media;
-    }
-}

package/src/file/footnotes/footnote/footnote-attributes.ts

@@ -1,11 +0,0 @@
-import { XmlAttributeComponent } from "@file/xml-components";
-
-export class FootnoteAttributes extends XmlAttributeComponent<{
-    readonly type?: string;
-    readonly id: number;
-}> {
-    protected readonly xmlKeys = {
-        type: "w:type",
-        id: "w:id",
-    };
-}