docx 9.1.1 → 9.3.0

package/README.md

@@ -14,6 +14,7 @@
 [![Known Vulnerabilities][snky-image]][snky-url]
 [![PRs Welcome][pr-image]][pr-url]
 [![codecov][codecov-image]][codecov-url]
+[![Docx.js Editor][docxjs-editor-image]][docxjs-editor-url]
 
 <p align="center">
     <img src="https://i.imgur.com/QeL1HuU.png" alt="drawing"/>
@@ -64,6 +65,10 @@ More [here](https://github.com/dolanmiu/docx/tree/master/demo)
 
 Please refer to the [documentation at https://docx.js.org/](https://docx.js.org/) for details on how to use this library, examples and much more!
 
+# Playground
+
+Experience `docx` in action through [Docx.js Editor][docxjs-editor-url], an interactive playground where you can code and preview the results in real-time.
+
 # Examples
 
 Check the [demo folder](https://github.com/dolanmiu/docx/tree/master/demo) for examples.
@@ -115,3 +120,5 @@ Made with 💖
 [patreon-url]: https://www.patreon.com/dolanmiu
 [browserstack-image]: https://user-images.githubusercontent.com/2917613/54233552-128e9d00-4505-11e9-88fb-025a4e04007c.png
 [browserstack-url]: https://www.browserstack.com
+[docxjs-editor-image]: https://img.shields.io/badge/Docx.js%20Editor-2b579a.svg?style=flat&amp;logo=javascript&amp;logoColor=white
+[docxjs-editor-url]: https://docxjs-editor.vercel.app/

package/dist/index.cjs

@@ -13017,7 +13017,7 @@ class SpacingAttributes extends XmlAttributeComponent {
       line: "w:line",
       lineRule: "w:lineRule",
       beforeAutoSpacing: "w:beforeAutospacing",
-      afterAutoSpacing: "w:afterAutoSpacing"
+      afterAutoSpacing: "w:afterAutospacing"
     });
   }
 }
