remark-docx 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 inokawa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,68 @@
+# remark-docx
+
+![npm](https://img.shields.io/npm/v/remark-docx) ![check](https://github.com/inokawa/remark-docx/workflows/check/badge.svg) ![demo](https://github.com/inokawa/remark-docx/workflows/demo/badge.svg)
+
+[remark](https://github.com/remarkjs/remark) plugin to transform markdown to docx.
+
+### 🚧 WIP 🚧
+
+The goal is to support all nodes in [mdast](https://github.com/syntax-tree/mdast) syntax tree, but currently transformation and stylings may not be well.
+
+If you have some feature requests or improvements, please create a [issue](https://github.com/inokawa/remark-docx/issues) or [PR](https://github.com/inokawa/remark-docx/pulls).
+
+## Demo
+
+https://inokawa.github.io/remark-docx/
+
+## Install
+
+```sh
+npm install remark-docx
+```
+
+## Usage
+
+### Browser
+
+```javascript
+import { unified } from "unified";
+import markdown from "remark-parse";
+import docx, { Packer } from "remark-docx";
+import { saveAs } from "file-saver";
+
+const processor = unified().use(markdown).use(docx);
+
+const text = "# hello world";
+
+(async () => {
+  const doc = await processor.process(text);
+  const blob = await Packer.toBlob(doc.result);
+  saveAs(blob, "example.docx");
+})();
+```
+
+### Node.js
+
+```javascript
+import { unified } from "unified";
+import markdown from "remark-parse";
+import docx, { Packer } from "remark-docx";
+import * as fs from "fs";
+
+const processor = unified().use(markdown).use(docx);
+
+const text = "# hello world";
+
+(async () => {
+  const doc = await processor.process(text);
+  const buffer = await Packer.toBuffer(doc.result);
+  fs.writeFileSync("example.docx", buffer);
+})();
+```
+
+## Options
+
+| Key           | Default   | Type          | Description                                                                                                                                                                                                                                      |
+| ------------- | --------- | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| docProperties | undefined | object        | Override properties of document.                                                                                                                                                                                                                 |
+| imageResolver | undefined | ImageResolver | **You must set** if your markdown includes images. See example for [Node.js](https://github.com/inokawa/remark-docx/blob/main/src/index.spec.ts) and [browser](https://github.com/inokawa/remark-docx/blob/main/stories/playground.stories.tsx). |

package/lib/index.d.ts

@@ -0,0 +1,3 @@
+export { default } from "./plugin";
+export type { Options as DocxOptions } from "./plugin";
+export { Packer } from "docx";

package/lib/index.js

@@ -0,0 +1,485 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var unistUtilVisit = require('unist-util-visit');
+var docx = require('docx');
+
+function _interopNamespace(e) {
+    if (e && e.__esModule) return e;
+    var n = Object.create(null);
+    if (e) {
+        Object.keys(e).forEach(function (k) {
+            if (k !== 'default') {
+                var d = Object.getOwnPropertyDescriptor(e, k);
+                Object.defineProperty(n, k, d.get ? d : {
+                    enumerable: true,
+                    get: function () { return e[k]; }
+                });
+            }
+        });
+    }
+    n["default"] = e;
+    return Object.freeze(n);
+}
+
+var docx__namespace = /*#__PURE__*/_interopNamespace(docx);
+
+/*! *****************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+var __assign = function() {
+    __assign = Object.assign || function __assign(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+function __generator(thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+}
+
+var ORDERED_LIST_REF = "ordered";
+var INDENT = 0.5;
+var DEFAULT_NUMBERINGS = [
+    {
+        level: 0,
+        format: docx__namespace.LevelFormat.DECIMAL,
+        text: "%1.",
+        alignment: docx__namespace.AlignmentType.START,
+    },
+    {
+        level: 1,
+        format: docx__namespace.LevelFormat.DECIMAL,
+        text: "%2.",
+        alignment: docx__namespace.AlignmentType.START,
+        style: {
+            paragraph: {
+                indent: { start: docx.convertInchesToTwip(INDENT * 1) },
+            },
+        },
+    },
+    {
+        level: 2,
+        format: docx__namespace.LevelFormat.DECIMAL,
+        text: "%3.",
+        alignment: docx__namespace.AlignmentType.START,
+        style: {
+            paragraph: {
+                indent: { start: docx.convertInchesToTwip(INDENT * 2) },
+            },
+        },
+    },
+    {
+        level: 3,
+        format: docx__namespace.LevelFormat.DECIMAL,
+        text: "%4.",
+        alignment: docx__namespace.AlignmentType.START,
+        style: {
+            paragraph: {
+                indent: { start: docx.convertInchesToTwip(INDENT * 3) },
+            },
+        },
+    },
+    {
+        level: 4,
+        format: docx__namespace.LevelFormat.DECIMAL,
+        text: "%5.",
+        alignment: docx__namespace.AlignmentType.START,
+        style: {
+            paragraph: {
+                indent: { start: docx.convertInchesToTwip(INDENT * 4) },
+            },
+        },
+    },
+    {
+        level: 5,
+        format: docx__namespace.LevelFormat.DECIMAL,
+        text: "%6.",
+        alignment: docx__namespace.AlignmentType.START,
+        style: {
+            paragraph: {
+                indent: { start: docx.convertInchesToTwip(INDENT * 5) },
+            },
+        },
+    },
+];
+var error = function (message) {
+    throw new Error(message);
+};
+function mdastToDocx(node, opts, images) {
+    return buildDocxRoot(node, opts, images);
+}
+function buildDocxRoot(root, opts, images) {
+    var ctx = { deco: {}, images: images };
+    var nodes = convertNodes(root.children, ctx, opts);
+    return new docx__namespace.Document(__assign(__assign({}, opts.docProperties), { sections: [{ children: nodes }], numbering: {
+            config: [
+                {
+                    reference: ORDERED_LIST_REF,
+                    levels: DEFAULT_NUMBERINGS,
+                },
+            ],
+        } }));
+}
+function convertNodes(nodes, ctx, opts) {
+    var _a;
+    var results = [];
+    for (var _i = 0, nodes_1 = nodes; _i < nodes_1.length; _i++) {
+        var node = nodes_1[_i];
+        switch (node.type) {
+            case "paragraph":
+                results.push(buildParagraph(node, ctx, opts));
+                break;
+            case "heading":
+                results.push(buildHeading(node, ctx, opts));
+                break;
+            case "thematicBreak":
+                results.push(buildThematicBreak());
+                break;
+            case "blockquote":
+                results.push.apply(results, buildBlockquote(node, ctx, opts));
+                break;
+            case "list":
+                results.push.apply(results, buildList(node, ctx, opts));
+                break;
+            case "listItem":
+                error("unreachable");
+                break;
+            case "table":
+                results.push(buildTable(node, ctx, opts));
+                break;
+            case "tableRow":
+                error("unreachable");
+                break;
+            case "tableCell":
+                error("unreachable");
+                break;
+            case "html":
+                results.push(buildHtml(node));
+                break;
+            case "code":
+                results.push(buildCode(node));
+                break;
+            case "yaml":
+                // FIXME: unimplemented
+                break;
+            case "toml":
+                // FIXME: unimplemented
+                break;
+            case "definition":
+                // FIXME: unimplemented
+                break;
+            case "footnoteDefinition":
+                // FIXME: unimplemented
+                break;
+            case "text":
+                results.push(buildText(node.value, ctx.deco));
+                break;
+            case "emphasis":
+            case "strong":
+            case "delete": {
+                var type = node.type, children = node.children;
+                results.push.apply(results, convertNodes(children, __assign(__assign({}, ctx), { deco: __assign(__assign({}, ctx.deco), (_a = {}, _a[type] = true, _a)) }), opts));
+                break;
+            }
+            case "inlineCode":
+                // FIXME: transform to text for now
+                results.push(buildText(node.value, ctx.deco));
+                break;
+            case "break":
+                results.push(buildBreak());
+                break;
+            case "link":
+                results.push(buildLink(node, ctx, opts));
+                break;
+            case "image":
+                results.push(buildImage(node, ctx.images));
+                break;
+            case "linkReference":
+                // FIXME: unimplemented
+                break;
+            case "imageReference":
+                // FIXME: unimplemented
+                break;
+            case "footnote":
+                results.push(buildFootnote(node, ctx, opts));
+                break;
+            case "footnoteReference":
+                // FIXME: unimplemented
+                break;
+            case "math":
+                results.push(buildMath(node));
+                break;
+            case "inlineMath":
+                results.push(buildInlineMath(node));
+                break;
+        }
+    }
+    return results;
+}
+function buildParagraph(node, ctx, opts) {
+    node.type; var children = node.children;
+    var list = ctx.list;
+    return new docx__namespace.Paragraph(__assign({ children: convertNodes(children, ctx, opts) }, (list &&
+        (list.ordered
+            ? {
+                numbering: {
+                    reference: ORDERED_LIST_REF,
+                    level: list.level,
+                },
+            }
+            : {
+                bullet: {
+                    level: list.level,
+                },
+            }))));
+}
+function buildHeading(node, ctx, opts) {
+    node.type; var children = node.children, depth = node.depth;
+    var heading;
+    switch (depth) {
+        case 1:
+            heading = docx__namespace.HeadingLevel.TITLE;
+            break;
+        case 2:
+            heading = docx__namespace.HeadingLevel.HEADING_1;
+            break;
+        case 3:
+            heading = docx__namespace.HeadingLevel.HEADING_2;
+            break;
+        case 4:
+            heading = docx__namespace.HeadingLevel.HEADING_3;
+            break;
+        case 5:
+            heading = docx__namespace.HeadingLevel.HEADING_4;
+            break;
+        case 6:
+            heading = docx__namespace.HeadingLevel.HEADING_5;
+            break;
+    }
+    return new docx__namespace.Paragraph({
+        heading: heading,
+        children: convertNodes(children, ctx, opts),
+    });
+}
+function buildThematicBreak(node) {
+    return new docx__namespace.Paragraph({
+        thematicBreak: true,
+    });
+}
+function buildBlockquote(node, ctx, opts) {
+    // FIXME: do nothing for now
+    return convertNodes(node.children, ctx, opts);
+}
+function buildList(node, ctx, opts) {
+    node.type; var children = node.children, ordered = node.ordered; node.start; node.spread;
+    var list = {
+        level: ctx.list ? ctx.list.level + 1 : 0,
+        ordered: !!ordered,
+    };
+    return children.reduce(function (acc, item) {
+        acc.push.apply(acc, buildListItem(item, __assign(__assign({}, ctx), { list: list }), opts));
+        return acc;
+    }, []);
+}
+function buildListItem(node, ctx, opts) {
+    node.type; var children = node.children; node.checked; node.spread;
+    return convertNodes(children, ctx, opts);
+}
+function buildTable(node, ctx, opts) {
+    node.type; var children = node.children, align = node.align;
+    var cellAligns = align === null || align === void 0 ? void 0 : align.map(function (a) {
+        switch (a) {
+            case "left":
+                return docx__namespace.AlignmentType.LEFT;
+            case "right":
+                return docx__namespace.AlignmentType.RIGHT;
+            case "center":
+                return docx__namespace.AlignmentType.CENTER;
+            default:
+                return docx__namespace.AlignmentType.LEFT;
+        }
+    });
+    return new docx__namespace.Table({
+        rows: children.map(function (r) {
+            return buildTableRow(r, ctx, opts, cellAligns);
+        }),
+    });
+}
+function buildTableRow(node, ctx, opts, cellAligns) {
+    node.type; var children = node.children;
+    return new docx__namespace.TableRow({
+        children: children.map(function (c, i) {
+            return buildTableCell(c, ctx, opts, cellAligns === null || cellAligns === void 0 ? void 0 : cellAligns[i]);
+        }),
+    });
+}
+function buildTableCell(node, ctx, opts, align) {
+    node.type; var children = node.children;
+    return new docx__namespace.TableCell({
+        children: [
+            new docx__namespace.Paragraph({
+                alignment: align,
+                children: convertNodes(children, ctx, opts),
+            }),
+        ],
+    });
+}
+function buildHtml(node) {
+    node.type; var value = node.value;
+    // FIXME: transform to text for now
+    return new docx__namespace.Paragraph({
+        children: [buildText(value, {})],
+    });
+}
+function buildCode(node) {
+    node.type; var value = node.value; node.lang; node.meta;
+    // FIXME: transform to text for now
+    return new docx__namespace.Paragraph({
+        children: [buildText(value, {})],
+    });
+}
+function buildMath(node) {
+    node.type; var value = node.value;
+    // FIXME: transform to text for now
+    return new docx__namespace.Paragraph({
+        children: [new docx__namespace.TextRun(value)],
+    });
+}
+function buildInlineMath(node) {
+    node.type; var value = node.value;
+    // FIXME: transform to text for now
+    return new docx__namespace.TextRun(value);
+}
+function buildText(text, deco) {
+    return new docx__namespace.TextRun({
+        text: text,
+        bold: deco.strong,
+        italics: deco.emphasis,
+        strike: deco.delete,
+    });
+}
+function buildBreak(node) {
+    return new docx__namespace.TextRun({ text: "", break: 1 });
+}
+function buildLink(node, ctx, opts) {
+    node.type; var children = node.children, url = node.url; node.title;
+    return new docx__namespace.ExternalHyperlink({
+        link: url,
+        children: convertNodes(children, ctx, opts),
+    });
+}
+function buildImage(node, images) {
+    node.type; var url = node.url; node.title; node.alt;
+    if (!images[url]) {
+        return error("Fetch image was failed: ".concat(url));
+    }
+    var _a = images[url], image = _a.image, width = _a.width, height = _a.height;
+    return new docx__namespace.ImageRun({
+        data: image,
+        transformation: {
+            width: width,
+            height: height,
+        },
+    });
+}
+function buildFootnote(node, ctx, opts) {
+    node.type; var children = node.children;
+    // FIXME: transform to paragraph for now
+    return new docx__namespace.Paragraph({
+        children: convertNodes(children, ctx, opts),
+    });
+}
+
+var plugin = function (opts) {
+    var _this = this;
+    if (opts === void 0) { opts = {}; }
+    var images = {};
+    this.Compiler = function (node) {
+        return mdastToDocx(node, opts, images);
+    };
+    return function (node) { return __awaiter(_this, void 0, void 0, function () {
+        var imageResolver, imageList, imageDatas;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    imageResolver = opts.imageResolver;
+                    if (!imageResolver) {
+                        throw new Error("options.imageResolver is not defined.");
+                    }
+                    imageList = [];
+                    unistUtilVisit.visit(node, "image", function (node) {
+                        imageList.push(node);
+                    });
+                    return [4 /*yield*/, Promise.all(imageList.map(function (_a) {
+                            var url = _a.url;
+                            return imageResolver(url);
+                        }))];
+                case 1:
+                    imageDatas = _a.sent();
+                    images = imageList.reduce(function (acc, img, i) {
+                        acc[img.url] = imageDatas[i];
+                        return acc;
+                    }, {});
+                    return [2 /*return*/, node];
+            }
+        });
+    }); };
+};
+
+Object.defineProperty(exports, 'Packer', {
+    enumerable: true,
+    get: function () { return docx.Packer; }
+});
+exports["default"] = plugin;

