@adobe/helix-md2docx 1.0.1

package/src/mdast2docx/all.js

@@ -0,0 +1,31 @@
+/*
+ * Copyright 2021 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.
+ */
+
+function unknown() {
+  return undefined;
+}
+
+export default async function all(ctx, parent) {
+  const nodes = parent.children || [];
+  let values = [];
+
+  for (const node of nodes) {
+    const fn = ctx.handlers[node.type] || unknown;
+
+    // eslint-disable-next-line no-await-in-loop
+    const result = await fn(ctx, node, parent, values);
+    if (result) {
+      values = values.concat(result);
+    }
+  }
+  return values;
+}

package/src/mdast2docx/default-numbering.js

@@ -0,0 +1,79 @@
+/*
+ * Copyright 2021 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';
+
+const { AlignmentType, convertMillimetersToTwip, LevelFormat } = docx;
+
+function createLevels() {
+  const levels = [];
+  const formats = [
+    LevelFormat.DECIMAL,
+    LevelFormat.LOWER_LETTER,
+    LevelFormat.LOWER_ROMAN,
+  ];
+  const sfx = [
+    '.',
+    '',
+    '',
+  ];
+  for (let level = 0; level < 6; level += 1) {
+    levels.push({
+      level,
+      format: formats[level % 3],
+      text: `%${level + 1}${sfx[level % 3]}`,
+      alignment: AlignmentType.START,
+      style: {
+        paragraph: {
+          indent: {
+            left: convertMillimetersToTwip(10 * (level + 1)),
+            hanging: convertMillimetersToTwip(5),
+          },
+        },
+      },
+    });
+  }
+  return levels;
+}
+
+function createBulletLevels() {
+  const levels = [];
+  for (let level = 0; level < 6; level += 1) {
+    levels.push({
+      level,
+      format: LevelFormat.BULLET,
+      text: '-',
+      alignment: AlignmentType.START,
+      style: {
+        paragraph: {
+          indent: {
+            left: convertMillimetersToTwip(5 * (level + 1)),
+            hanging: convertMillimetersToTwip(5),
+          },
+        },
+      },
+    });
+  }
+  return levels;
+}
+
+export default {
+  config: [
+    {
+      reference: 'default-numbering',
+      levels: createLevels(),
+    },
+    {
+      reference: 'default-bullets',
+      levels: createBulletLevels(),
+    },
+  ],
+};

package/src/mdast2docx/handlers/break.js

@@ -0,0 +1,22 @@
+/*
+ * Copyright 2021 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';
+
+const { TextRun } = docx;
+
+export default function brk() {
+  return new TextRun({
+    // could probably be optimized....
+    text: '',
+    break: 1,
+  });
+}

package/src/mdast2docx/handlers/characterStyle.js

@@ -0,0 +1,29 @@
+/*
+ * Copyright 2021 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 all from '../all.js';
+
+export default function characterStyle(opts) {
+  return async (ctx, node) => {
+    if (typeof opts === 'string') {
+      // eslint-disable-next-line no-param-reassign
+      opts = {
+        [opts]: true,
+      };
+    }
+    Object.assign(ctx.style, opts);
+    const result = await all(ctx, node);
+    Object.keys(opts).forEach((key) => {
+      delete ctx.style[key];
+    });
+    return result;
+  };
+}

package/src/mdast2docx/handlers/code.js

@@ -0,0 +1,27 @@
+/*
+ * Copyright 2021 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';
+
+const { Paragraph, TextRun } = docx;
+
+export default function code(ctx, node) {
+  const children = node.value.split('\n').map((text, idx) => (
+    new TextRun({
+      text,
+      break: idx > 0 ? 1 : 0,
+    })
+  ));
+  return new Paragraph({
+    children,
+    style: 'CodeBlock',
+  });
+}

package/src/mdast2docx/handlers/heading.js

@@ -0,0 +1,32 @@
+/*
+ * Copyright 2021 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 { HeadingLevel, Paragraph } = docx;
+
+const DEPTHS = [
+  HeadingLevel.HEADING_1,
+  HeadingLevel.HEADING_2,
+  HeadingLevel.HEADING_3,
+  HeadingLevel.HEADING_4,
+  HeadingLevel.HEADING_5,
+  HeadingLevel.HEADING_6,
+];
+
+export default async function heading(ctx, node) {
+  const children = await all(ctx, node);
+  return new Paragraph({
+    heading: DEPTHS[node.depth - 1],
+    children,
+  });
+}

package/src/mdast2docx/handlers/html.js

@@ -0,0 +1,35 @@
+/*
+ * Copyright 2021 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';
+
+const { Paragraph, TextRun } = docx;
+
+export default function html(ctx, node, parent) {
+  if (node.value === '<!---->') {
+    // ignore
+    return undefined;
+  }
+  // should not occur...just create text
+  const text = new TextRun({
+    color: 'ff0000',
+    text: node.value,
+  });
+
+  if (parent.type === 'paragraph') {
+    return text;
+  }
+  return new Paragraph({
+    children: [
+      text,
+    ],
+  });
+}

package/src/mdast2docx/handlers/image.js

@@ -0,0 +1,90 @@
+/*
+ * Copyright 2021 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 { findXMLComponent } from '../utils.js';
+
+const { Drawing, ImageRun } = docx;
+
+// max image width (6.5") and height (2")
+const LIMITS = {
+  width: 914400 * 6.5,
+  height: 914400 * 2.0,
+};
+
+// max image width (2") and height (1") in tables
+const LIMITS_TABLE = {
+  width: 914400 * 2.0,
+  height: 914400,
+};
+
+export default async function image(ctx, node) {
+  const { data } = node;
+  if (!data) {
+    return undefined;
+  }
+  let x = data.dimensions.width * 9525;
+  let y = data.dimensions.height * 9525;
+  const limits = ctx.tableAlign ? LIMITS_TABLE : LIMITS;
+  if (x > limits.width) {
+    y = Math.round((limits.width * y) / x);
+    x = limits.width;
+  }
+  if (y > limits.height) {
+    x = Math.round((limits.height * x) / y);
+    y = limits.height;
+  }
+
+  const imageData = {
+    stream: data.buffer,
+    fileName: data.key,
+    transformation: {
+      pixels: {
+        x: Math.round(data.dimensions.width),
+        y: Math.round(data.dimensions.height),
+      },
+      emus: {
+        x,
+        y,
+      },
+    },
+  };
+
+  const drawing = new Drawing(imageData, { floating: false });
+  // hack to get document properties to set alt text
+  if (node.title || node.alt) {
+    const docProps = findXMLComponent(drawing, 'wp:inline/wp:docPr/_attr');
+    if (docProps && docProps.root) {
+      if (node.title) {
+        docProps.root.title = node.title;
+      }
+      if (node.alt) {
+        docProps.root.descr = 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;
+  return pic;
+}

package/src/mdast2docx/handlers/index.js

@@ -0,0 +1,56 @@
+/*
+ * Copyright 2021 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 brk from './break.js';
+import characterStyle from './characterStyle.js';
+import code from './code.js';
+import heading from './heading.js';
+import html from './html.js';
+import image from './image.js';
+import inlineCode from './inlineCode.js';
+import link from './link.js';
+import list from './list.js';
+import listItem from './listItem.js';
+import paragraph from './paragraph.js';
+import paragraphStyle from './paragraphStyle.js';
+import root from './root.js';
+import table from './table.js';
+import tableRow from './tableRow.js';
+import tableCell from './tableCell.js';
+import text from './text.js';
+import thematicBreak from './thematicBreak.js';
+
+export default {
+  blockquote: paragraphStyle('Quote'),
+  break: brk,
+  code,
+  delete: characterStyle('strike'),
+  emphasis: characterStyle('italics'),
+  strong: characterStyle('bold'),
+  underline: characterStyle('underline'),
+  subScript: characterStyle('subScript'),
+  superScript: characterStyle('superScript'),
+  heading,
+  html,
+  image,
+  inlineCode,
+  link,
+  list,
+  listItem,
+  paragraph,
+  root,
+  table,
+  tableRow,
+  tableCell,
+  text,
+  thematicBreak,
+};

package/src/mdast2docx/handlers/inlineCode.js

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2021 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';
+
+const { TextRun } = docx;
+
+export default function inlineCode(ctx, node) {
+  return new TextRun({
+    text: node.value,
+    style: 'InlineCode',
+  });
+}

package/src/mdast2docx/handlers/link.js

@@ -0,0 +1,63 @@
+/*
+ * Copyright 2021 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 { ExternalHyperlink, ImageRun, TextRun } = docx;
+
+/**
+ * Handles links.
+ *
+ * @param ctx
+ * @param node
+ * @returns {Promise<[]>}
+ */
+export default async function link(ctx, node) {
+  const result = [];
+  ctx.style.style = 'Hyperlink';
+
+  const children = await all(ctx, node);
+  // check if one of the children is an image
+  if (children.findIndex((child) => child instanceof ImageRun) >= 0) {
+    for (const child of await all(ctx, node)) {
+      // links on images can't be edited in word. so create a link below the image
+      if (child instanceof ImageRun) {
+        result.push(
+          child,
+          new TextRun({ text: '', break: 1 }),
+          new ExternalHyperlink({
+            children: [
+              new TextRun({ text: node.url, style: 'Hyperlink' }),
+            ],
+            link: node.url,
+          }),
+          new TextRun({ text: '', break: 1 }),
+        );
+      } else {
+        result.push(new ExternalHyperlink({
+          children: [
+            child,
+          ],
+          link: node.url,
+        }));
+      }
+    }
+  } else {
+    result.push(new ExternalHyperlink({
+      children,
+      link: node.url,
+    }));
+  }
+
+  delete ctx.style.style;
+  return result;
+}

