docx 8.2.2 → 8.2.4

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

@@ -34,10 +34,10 @@ export interface ISectionPropertiesOptions {
     readonly type?: SectionType;
 }
 export declare const sectionMarginDefaults: {
-    TOP: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
-    RIGHT: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
-    BOTTOM: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi` | `-${number}mm` | `-${number}cm` | `-${number}in` | `-${number}pt` | `-${number}pc` | `-${number}pi`;
-    LEFT: `${number}mm` | `${number}cm` | `${number}in` | `${number}pt` | `${number}pc` | `${number}pi`;
+    TOP: number;
+    RIGHT: number;
+    BOTTOM: number;
+    LEFT: number;
     HEADER: number;
     FOOTER: number;
     GUTTER: number;

package/build/file/xml-components/xmlable-object.d.ts

@@ -1,7 +1,7 @@
 export interface IXmlAttribute {
     readonly [key: string]: string | number | boolean;
 }
-export interface IXmlableObject extends Object {
+export interface IXmlableObject extends Record<string, unknown> {
     readonly [key: string]: any;
 }
 export declare const WORKAROUND3 = "";

package/build/index.cjs

@@ -11740,10 +11740,10 @@ class Type extends XmlComponent {
   }
 }
 const sectionMarginDefaults = {
-  TOP: "1in",
-  RIGHT: "1in",
-  BOTTOM: "1in",
-  LEFT: "1in",
+  TOP: 1440,
+  RIGHT: 1440,
+  BOTTOM: 1440,
+  LEFT: 1440,
   HEADER: 708,
   FOOTER: 708,
   GUTTER: 0
@@ -14219,13 +14219,15 @@ class Numbering extends XmlComponent {
       abstractNumId: abstractNumbering.id,
       reference,
       instance,
-      overrideLevel: firstLevelStartNumber && Number.isInteger(firstLevelStartNumber) ? {
-        num: 0,
-        start: firstLevelStartNumber
-      } : {
-        num: 0,
-        start: 1
-      }
+      overrideLevels: [
+        firstLevelStartNumber && Number.isInteger(firstLevelStartNumber) ? {
+          num: 0,
+          start: firstLevelStartNumber
+        } : {
+          num: 0,
+          start: 1
+        }
+      ]
     };
     this.concreteNumberingMap.set(fullReference, new ConcreteNumbering(concreteNumberingSettings));
   }
@@ -18950,7 +18952,7 @@ const splitRunElement = (runElement, token) => {
 };
 const formatter = new Formatter();
 const SPLIT_TOKEN = "ɵ";
-const replacer = (json, patch, patchText, renderedParagraphs, context) => {
+const replacer = (json, patch, patchText, renderedParagraphs, context, keepOriginalStyles = false) => {
   for (const renderedParagraph of renderedParagraphs) {
     const textJson = patch.children.map((c) => toJson(xml$1(formatter.format(c, context)))).map((c) => c.elements[0]);
     switch (patch.type) {
@@ -18970,8 +18972,24 @@ const replacer = (json, patch, patchText, renderedParagraphs, context) => {
           replacementText: SPLIT_TOKEN
         });
         const index = findRunElementIndexWithToken(paragraphElement, SPLIT_TOKEN);
-        const { left, right } = splitRunElement(paragraphElement.elements[index], SPLIT_TOKEN);
-        paragraphElement.elements.splice(index, 1, left, ...textJson, right);
+        const runElementToBeReplaced = paragraphElement.elements[index];
+        const { left, right } = splitRunElement(runElementToBeReplaced, SPLIT_TOKEN);
+        let newRunElements = textJson;
+        let patchedRightElement = right;
+        if (keepOriginalStyles) {
+          const runElementNonTextualElements = runElementToBeReplaced.elements.filter(
+            (e) => e.type === "element" && e.name !== "w:t"
+          );
+          newRunElements = textJson.map((e) => ({
+            ...e,
+            elements: [...runElementNonTextualElements, ...e.elements]
+          }));
+          patchedRightElement = {
+            ...right,
+            elements: [...runElementNonTextualElements, ...right.elements]
+          };
+        }
+        paragraphElement.elements.splice(index, 1, left, ...newRunElements, patchedRightElement);
         break;
       }
     }
@@ -19195,7 +19213,8 @@ const patchDocument = async (data, options2) => {
           },
           patchText,
           renderedParagraphs,
-          context
+          context,
+          options2.keepOriginalStyles
         );
       }
       const mediaDatas = imageReplacer.getMediaData(JSON.stringify(json), context.file.Media);

package/build/index.iife.js

@@ -11740,10 +11740,10 @@ var __publicField = (obj, key, value) => {
     }
   }
   const sectionMarginDefaults = {
-    TOP: "1in",
-    RIGHT: "1in",
-    BOTTOM: "1in",
-    LEFT: "1in",
+    TOP: 1440,
+    RIGHT: 1440,
+    BOTTOM: 1440,
+    LEFT: 1440,
     HEADER: 708,
     FOOTER: 708,
     GUTTER: 0
@@ -14219,13 +14219,15 @@ var __publicField = (obj, key, value) => {
         abstractNumId: abstractNumbering.id,
         reference,
         instance,
-        overrideLevel: firstLevelStartNumber && Number.isInteger(firstLevelStartNumber) ? {
-          num: 0,
-          start: firstLevelStartNumber
-        } : {
-          num: 0,
-          start: 1
-        }
+        overrideLevels: [
+          firstLevelStartNumber && Number.isInteger(firstLevelStartNumber) ? {
+            num: 0,
+            start: firstLevelStartNumber
+          } : {
+            num: 0,
+            start: 1
+          }
+        ]
       };
       this.concreteNumberingMap.set(fullReference, new ConcreteNumbering(concreteNumberingSettings));
     }
@@ -18950,7 +18952,7 @@ var __publicField = (obj, key, value) => {
   };
   const formatter = new Formatter();
   const SPLIT_TOKEN = "ɵ";
-  const replacer = (json, patch, patchText, renderedParagraphs, context) => {
+  const replacer = (json, patch, patchText, renderedParagraphs, context, keepOriginalStyles = false) => {
     for (const renderedParagraph of renderedParagraphs) {
       const textJson = patch.children.map((c) => toJson(xml$1(formatter.format(c, context)))).map((c) => c.elements[0]);
       switch (patch.type) {
@@ -18970,8 +18972,24 @@ var __publicField = (obj, key, value) => {
             replacementText: SPLIT_TOKEN
           });
           const index = findRunElementIndexWithToken(paragraphElement, SPLIT_TOKEN);
-          const { left, right } = splitRunElement(paragraphElement.elements[index], SPLIT_TOKEN);
-          paragraphElement.elements.splice(index, 1, left, ...textJson, right);
+          const runElementToBeReplaced = paragraphElement.elements[index];
+          const { left, right } = splitRunElement(runElementToBeReplaced, SPLIT_TOKEN);
+          let newRunElements = textJson;
+          let patchedRightElement = right;
+          if (keepOriginalStyles) {
+            const runElementNonTextualElements = runElementToBeReplaced.elements.filter(
+              (e) => e.type === "element" && e.name !== "w:t"
+            );
+            newRunElements = textJson.map((e) => ({
+              ...e,
+              elements: [...runElementNonTextualElements, ...e.elements]
+            }));
+            patchedRightElement = {
+              ...right,
+              elements: [...runElementNonTextualElements, ...right.elements]
+            };
+          }
+          paragraphElement.elements.splice(index, 1, left, ...newRunElements, patchedRightElement);
           break;
         }
       }
@@ -19195,7 +19213,8 @@ var __publicField = (obj, key, value) => {
             },
             patchText,
             renderedParagraphs,
-            context
+            context,
+            options2.keepOriginalStyles
           );
         }
         const mediaDatas = imageReplacer.getMediaData(JSON.stringify(json), context.file.Media);

package/build/{index.js → index.mjs}

@@ -11738,10 +11738,10 @@ class Type extends XmlComponent {
   }
 }
 const sectionMarginDefaults = {
-  TOP: "1in",
-  RIGHT: "1in",
-  BOTTOM: "1in",
-  LEFT: "1in",
+  TOP: 1440,
+  RIGHT: 1440,
+  BOTTOM: 1440,
+  LEFT: 1440,
   HEADER: 708,
   FOOTER: 708,
   GUTTER: 0
@@ -14217,13 +14217,15 @@ class Numbering extends XmlComponent {
       abstractNumId: abstractNumbering.id,
       reference,
       instance,
-      overrideLevel: firstLevelStartNumber && Number.isInteger(firstLevelStartNumber) ? {
-        num: 0,
-        start: firstLevelStartNumber
-      } : {
-        num: 0,
-        start: 1
-      }
+      overrideLevels: [
+        firstLevelStartNumber && Number.isInteger(firstLevelStartNumber) ? {
+          num: 0,
+          start: firstLevelStartNumber
+        } : {
+          num: 0,
+          start: 1
+        }
+      ]
     };
     this.concreteNumberingMap.set(fullReference, new ConcreteNumbering(concreteNumberingSettings));
   }
@@ -18948,7 +18950,7 @@ const splitRunElement = (runElement, token) => {
 };
 const formatter = new Formatter();
 const SPLIT_TOKEN = "ɵ";
-const replacer = (json, patch, patchText, renderedParagraphs, context) => {
+const replacer = (json, patch, patchText, renderedParagraphs, context, keepOriginalStyles = false) => {
   for (const renderedParagraph of renderedParagraphs) {
     const textJson = patch.children.map((c) => toJson(xml$1(formatter.format(c, context)))).map((c) => c.elements[0]);
     switch (patch.type) {
@@ -18968,8 +18970,24 @@ const replacer = (json, patch, patchText, renderedParagraphs, context) => {
           replacementText: SPLIT_TOKEN
         });
         const index = findRunElementIndexWithToken(paragraphElement, SPLIT_TOKEN);
-        const { left, right } = splitRunElement(paragraphElement.elements[index], SPLIT_TOKEN);
-        paragraphElement.elements.splice(index, 1, left, ...textJson, right);
+        const runElementToBeReplaced = paragraphElement.elements[index];
+        const { left, right } = splitRunElement(runElementToBeReplaced, SPLIT_TOKEN);
+        let newRunElements = textJson;
+        let patchedRightElement = right;
+        if (keepOriginalStyles) {
+          const runElementNonTextualElements = runElementToBeReplaced.elements.filter(
+            (e) => e.type === "element" && e.name !== "w:t"
+          );
+          newRunElements = textJson.map((e) => ({
+            ...e,
+            elements: [...runElementNonTextualElements, ...e.elements]
+          }));
+          patchedRightElement = {
+            ...right,
+            elements: [...runElementNonTextualElements, ...right.elements]
+          };
+        }
+        paragraphElement.elements.splice(index, 1, left, ...newRunElements, patchedRightElement);
         break;
       }
     }
@@ -19193,7 +19211,8 @@ const patchDocument = async (data, options2) => {
           },
           patchText,
           renderedParagraphs,
-          context
+          context,
+          options2.keepOriginalStyles
         );
       }
       const mediaDatas = imageReplacer.getMediaData(JSON.stringify(json), context.file.Media);

package/build/index.umd.js

@@ -11742,10 +11742,10 @@ var __publicField = (obj, key, value) => {
     }
   }
   const sectionMarginDefaults = {
-    TOP: "1in",
-    RIGHT: "1in",
-    BOTTOM: "1in",
-    LEFT: "1in",
+    TOP: 1440,
+    RIGHT: 1440,
+    BOTTOM: 1440,
+    LEFT: 1440,
     HEADER: 708,
     FOOTER: 708,
     GUTTER: 0
@@ -14221,13 +14221,15 @@ var __publicField = (obj, key, value) => {
         abstractNumId: abstractNumbering.id,
         reference,
         instance,
-        overrideLevel: firstLevelStartNumber && Number.isInteger(firstLevelStartNumber) ? {
-          num: 0,
-          start: firstLevelStartNumber
-        } : {
-          num: 0,
-          start: 1
-        }
+        overrideLevels: [
+          firstLevelStartNumber && Number.isInteger(firstLevelStartNumber) ? {
+            num: 0,
+            start: firstLevelStartNumber
+          } : {
+            num: 0,
+            start: 1
+          }
+        ]
       };
       this.concreteNumberingMap.set(fullReference, new ConcreteNumbering(concreteNumberingSettings));
     }
@@ -18952,7 +18954,7 @@ var __publicField = (obj, key, value) => {
   };
   const formatter = new Formatter();
   const SPLIT_TOKEN = "ɵ";
-  const replacer = (json, patch, patchText, renderedParagraphs, context) => {
+  const replacer = (json, patch, patchText, renderedParagraphs, context, keepOriginalStyles = false) => {
     for (const renderedParagraph of renderedParagraphs) {
       const textJson = patch.children.map((c) => toJson(xml$1(formatter.format(c, context)))).map((c) => c.elements[0]);
       switch (patch.type) {
@@ -18972,8 +18974,24 @@ var __publicField = (obj, key, value) => {
             replacementText: SPLIT_TOKEN
           });
           const index = findRunElementIndexWithToken(paragraphElement, SPLIT_TOKEN);
-          const { left, right } = splitRunElement(paragraphElement.elements[index], SPLIT_TOKEN);
-          paragraphElement.elements.splice(index, 1, left, ...textJson, right);
+          const runElementToBeReplaced = paragraphElement.elements[index];
+          const { left, right } = splitRunElement(runElementToBeReplaced, SPLIT_TOKEN);
+          let newRunElements = textJson;
+          let patchedRightElement = right;
+          if (keepOriginalStyles) {
+            const runElementNonTextualElements = runElementToBeReplaced.elements.filter(
+              (e) => e.type === "element" && e.name !== "w:t"
+            );
+            newRunElements = textJson.map((e) => ({
+              ...e,
+              elements: [...runElementNonTextualElements, ...e.elements]
+            }));
+            patchedRightElement = {
+              ...right,
+              elements: [...runElementNonTextualElements, ...right.elements]
+            };
+          }
+          paragraphElement.elements.splice(index, 1, left, ...newRunElements, patchedRightElement);
           break;
         }
       }
@@ -19197,7 +19215,8 @@ var __publicField = (obj, key, value) => {
             },
             patchText,
             renderedParagraphs,
-            context
+            context,
+            options2.keepOriginalStyles
           );
         }
         const mediaDatas = imageReplacer.getMediaData(JSON.stringify(json), context.file.Media);

package/build/patcher/from-docx.d.ts

@@ -20,6 +20,7 @@ export interface PatchDocumentOptions {
     readonly patches: {
         readonly [key: string]: IPatch;
     };
+    readonly keepOriginalStyles?: boolean;
 }
 export declare const patchDocument: (data: InputDataType, options: PatchDocumentOptions) => Promise<Uint8Array>;
 export {};

package/build/patcher/replacer.d.ts

@@ -2,4 +2,4 @@ import { Element } from "xml-js";
 import { IContext } from '../file/xml-components';
 import { IPatch } from "./from-docx";
 import { IRenderedParagraphNode } from "./run-renderer";
-export declare const replacer: (json: Element, patch: IPatch, patchText: string, renderedParagraphs: readonly IRenderedParagraphNode[], context: IContext) => Element;
+export declare const replacer: (json: Element, patch: IPatch, patchText: string, renderedParagraphs: readonly IRenderedParagraphNode[], context: IContext, keepOriginalStyles?: boolean) => Element;

package/package.json

@@ -1,17 +1,17 @@
 {
     "name": "docx",
-    "version": "8.2.2",
+    "version": "8.2.4",
     "description": "Easily generate .docx files with JS/TS with a nice declarative API. Works for Node and on the Browser.",
     "type": "module",
     "main": "build/index.umd.js",
-    "module": "./build/index.js",
+    "module": "./build/index.mjs",
     "types": "./build/index.d.ts",
     "exports": {
         ".": {
             "require": "./build/index.cjs",
             "types": "./build/index.d.ts",
-            "import": "./build/index.js",
-            "default": "./build/index.js"
+            "import": "./build/index.mjs",
+            "default": "./build/index.mjs"
         }
     },
     "files": [
@@ -67,16 +67,15 @@
     },
     "homepage": "https://docx.js.org",
     "devDependencies": {
-        "@esbuild/win32-x64": "^0.18.3",
         "@types/inquirer": "^9.0.3",
         "@types/prompt": "^1.1.1",
         "@types/unzipper": "^0.10.4",
         "@types/xml": "^1.0.8",
-        "@typescript-eslint/eslint-plugin": "^5.36.1",
-        "@typescript-eslint/parser": "^5.36.1",
+        "@typescript-eslint/eslint-plugin": "^6.9.1",
+        "@typescript-eslint/parser": "^6.9.1",
         "@vitest/coverage-v8": "^0.33.0",
         "@vitest/ui": "^0.33.0",
-        "cspell": "^6.2.2",
+        "cspell": "^7.3.8",
         "docsify-cli": "^4.3.0",
         "eslint": "^8.23.0",
         "eslint-plugin-functional": "^5.0.8",
@@ -84,13 +83,13 @@
         "eslint-plugin-jsdoc": "^46.2.6",
         "eslint-plugin-no-null": "^1.0.2",
         "eslint-plugin-prefer-arrow": "^1.2.3",
-        "eslint-plugin-unicorn": "^47.0.0",
-        "execa": "^7.1.1",
+        "eslint-plugin-unicorn": "^48.0.1",
+        "execa": "^8.0.1",
         "glob": "^10.2.7",
         "inquirer": "^9.2.7",
         "jsdom": "^22.1.0",
         "pre-commit": "^1.2.2",
-        "prettier": "^2.3.1",
+        "prettier": "^3.0.0",
         "ts-node": "^10.2.1",
         "tsconfig-paths": "^4.0.0",
         "typedoc": "^0.24.8",