package/lib/index.mjs

@@ -0,0 +1,459 @@
+import { visit } from 'unist-util-visit';
+import * as docx from 'docx';
+import { convertInchesToTwip } from 'docx';
+export { Packer } from 'docx';
+
+/*! *****************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+
+var __assign = function() {
+    __assign = Object.assign || function __assign(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+
+function __awaiter(thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+}
+
+function __generator(thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+}
+
+var ORDERED_LIST_REF = "ordered";
+var INDENT = 0.5;
+var DEFAULT_NUMBERINGS = [
+    {
+        level: 0,
+        format: docx.LevelFormat.DECIMAL,
+        text: "%1.",
+        alignment: docx.AlignmentType.START,
+    },
+    {
+        level: 1,
+        format: docx.LevelFormat.DECIMAL,
+        text: "%2.",
+        alignment: docx.AlignmentType.START,
+        style: {
+            paragraph: {
+                indent: { start: convertInchesToTwip(INDENT * 1) },
+            },
+        },
+    },
+    {
+        level: 2,
+        format: docx.LevelFormat.DECIMAL,
+        text: "%3.",
+        alignment: docx.AlignmentType.START,
+        style: {
+            paragraph: {
+                indent: { start: convertInchesToTwip(INDENT * 2) },
+            },
+        },
+    },
+    {
+        level: 3,
+        format: docx.LevelFormat.DECIMAL,
+        text: "%4.",
+        alignment: docx.AlignmentType.START,
+        style: {
+            paragraph: {
+                indent: { start: convertInchesToTwip(INDENT * 3) },
+            },
+        },
+    },
+    {
+        level: 4,
+        format: docx.LevelFormat.DECIMAL,
+        text: "%5.",
+        alignment: docx.AlignmentType.START,
+        style: {
+            paragraph: {
+                indent: { start: convertInchesToTwip(INDENT * 4) },
+            },
+        },
+    },
+    {
+        level: 5,
+        format: docx.LevelFormat.DECIMAL,
+        text: "%6.",
+        alignment: docx.AlignmentType.START,
+        style: {
+            paragraph: {
+                indent: { start: convertInchesToTwip(INDENT * 5) },
+            },
+        },
+    },
+];
+var error = function (message) {
+    throw new Error(message);
+};
+function mdastToDocx(node, opts, images) {
+    return buildDocxRoot(node, opts, images);
+}
+function buildDocxRoot(root, opts, images) {
+    var ctx = { deco: {}, images: images };
+    var nodes = convertNodes(root.children, ctx, opts);
+    return new docx.Document(__assign(__assign({}, opts.docProperties), { sections: [{ children: nodes }], numbering: {
+            config: [
+                {
+                    reference: ORDERED_LIST_REF,
+                    levels: DEFAULT_NUMBERINGS,
+                },
+            ],
+        } }));
+}
+function convertNodes(nodes, ctx, opts) {
+    var _a;
+    var results = [];
+    for (var _i = 0, nodes_1 = nodes; _i < nodes_1.length; _i++) {
+        var node = nodes_1[_i];
+        switch (node.type) {
+            case "paragraph":
+                results.push(buildParagraph(node, ctx, opts));
+                break;
+            case "heading":
+                results.push(buildHeading(node, ctx, opts));
+                break;
+            case "thematicBreak":
+                results.push(buildThematicBreak());
+                break;
+            case "blockquote":
+                results.push.apply(results, buildBlockquote(node, ctx, opts));
+                break;
+            case "list":
+                results.push.apply(results, buildList(node, ctx, opts));
+                break;
+            case "listItem":
+                error("unreachable");
+                break;
+            case "table":
+                results.push(buildTable(node, ctx, opts));
+                break;
+            case "tableRow":
+                error("unreachable");
+                break;
+            case "tableCell":
+                error("unreachable");
+                break;
+            case "html":
+                results.push(buildHtml(node));
+                break;
+            case "code":
+                results.push(buildCode(node));
+                break;
+            case "yaml":
+                // FIXME: unimplemented
+                break;
+            case "toml":
+                // FIXME: unimplemented
+                break;
+            case "definition":
+                // FIXME: unimplemented
+                break;
+            case "footnoteDefinition":
+                // FIXME: unimplemented
+                break;
+            case "text":
+                results.push(buildText(node.value, ctx.deco));
+                break;
+            case "emphasis":
+            case "strong":
+            case "delete": {
+                var type = node.type, children = node.children;
+                results.push.apply(results, convertNodes(children, __assign(__assign({}, ctx), { deco: __assign(__assign({}, ctx.deco), (_a = {}, _a[type] = true, _a)) }), opts));
+                break;
+            }
+            case "inlineCode":
+                // FIXME: transform to text for now
+                results.push(buildText(node.value, ctx.deco));
+                break;
+            case "break":
+                results.push(buildBreak());
+                break;
+            case "link":
+                results.push(buildLink(node, ctx, opts));
+                break;
+            case "image":
+                results.push(buildImage(node, ctx.images));
+                break;
+            case "linkReference":
+                // FIXME: unimplemented
+                break;
+            case "imageReference":
+                // FIXME: unimplemented
+                break;
+            case "footnote":
+                results.push(buildFootnote(node, ctx, opts));
+                break;
+            case "footnoteReference":
+                // FIXME: unimplemented
+                break;
+            case "math":
+                results.push(buildMath(node));
+                break;
+            case "inlineMath":
+                results.push(buildInlineMath(node));
+                break;
+        }
+    }
+    return results;
+}
+function buildParagraph(node, ctx, opts) {
+    node.type; var children = node.children;
+    var list = ctx.list;
+    return new docx.Paragraph(__assign({ children: convertNodes(children, ctx, opts) }, (list &&
+        (list.ordered
+            ? {
+                numbering: {
+                    reference: ORDERED_LIST_REF,
+                    level: list.level,
+                },
+            }
+            : {
+                bullet: {
+                    level: list.level,
+                },
+            }))));
+}
+function buildHeading(node, ctx, opts) {
+    node.type; var children = node.children, depth = node.depth;
+    var heading;
+    switch (depth) {
+        case 1:
+            heading = docx.HeadingLevel.TITLE;
+            break;
+        case 2:
+            heading = docx.HeadingLevel.HEADING_1;
+            break;
+        case 3:
+            heading = docx.HeadingLevel.HEADING_2;
+            break;
+        case 4:
+            heading = docx.HeadingLevel.HEADING_3;
+            break;
+        case 5:
+            heading = docx.HeadingLevel.HEADING_4;
+            break;
+        case 6:
+            heading = docx.HeadingLevel.HEADING_5;
+            break;
+    }
+    return new docx.Paragraph({
+        heading: heading,
+        children: convertNodes(children, ctx, opts),
+    });
+}
+function buildThematicBreak(node) {
+    return new docx.Paragraph({
+        thematicBreak: true,
+    });
+}
+function buildBlockquote(node, ctx, opts) {
+    // FIXME: do nothing for now
+    return convertNodes(node.children, ctx, opts);
+}
+function buildList(node, ctx, opts) {
+    node.type; var children = node.children, ordered = node.ordered; node.start; node.spread;
+    var list = {
+        level: ctx.list ? ctx.list.level + 1 : 0,
+        ordered: !!ordered,
+    };
+    return children.reduce(function (acc, item) {
+        acc.push.apply(acc, buildListItem(item, __assign(__assign({}, ctx), { list: list }), opts));
+        return acc;
+    }, []);
+}
+function buildListItem(node, ctx, opts) {
+    node.type; var children = node.children; node.checked; node.spread;
+    return convertNodes(children, ctx, opts);
+}
+function buildTable(node, ctx, opts) {
+    node.type; var children = node.children, align = node.align;
+    var cellAligns = align === null || align === void 0 ? void 0 : align.map(function (a) {
+        switch (a) {
+            case "left":
+                return docx.AlignmentType.LEFT;
+            case "right":
+                return docx.AlignmentType.RIGHT;
+            case "center":
+                return docx.AlignmentType.CENTER;
+            default:
+                return docx.AlignmentType.LEFT;
+        }
+    });
+    return new docx.Table({
+        rows: children.map(function (r) {
+            return buildTableRow(r, ctx, opts, cellAligns);
+        }),
+    });
+}
+function buildTableRow(node, ctx, opts, cellAligns) {
+    node.type; var children = node.children;
+    return new docx.TableRow({
+        children: children.map(function (c, i) {
+            return buildTableCell(c, ctx, opts, cellAligns === null || cellAligns === void 0 ? void 0 : cellAligns[i]);
+        }),
+    });
+}
+function buildTableCell(node, ctx, opts, align) {
+    node.type; var children = node.children;
+    return new docx.TableCell({
+        children: [
+            new docx.Paragraph({
+                alignment: align,
+                children: convertNodes(children, ctx, opts),
+            }),
+        ],
+    });
+}
+function buildHtml(node) {
+    node.type; var value = node.value;
+    // FIXME: transform to text for now
+    return new docx.Paragraph({
+        children: [buildText(value, {})],
+    });
+}
+function buildCode(node) {
+    node.type; var value = node.value; node.lang; node.meta;
+    // FIXME: transform to text for now
+    return new docx.Paragraph({
+        children: [buildText(value, {})],
+    });
+}
+function buildMath(node) {
+    node.type; var value = node.value;
+    // FIXME: transform to text for now
+    return new docx.Paragraph({
+        children: [new docx.TextRun(value)],
+    });
+}
+function buildInlineMath(node) {
+    node.type; var value = node.value;
+    // FIXME: transform to text for now
+    return new docx.TextRun(value);
+}
+function buildText(text, deco) {
+    return new docx.TextRun({
+        text: text,
+        bold: deco.strong,
+        italics: deco.emphasis,
+        strike: deco.delete,
+    });
+}
+function buildBreak(node) {
+    return new docx.TextRun({ text: "", break: 1 });
+}
+function buildLink(node, ctx, opts) {
+    node.type; var children = node.children, url = node.url; node.title;
+    return new docx.ExternalHyperlink({
+        link: url,
+        children: convertNodes(children, ctx, opts),
+    });
+}
+function buildImage(node, images) {
+    node.type; var url = node.url; node.title; node.alt;
+    if (!images[url]) {
+        return error("Fetch image was failed: ".concat(url));
+    }
+    var _a = images[url], image = _a.image, width = _a.width, height = _a.height;
+    return new docx.ImageRun({
+        data: image,
+        transformation: {
+            width: width,
+            height: height,
+        },
+    });
+}
+function buildFootnote(node, ctx, opts) {
+    node.type; var children = node.children;
+    // FIXME: transform to paragraph for now
+    return new docx.Paragraph({
+        children: convertNodes(children, ctx, opts),
+    });
+}
+
+var plugin = function (opts) {
+    var _this = this;
+    if (opts === void 0) { opts = {}; }
+    var images = {};
+    this.Compiler = function (node) {
+        return mdastToDocx(node, opts, images);
+    };
+    return function (node) { return __awaiter(_this, void 0, void 0, function () {
+        var imageResolver, imageList, imageDatas;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    imageResolver = opts.imageResolver;
+                    if (!imageResolver) {
+                        throw new Error("options.imageResolver is not defined.");
+                    }
+                    imageList = [];
+                    visit(node, "image", function (node) {
+                        imageList.push(node);
+                    });
+                    return [4 /*yield*/, Promise.all(imageList.map(function (_a) {
+                            var url = _a.url;
+                            return imageResolver(url);
+                        }))];
+                case 1:
+                    imageDatas = _a.sent();
+                    images = imageList.reduce(function (acc, img, i) {
+                        acc[img.url] = imageDatas[i];
+                        return acc;
+                    }, {});
+                    return [2 /*return*/, node];
+            }
+        });
+    }); };
+};
+
+export { plugin as default };