package/src/mdast2docx/handlers/list.js

@@ -0,0 +1,39 @@
+/*
+ * Copyright 2021 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 all from '../all.js';
+
+export default async function list(ctx, node) {
+  const { ordered, start } = node;
+  ctx.listLevel += 1;
+  let lst = ctx.lists[ctx.listLevel];
+  if (!lst) {
+    lst = {
+      level: ctx.listLevel,
+      number: start || 1,
+      instance: 1,
+    };
+    ctx.lists[ctx.listLevel] = lst;
+  }
+  if (start && start < lst.number) {
+    lst.number = start;
+    lst.instance += 1;
+  }
+  if (ordered) {
+    lst.numbering = 'default-numbering';
+  } else {
+    lst.numbering = 'default-bullets';
+  }
+
+  const children = await all(ctx, node);
+  ctx.listLevel -= 1;
+  return children;
+}

package/src/mdast2docx/handlers/listItem.js

@@ -0,0 +1,16 @@
+/*
+ * Copyright 2021 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 all from '../all.js';
+
+export default function listItem(ctx, node) {
+  return all(ctx, node);
+}

package/src/mdast2docx/handlers/paragraph.js

@@ -0,0 +1,52 @@
+/*
+ * Copyright 2021 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 } = docx;
+
+export default async function paragraph(ctx, node) {
+  // clear style
+  ctx.style = {};
+
+  // fix wrong children (todo: do in preprocessor)
+  for (let i = 0; i < node.children.length; i += 1) {
+    const child = node.children[i];
+    if (child.type === 'paragraph') {
+      node.children.splice(i, 1, ...child.children);
+    }
+  }
+
+  const children = await all(ctx, node);
+  const opts = {
+    children,
+  };
+
+  if (ctx.listLevel >= 0) {
+    const list = ctx.lists[ctx.listLevel];
+    if (list.numbering) {
+      opts.numbering = {
+        reference: list.numbering,
+        level: list.level,
+        instance: list.instance,
+      };
+      list.number += 1;
+    } else {
+      opts.bullet = {
+        level: list.level,
+      };
+    }
+  } else if (ctx.paragraphStyle) {
+    opts.style = ctx.paragraphStyle;
+  }
+  return new Paragraph(opts);
+}

package/src/mdast2docx/handlers/paragraphStyle.js

@@ -0,0 +1,21 @@
+/*
+ * Copyright 2021 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 all from '../all.js';
+
+export default function paragraphStyle(style) {
+  return async (ctx, node) => {
+    ctx.paragraphStyle = style;
+    const result = await all(ctx, node);
+    delete ctx.paragraphStyle;
+    return result;
+  };
+}

package/src/mdast2docx/handlers/root.js

@@ -0,0 +1,16 @@
+/*
+ * Copyright 2021 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 all from '../all.js';
+
+export default function root(ctx, node) {
+  return all(ctx, node);
+}