docxmlater 11.0.8 → 11.0.9

package/dist/esm/elements/ImageRun.js.map

@@ -1 +1 @@
-{"version":3,"file":"ImageRun.js","sourceRoot":"","sources":["../../../src/elements/ImageRun.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAgB/B,MAAM,OAAO,QAAS,SAAQ,GAAG;IACvB,YAAY,CAAQ;IACpB,UAAU,CAAU;IAM5B,YAAY,KAAY;QAGtB,KAAK,CAAC,EAAE,CAAC,CAAC;QACV,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;IAC5B,CAAC;IAED,YAAY,CAAC,GAAW;QACtB,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IACxB,CAAC;IAED,YAAY;QACV,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAMD,eAAe;QACb,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAOD,KAAK;QACH,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpB,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC;QACvD,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QAC1C,MAAM,QAAQ,GAAiB,EAAE,CAAC;QAMlC,MAAM,GAAG,GAAG,GAAG,CAAC,wBAAwB,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QAC/D,IAAI,GAAG;YAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC5B,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,OAAO;YACL,IAAI,EAAE,KAAK;YACX,QAAQ;SACT,CAAC;IACJ,CAAC;CACF","sourcesContent":["/**\n * ImageRun - A run that contains an image (drawing)\n * Extends Run class for type-safe paragraph content\n *\n * This is a specialized Run that contains a drawing instead of text.\n * It generates proper w:r (run) XML with w:drawing child element.\n */\n\nimport { Run } from './Run.js';\nimport { Image } from './Image.js';\nimport { XMLElement } from '../xml/XMLBuilder.js';\n\n/**\n * ImageRun - A run containing an embedded image\n *\n * In WordprocessingML, images are embedded in runs as drawing elements:\n * <w:r>\n *   <w:drawing>\n *     <wp:inline>\n *       ... image data ...\n *     </wp:inline>\n *   </w:drawing>\n * </w:r>\n */\nexport class ImageRun extends Run {\n  private imageElement: Image;\n  private _rawRunXml?: string;\n\n  /**\n   * Creates a new image run\n   * @param image The image to embed in this run\n   */\n  constructor(image: Image) {\n    // Call parent constructor with empty text\n    // The text is irrelevant for image runs\n    super('');\n    this.imageElement = image;\n  }\n\n  setRawRunXml(xml: string): void {\n    this._rawRunXml = xml;\n  }\n\n  getRawRunXml(): string | undefined {\n    return this._rawRunXml;\n  }\n\n  /**\n   * Gets the image element\n   * @returns Image instance\n   */\n  getImageElement(): Image {\n    return this.imageElement;\n  }\n\n  /**\n   * Override toXML to generate image-specific XML\n   * Generates a w:r element containing w:drawing instead of w:t\n   * @returns XMLElement with w:r containing w:drawing\n   */\n  toXML(): XMLElement {\n    if (this._rawRunXml) {\n      return { name: '__rawXml', rawXml: this._rawRunXml };\n    }\n    const drawing = this.imageElement.toXML();\n    const children: XMLElement[] = [];\n    // Per ECMA-376 §17.3.2.28, w:rPr (if present) must precede the run's\n    // content. For runs containing an inline drawing, the rPr's w:rFonts\n    // affects line metrics in Word; dropping it shifts the baseline and\n    // can let images (with shadow effectExtent) overflow their containing\n    // cell. Emit rPr whenever the run carries formatting.\n    const rPr = Run.generateRunPropertiesXML(this.getFormatting());\n    if (rPr) children.push(rPr);\n    children.push(drawing);\n    return {\n      name: 'w:r',\n      children,\n    };\n  }\n}\n"]}
+{"version":3,"file":"ImageRun.js","sourceRoot":"","sources":["../../../src/elements/ImageRun.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAE/B,OAAO,EAAc,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAc9D,MAAM,OAAO,QAAS,SAAQ,GAAG;IACvB,YAAY,CAAQ;IACpB,UAAU,CAAU;IAM5B,YAAY,KAAY;QAGtB,KAAK,CAAC,EAAE,CAAC,CAAC;QACV,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC;IAC5B,CAAC;IAED,YAAY,CAAC,GAAW;QACtB,IAAI,CAAC,UAAU,GAAG,GAAG,CAAC;IACxB,CAAC;IAED,YAAY;QACV,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAMD,eAAe;QACb,OAAO,IAAI,CAAC,YAAY,CAAC;IAC3B,CAAC;IAOD,KAAK;QACH,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YAEpB,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,SAAS,EAAE,EAAE,CAAC;gBACnC,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,UAAU,EAAE,CAAC;YACvD,CAAC;YAKD,MAAM,UAAU,GAAG,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC,CAAC;YACzE,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,kCAAkC,EAAE,UAAU,CAAC,CAAC;YACxF,IAAI,OAAO,KAAK,IAAI,CAAC,UAAU,EAAE,CAAC;gBAChC,OAAO,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC;YAC/C,CAAC;QAEH,CAAC;QACD,MAAM,OAAO,GAAG,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,CAAC;QAC1C,MAAM,QAAQ,GAAiB,EAAE,CAAC;QAMlC,MAAM,GAAG,GAAG,GAAG,CAAC,wBAAwB,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QAC/D,IAAI,GAAG;YAAE,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC5B,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,OAAO;YACL,IAAI,EAAE,KAAK;YACX,QAAQ;SACT,CAAC;IACJ,CAAC;CACF","sourcesContent":["/**\n * ImageRun - A run that contains an image (drawing)\n * Extends Run class for type-safe paragraph content\n *\n * This is a specialized Run that contains a drawing instead of text.\n * It generates proper w:r (run) XML with w:drawing child element.\n */\n\nimport { Run } from './Run.js';\nimport { Image } from './Image.js';\nimport { XMLElement, XMLBuilder } from '../xml/XMLBuilder.js';\n\n/**\n * ImageRun - A run containing an embedded image\n *\n * In WordprocessingML, images are embedded in runs as drawing elements:\n * <w:r>\n *   <w:drawing>\n *     <wp:inline>\n *       ... image data ...\n *     </wp:inline>\n *   </w:drawing>\n * </w:r>\n */\nexport class ImageRun extends Run {\n  private imageElement: Image;\n  private _rawRunXml?: string;\n\n  /**\n   * Creates a new image run\n   * @param image The image to embed in this run\n   */\n  constructor(image: Image) {\n    // Call parent constructor with empty text\n    // The text is irrelevant for image runs\n    super('');\n    this.imageElement = image;\n  }\n\n  setRawRunXml(xml: string): void {\n    this._rawRunXml = xml;\n  }\n\n  getRawRunXml(): string | undefined {\n    return this._rawRunXml;\n  }\n\n  /**\n   * Gets the image element\n   * @returns Image instance\n   */\n  getImageElement(): Image {\n    return this.imageElement;\n  }\n\n  /**\n   * Override toXML to generate image-specific XML\n   * Generates a w:r element containing w:drawing instead of w:t\n   * @returns XMLElement with w:r containing w:drawing\n   */\n  toXML(): XMLElement {\n    if (this._rawRunXml) {\n      // No live mutation since parse — emit the captured run XML verbatim (round-trip).\n      if (!this.imageElement.isMutated()) {\n        return { name: '__rawXml', rawXml: this._rawRunXml };\n      }\n      // The live image was mutated (e.g. setBorder/setSize). Splice the regenerated\n      // <w:drawing> into the captured run XML so the change applies while preserving the\n      // run's rPr and other captured details — a full regenerate would drop the parsed\n      // rPr (not modeled on revision-nested image runs) and can clip the image in Word.\n      const drawingXml = XMLBuilder.elementToString(this.imageElement.toXML());\n      const spliced = this._rawRunXml.replace(/<w:drawing\\b[\\s\\S]*<\\/w:drawing>/, drawingXml);\n      if (spliced !== this._rawRunXml) {\n        return { name: '__rawXml', rawXml: spliced };\n      }\n      // No <w:drawing> found to splice (unexpected) — fall through to full regeneration.\n    }\n    const drawing = this.imageElement.toXML();\n    const children: XMLElement[] = [];\n    // Per ECMA-376 §17.3.2.28, w:rPr (if present) must precede the run's\n    // content. For runs containing an inline drawing, the rPr's w:rFonts\n    // affects line metrics in Word; dropping it shifts the baseline and\n    // can let images (with shadow effectExtent) overflow their containing\n    // cell. Emit rPr whenever the run carries formatting.\n    const rPr = Run.generateRunPropertiesXML(this.getFormatting());\n    if (rPr) children.push(rPr);\n    children.push(drawing);\n    return {\n      name: 'w:r',\n      children,\n    };\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docxmlater",
-  "version": "11.0.8",
+  "version": "11.0.9",
   "description": "TypeScript library for editing existing Word documents with full tracked-changes, comment, and bookmark fidelity. Round-trip safe DOCX modification.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/elements/Image.ts

@@ -335,6 +335,10 @@ export class Image {
   private flipV = false;
   private border?: ImageBorder;
 
+  // Set true when a serialization-affecting setter (setBorder/setSize) mutates this image
+  // after parse, so an owning ImageRun knows to refresh its captured raw run XML.
+  private _mutated = false;
+
   // Group A: Simple attribute preservation (ECMA-376 compliance)
   private presetGeometry: PresetGeometry = 'rect';
   private compressionState: BlipCompressionState = 'none';
@@ -978,9 +982,18 @@ export class Image {
   setSize(width: number, height: number): this {
     this.width = width;
     this.height = height;
+    this._mutated = true;
     return this;
   }
 
+  /**
+   * Returns true if a serialization-affecting setter mutated this image after parse.
+   * An owning ImageRun uses this to refresh its captured raw run XML.
+   */
+  isMutated(): boolean {
+    return this._mutated;
+  }
+
   async updateImageData(newSource: string | Buffer): Promise<void> {
     this.source = newSource;
     this.imageData = undefined;
@@ -1510,6 +1523,7 @@ export class Image {
     this.effectExtent.right = Math.max(this.effectExtent.right, halfBorderEmu);
     this.effectExtent.bottom = Math.max(this.effectExtent.bottom, halfBorderEmu);
 
+    this._mutated = true;
     return this;
   }
 

package/src/elements/ImageRun.ts

@@ -8,7 +8,7 @@
 
 import { Run } from './Run.js';
 import { Image } from './Image.js';
-import { XMLElement } from '../xml/XMLBuilder.js';
+import { XMLElement, XMLBuilder } from '../xml/XMLBuilder.js';
 
 /**
  * ImageRun - A run containing an embedded image
@@ -60,7 +60,20 @@ export class ImageRun extends Run {
    */
   toXML(): XMLElement {
     if (this._rawRunXml) {
-      return { name: '__rawXml', rawXml: this._rawRunXml };
+      // No live mutation since parse — emit the captured run XML verbatim (round-trip).
+      if (!this.imageElement.isMutated()) {
+        return { name: '__rawXml', rawXml: this._rawRunXml };
+      }
+      // The live image was mutated (e.g. setBorder/setSize). Splice the regenerated
+      // <w:drawing> into the captured run XML so the change applies while preserving the
+      // run's rPr and other captured details — a full regenerate would drop the parsed
+      // rPr (not modeled on revision-nested image runs) and can clip the image in Word.
+      const drawingXml = XMLBuilder.elementToString(this.imageElement.toXML());
+      const spliced = this._rawRunXml.replace(/<w:drawing\b[\s\S]*<\/w:drawing>/, drawingXml);
+      if (spliced !== this._rawRunXml) {
+        return { name: '__rawXml', rawXml: spliced };
+      }
+      // No <w:drawing> found to splice (unexpected) — fall through to full regeneration.
     }
     const drawing = this.imageElement.toXML();
     const children: XMLElement[] = [];