package/lib/models/mdast.d.ts

@@ -0,0 +1,21 @@
+import type { Parent, Literal, Root, Paragraph, Heading, ThematicBreak, Blockquote, List, ListItem, Table, TableRow, TableCell, HTML, Code, YAML, Definition, FootnoteDefinition, Text, Emphasis, Strong, Delete, InlineCode, Break, Link, Image, LinkReference, ImageReference, Footnote, FootnoteReference, Resource, Association, Reference, Alternative } from "mdast";
+export type { Parent, Literal, Root, Paragraph, Heading, ThematicBreak, Blockquote, List, ListItem, Table, TableRow, TableCell, HTML, Code, YAML, Definition, FootnoteDefinition, Text, Emphasis, Strong, Delete, InlineCode, Break, Link, Image, LinkReference, ImageReference, Footnote, FootnoteReference, Resource, Association, Reference, Alternative, };
+export interface TOML extends Literal {
+    type: "toml";
+}
+export interface Math extends Literal {
+    type: "math";
+}
+export interface InlineMath extends Literal {
+    type: "inlineMath";
+}
+export declare type Content = TopLevelContent | ListContent | TableContent | RowContent | PhrasingContent;
+export declare type TopLevelContent = BlockContent | FrontmatterContent | DefinitionContent;
+export declare type BlockContent = Paragraph | Heading | ThematicBreak | Blockquote | List | Table | HTML | Code | Math;
+export declare type FrontmatterContent = YAML | TOML;
+export declare type DefinitionContent = Definition | FootnoteDefinition;
+export declare type ListContent = ListItem;
+export declare type TableContent = TableRow;
+export declare type RowContent = TableCell;
+export declare type PhrasingContent = StaticPhrasingContent | Link | LinkReference;
+export declare type StaticPhrasingContent = Text | Emphasis | Strong | Delete | HTML | InlineCode | Break | Image | ImageReference | Footnote | FootnoteReference | InlineMath;

