docx 7.1.2 → 7.4.0

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-    <img alt="clippy the assistant" src="https://i.imgur.com/37uBGhO.gif">
+    <img src="./logo/logo-animate.svg" width="100%" height="300" alt="clippy the assistant">
 </p>
 
 <p align="center">
@@ -11,7 +11,6 @@
 [![NPM version][npm-image]][npm-url]
 [![Downloads per month][downloads-image]][downloads-url]
 [![GitHub Action Workflow Status][github-actions-workflow-image]][github-actions-workflow-url]
-[![Dependency Status][daviddm-image]][daviddm-url]
 [![Known Vulnerabilities][snky-image]][snky-url]
 [![Chat on Gitter][gitter-image]][gitter-url]
 [![PRs Welcome][pr-image]][pr-url]
@@ -85,8 +84,9 @@ Read the contribution guidelines [here](https://docx.js.org/#/contribution-guide
 [<img src="https://i.imgur.com/QEZXU5b.png" alt="drawing" height="50"/>](https://www.beekast.com/)
 [<img src="https://i.imgur.com/XVU6aoi.png" alt="drawing" height="50"/>](https://herraizsoto.com/)
 [<img src="https://i.imgur.com/fn1xccG.png" alt="drawing" height="50"/>](http://www.ativer.com.br/)
-[<img src="https://i.imgur.com/cmykN7c.png" alt="drawing" />](https://www.arity.co/)
+[<img src="https://i.imgur.com/cmykN7c.png" alt="drawing"/>](https://www.arity.co/)
 [<img src="https://i.imgur.com/PXo25um.png" alt="drawing" height="50"/>](https://www.circadianrisk.com/)
+[<img src="https://i.imgur.com/AKGhtlh.png" alt="drawing"/>](https://lexense.com/)
 
 
 ...and many more!
@@ -104,8 +104,6 @@ Made with 💖
 [downloads-url]: https://npmjs.org/package/docx
 [github-actions-workflow-image]: https://github.com/dolanmiu/docx/workflows/Default/badge.svg
 [github-actions-workflow-url]: https://github.com/dolanmiu/docx/actions
-[daviddm-image]: https://david-dm.org/dolanmiu/docx.svg?theme=shields.io
-[daviddm-url]: https://david-dm.org/dolanmiu/docx
 [snky-image]: https://snyk.io/test/github/dolanmiu/docx/badge.svg
 [snky-url]: https://snyk.io/test/github/dolanmiu/docx
 [gitter-image]: https://badges.gitter.im/dolanmiu/docx.svg

package/build/export/formatter.d.ts

@@ -1,4 +1,4 @@
-import { BaseXmlComponent, IContext, IXmlableObject } from "../file/xml-components";
-export declare class Formatter {
-    format(input: BaseXmlComponent, context?: IContext): IXmlableObject;
-}
+import { BaseXmlComponent, IContext, IXmlableObject } from "../file/xml-components";
+export declare class Formatter {
+    format(input: BaseXmlComponent, context?: IContext): IXmlableObject;
+}

package/build/export/index.d.ts

@@ -1 +1 @@
-export * from "./packer/packer";
+export * from "./packer/packer";

package/build/export/packer/image-replacer.d.ts

@@ -1,5 +1,5 @@
-import { IMediaData, Media } from "../../file/media";
-export declare class ImageReplacer {
-    replace(xmlData: string, mediaData: IMediaData[], offset: number): string;
-    getMediaData(xmlData: string, media: Media): IMediaData[];
-}
+import { IMediaData, Media } from "../../file/media";
+export declare class ImageReplacer {
+    replace(xmlData: string, mediaData: IMediaData[], offset: number): string;
+    getMediaData(xmlData: string, media: Media): IMediaData[];
+}

package/build/export/packer/next-compiler.d.ts

@@ -1,10 +1,11 @@
-import * as JSZip from "jszip";
-import { File } from "../../file";
-export declare class Compiler {
-    private readonly formatter;
-    private readonly imageReplacer;
-    private readonly numberingReplacer;
-    constructor();
-    compile(file: File, prettifyXml?: boolean): JSZip;
-    private xmlifyFile;
-}
+import * as JSZip from "jszip";
+import { File } from "../../file/file";
+import { PrettityType } from "./packer";
+export declare class Compiler {
+    private readonly formatter;
+    private readonly imageReplacer;
+    private readonly numberingReplacer;
+    constructor();
+    compile(file: File, prettifyXml?: boolean | PrettityType): JSZip;
+    private xmlifyFile;
+}

package/build/export/packer/numbering-replacer.d.ts

@@ -1,4 +1,4 @@
-import { ConcreteNumbering } from "../../file";
-export declare class NumberingReplacer {
-    replace(xmlData: string, concreteNumberings: ConcreteNumbering[]): string;
-}
+import { ConcreteNumbering } from "../../file/numbering";
+export declare class NumberingReplacer {
+    replace(xmlData: string, concreteNumberings: ConcreteNumbering[]): string;
+}

package/build/export/packer/packer.d.ts

@@ -1,8 +1,14 @@
-/// <reference types="node" />
-import { File } from "../../file";
-export declare class Packer {
-    static toBuffer(file: File, prettify?: boolean): Promise<Buffer>;
-    static toBase64String(file: File, prettify?: boolean): Promise<string>;
-    static toBlob(file: File, prettify?: boolean): Promise<Blob>;
-    private static readonly compiler;
-}
+/// <reference types="node" />
+import { File } from "../../file/file";
+export declare enum PrettityType {
+    NONE = "",
+    WITH_2_BLANKS = "  ",
+    WITH_4_BLANKS = "    ",
+    WITH_TAB = "\t"
+}
+export declare class Packer {
+    static toBuffer(file: File, prettify?: boolean | PrettityType): Promise<Buffer>;
+    static toBase64String(file: File, prettify?: boolean | PrettityType): Promise<string>;
+    static toBlob(file: File, prettify?: boolean | PrettityType): Promise<Blob>;
+    private static readonly compiler;
+}

package/build/file/app-properties/app-properties-attributes.d.ts

@@ -1,10 +1,10 @@
-import { XmlAttributeComponent } from "../../file/xml-components";
-export declare class AppPropertiesAttributes extends XmlAttributeComponent<{
-    readonly xmlns: string;
-    readonly vt: string;
-}> {
-    protected readonly xmlKeys: {
-        xmlns: string;
-        vt: string;
-    };
-}
+import { XmlAttributeComponent } from "../../file/xml-components";
+export declare class AppPropertiesAttributes extends XmlAttributeComponent<{
+    readonly xmlns: string;
+    readonly vt: string;
+}> {
+    protected readonly xmlKeys: {
+        xmlns: string;
+        vt: string;
+    };
+}

package/build/file/app-properties/app-properties.d.ts

@@ -1,4 +1,4 @@
-import { XmlComponent } from "../../file/xml-components";
-export declare class AppProperties extends XmlComponent {
-    constructor();
-}
+import { XmlComponent } from "../../file/xml-components";
+export declare class AppProperties extends XmlComponent {
+    constructor();
+}

package/build/file/border/border.d.ts

@@ -1,39 +1,39 @@
-import { XmlComponent } from "../../file/xml-components";
-export interface IBorderOptions {
-    readonly style: BorderStyle;
-    readonly color?: string;
-    readonly size?: number;
-    readonly space?: number;
-}
-export declare class BorderElement extends XmlComponent {
-    constructor(elementName: string, { color, size, space, style }: IBorderOptions);
-}
-export declare enum BorderStyle {
-    SINGLE = "single",
-    DASH_DOT_STROKED = "dashDotStroked",
-    DASHED = "dashed",
-    DASH_SMALL_GAP = "dashSmallGap",
-    DOT_DASH = "dotDash",
-    DOT_DOT_DASH = "dotDotDash",
-    DOTTED = "dotted",
-    DOUBLE = "double",
-    DOUBLE_WAVE = "doubleWave",
-    INSET = "inset",
-    NIL = "nil",
-    NONE = "none",
-    OUTSET = "outset",
-    THICK = "thick",
-    THICK_THIN_LARGE_GAP = "thickThinLargeGap",
-    THICK_THIN_MEDIUM_GAP = "thickThinMediumGap",
-    THICK_THIN_SMALL_GAP = "thickThinSmallGap",
-    THIN_THICK_LARGE_GAP = "thinThickLargeGap",
-    THIN_THICK_MEDIUM_GAP = "thinThickMediumGap",
-    THIN_THICK_SMALL_GAP = "thinThickSmallGap",
-    THIN_THICK_THIN_LARGE_GAP = "thinThickThinLargeGap",
-    THIN_THICK_THIN_MEDIUM_GAP = "thinThickThinMediumGap",
-    THIN_THICK_THIN_SMALL_GAP = "thinThickThinSmallGap",
-    THREE_D_EMBOSS = "threeDEmboss",
-    THREE_D_ENGRAVE = "threeDEngrave",
-    TRIPLE = "triple",
-    WAVE = "wave"
-}
+import { XmlComponent } from "../../file/xml-components";
+export interface IBorderOptions {
+    readonly style: BorderStyle;
+    readonly color?: string;
+    readonly size?: number;
+    readonly space?: number;
+}
+export declare class BorderElement extends XmlComponent {
+    constructor(elementName: string, { color, size, space, style }: IBorderOptions);
+}
+export declare enum BorderStyle {
+    SINGLE = "single",
+    DASH_DOT_STROKED = "dashDotStroked",
+    DASHED = "dashed",
+    DASH_SMALL_GAP = "dashSmallGap",
+    DOT_DASH = "dotDash",
+    DOT_DOT_DASH = "dotDotDash",
+    DOTTED = "dotted",
+    DOUBLE = "double",
+    DOUBLE_WAVE = "doubleWave",
+    INSET = "inset",
+    NIL = "nil",
+    NONE = "none",
+    OUTSET = "outset",
+    THICK = "thick",
+    THICK_THIN_LARGE_GAP = "thickThinLargeGap",
+    THICK_THIN_MEDIUM_GAP = "thickThinMediumGap",
+    THICK_THIN_SMALL_GAP = "thickThinSmallGap",
+    THIN_THICK_LARGE_GAP = "thinThickLargeGap",
+    THIN_THICK_MEDIUM_GAP = "thinThickMediumGap",
+    THIN_THICK_SMALL_GAP = "thinThickSmallGap",
+    THIN_THICK_THIN_LARGE_GAP = "thinThickThinLargeGap",
+    THIN_THICK_THIN_MEDIUM_GAP = "thinThickThinMediumGap",
+    THIN_THICK_THIN_SMALL_GAP = "thinThickThinSmallGap",
+    THREE_D_EMBOSS = "threeDEmboss",
+    THREE_D_ENGRAVE = "threeDEngrave",
+    TRIPLE = "triple",
+    WAVE = "wave"
+}

package/build/file/border/index.d.ts

@@ -1 +1 @@
-export * from "./border";
+export * from "./border";

package/build/file/content-types/content-types-attributes.d.ts

@@ -1,8 +1,8 @@
-import { XmlAttributeComponent } from "../../file/xml-components";
-export declare class ContentTypeAttributes extends XmlAttributeComponent<{
-    readonly xmlns?: string;
-}> {
-    protected readonly xmlKeys: {
-        xmlns: string;
-    };
-}
+import { XmlAttributeComponent } from "../../file/xml-components";
+export declare class ContentTypeAttributes extends XmlAttributeComponent<{
+    readonly xmlns?: string;
+}> {
+    protected readonly xmlKeys: {
+        xmlns: string;
+    };
+}

package/build/file/content-types/content-types.d.ts

@@ -1,6 +1,6 @@
-import { XmlComponent } from "../../file/xml-components";
-export declare class ContentTypes extends XmlComponent {
-    constructor();
-    addFooter(index: number): void;
-    addHeader(index: number): void;
-}
+import { XmlComponent } from "../../file/xml-components";
+export declare class ContentTypes extends XmlComponent {
+    constructor();
+    addFooter(index: number): void;
+    addHeader(index: number): void;
+}

package/build/file/content-types/default/default-attributes.d.ts

@@ -1,10 +1,10 @@
-import { XmlAttributeComponent } from "../../../file/xml-components";
-export declare class DefaultAttributes extends XmlAttributeComponent<{
-    readonly contentType: string;
-    readonly extension?: string;
-}> {
-    protected readonly xmlKeys: {
-        contentType: string;
-        extension: string;
-    };
-}
+import { XmlAttributeComponent } from "../../../file/xml-components";
+export declare class DefaultAttributes extends XmlAttributeComponent<{
+    readonly contentType: string;
+    readonly extension?: string;
+}> {
+    protected readonly xmlKeys: {
+        contentType: string;
+        extension: string;
+    };
+}

package/build/file/content-types/default/default.d.ts

@@ -1,4 +1,4 @@
-import { XmlComponent } from "../../../file/xml-components";
-export declare class Default extends XmlComponent {
-    constructor(contentType: string, extension?: string);
-}
+import { XmlComponent } from "../../../file/xml-components";
+export declare class Default extends XmlComponent {
+    constructor(contentType: string, extension?: string);
+}

package/build/file/content-types/override/override-attributes.d.ts

@@ -1,10 +1,10 @@
-import { XmlAttributeComponent } from "../../../file/xml-components";
-export declare class OverrideAttributes extends XmlAttributeComponent<{
-    readonly contentType: string;
-    readonly partName?: string;
-}> {
-    protected readonly xmlKeys: {
-        contentType: string;
-        partName: string;
-    };
-}
+import { XmlAttributeComponent } from "../../../file/xml-components";
+export declare class OverrideAttributes extends XmlAttributeComponent<{
+    readonly contentType: string;
+    readonly partName?: string;
+}> {
+    protected readonly xmlKeys: {
+        contentType: string;
+        partName: string;
+    };
+}

package/build/file/content-types/override/override.d.ts

@@ -1,4 +1,4 @@
-import { XmlComponent } from "../../../file/xml-components";
-export declare class Override extends XmlComponent {
-    constructor(contentType: string, partName?: string);
-}
+import { XmlComponent } from "../../../file/xml-components";
+export declare class Override extends XmlComponent {
+    constructor(contentType: string, partName?: string);
+}

package/build/file/core-properties/index.d.ts

@@ -1 +1 @@
-export * from "./properties";
+export * from "./properties";

package/build/file/core-properties/properties.d.ts

@@ -1,36 +1,38 @@
-import { XmlComponent } from "../../file/xml-components";
-import { ICustomPropertyOptions } from "../custom-properties";
-import { IDocumentBackgroundOptions } from "../document";
-import { ISectionOptions } from "../file";
-import { INumberingOptions } from "../numbering";
-import { Paragraph } from "../paragraph";
-import { IStylesOptions } from "../styles";
-export interface IPropertiesOptions {
-    readonly sections: ISectionOptions[];
-    readonly title?: string;
-    readonly subject?: string;
-    readonly creator?: string;
-    readonly keywords?: string;
-    readonly description?: string;
-    readonly lastModifiedBy?: string;
-    readonly revision?: number;
-    readonly externalStyles?: string;
-    readonly styles?: IStylesOptions;
-    readonly numbering?: INumberingOptions;
-    readonly footnotes?: {
-        readonly [key: string]: {
-            readonly children: Paragraph[];
-        };
-    };
-    readonly background?: IDocumentBackgroundOptions;
-    readonly features?: {
-        readonly trackRevisions?: boolean;
-        readonly updateFields?: boolean;
-    };
-    readonly compatabilityModeVersion?: number;
-    readonly customProperties?: ICustomPropertyOptions[];
-    readonly evenAndOddHeaderAndFooters?: boolean;
-}
-export declare class CoreProperties extends XmlComponent {
-    constructor(options: Omit<IPropertiesOptions, "sections">);
-}
+import { ICommentsOptions } from "../../file/paragraph/run/comment-run";
+import { XmlComponent } from "../../file/xml-components";
+import { ICustomPropertyOptions } from "../custom-properties";
+import { IDocumentBackgroundOptions } from "../document";
+import { ISectionOptions } from "../file";
+import { INumberingOptions } from "../numbering";
+import { Paragraph } from "../paragraph";
+import { IStylesOptions } from "../styles";
+export interface IPropertiesOptions {
+    readonly sections: ISectionOptions[];
+    readonly title?: string;
+    readonly subject?: string;
+    readonly creator?: string;
+    readonly keywords?: string;
+    readonly description?: string;
+    readonly lastModifiedBy?: string;
+    readonly revision?: number;
+    readonly externalStyles?: string;
+    readonly styles?: IStylesOptions;
+    readonly numbering?: INumberingOptions;
+    readonly comments?: ICommentsOptions;
+    readonly footnotes?: {
+        readonly [key: string]: {
+            readonly children: Paragraph[];
+        };
+    };
+    readonly background?: IDocumentBackgroundOptions;
+    readonly features?: {
+        readonly trackRevisions?: boolean;
+        readonly updateFields?: boolean;
+    };
+    readonly compatabilityModeVersion?: number;
+    readonly customProperties?: ICustomPropertyOptions[];
+    readonly evenAndOddHeaderAndFooters?: boolean;
+}
+export declare class CoreProperties extends XmlComponent {
+    constructor(options: Omit<IPropertiesOptions, "sections">);
+}

package/build/file/custom-properties/custom-properties-attributes.d.ts

@@ -1,10 +1,10 @@
-import { XmlAttributeComponent } from "../../file/xml-components";
-export declare class CustomPropertiesAttributes extends XmlAttributeComponent<{
-    readonly xmlns: string;
-    readonly vt: string;
-}> {
-    protected readonly xmlKeys: {
-        xmlns: string;
-        vt: string;
-    };
-}
+import { XmlAttributeComponent } from "../../file/xml-components";
+export declare class CustomPropertiesAttributes extends XmlAttributeComponent<{
+    readonly xmlns: string;
+    readonly vt: string;
+}> {
+    protected readonly xmlKeys: {
+        xmlns: string;
+        vt: string;
+    };
+}

package/build/file/custom-properties/custom-properties.d.ts

@@ -1,9 +1,9 @@
-import { IContext, IXmlableObject, XmlComponent } from "../../file/xml-components";
-import { ICustomPropertyOptions } from "./custom-property";
-export declare class CustomProperties extends XmlComponent {
-    private nextId;
-    private readonly properties;
-    constructor(properties: ICustomPropertyOptions[]);
-    prepForXml(context: IContext): IXmlableObject | undefined;
-    addCustomProperty(property: ICustomPropertyOptions): void;
-}
+import { IContext, IXmlableObject, XmlComponent } from "../../file/xml-components";
+import { ICustomPropertyOptions } from "./custom-property";
+export declare class CustomProperties extends XmlComponent {
+    private nextId;
+    private readonly properties;
+    constructor(properties: ICustomPropertyOptions[]);
+    prepForXml(context: IContext): IXmlableObject | undefined;
+    addCustomProperty(property: ICustomPropertyOptions): void;
+}

package/build/file/custom-properties/custom-property-attributes.d.ts

@@ -1,12 +1,12 @@
-import { XmlAttributeComponent } from "../../file/xml-components";
-export declare class CustomPropertyAttributes extends XmlAttributeComponent<{
-    readonly fmtid: string;
-    readonly pid: string;
-    readonly name: string;
-}> {
-    protected readonly xmlKeys: {
-        fmtid: string;
-        pid: string;
-        name: string;
-    };
-}
+import { XmlAttributeComponent } from "../../file/xml-components";
+export declare class CustomPropertyAttributes extends XmlAttributeComponent<{
+    readonly fmtid: string;
+    readonly pid: string;
+    readonly name: string;
+}> {
+    protected readonly xmlKeys: {
+        fmtid: string;
+        pid: string;
+        name: string;
+    };
+}

package/build/file/custom-properties/custom-property.d.ts

@@ -1,11 +1,11 @@
-import { XmlComponent } from "../../file/xml-components";
-export interface ICustomPropertyOptions {
-    readonly name: string;
-    readonly value: string;
-}
-export declare class CustomProperty extends XmlComponent {
-    constructor(id: number, properties: ICustomPropertyOptions);
-}
-export declare class CustomPropertyValue extends XmlComponent {
-    constructor(value: string);
-}
+import { XmlComponent } from "../../file/xml-components";
+export interface ICustomPropertyOptions {
+    readonly name: string;
+    readonly value: string;
+}
+export declare class CustomProperty extends XmlComponent {
+    constructor(id: number, properties: ICustomPropertyOptions);
+}
+export declare class CustomPropertyValue extends XmlComponent {
+    constructor(value: string);
+}

package/build/file/custom-properties/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./custom-properties";
-export * from "./custom-property";
+export * from "./custom-properties";
+export * from "./custom-property";

package/build/file/document/body/body.d.ts

@@ -1,10 +1,10 @@
-import { IContext, IXmlableObject, XmlComponent } from "../../../file/xml-components";
-import { ISectionPropertiesOptions } from "./section-properties/section-properties";
-export declare class Body extends XmlComponent {
-    private readonly sections;
-    constructor();
-    addSection(options: ISectionPropertiesOptions): void;
-    prepForXml(context: IContext): IXmlableObject | undefined;
-    push(component: XmlComponent): void;
-    private createSectionParagraph;
-}
+import { IContext, IXmlableObject, XmlComponent } from "../../../file/xml-components";
+import { ISectionPropertiesOptions } from "./section-properties/section-properties";
+export declare class Body extends XmlComponent {
+    private readonly sections;
+    constructor();
+    addSection(options: ISectionPropertiesOptions): void;
+    prepForXml(context: IContext): IXmlableObject | undefined;
+    push(component: XmlComponent): void;
+    private createSectionParagraph;
+}

package/build/file/document/body/index.d.ts

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

package/build/file/document/body/section-properties/index.d.ts

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

package/build/file/document/body/section-properties/properties/column.d.ts

@@ -1,14 +1,14 @@
-import { XmlAttributeComponent, XmlComponent } from "../../../../../file/xml-components";
-export interface IColumnAttributes {
-    readonly width: number | string;
-    readonly space?: number | string;
-}
-export declare class ColumnAttributes extends XmlAttributeComponent<IColumnAttributes> {
-    protected readonly xmlKeys: {
-        width: string;
-        space: string;
-    };
-}
-export declare class Column extends XmlComponent {
-    constructor({ width, space }: IColumnAttributes);
-}
+import { XmlAttributeComponent, XmlComponent } from "../../../../../file/xml-components";
+export interface IColumnAttributes {
+    readonly width: number | string;
+    readonly space?: number | string;
+}
+export declare class ColumnAttributes extends XmlAttributeComponent<IColumnAttributes> {
+    protected readonly xmlKeys: {
+        width: string;
+        space: string;
+    };
+}
+export declare class Column extends XmlComponent {
+    constructor({ width, space }: IColumnAttributes);
+}

package/build/file/document/body/section-properties/properties/columns.d.ts

@@ -1,20 +1,20 @@
-import { XmlAttributeComponent, XmlComponent } from "../../../../../file/xml-components";
-import { Column } from "./column";
-export interface IColumnsAttributes {
-    readonly space?: number | string;
-    readonly count?: number;
-    readonly separate?: boolean;
-    readonly equalWidth?: boolean;
-    readonly children?: Column[];
-}
-export declare class ColumnsAttributes extends XmlAttributeComponent<IColumnsAttributes> {
-    protected readonly xmlKeys: {
-        space: string;
-        count: string;
-        separate: string;
-        equalWidth: string;
-    };
-}
-export declare class Columns extends XmlComponent {
-    constructor({ space, count, separate, equalWidth, children }: IColumnsAttributes);
-}
+import { XmlAttributeComponent, XmlComponent } from "../../../../../file/xml-components";
+import { Column } from "./column";
+export interface IColumnsAttributes {
+    readonly space?: number | string;
+    readonly count?: number;
+    readonly separate?: boolean;
+    readonly equalWidth?: boolean;
+    readonly children?: Column[];
+}
+export declare class ColumnsAttributes extends XmlAttributeComponent<IColumnsAttributes> {
+    protected readonly xmlKeys: {
+        space: string;
+        count: string;
+        separate: string;
+        equalWidth: string;
+    };
+}
+export declare class Columns extends XmlComponent {
+    constructor({ space, count, separate, equalWidth, children }: IColumnsAttributes);
+}