@adobe/helix-md2docx 1.3.8 → 1.3.11

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+## [1.3.11](https://github.com/adobe/helix-md2docx/compare/v1.3.10...v1.3.11) (2022-03-24)
+
+
+### Bug Fixes
+
+* handle row and colspan ([7077d4f](https://github.com/adobe/helix-md2docx/commit/7077d4f99957741885cdc1be39d6f23fa0cb88fa)), closes [#47](https://github.com/adobe/helix-md2docx/issues/47)
+
+## [1.3.10](https://github.com/adobe/helix-md2docx/compare/v1.3.9...v1.3.10) (2022-03-20)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/helix-fetch to v3.0.7 ([f211f44](https://github.com/adobe/helix-md2docx/commit/f211f4483dd6687e310e98c8b9793f65fa2f1893))
+
+## [1.3.9](https://github.com/adobe/helix-md2docx/compare/v1.3.8...v1.3.9) (2022-03-18)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/helix-docx2md to v1.0.10 ([#42](https://github.com/adobe/helix-md2docx/issues/42)) ([d58c683](https://github.com/adobe/helix-md2docx/commit/d58c683cb1f9d9fb802fa7dba1366dfb36475a1c))
+
 ## [1.3.8](https://github.com/adobe/helix-md2docx/compare/v1.3.7...v1.3.8) (2022-03-18)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-md2docx",
-  "version": "1.3.8",
+  "version": "1.3.11",
   "description": "Helix Service that converts markdown to word documents",
   "main": "src/index.js",
   "type": "module",
@@ -27,10 +27,10 @@
   },
   "homepage": "https://github.com/adobe/helix-md2docx#readme",
   "dependencies": {
-    "@adobe/helix-fetch": "3.0.6",
+    "@adobe/helix-fetch": "3.0.7",
     "@adobe/helix-markdown-support": "3.1.2",
     "@adobe/helix-shared-process-queue": "1.1.4",
-    "@adobe/helix-docx2md": "1.0.9",
+    "@adobe/helix-docx2md": "1.0.10",
     "docx": "7.3.0",
     "hast-util-is-element": "2.1.2",
     "hast-util-to-mdast": "8.3.1",
@@ -43,7 +43,7 @@
   },
   "devDependencies": {
     "@adobe/eslint-config-helix": "1.3.2",
-    "@adobe/helix-mediahandler": "1.0.11",
+    "@adobe/helix-mediahandler": "1.0.13",
     "@semantic-release/changelog": "6.0.1",
     "@semantic-release/exec": "6.0.3",
     "@semantic-release/git": "10.0.1",
@@ -57,7 +57,7 @@
     "fs-extra": "10.0.1",
     "husky": "7.0.4",
     "junit-report-builder": "3.0.0",
-    "lint-staged": "12.3.5",
+    "lint-staged": "12.3.7",
     "mocha": "9.2.2",
     "mocha-multi-reporters": "1.5.1",
     "semantic-release": "19.0.2",

package/src/mdast2docx/handlers/tableCell.js

@@ -45,7 +45,15 @@ export default async function tableCell(ctx, node, parent, siblings) {
     content.push(new Paragraph({ alignment, children: leaves }));
   }
 
-  return new TableCell({
+  const opts = {
     children: content,
-  });
+  };
+
+  if (node.data?.colSpan) {
+    opts.columnSpan = node.data.colSpan;
+  }
+  if (node.data?.rowSpan) {
+    opts.rowSpan = node.data.rowSpan;
+  }
+  return new TableCell(opts);
 }

package/src/mdast2docx/hast-table-cell-handler.js

@@ -0,0 +1,46 @@
+/*
+ * Copyright 2022 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+/*
+   copied and adapted (adding align) from
+   https://github.com/syntax-tree/hast-util-to-mdast/blob/main/lib/handlers/table-cell.js
+ */
+
+'use strict';
+
+import { all } from 'hast-util-to-mdast/lib/all.js';
+
+export default function cell(h, node) {
+  const wrap = h.wrapText;
+
+  // eslint-disable-next-line no-param-reassign
+  h.wrapText = false;
+
+  const result = h(node, 'tableCell', all(h, node));
+
+  if (node.properties?.rowSpan || node.properties?.colSpan || node.properties?.align) {
+    const data = result.data || (result.data = {});
+    if (node.properties.rowSpan) {
+      data.rowSpan = node.properties.rowSpan;
+    }
+    if (node.properties.colSpan) {
+      data.colSpan = node.properties.colSpan;
+    }
+    if (node.properties.align) {
+      data.align = node.properties.align;
+    }
+  }
+  // eslint-disable-next-line no-param-reassign
+  h.wrapText = wrap;
+
+  return result;
+}

package/src/mdast2docx/hast-table-handler.js

@@ -12,56 +12,15 @@
 
 'use strict';
 
-import { convertElement } from 'hast-util-is-element';
-import { visit } from 'unist-util-visit';
 import { all } from 'hast-util-to-mdast/lib/all.js';
 
-const thead = convertElement('thead');
-const tr = convertElement('tr');
-const cell = convertElement(['th', 'td']);
-
 /*
    copied and adapted from
-   https://github.com/syntax-tree/hast-util-to-mdast/blob/7.1.3/lib/handlers/table.js
+   https://github.com/syntax-tree/hast-util-to-mdast/blob/main/lib/handlers/table.js
  */
 
-// Infer whether the HTML table has a head and how it aligns.
-function inspect(node) {
-  let headless = true;
-  const align = [];
-  let rowIndex = 0;
-  let cellIndex = 0;
-
-  function visitor(child) {
-    // If there is a `thead`, assume there is a header row.
-    if (thead(child)) {
-      headless = false;
-    } else if (tr(child)) {
-      rowIndex += 1;
-      cellIndex = 0;
-    } else if (cell(child)) {
-      if (align[cellIndex] === undefined) {
-        align[cellIndex] = child.properties.align || null;
-      }
-
-      // If there is a th in the first row, assume there is a header row.
-      if (headless && rowIndex < 2 && child.tagName === 'th') {
-        headless = false;
-      }
-
-      cellIndex += 1;
-      return visit.SKIP;
-    }
-    return visit.CONTINUE;
-  }
-
-  visit(node, 'element', visitor);
-
-  return { align, headless };
-}
-
 // Ensure the cells in a row are properly structured.
-function toCells(children, info) {
+function toCells(children) {
   const nodes = [];
   let queue;
 
@@ -93,25 +52,14 @@ function toCells(children, info) {
     node.children = node.children.concat(queue);
   }
 
-  // add empty cells if there are more in the table
-  for (let index = nodes.length; index < info.align.length; index += 1) {
-    nodes.push({ type: 'tableCell', children: [] });
-  }
-
   return nodes;
 }
 
 // Ensure the rows are properly structured.
-function toRows(children, info) {
+function toRows(children) {
   const nodes = [];
   let queue;
 
-  // Add an empty header row.
-  // we don't need extra header rows
-  // if (info.headless) {
-  //   nodes.push({ type: 'tableRow', children: [] });
-  // }
-
   children.forEach((node) => {
     if (node.type === 'tableRow') {
       if (queue) {
@@ -133,13 +81,46 @@ function toRows(children, info) {
   }
   nodes.forEach((node) => {
     // eslint-disable-next-line no-param-reassign
-    node.children = toCells(node.children, info);
+    node.children = toCells(node.children);
   });
 
   return nodes;
 }
 
 export default function table(h, node) {
-  const info = inspect(node);
-  return h(node, 'table', { align: info.align }, toRows(all(h, node), info));
+  const mdNode = h(node, 'table', toRows(all(h, node)));
+
+  // clean up table in respect to row and colspan and compute alignments
+  mdNode.align = [];
+
+  // compute the number of cells in each row, respecting the row and col spans.
+  let maxCols = 0;
+  const pendingRowSpans = [];
+  for (const row of mdNode.children) {
+    row.numCols = pendingRowSpans.shift() || 0;
+    for (const cell of row.children) {
+      const rowSpan = Number.parseInt(cell.data?.rowSpan || '1', 10);
+      const colSpan = Number.parseInt(cell.data?.colSpan || '1', 10);
+      if (cell.data?.align && !mdNode.align[row.numCols]) {
+        mdNode.align[row.numCols] = cell.data.align;
+      }
+      row.numCols += colSpan;
+      if (rowSpan > 1) {
+        for (let i = 0; i < rowSpan - 1; i += 1) {
+          pendingRowSpans[i] = (pendingRowSpans[i] || 0) + colSpan;
+        }
+      }
+    }
+    maxCols = Math.max(maxCols, row.numCols);
+  }
+
+  // add empty cells if needed
+  for (const row of mdNode.children) {
+    for (let i = row.numCols; i < maxCols; i += 1) {
+      row.children.push({ type: 'tableCell', children: [] });
+    }
+    delete row.numCols;
+  }
+
+  return mdNode;
 }

package/src/mdast2docx/mdast-sanitize-html.js

@@ -15,6 +15,7 @@ import parse from 'rehype-parse';
 import { toMdast } from 'hast-util-to-mdast';
 // import inspect from 'unist-util-inspect';
 import tableHandler from './hast-table-handler.js';
+import tableCellHandler from './hast-table-cell-handler.js';
 
 /**
  * Creates simple format handler
@@ -90,6 +91,8 @@ export default function sanitizeHtml(tree) {
           sup: formatHandler('superScript'),
           table: tableHandler,
           markdown: mdHandler(mdInserts),
+          th: tableCellHandler,
+          td: tableCellHandler,
         },
       });