@@ -15310,10 +15310,10 @@ const createFont = ({
       // http://www.datypic.com/sc/ooxml/e-w_charset-1.html
       ...charset ? [createStringElement("w:charset", charset)] : [],
       // http://www.datypic.com/sc/ooxml/e-w_family-1.html
-      ...family ? [createStringElement("w:family", family)] : [],
+      ...[createStringElement("w:family", family)],
       // http://www.datypic.com/sc/ooxml/e-w_notTrueType-1.html
       ...notTrueType ? [new OnOffElement("w:notTrueType", notTrueType)] : [],
-      ...pitch ? [createStringElement("w:pitch", pitch)] : [],
+      ...[createStringElement("w:pitch", pitch)],
       // http://www.datypic.com/sc/ooxml/e-w_sig-1.html
       ...sig ? [
         new BuilderElement({
@@ -20200,7 +20200,7 @@ class Compiler {
     this.imageReplacer = new ImageReplacer();
     this.numberingReplacer = new NumberingReplacer();
   }
-  compile(file, prettifyXml) {
+  compile(file, prettifyXml, overrides = []) {
     const zip = new JSZip();
     const xmlifiedFileMapping = this.xmlifyFile(file, prettifyXml);
     const map = new Map(Object.entries(xmlifiedFileMapping));
@@ -20213,6 +20213,9 @@ class Compiler {
         zip.file(obj.path, obj.data);
       }
     }
+    for (const subFile of overrides) {
+      zip.file(subFile.path, subFile.data);
+    }
     for (const data of file.Media.Array) {
       if (data.type !== "svg") {
         zip.file(`word/media/${data.fileName}`, data.data);
@@ -20635,54 +20638,36 @@ const PrettifyType = {
   WITH_TAB: "	"
 };
 const convertPrettifyType = (prettify) => prettify === true ? PrettifyType.WITH_2_BLANKS : prettify === false ? void 0 : prettify;
-class Packer {
-  static toString(file, prettify) {
-    return __async(this, null, function* () {
-      const zip = this.compiler.compile(file, convertPrettifyType(prettify));
-      const zipData = yield zip.generateAsync({
-        type: "string",
+const _Packer = class _Packer {
+  // eslint-disable-next-line require-await
+  static pack(_0, _12, _2) {
+    return __async(this, arguments, function* (file, type2, prettify, overrides = []) {
+      const zip = this.compiler.compile(file, convertPrettifyType(prettify), overrides);
+      return zip.generateAsync({
+        type: type2,
         mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
         compression: "DEFLATE"
       });
-      return zipData;
     });
   }
-  static toBuffer(file, prettify) {
-    return __async(this, null, function* () {
-      const zip = this.compiler.compile(file, convertPrettifyType(prettify));
-      const zipData = yield zip.generateAsync({
-        type: "nodebuffer",
-        mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
-        compression: "DEFLATE"
-      });
-      return zipData;
-    });
+  static toString(file, prettify, overrides = []) {
+    return _Packer.pack(file, "string", prettify, overrides);
   }
-  static toBase64String(file, prettify) {
-    return __async(this, null, function* () {
-      const zip = this.compiler.compile(file, convertPrettifyType(prettify));
-      const zipData = yield zip.generateAsync({
-        type: "base64",
-        mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
-        compression: "DEFLATE"
-      });
-      return zipData;
-    });
+  static toBuffer(file, prettify, overrides = []) {
+    return _Packer.pack(file, "nodebuffer", prettify, overrides);
   }
-  static toBlob(file, prettify) {
-    return __async(this, null, function* () {
-      const zip = this.compiler.compile(file, convertPrettifyType(prettify));
-      const zipData = yield zip.generateAsync({
-        type: "blob",
-        mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
-        compression: "DEFLATE"
-      });
-      return zipData;
-    });
+  static toBase64String(file, prettify, overrides = []) {
+    return _Packer.pack(file, "base64", prettify, overrides);
   }
-  static toStream(file, prettify) {
+  static toBlob(file, prettify, overrides = []) {
+    return _Packer.pack(file, "blob", prettify, overrides);
+  }
+  static toArrayBuffer(file, prettify, overrides = []) {
+    return _Packer.pack(file, "arraybuffer", prettify, overrides);
+  }
+  static toStream(file, prettify, overrides = []) {
     const stream = new streamBrowserifyExports.Stream();
-    const zip = this.compiler.compile(file, convertPrettifyType(prettify));
+    const zip = this.compiler.compile(file, convertPrettifyType(prettify), overrides);
     zip.generateAsync({
       type: "nodebuffer",
       mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
@@ -20693,8 +20678,9 @@ class Packer {
     });
     return stream;
   }
-}
-__publicField(Packer, "compiler", new Compiler());
+};
+__publicField(_Packer, "compiler", new Compiler());
+let Packer = _Packer;
 const formatter$1 = new Formatter();
 const toJson = (xmlData) => {
   const xmlObj = libExports.xml2js(xmlData, { compact: false, captureSpacesBetweenElements: true });

package/dist/index.d.cts

@@ -1352,7 +1352,6 @@ export declare type IParagraphOptions = {
 } & IParagraphPropertiesOptions;
 
 export declare type IParagraphPropertiesOptions = {
-    readonly border?: IBordersOptions;
     readonly heading?: (typeof HeadingLevel)[keyof typeof HeadingLevel];
     readonly bidirectional?: boolean;
     readonly pageBreakBefore?: boolean;
@@ -1361,7 +1360,6 @@ export declare type IParagraphPropertiesOptions = {
     readonly bullet?: {
         readonly level: number;
     };
-    readonly shading?: IShadingAttributesProperties;
     readonly widowControl?: boolean;
     readonly frame?: IFrameOptions;
     readonly suppressLineNumbers?: boolean;
@@ -1377,6 +1375,8 @@ export declare type IParagraphStyleOptions = {
 } & IBaseParagraphStyleOptions;
 
 export declare type IParagraphStylePropertiesOptions = {
+    readonly border?: IBordersOptions;
+    readonly shading?: IShadingAttributesProperties;
     readonly numbering?: {
         readonly reference: string;
         readonly level: number;
@@ -1387,7 +1387,7 @@ export declare type IParagraphStylePropertiesOptions = {
 
 export declare type IPatch = ParagraphPatch | FilePatch;
 
-declare type IPropertiesOptions = {
+export declare type IPropertiesOptions = {
     readonly sections: readonly ISectionOptions[];
     readonly title?: string;
     readonly subject?: string;
@@ -1708,6 +1708,11 @@ export declare interface IXmlableObject extends Record<string, unknown> {
 
 export declare type IXmlAttribute = Readonly<Record<string, string | number | boolean>>;
 
+declare type IXmlifyedFile = {
+    readonly data: string;
+    readonly path: string;
+};
+
 export declare type IXYFrameOptions = {
     readonly type: "absolute";
     readonly position: {
@@ -2137,7 +2142,7 @@ declare type OutlineSchemeSolidFill = {
 
 declare type OutlineSolidFill = OutlineRgbSolidFill | OutlineSchemeSolidFill;
 
-declare type OutputByType = {
+export declare type OutputByType = {
     readonly base64: string;
     readonly string: string;
     readonly text: string;
@@ -2149,17 +2154,21 @@ declare type OutputByType = {
     readonly nodebuffer: Buffer;
 };
 
+export declare type OutputType = keyof OutputByType;
+
 export declare const OverlapType: {
     readonly NEVER: "never";
     readonly OVERLAP: "overlap";
 };
 
 export declare class Packer {
-    static toString(file: File_2, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType]): Promise<string>;
-    static toBuffer(file: File_2, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType]): Promise<Buffer>;
-    static toBase64String(file: File_2, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType]): Promise<string>;
-    static toBlob(file: File_2, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType]): Promise<Blob>;
-    static toStream(file: File_2, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType]): Stream;
+    static pack<T extends OutputType>(file: File_2, type: T, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType], overrides?: readonly IXmlifyedFile[]): Promise<OutputByType[T]>;
+    static toString(file: File_2, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType], overrides?: readonly IXmlifyedFile[]): Promise<string>;
+    static toBuffer(file: File_2, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType], overrides?: readonly IXmlifyedFile[]): Promise<Buffer>;
+    static toBase64String(file: File_2, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType], overrides?: readonly IXmlifyedFile[]): Promise<string>;
+    static toBlob(file: File_2, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType], overrides?: readonly IXmlifyedFile[]): Promise<Blob>;
+    static toArrayBuffer(file: File_2, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType], overrides?: readonly IXmlifyedFile[]): Promise<ArrayBuffer>;
+    static toStream(file: File_2, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType], overrides?: readonly IXmlifyedFile[]): Stream;
     private static readonly compiler;
 }
 
@@ -2288,7 +2297,7 @@ export declare type PatchDocumentOptions<T extends PatchDocumentOutputType = Pat
     readonly keepOriginalStyles?: boolean;
 };
 
-export declare type PatchDocumentOutputType = keyof OutputByType;
+export declare type PatchDocumentOutputType = OutputType;
 
 export declare const PatchType: {
     readonly DOCUMENT: "file";

package/dist/index.d.ts

@@ -1352,7 +1352,6 @@ export declare type IParagraphOptions = {
 } & IParagraphPropertiesOptions;
 
 export declare type IParagraphPropertiesOptions = {
-    readonly border?: IBordersOptions;
     readonly heading?: (typeof HeadingLevel)[keyof typeof HeadingLevel];
     readonly bidirectional?: boolean;
     readonly pageBreakBefore?: boolean;
@@ -1361,7 +1360,6 @@ export declare type IParagraphPropertiesOptions = {
     readonly bullet?: {
         readonly level: number;
     };
-    readonly shading?: IShadingAttributesProperties;
     readonly widowControl?: boolean;
     readonly frame?: IFrameOptions;
     readonly suppressLineNumbers?: boolean;
@@ -1377,6 +1375,8 @@ export declare type IParagraphStyleOptions = {
 } & IBaseParagraphStyleOptions;
 
 export declare type IParagraphStylePropertiesOptions = {
+    readonly border?: IBordersOptions;
+    readonly shading?: IShadingAttributesProperties;
     readonly numbering?: {
         readonly reference: string;
         readonly level: number;
@@ -1387,7 +1387,7 @@ export declare type IParagraphStylePropertiesOptions = {
 
 export declare type IPatch = ParagraphPatch | FilePatch;
 
-declare type IPropertiesOptions = {
+export declare type IPropertiesOptions = {
     readonly sections: readonly ISectionOptions[];
     readonly title?: string;
     readonly subject?: string;
@@ -1708,6 +1708,11 @@ export declare interface IXmlableObject extends Record<string, unknown> {
 
 export declare type IXmlAttribute = Readonly<Record<string, string | number | boolean>>;
 
+declare type IXmlifyedFile = {
+    readonly data: string;
+    readonly path: string;
+};
+
 export declare type IXYFrameOptions = {
     readonly type: "absolute";
     readonly position: {
@@ -2137,7 +2142,7 @@ declare type OutlineSchemeSolidFill = {
 
 declare type OutlineSolidFill = OutlineRgbSolidFill | OutlineSchemeSolidFill;
 
-declare type OutputByType = {
+export declare type OutputByType = {
     readonly base64: string;
     readonly string: string;
     readonly text: string;
@@ -2149,17 +2154,21 @@ declare type OutputByType = {
     readonly nodebuffer: Buffer;
 };
 
+export declare type OutputType = keyof OutputByType;
+
 export declare const OverlapType: {
     readonly NEVER: "never";
     readonly OVERLAP: "overlap";
 };
 
 export declare class Packer {
-    static toString(file: File_2, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType]): Promise<string>;
-    static toBuffer(file: File_2, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType]): Promise<Buffer>;
-    static toBase64String(file: File_2, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType]): Promise<string>;
-    static toBlob(file: File_2, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType]): Promise<Blob>;
-    static toStream(file: File_2, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType]): Stream;
+    static pack<T extends OutputType>(file: File_2, type: T, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType], overrides?: readonly IXmlifyedFile[]): Promise<OutputByType[T]>;
+    static toString(file: File_2, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType], overrides?: readonly IXmlifyedFile[]): Promise<string>;
+    static toBuffer(file: File_2, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType], overrides?: readonly IXmlifyedFile[]): Promise<Buffer>;
+    static toBase64String(file: File_2, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType], overrides?: readonly IXmlifyedFile[]): Promise<string>;
+    static toBlob(file: File_2, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType], overrides?: readonly IXmlifyedFile[]): Promise<Blob>;
+    static toArrayBuffer(file: File_2, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType], overrides?: readonly IXmlifyedFile[]): Promise<ArrayBuffer>;
+    static toStream(file: File_2, prettify?: boolean | (typeof PrettifyType)[keyof typeof PrettifyType], overrides?: readonly IXmlifyedFile[]): Stream;
     private static readonly compiler;
 }
 
@@ -2288,7 +2297,7 @@ export declare type PatchDocumentOptions<T extends PatchDocumentOutputType = Pat
     readonly keepOriginalStyles?: boolean;
 };
 
-export declare type PatchDocumentOutputType = keyof OutputByType;
+export declare type PatchDocumentOutputType = OutputType;
 
 export declare const PatchType: {
     readonly DOCUMENT: "file";

package/dist/index.iife.js

@@ -13017,7 +13017,7 @@ var __async = (__this, __arguments, generator) => {
         line: "w:line",
         lineRule: "w:lineRule",
         beforeAutoSpacing: "w:beforeAutospacing",
-        afterAutoSpacing: "w:afterAutoSpacing"
+        afterAutoSpacing: "w:afterAutospacing"
       });
     }
   }
@@ -15310,10 +15310,10 @@ var __async = (__this, __arguments, generator) => {
         // http://www.datypic.com/sc/ooxml/e-w_charset-1.html
         ...charset ? [createStringElement("w:charset", charset)] : [],
         // http://www.datypic.com/sc/ooxml/e-w_family-1.html
-        ...family ? [createStringElement("w:family", family)] : [],
+        ...[createStringElement("w:family", family)],
         // http://www.datypic.com/sc/ooxml/e-w_notTrueType-1.html
         ...notTrueType ? [new OnOffElement("w:notTrueType", notTrueType)] : [],
-        ...pitch ? [createStringElement("w:pitch", pitch)] : [],
+        ...[createStringElement("w:pitch", pitch)],
         // http://www.datypic.com/sc/ooxml/e-w_sig-1.html
         ...sig ? [
           new BuilderElement({
@@ -20200,7 +20200,7 @@ var __async = (__this, __arguments, generator) => {
       this.imageReplacer = new ImageReplacer();
       this.numberingReplacer = new NumberingReplacer();
     }
-    compile(file, prettifyXml) {
+    compile(file, prettifyXml, overrides = []) {
       const zip = new JSZip();
       const xmlifiedFileMapping = this.xmlifyFile(file, prettifyXml);
       const map = new Map(Object.entries(xmlifiedFileMapping));
@@ -20213,6 +20213,9 @@ var __async = (__this, __arguments, generator) => {
           zip.file(obj.path, obj.data);
         }
       }
+      for (const subFile of overrides) {
+        zip.file(subFile.path, subFile.data);
+      }
       for (const data of file.Media.Array) {
         if (data.type !== "svg") {
           zip.file(`word/media/${data.fileName}`, data.data);
@@ -20635,54 +20638,36 @@ var __async = (__this, __arguments, generator) => {
     WITH_TAB: "	"
   };
   const convertPrettifyType = (prettify) => prettify === true ? PrettifyType.WITH_2_BLANKS : prettify === false ? void 0 : prettify;
-  class Packer {
-    static toString(file, prettify) {
-      return __async(this, null, function* () {
-        const zip = this.compiler.compile(file, convertPrettifyType(prettify));
-        const zipData = yield zip.generateAsync({
-          type: "string",
+  const _Packer = class _Packer {
+    // eslint-disable-next-line require-await
+    static pack(_0, _12, _2) {
+      return __async(this, arguments, function* (file, type2, prettify, overrides = []) {
+        const zip = this.compiler.compile(file, convertPrettifyType(prettify), overrides);
+        return zip.generateAsync({
+          type: type2,
           mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
           compression: "DEFLATE"
         });
-        return zipData;
       });
     }
-    static toBuffer(file, prettify) {
-      return __async(this, null, function* () {
-        const zip = this.compiler.compile(file, convertPrettifyType(prettify));
-        const zipData = yield zip.generateAsync({
-          type: "nodebuffer",
-          mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
-          compression: "DEFLATE"
-        });
-        return zipData;
-      });
+    static toString(file, prettify, overrides = []) {
+      return _Packer.pack(file, "string", prettify, overrides);
     }
-    static toBase64String(file, prettify) {
-      return __async(this, null, function* () {
-        const zip = this.compiler.compile(file, convertPrettifyType(prettify));
-        const zipData = yield zip.generateAsync({
-          type: "base64",
-          mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
-          compression: "DEFLATE"
-        });
-        return zipData;
-      });
+    static toBuffer(file, prettify, overrides = []) {
+      return _Packer.pack(file, "nodebuffer", prettify, overrides);
     }
-    static toBlob(file, prettify) {
-      return __async(this, null, function* () {
-        const zip = this.compiler.compile(file, convertPrettifyType(prettify));
-        const zipData = yield zip.generateAsync({
-          type: "blob",
-          mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
-          compression: "DEFLATE"
-        });
-        return zipData;
-      });
+    static toBase64String(file, prettify, overrides = []) {
+      return _Packer.pack(file, "base64", prettify, overrides);
     }
-    static toStream(file, prettify) {
+    static toBlob(file, prettify, overrides = []) {
+      return _Packer.pack(file, "blob", prettify, overrides);
+    }
+    static toArrayBuffer(file, prettify, overrides = []) {
+      return _Packer.pack(file, "arraybuffer", prettify, overrides);
+    }
+    static toStream(file, prettify, overrides = []) {
       const stream = new streamBrowserifyExports.Stream();
-      const zip = this.compiler.compile(file, convertPrettifyType(prettify));
+      const zip = this.compiler.compile(file, convertPrettifyType(prettify), overrides);
       zip.generateAsync({
         type: "nodebuffer",
         mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
@@ -20693,8 +20678,9 @@ var __async = (__this, __arguments, generator) => {
       });
       return stream;
     }
-  }
-  __publicField(Packer, "compiler", new Compiler());
+  };
+  __publicField(_Packer, "compiler", new Compiler());
+  let Packer = _Packer;
   const formatter$1 = new Formatter();
   const toJson = (xmlData) => {
     const xmlObj = libExports.xml2js(xmlData, { compact: false, captureSpacesBetweenElements: true });

package/dist/index.mjs

@@ -13015,7 +13015,7 @@ class SpacingAttributes extends XmlAttributeComponent {
       line: "w:line",
       lineRule: "w:lineRule",
       beforeAutoSpacing: "w:beforeAutospacing",
-      afterAutoSpacing: "w:afterAutoSpacing"
+      afterAutoSpacing: "w:afterAutospacing"
     });
   }
 }
@@ -15308,10 +15308,10 @@ const createFont = ({
       // http://www.datypic.com/sc/ooxml/e-w_charset-1.html
       ...charset ? [createStringElement("w:charset", charset)] : [],
       // http://www.datypic.com/sc/ooxml/e-w_family-1.html
-      ...family ? [createStringElement("w:family", family)] : [],
+      ...[createStringElement("w:family", family)],
       // http://www.datypic.com/sc/ooxml/e-w_notTrueType-1.html
       ...notTrueType ? [new OnOffElement("w:notTrueType", notTrueType)] : [],
-      ...pitch ? [createStringElement("w:pitch", pitch)] : [],
+      ...[createStringElement("w:pitch", pitch)],
       // http://www.datypic.com/sc/ooxml/e-w_sig-1.html
       ...sig ? [
         new BuilderElement({
@@ -20198,7 +20198,7 @@ class Compiler {
     this.imageReplacer = new ImageReplacer();
     this.numberingReplacer = new NumberingReplacer();
   }
-  compile(file, prettifyXml) {
+  compile(file, prettifyXml, overrides = []) {
     const zip = new JSZip();
     const xmlifiedFileMapping = this.xmlifyFile(file, prettifyXml);
     const map = new Map(Object.entries(xmlifiedFileMapping));
@@ -20211,6 +20211,9 @@ class Compiler {
         zip.file(obj.path, obj.data);
       }
     }
+    for (const subFile of overrides) {
+      zip.file(subFile.path, subFile.data);
+    }
     for (const data of file.Media.Array) {
       if (data.type !== "svg") {
         zip.file(`word/media/${data.fileName}`, data.data);
@@ -20633,54 +20636,36 @@ const PrettifyType = {
   WITH_TAB: "	"
 };
 const convertPrettifyType = (prettify) => prettify === true ? PrettifyType.WITH_2_BLANKS : prettify === false ? void 0 : prettify;
-class Packer {
-  static toString(file, prettify) {
-    return __async(this, null, function* () {
-      const zip = this.compiler.compile(file, convertPrettifyType(prettify));
-      const zipData = yield zip.generateAsync({
-        type: "string",
+const _Packer = class _Packer {
+  // eslint-disable-next-line require-await
+  static pack(_0, _12, _2) {
+    return __async(this, arguments, function* (file, type2, prettify, overrides = []) {
+      const zip = this.compiler.compile(file, convertPrettifyType(prettify), overrides);
+      return zip.generateAsync({
+        type: type2,
         mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
         compression: "DEFLATE"
       });
-      return zipData;
     });
   }
-  static toBuffer(file, prettify) {
-    return __async(this, null, function* () {
-      const zip = this.compiler.compile(file, convertPrettifyType(prettify));
-      const zipData = yield zip.generateAsync({
-        type: "nodebuffer",
-        mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
-        compression: "DEFLATE"
-      });
-      return zipData;
-    });
+  static toString(file, prettify, overrides = []) {
+    return _Packer.pack(file, "string", prettify, overrides);
   }
-  static toBase64String(file, prettify) {
-    return __async(this, null, function* () {
-      const zip = this.compiler.compile(file, convertPrettifyType(prettify));
-      const zipData = yield zip.generateAsync({
-        type: "base64",
-        mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
-        compression: "DEFLATE"
-      });
-      return zipData;
-    });
+  static toBuffer(file, prettify, overrides = []) {
+    return _Packer.pack(file, "nodebuffer", prettify, overrides);
   }
-  static toBlob(file, prettify) {
-    return __async(this, null, function* () {
-      const zip = this.compiler.compile(file, convertPrettifyType(prettify));
-      const zipData = yield zip.generateAsync({
-        type: "blob",
-        mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
-        compression: "DEFLATE"
-      });
-      return zipData;
-    });
+  static toBase64String(file, prettify, overrides = []) {
+    return _Packer.pack(file, "base64", prettify, overrides);
   }
-  static toStream(file, prettify) {
+  static toBlob(file, prettify, overrides = []) {
+    return _Packer.pack(file, "blob", prettify, overrides);
+  }
+  static toArrayBuffer(file, prettify, overrides = []) {
+    return _Packer.pack(file, "arraybuffer", prettify, overrides);
+  }
+  static toStream(file, prettify, overrides = []) {
     const stream = new streamBrowserifyExports.Stream();
-    const zip = this.compiler.compile(file, convertPrettifyType(prettify));
+    const zip = this.compiler.compile(file, convertPrettifyType(prettify), overrides);
     zip.generateAsync({
       type: "nodebuffer",
       mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
@@ -20691,8 +20676,9 @@ class Packer {
     });
     return stream;
   }
-}
-__publicField(Packer, "compiler", new Compiler());
+};
+__publicField(_Packer, "compiler", new Compiler());
+let Packer = _Packer;
 const formatter$1 = new Formatter();
 const toJson = (xmlData) => {
   const xmlObj = libExports.xml2js(xmlData, { compact: false, captureSpacesBetweenElements: true });

package/dist/index.umd.cjs

@@ -13019,7 +13019,7 @@ var __async = (__this, __arguments, generator) => {
         line: "w:line",
         lineRule: "w:lineRule",
         beforeAutoSpacing: "w:beforeAutospacing",
-        afterAutoSpacing: "w:afterAutoSpacing"
+        afterAutoSpacing: "w:afterAutospacing"
       });
     }
   }
@@ -15312,10 +15312,10 @@ var __async = (__this, __arguments, generator) => {
         // http://www.datypic.com/sc/ooxml/e-w_charset-1.html
         ...charset ? [createStringElement("w:charset", charset)] : [],
         // http://www.datypic.com/sc/ooxml/e-w_family-1.html
-        ...family ? [createStringElement("w:family", family)] : [],
+        ...[createStringElement("w:family", family)],
         // http://www.datypic.com/sc/ooxml/e-w_notTrueType-1.html
         ...notTrueType ? [new OnOffElement("w:notTrueType", notTrueType)] : [],
-        ...pitch ? [createStringElement("w:pitch", pitch)] : [],
+        ...[createStringElement("w:pitch", pitch)],
         // http://www.datypic.com/sc/ooxml/e-w_sig-1.html
         ...sig ? [
           new BuilderElement({
@@ -20202,7 +20202,7 @@ var __async = (__this, __arguments, generator) => {
       this.imageReplacer = new ImageReplacer();
       this.numberingReplacer = new NumberingReplacer();
     }
-    compile(file, prettifyXml) {
+    compile(file, prettifyXml, overrides = []) {
       const zip = new JSZip();
       const xmlifiedFileMapping = this.xmlifyFile(file, prettifyXml);
       const map = new Map(Object.entries(xmlifiedFileMapping));
@@ -20215,6 +20215,9 @@ var __async = (__this, __arguments, generator) => {
           zip.file(obj.path, obj.data);
         }
       }
+      for (const subFile of overrides) {
+        zip.file(subFile.path, subFile.data);
+      }
       for (const data of file.Media.Array) {
         if (data.type !== "svg") {
           zip.file(`word/media/${data.fileName}`, data.data);
@@ -20637,54 +20640,36 @@ var __async = (__this, __arguments, generator) => {
     WITH_TAB: "	"
   };
   const convertPrettifyType = (prettify) => prettify === true ? PrettifyType.WITH_2_BLANKS : prettify === false ? void 0 : prettify;
-  class Packer {
-    static toString(file, prettify) {
-      return __async(this, null, function* () {
-        const zip = this.compiler.compile(file, convertPrettifyType(prettify));
-        const zipData = yield zip.generateAsync({
-          type: "string",
+  const _Packer = class _Packer {
+    // eslint-disable-next-line require-await
+    static pack(_0, _12, _2) {
+      return __async(this, arguments, function* (file, type2, prettify, overrides = []) {
+        const zip = this.compiler.compile(file, convertPrettifyType(prettify), overrides);
+        return zip.generateAsync({
+          type: type2,
           mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
           compression: "DEFLATE"
         });
-        return zipData;
       });
     }
-    static toBuffer(file, prettify) {
-      return __async(this, null, function* () {
-        const zip = this.compiler.compile(file, convertPrettifyType(prettify));
-        const zipData = yield zip.generateAsync({
-          type: "nodebuffer",
-          mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
-          compression: "DEFLATE"
-        });
-        return zipData;
-      });
+    static toString(file, prettify, overrides = []) {
+      return _Packer.pack(file, "string", prettify, overrides);
     }
-    static toBase64String(file, prettify) {
-      return __async(this, null, function* () {
-        const zip = this.compiler.compile(file, convertPrettifyType(prettify));
-        const zipData = yield zip.generateAsync({
-          type: "base64",
-          mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
-          compression: "DEFLATE"
-        });
-        return zipData;
-      });
+    static toBuffer(file, prettify, overrides = []) {
+      return _Packer.pack(file, "nodebuffer", prettify, overrides);
     }
-    static toBlob(file, prettify) {
-      return __async(this, null, function* () {
-        const zip = this.compiler.compile(file, convertPrettifyType(prettify));
-        const zipData = yield zip.generateAsync({
-          type: "blob",
-          mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
-          compression: "DEFLATE"
-        });
-        return zipData;
-      });
+    static toBase64String(file, prettify, overrides = []) {
+      return _Packer.pack(file, "base64", prettify, overrides);
     }
-    static toStream(file, prettify) {
+    static toBlob(file, prettify, overrides = []) {
+      return _Packer.pack(file, "blob", prettify, overrides);
+    }
+    static toArrayBuffer(file, prettify, overrides = []) {
+      return _Packer.pack(file, "arraybuffer", prettify, overrides);
+    }
+    static toStream(file, prettify, overrides = []) {
       const stream = new streamBrowserifyExports.Stream();
-      const zip = this.compiler.compile(file, convertPrettifyType(prettify));
+      const zip = this.compiler.compile(file, convertPrettifyType(prettify), overrides);
       zip.generateAsync({
         type: "nodebuffer",
         mimeType: "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
@@ -20695,8 +20680,9 @@ var __async = (__this, __arguments, generator) => {
       });
       return stream;
     }
-  }
-  __publicField(Packer, "compiler", new Compiler());
+  };
+  __publicField(_Packer, "compiler", new Compiler());
+  let Packer = _Packer;
   const formatter$1 = new Formatter();
   const toJson = (xmlData) => {
     const xmlObj = libExports.xml2js(xmlData, { compact: false, captureSpacesBetweenElements: true });

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "docx",
-    "version": "9.1.1",
+    "version": "9.3.0",
     "description": "Easily generate .docx files with JS/TS with a nice declarative API. Works for Node and on the Browser.",
     "type": "module",
     "main": "dist/index.umd.cjs",
@@ -61,7 +61,7 @@
         "@types/node": "^22.7.5",
         "hash.js": "^1.1.7",
         "jszip": "^3.10.1",
-        "nanoid": "^5.0.4",
+        "nanoid": "^5.1.3",
         "xml": "^1.0.1",
         "xml-js": "^1.6.8"
     },
@@ -79,8 +79,8 @@
         "@types/xml": "^1.0.8",
         "@typescript-eslint/eslint-plugin": "^8.8.1",
         "@typescript-eslint/parser": "^8.8.1",
-        "@vitest/coverage-v8": "^2.1.8",
-        "@vitest/ui": "^2.1.2",
+        "@vitest/coverage-v8": "^3.0.8",
+        "@vitest/ui": "^3.0.8",
         "cspell": "^8.2.3",
         "docsify-cli": "^4.3.0",
         "eslint": "^9.13.0",
@@ -95,7 +95,7 @@
         "glob": "^11.0.0",
         "inquirer": "^12.0.0",
         "jiti": "^2.3.3",
-        "jsdom": "^25.0.1",
+        "jsdom": "^26.0.0",
         "pre-commit": "^1.2.2",
         "prettier": "^3.1.1",
         "tsconfig-paths": "^4.0.0",
@@ -106,9 +106,9 @@
         "unzipper": "^0.12.3",
         "vite": "^6.0.1",
         "vite-plugin-dts": "^4.2.4",
-        "vite-plugin-node-polyfills": "^0.22.0",
+        "vite-plugin-node-polyfills": "^0.23.0",
         "vite-tsconfig-paths": "^5.0.1",
-        "vitest": "^2.1.8"
+        "vitest": "^3.0.8"
     },
     "engines": {
         "node": ">=10"