package/lib/plugin.d.ts

@@ -0,0 +1,5 @@
+import type { Plugin } from "unified";
+import { Opts } from "./transformer";
+export declare type Options = Opts;
+declare const plugin: Plugin<[Options?]>;
+export default plugin;

package/lib/transformer.d.ts

@@ -0,0 +1,17 @@
+import * as docx from "docx";
+import { IPropertiesOptions } from "docx/build/file/core-properties";
+import * as mdast from "./models/mdast";
+export declare type ImageDataMap = {
+    [url: string]: ImageData;
+};
+export declare type ImageData = {
+    image: docx.IImageOptions["data"];
+    width: number;
+    height: number;
+};
+export declare type ImageResolver = (url: string) => Promise<ImageData> | ImageData;
+export declare type Opts = {
+    docProperties?: Omit<IPropertiesOptions, "sections" | "numbering">;
+    imageResolver?: ImageResolver;
+};
+export declare function mdastToDocx(node: mdast.Root, opts: Opts, images: ImageDataMap): docx.File;

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "remark-docx",
+  "version": "0.0.1",
+  "description": "remark plugin to transform markdown to docx.",
+  "main": "lib/index.js",
+  "module": "lib/index.mjs",
+  "types": "lib/index.d.ts",
+  "files": [
+    "lib"
+  ],
+  "scripts": {
+    "build": "rollup -c",
+    "test": "jest",
+    "tsc": "tsc -p . --noEmit",
+    "tsc:d": "tsc -p . --outDir lib -d --emitDeclarationOnly",
+    "storybook": "start-storybook -p 6006",
+    "storybook:build": "build-storybook",
+    "prepublishOnly": "rimraf lib && npm run build && npm run tsc:d"
+  },
+  "dependencies": {
+    "docx": "^7.3.0",
+    "unist-util-visit": "^4.1.0"
+  },
+  "devDependencies": {
+    "@babel/core": "7.15.5",
+    "@babel/preset-env": "7.15.6",
+    "@babel/preset-typescript": "7.15.0",
+    "@rollup/plugin-typescript": "8.2.5",
+    "@storybook/addon-essentials": "6.4.9",
+    "@storybook/addon-links": "6.4.9",
+    "@storybook/react": "6.4.9",
+    "@types/jest": "^27.4.0",
+    "@types/mdast": "^3.0.10",
+    "@types/unist": "2.0.6",
+    "babel-jest": "27.4.6",
+    "file-saver": "^2.0.5",
+    "jest": "27.4.7",
+    "react": "17.0.2",
+    "react-dom": "17.0.2",
+    "react-is": "17.0.2",
+    "remark-footnotes": "4.0.1",
+    "remark-frontmatter": "4.0.1",
+    "remark-gfm": "3.0.1",
+    "remark-math": "5.1.1",
+    "remark-parse": "10.0.1",
+    "rimraf": "3.0.2",
+    "rollup": "2.63.0",
+    "tslib": "2.3.1",
+    "typescript": "4.5.4",
+    "unified": "10.1.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/inokawa/remark-docx.git"
+  },
+  "keywords": [
+    "unist",
+    "remark",
+    "mdast",
+    "markdown",
+    "docx",
+    "word",
+    "office"
+  ],
+  "author": "inokawa <stratoooo-taster@yahoo.co.jp> (https://github.com/inokawa/)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/inokawa/remark-docx/issues"
+  },
+  "homepage": "https://github.com/inokawa/remark-docx#readme"
+}