@adobe/helix-md2docx 2.1.77 → 2.1.79

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [2.1.79](https://github.com/adobe/helix-md2docx/compare/v2.1.78...v2.1.79) (2024-10-16)
+
+
+### Bug Fixes
+
+* **deps:** update dependency docx to v9 ([#495](https://github.com/adobe/helix-md2docx/issues/495)) ([88808e0](https://github.com/adobe/helix-md2docx/commit/88808e0f7a1b1aafb2f8a6a5d39607f1a3315398))
+
+## [2.1.78](https://github.com/adobe/helix-md2docx/compare/v2.1.77...v2.1.78) (2024-10-15)
+
+
+### Bug Fixes
+
+* don't create bookmarks if heading is not referenced ([656e792](https://github.com/adobe/helix-md2docx/commit/656e792d3f31a0731c72fac9583d370cbf3a2a5d)), closes [#492](https://github.com/adobe/helix-md2docx/issues/492)
+
 ## [2.1.77](https://github.com/adobe/helix-md2docx/compare/v2.1.76...v2.1.77) (2024-09-30)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-md2docx",
-  "version": "2.1.77",
+  "version": "2.1.79",
   "description": "Helix Service that converts markdown to word documents",
   "main": "src/index.js",
   "type": "module",
@@ -9,7 +9,7 @@
     "lint": "eslint .",
     "semantic-release": "semantic-release",
     "semantic-release-dry": "semantic-release --dry-run --branches $CI_BRANCH",
-    "prepare": "husky install"
+    "prepare": "husky"
   },
   "mocha": {
     "spec": "test/*.test.js",
@@ -33,7 +33,7 @@
     "@adobe/helix-markdown-support": "7.1.6",
     "@adobe/helix-shared-process-queue": "3.0.4",
     "@adobe/remark-gridtables": "3.0.6",
-    "docx": "8.5.0",
+    "docx": "9.0.2",
     "github-slugger": "2.0.0",
     "hast-util-is-element": "3.0.0",
     "hast-util-to-mdast": "10.1.0",
@@ -47,8 +47,8 @@
     "unist-util-visit": "5.0.0"
   },
   "devDependencies": {
-    "@adobe/eslint-config-helix": "2.0.7",
-    "@adobe/helix-mediahandler": "2.5.23",
+    "@adobe/eslint-config-helix": "2.0.8",
+    "@adobe/helix-mediahandler": "2.5.26",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/exec": "6.0.3",
     "@semantic-release/git": "10.0.1",
@@ -57,7 +57,7 @@
     "eslint": "8.57.1",
     "eslint-import-resolver-exports": "1.0.0-beta.5",
     "eslint-plugin-header": "3.1.1",
-    "eslint-plugin-import": "2.30.0",
+    "eslint-plugin-import": "2.31.0",
     "husky": "9.1.6",
     "junit-report-builder": "5.1.1",
     "lint-staged": "15.2.10",

package/src/mdast2docx/handlers/image.js

@@ -9,10 +9,7 @@
  * OF ANY KIND, either express or implied. See the License for the specific language
  * governing permissions and limitations under the License.
  */
-import {
-  Drawing, ImageRun, XmlComponent, XmlAttributeComponent,
-} from 'docx';
-import { findXMLComponent } from '../utils.js';
+import { ImageRun } from 'docx';
 
 // max image width (6.5") and height (2")
 const LIMITS = {
@@ -31,6 +28,7 @@ export default async function image(ctx, node) {
   if (!data) {
     return undefined;
   }
+
   let x = data.dimensions.width * 9525;
   let y = data.dimensions.height * 9525;
   const limits = ctx.tableAlign ? LIMITS_TABLE : LIMITS;
@@ -43,127 +41,28 @@ export default async function image(ctx, node) {
     y = limits.height;
   }
 
-  const imageData = {
-    stream: data.buffer,
-    fileName: data.key,
+  const options = {
+    type: data.dimensions.type || 'png',
+    data: data.buffer,
     transformation: {
-      pixels: {
-        x: Math.round(data.dimensions.width),
-        y: Math.round(data.dimensions.height),
-      },
-      emus: {
-        x,
-        y,
-      },
+      width: Math.max(x / 9525, 32),
+      height: Math.max(y / 9525, 32),
     },
-  };
-
-  const drawing = new Drawing(imageData, {
-    floating: false,
-    docProperties: {
+    altText: {
       title: node.title || '',
       description: node.alt || '',
       name: node.title || node.alt || '',
     },
-  });
-
-  // create picture
-  const pic = new ImageRun({
-    data: data.buffer,
-    transformation: data.dimensions,
-  });
-  // replace drawing
-  const oldDrawing = findXMLComponent(pic, 'w:drawing');
-  const idx = pic.root.indexOf(oldDrawing);
-  if (idx >= 0) {
-    pic.root.splice(idx, 1);
-  }
-  pic.root.push(drawing);
-  pic.key = data.key;
-  pic.imageData = imageData;
-
-  // for SVGs, we need to generate a proper svgBlip
-  /*
-  <pic:blipFill>
-    <a:blip r:embed="rId4">
-      <a:extLst>
-        <a:ext uri="{28A0092B-C50C-407E-A947-70E740481C1C}">
-          <a14:useLocalDpi val="0" xmlns:a14="http://schemas.microsoft.com/office/drawing/2010/main"/>
-        </a:ext>
-        <a:ext uri="{96DAC541-7B7A-43D3-8B79-37D633B846F1}">
-          <asvg:svgBlip r:embed="rId5" xmlns:asvg="http://schemas.microsoft.com/office/drawing/2016/SVG/main"/>
-        </a:ext>
-      </a:extLst>
-    </a:blip>
-    <a:stretch>
-      <a:fillRect/>
-    </a:stretch>
-  </pic:blipFill>
-   */
-
-  class SvgBlip extends XmlComponent {
-    constructor(imgData) {
-      super('asvg:svgBlip');
-      this.imageData = imgData;
-      this.addChildElement(new XmlAttributeComponent({
-        'xmlns:asvg': 'http://schemas.microsoft.com/office/drawing/2016/SVG/main',
-        'r:embed': `rId{${imgData.fileName}}`,
-      }));
-    }
-
-    prepForXml(context) {
-      // add the svg data if it has a stream
-      if (this.imageData.stream) {
-        context.file.Media.addImage(this.imageData.fileName, this.imageData);
-      }
+  };
 
-      // add svg content type if missing
-      if (!context.file.contentTypes.root.find((entry) => entry.rootKey === 'Default'
-          && (entry.root[0].root.extension === 'svg' || entry.root[0].root.Extension === 'svg'))) {
-        context.file.contentTypes.root.push(new XmlComponent('Default').addChildElement(new XmlAttributeComponent({
-          ContentType: 'image/svg+xml',
-          Extension: 'svg',
-        })));
-      }
-      return super.prepForXml(context);
-    }
+  if (data.originalType === 'image/svg' || data.originalType === 'image/svg+xml') {
+    options.type = 'svg';
+    options.data = data.originalBuffer;
+    options.fallback = {
+      type: data.ext,
+      data: data.buffer,
+    };
   }
 
-  if (data.originalType === 'image/svg') {
-    // create a fake image run for the svg image
-    const ir = new ImageRun({
-      data: data.originalBuffer,
-      transformation: data.dimensions,
-    });
-    ir.imageData.fileName = data.svgKey;
-
-    const blipFill = findXMLComponent(drawing, 'wp:inline/a:graphic/a:graphicData/pic:pic/pic:blipFill');
-    const blip = findXMLComponent(blipFill, 'a:blip');
-
-    // const blipAttrs = findXMLComponent(oldBlip, '_attr');
-    // blipAttrs.root.embed = `rId{${ir.imageData.fileName}}`;
-
-    // add svg stuff
-    // const newBlip = new XmlComponent('a:blip')
-    blip
-      .addChildElement(new XmlComponent('a:extLst')
-        .addChildElement(new XmlComponent('a:ext')
-          .addChildElement(new XmlAttributeComponent({
-            uri: '{28A0092B-C50C-407E-A947-70E740481C1C}',
-          }))
-          .addChildElement(new XmlComponent('a14:useLocalDpi')
-            .addChildElement(new XmlAttributeComponent({
-              'xmlns:a14': 'http://schemas.microsoft.com/office/drawing/2010/main',
-              val: '0',
-            }))))
-        .addChildElement(new XmlComponent('a:ext')
-          .addChildElement(new XmlAttributeComponent({
-            uri: '{96DAC541-7B7A-43D3-8B79-37D633B846F1}',
-          }))
-          .addChildElement(new SvgBlip(ir.imageData))));
-
-    // replace blip
-    // blipFill.root.splice(blipFill.root.indexOf(oldBlip), 1, newBlip);
-  }
-  return pic;
+  return new ImageRun(options);
 }

package/src/mdast2docx/mdast-docx-anchors.js

@@ -46,7 +46,20 @@ export function buildAnchors(tree) {
   const track = (url) => {
     let ref = tracking[url];
     if (!ref) {
-      ref = { links: [], heading: null, bookmark: null };
+      ref = {
+        /**
+         * links that use this `url`
+         */
+        links: [],
+        /**
+         * heading that is anchored at this `url`
+         */
+        heading: null,
+        /**
+         * bookmark that is anchored at this `url`
+         */
+        bookmark: null,
+      };
       tracking[url] = ref;
     }
     return ref;
@@ -75,7 +88,7 @@ export function buildAnchors(tree) {
   const anchors = {};
   Object.keys(tracking).forEach((k) => {
     const ref = tracking[k];
-    if (ref.heading) {
+    if (ref.heading && ref.links.length) {
       // ms-word heading bookmark algorithm
       const words = toString(ref.heading).split(/\s+/).slice(0, 3);
       let anchor = `_${words.join('_')}`.substring(0, 36);
@@ -88,8 +101,10 @@ export function buildAnchors(tree) {
       }
       anchors[anchor] = 0;
 
+      // remember word-specific anchor for heading
       ref.heading.anchor = anchor;
       for (const link of ref.links) {
+        // change links to reference word-specific anchor
         link.anchor = anchor;
       }
     } else if (ref.bookmark) {