@adobe/helix-md2docx 2.0.2 → 2.0.4

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## [2.0.4](https://github.com/adobe/helix-md2docx/compare/v2.0.3...v2.0.4) (2022-09-27)
+
+
+### Bug Fixes
+
+* add support for gridtables ([#141](https://github.com/adobe/helix-md2docx/issues/141)) ([a5a3952](https://github.com/adobe/helix-md2docx/commit/a5a39527891504f04dafc932d7dd65caf47e8b6a))
+
+## [2.0.3](https://github.com/adobe/helix-md2docx/compare/v2.0.2...v2.0.3) (2022-09-27)
+
+
+### Bug Fixes
+
+* **deps:** update dependency @adobe/helix-docx2md to v1.1.2 ([#140](https://github.com/adobe/helix-md2docx/issues/140)) ([8a20252](https://github.com/adobe/helix-md2docx/commit/8a20252aad5567488c464c9694e3627f787d359b))
+
 ## [2.0.2](https://github.com/adobe/helix-md2docx/compare/v2.0.1...v2.0.2) (2022-09-24)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/helix-md2docx",
-  "version": "2.0.2",
+  "version": "2.0.4",
   "description": "Helix Service that converts markdown to word documents",
   "main": "src/index.js",
   "type": "module",
@@ -28,7 +28,7 @@
   "homepage": "https://github.com/adobe/helix-md2docx#readme",
   "dependencies": {
     "@adobe/fetch": "3.1.4",
-    "@adobe/helix-docx2md": "1.1.1",
+    "@adobe/helix-docx2md": "1.1.2",
     "@adobe/helix-markdown-support": "5.0.7",
     "@adobe/helix-shared-process-queue": "1.1.5",
     "docx": "7.5.0",
@@ -44,7 +44,7 @@
   },
   "devDependencies": {
     "@adobe/eslint-config-helix": "1.3.2",
-    "@adobe/helix-mediahandler": "1.2.4",
+    "@adobe/helix-mediahandler": "1.2.5",
     "@semantic-release/changelog": "6.0.1",
     "@semantic-release/exec": "6.0.3",
     "@semantic-release/git": "10.0.1",

package/src/mdast2docx/handlers/gridTable.js

@@ -0,0 +1,85 @@
+/*
+ * 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.
+ */
+import docx from 'docx';
+import all from '../all.js';
+
+const { Paragraph, Table, WidthType } = docx;
+
+function* rowIter(node) {
+  for (const child of node.children) {
+    if (child.type === 'gtRow') {
+      yield child;
+    } else {
+      for (const grandChild of child.children) {
+        yield grandChild;
+      }
+    }
+  }
+}
+
+// see http://officeopenxml.com/WPtableWidth.php
+// Note: The 2006 version of the OOXML standard specified that the value was to be a decimal.
+// When type="pct", the value was interpreted as fifths of a percent, so 4975=99.5%,
+// and no % symbol was included in the attribute. In the 2011 version the value can be either a
+// decimal or a percent, so a % symbol should be included when type="pct".
+
+export default async function gridTable(ctx, node) {
+  let maxCols = 1;
+
+  // need to calculate the number of columns beforehand, for nested tables
+  // compute the number of cells in each row, respecting the row and col spans.
+  const pendingRowSpans = [];
+  for (const row of rowIter(node)) {
+    let 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);
+      numCols += colSpan;
+      if (rowSpan > 1) {
+        for (let i = 0; i < rowSpan - 1; i += 1) {
+          pendingRowSpans[i] = (pendingRowSpans[i] || 0) + colSpan;
+        }
+      }
+    }
+    maxCols = Math.max(maxCols, numCols);
+  }
+
+  const oldTable = ctx.table;
+  ctx.table = {
+    // remember the table width
+    // default width: Letter Width - Margin = 8.5" - 2" = 6.5". the unit is 1/1440 inches.
+    width: oldTable?.columnWidth || 1440 * 6.5,
+    align: node.align || [],
+  };
+
+  // use the same width for all columns
+  ctx.table.columnWidth = maxCols ? (ctx.table.width / maxCols) : ctx.table.width;
+  const columnWidths = new Array(maxCols).fill(Math.round(ctx.table.columnWidth));
+
+  // process the rows
+  const rows = await all(ctx, node);
+
+  ctx.table = oldTable;
+
+  const tbl = new Table({
+    style: 'PageBlock',
+    rows,
+    columnWidths,
+    width: {
+      size: 100,
+      type: WidthType.PERCENTAGE,
+    },
+  });
+
+  // add empty paragraph for better separation in word
+  return [tbl, new Paragraph([])];
+}

package/src/mdast2docx/handlers/gtRow.js

@@ -0,0 +1,23 @@
+/*
+ * 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.
+ */
+import docx from 'docx';
+import all from '../all.js';
+
+const { TableRow } = docx;
+
+export default async function gridTableRow(ctx, node, parent) {
+  const children = await all(ctx, node);
+  return new TableRow({
+    children,
+    tableHeader: parent.type === 'gtHeader' ? true : undefined,
+  });
+}

package/src/mdast2docx/handlers/index.js

@@ -28,6 +28,9 @@ import tableRow from './tableRow.js';
 import tableCell from './tableCell.js';
 import text from './text.js';
 import thematicBreak from './thematicBreak.js';
+import gridTable from './gridTable.js';
+import gtRow from './gtRow.js';
+import all from '../all.js';
 
 export default {
   blockquote: paragraphStyle('Quote'),
@@ -53,4 +56,10 @@ export default {
   tableCell,
   text,
   thematicBreak,
+  gridTable,
+  gtRow,
+  gtHeader: all,
+  gtFooter: all,
+  gtBody: all,
+  gtCell: tableCell,
 };

package/src/mdast2docx/handlers/paragraph.js

@@ -14,7 +14,7 @@ import all from '../all.js';
 
 const { Paragraph } = docx;
 
-export default async function paragraph(ctx, node) {
+export default async function paragraph(ctx, node, parent) {
   // clear style
   ctx.style = {};
 
@@ -29,6 +29,7 @@ export default async function paragraph(ctx, node) {
   const children = await all(ctx, node);
   const opts = {
     children,
+    alignment: parent.alignment,
   };
 
   if (ctx.listLevel >= 0) {

package/src/mdast2docx/handlers/tableCell.js

@@ -11,20 +11,30 @@
  */
 import docx from 'docx';
 import all from '../all.js';
+import { removeUndefined } from '../utils.js';
 
 const {
-  AlignmentType, Paragraph, Table, TableCell, ShadingType,
+  AlignmentType, Paragraph, Table, TableCell, ShadingType, VerticalAlign,
 } = docx;
 
 const ALIGN = {
   left: null,
   right: AlignmentType.RIGHT,
   center: AlignmentType.CENTER,
+  justify: AlignmentType.JUSTIFIED,
+  distribute: AlignmentType.DISTRIBUTE,
+};
+
+const V_ALIGN = {
+  top: VerticalAlign.TOP,
+  middle: VerticalAlign.CENTER,
+  bottom: VerticalAlign.BOTTOM,
 };
 
 export default async function tableCell(ctx, node, parent, siblings) {
+  // eslint-disable-next-line no-param-reassign
+  node.alignment = ALIGN[node.align || ctx.table.align?.[siblings.length]];
   const children = await all(ctx, node);
-  const alignment = ALIGN[ctx.table.align[siblings.length]];
 
   const content = [];
   let leaves = [];
@@ -33,7 +43,7 @@ export default async function tableCell(ctx, node, parent, siblings) {
     const child = children[i];
     if ((child instanceof Paragraph) || (child instanceof Table)) {
       if (leaves.length) {
-        content.push(new Paragraph({ alignment, children: leaves }));
+        content.push(new Paragraph({ alignment: node.alignment, children: leaves }));
       }
       content.push(child);
       leaves = [];
@@ -42,19 +52,15 @@ export default async function tableCell(ctx, node, parent, siblings) {
     }
   }
   if (leaves.length) {
-    content.push(new Paragraph({ alignment, children: leaves }));
+    content.push(new Paragraph({ alignment: node.alignment, children: leaves }));
   }
 
-  const opts = {
+  const opts = removeUndefined({
     children: content,
-  };
-
-  if (node.data?.colSpan) {
-    opts.columnSpan = node.data.colSpan;
-  }
-  if (node.data?.rowSpan) {
-    opts.rowSpan = node.data.rowSpan;
-  }
+    verticalAlign: V_ALIGN[node.valign],
+    columnSpan: node.data?.colSpan ?? node.colSpan,
+    rowSpan: node.data?.rowSpan ?? node.rowSpan,
+  });
 
   if (parent.tableHeader) {
     // shading for header row

package/src/mdast2docx/handlers/text.js

@@ -14,11 +14,8 @@ import docx from 'docx';
 const { TextRun } = docx;
 
 export default function textNode(ctx, node) {
-  return node.value.split('\n').map((text, idx) => (
-    new TextRun({
-      ...ctx.style,
-      text,
-      break: idx > 0 ? 1 : 0,
-    })
-  ));
+  return new TextRun({
+    ...ctx.style,
+    text: node.value,
+  });
 }

package/src/mdast2docx/utils.js

@@ -27,3 +27,18 @@ export function findXMLComponent(root, path) {
   }
   return comp;
 }
+
+/**
+ * removes undefined and null properties from the given object.
+ * @param {object} obj
+ * @returns {object}
+ */
+export function removeUndefined(obj) {
+  for (const key of Object.keys(obj)) {
+    if (obj[key] === undefined || obj[key] === null) {
+      // eslint-disable-next-line no-param-reassign
+      delete obj[key];
+    }
+  }
+  return obj;
+}