remark-docx 0.1.5 → 0.1.7

package/README.md

@@ -1,6 +1,6 @@
 # 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)
+![npm](https://img.shields.io/npm/v/remark-docx) ![npm](https://img.shields.io/npm/dw/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 compile markdown to docx (Microsoft Word, Office Open XML).
 
@@ -100,10 +100,11 @@ If you find a problem, feel free to create an [issue](https://github.com/inokawa
 
 ### Making a Pull Request
 
-1. Clone this repo.
+1. Fork this repo.
 2. Run `npm install`.
 3. Commit your fix.
-4. Make a PR and confirm all the CI checks passed.
+4. Add tests to cover the fix.
+5. Make a PR and confirm all the CI checks passed.
 
 ## Related projects
 

package/lib/index.js

@@ -1,13 +1,18 @@
 'use strict';
 
-var tslib = require('tslib');
 var unistUtilVisit = require('unist-util-visit');
 var docx = require('docx');
 var unifiedLatexUtilParse = require('@unified-latex/unified-latex-util-parse');
 
+/**
+ * @internal
+ */
 const unreachable = (_) => {
     throw new Error("unreachable");
 };
+/**
+ * @internal
+ */
 function invariant(cond, message) {
     if (!cond)
         throw new Error(message);
@@ -337,6 +342,9 @@ const mapNode = (n, runs) => {
     }
     return [];
 };
+/**
+ * @internal
+ */
 const parseLatex = (value) => {
     const parsed = unifiedLatexUtilParse.parseMath(value);
     const paragraphs = [[]];
@@ -419,11 +427,13 @@ const DEFAULT_NUMBERINGS = [
         },
     },
 ];
-const mdastToDocx = (node, { output = "buffer", title, subject, creator, keywords, description, lastModifiedBy, revision, styles, background, }, images) => tslib.__awaiter(void 0, void 0, void 0, function* () {
+const mdastToDocx = async (node, { output = "buffer", title, subject, creator, keywords, description, lastModifiedBy, revision, styles, background, }, images) => {
+    const footnoteRegistry = {};
     const { nodes, footnotes } = convertNodes(node.children, {
         deco: {},
         images,
         indent: 0,
+        footnoteRegistry,
     });
     const doc = new docx.Document({
         title,
@@ -448,7 +458,7 @@ const mdastToDocx = (node, { output = "buffer", title, subject, creator, keyword
     });
     switch (output) {
         case "buffer":
-            const bufOut = yield docx.Packer.toBuffer(doc);
+            const bufOut = await docx.Packer.toBuffer(doc);
             // feature detection instead of environment detection, but if Buffer exists
             // it's probably Node. If not, return the Uint8Array that JSZip returns
             // when it doesn't detect a Node environment.
@@ -456,27 +466,45 @@ const mdastToDocx = (node, { output = "buffer", title, subject, creator, keyword
         case "blob":
             return docx.Packer.toBlob(doc);
     }
-});
+};
+const getOrCreateFootnoteId = (identifier, registry) => {
+    if (!(identifier in registry)) {
+        registry[identifier] = Object.keys(registry).length + 1;
+    }
+    return registry[identifier];
+};
 const convertNodes = (nodes, ctx) => {
     const results = [];
     let footnotes = {};
     for (const node of nodes) {
         switch (node.type) {
-            case "paragraph":
-                results.push(buildParagraph(node, ctx));
+            case "paragraph": {
+                const { paragraph, footnotes: nestedFootnotes } = buildParagraph(node, ctx);
+                results.push(paragraph);
+                footnotes = { ...footnotes, ...nestedFootnotes };
                 break;
-            case "heading":
-                results.push(buildHeading(node, ctx));
+            }
+            case "heading": {
+                const { heading, footnotes: nestedFootnotes } = buildHeading(node, ctx);
+                results.push(heading);
+                footnotes = { ...footnotes, ...nestedFootnotes };
                 break;
+            }
             case "thematicBreak":
                 results.push(buildThematicBreak());
                 break;
-            case "blockquote":
-                results.push(...buildBlockquote(node, ctx));
+            case "blockquote": {
+                const { nodes: blockquoteNodes, footnotes: nestedFootnotes } = buildBlockquote(node, ctx);
+                results.push(...blockquoteNodes);
+                footnotes = { ...footnotes, ...nestedFootnotes };
                 break;
-            case "list":
-                results.push(...buildList(node, ctx));
+            }
+            case "list": {
+                const { nodes: listNodes, footnotes: nestedFootnotes } = buildList(node, ctx);
+                results.push(...listNodes);
+                footnotes = { ...footnotes, ...nestedFootnotes };
                 break;
+            }
             case "listItem":
                 invariant(false, "unreachable");
             case "table":
@@ -501,9 +529,11 @@ const convertNodes = (nodes, ctx) => {
             case "definition":
                 // FIXME: unimplemented
                 break;
-            case "footnoteDefinition":
-                footnotes[node.identifier] = buildFootnoteDefinition(node, ctx);
+            case "footnoteDefinition": {
+                const footnoteId = getOrCreateFootnoteId(node.identifier, ctx.footnoteRegistry || {});
+                footnotes[footnoteId] = buildFootnoteDefinition(node, ctx);
                 break;
+            }
             case "text":
                 results.push(buildText(node.value, ctx.deco));
                 break;
@@ -511,8 +541,12 @@ const convertNodes = (nodes, ctx) => {
             case "strong":
             case "delete": {
                 const { type, children } = node;
-                const { nodes } = convertNodes(children, Object.assign(Object.assign({}, ctx), { deco: Object.assign(Object.assign({}, ctx.deco), { [type]: true }) }));
+                const { nodes, footnotes: nestedFootnotes } = convertNodes(children, {
+                    ...ctx,
+                    deco: { ...ctx.deco, [type]: true },
+                });
                 results.push(...nodes);
+                footnotes = { ...footnotes, ...nestedFootnotes };
                 break;
             }
             case "inlineCode":
@@ -522,9 +556,12 @@ const convertNodes = (nodes, ctx) => {
             case "break":
                 results.push(buildBreak());
                 break;
-            case "link":
-                results.push(buildLink(node, ctx));
+            case "link": {
+                const { link, footnotes: nestedFootnotes } = buildLink(node, ctx);
+                results.push(link);
+                footnotes = { ...footnotes, ...nestedFootnotes };
                 break;
+            }
             case "image":
                 results.push(buildImage(node, ctx.images));
                 break;
@@ -534,12 +571,14 @@ const convertNodes = (nodes, ctx) => {
             case "imageReference":
                 // FIXME: unimplemented
                 break;
-            case "footnote":
-                results.push(buildFootnote(node, ctx));
+            case "footnote": {
+                const { footnoteRef, footnoteData } = buildFootnote(node, ctx);
+                results.push(footnoteRef);
+                footnotes = { ...footnotes, ...footnoteData };
                 break;
+            }
             case "footnoteReference":
-                // do we need context here?
-                results.push(buildFootnoteReference(node));
+                results.push(buildFootnoteReference(node, ctx));
                 break;
             case "math":
                 results.push(...buildMath(node));
@@ -559,60 +598,69 @@ const convertNodes = (nodes, ctx) => {
 };
 const buildParagraph = ({ children }, ctx) => {
     const list = ctx.list;
-    const { nodes } = convertNodes(children, ctx);
-    const paragraphChildren = [...nodes];
+    const { nodes, footnotes: nestedFootnotes } = convertNodes(children, ctx);
     if (list && list.checked != null) {
-        paragraphChildren.unshift(new docx.CheckBox({
+        nodes.unshift(new docx.CheckBox({
             checked: list.checked,
             checkedState: { value: "2611" },
             uncheckedState: { value: "2610" },
         }));
     }
-    return new docx.Paragraph(Object.assign({ children: paragraphChildren, indent: ctx.indent > 0
-            ? {
-                start: docx.convertInchesToTwip(INDENT * ctx.indent),
-            }
-            : undefined }, (list &&
-        (list.ordered
-            ? {
-                numbering: {
-                    reference: ORDERED_LIST_REF,
-                    level: list.level,
-                },
-            }
-            : {
-                bullet: {
-                    level: list.level,
-                },
-            }))));
+    return {
+        paragraph: new docx.Paragraph({
+            children: nodes,
+            indent: ctx.indent > 0
+                ? {
+                    start: docx.convertInchesToTwip(INDENT * ctx.indent),
+                }
+                : undefined,
+            ...(list &&
+                (list.ordered
+                    ? {
+                        numbering: {
+                            reference: ORDERED_LIST_REF,
+                            level: list.level,
+                        },
+                    }
+                    : {
+                        bullet: {
+                            level: list.level,
+                        },
+                    })),
+        }),
+        footnotes: nestedFootnotes,
+    };
 };
 const buildHeading = ({ children, depth }, ctx) => {
-    let heading;
+    let headingLevel;
     switch (depth) {
         case 1:
-            heading = docx.HeadingLevel.TITLE;
+            headingLevel = docx.HeadingLevel.TITLE;
             break;
         case 2:
-            heading = docx.HeadingLevel.HEADING_1;
+            headingLevel = docx.HeadingLevel.HEADING_1;
             break;
         case 3:
-            heading = docx.HeadingLevel.HEADING_2;
+            headingLevel = docx.HeadingLevel.HEADING_2;
             break;
         case 4:
-            heading = docx.HeadingLevel.HEADING_3;
+            headingLevel = docx.HeadingLevel.HEADING_3;
             break;
         case 5:
-            heading = docx.HeadingLevel.HEADING_4;
+            headingLevel = docx.HeadingLevel.HEADING_4;
             break;
         case 6:
-            heading = docx.HeadingLevel.HEADING_5;
+            headingLevel = docx.HeadingLevel.HEADING_5;
             break;
     }
-    const { nodes } = convertNodes(children, ctx);
-    return new docx.Paragraph({
-        heading,
-        children: nodes,
-    });
+    const { nodes, footnotes: nestedFootnotes } = convertNodes(children, ctx);
+    return {
+        heading: new docx.Paragraph({
+            heading: headingLevel,
+            children: nodes,
+        }),
+        footnotes: nestedFootnotes,
+    };
 };
 const buildThematicBreak = (_) => {
     return new docx.Paragraph({
@@ -620,22 +668,31 @@ const buildThematicBreak = (_) => {
     });
 };
 const buildBlockquote = ({ children }, ctx) => {
-    const { nodes } = convertNodes(children, Object.assign(Object.assign({}, ctx), { indent: ctx.indent + 1 }));
-    return nodes;
+    const { nodes, footnotes: nestedFootnotes } = convertNodes(children, { ...ctx, indent: ctx.indent + 1 });
+    return { nodes, footnotes: nestedFootnotes };
 };
 const buildList = ({ children, ordered, start: _start, spread: _spread }, ctx) => {
     const list = {
         level: ctx.list ? ctx.list.level + 1 : 0,
         ordered: !!ordered,
     };
-    return children.reduce((acc, item) => {
-        acc.push(...buildListItem(item, Object.assign(Object.assign({}, ctx), { list })));
-        return acc;
-    }, []);
+    let allFootnotes = {};
+    const allNodes = children.flatMap((item) => {
+        const { nodes, footnotes: itemFootnotes } = buildListItem(item, {
+            ...ctx,
+            list,
+        });
+        allFootnotes = { ...allFootnotes, ...itemFootnotes };
+        return nodes;
+    });
+    return { nodes: allNodes, footnotes: allFootnotes };
 };
 const buildListItem = ({ children, checked, spread: _spread }, ctx) => {
-    const { nodes } = convertNodes(children, Object.assign(Object.assign({}, ctx), (ctx.list && { list: Object.assign(Object.assign({}, ctx.list), { checked: checked !== null && checked !== void 0 ? checked : undefined }) })));
-    return nodes;
+    const { nodes, footnotes: nestedFootnotes } = convertNodes(children, {
+        ...ctx,
+        ...(ctx.list && { list: { ...ctx.list, checked: checked !== null && checked !== void 0 ? checked : undefined } }),
+    });
+    return { nodes, footnotes: nestedFootnotes };
 };
 const buildTable = ({ children, align }, ctx) => {
     const cellAligns = align === null || align === void 0 ? void 0 : align.map((a) => {
@@ -712,11 +769,14 @@ const buildBreak = (_) => {
     return new docx.TextRun({ text: "", break: 1 });
 };
 const buildLink = ({ children, url, title: _title }, ctx) => {
-    const { nodes } = convertNodes(children, ctx);
-    return new docx.ExternalHyperlink({
-        link: url,
-        children: nodes,
-    });
+    const { nodes, footnotes: nestedFootnotes } = convertNodes(children, ctx);
+    return {
+        link: new docx.ExternalHyperlink({
+            link: url,
+            children: nodes,
+        }),
+        footnotes: nestedFootnotes,
+    };
 };
 const buildImage = ({ url, title: _title, alt: _alt }, images) => {
     const img = images[url];
@@ -731,23 +791,42 @@ const buildImage = ({ url, title: _title, alt: _alt }, images) => {
     });
 };
 const buildFootnote = ({ children }, ctx) => {
-    // FIXME: transform to paragraph for now
-    const { nodes } = convertNodes(children, ctx);
-    return new docx.Paragraph({
-        children: nodes,
+    // Generate auto ID based on current registry size to ensure uniqueness
+    const registry = ctx.footnoteRegistry || {};
+    const autoId = `inline-${Object.keys(registry).length + 1}`;
+    const footnoteId = getOrCreateFootnoteId(autoId, registry);
+    const footnoteContent = children.map((node) => {
+        // Convert each node and extract the first result as a paragraph
+        const { nodes } = convertNodes([node], ctx);
+        if (nodes[0] instanceof docx.Paragraph) {
+            return nodes[0];
+        }
+        // For non-paragraph content, wrap in a paragraph
+        return new docx.Paragraph({ children: nodes });
     });
+    return {
+        footnoteRef: new docx.FootnoteReferenceRun(footnoteId),
+        footnoteData: {
+            [footnoteId]: { children: footnoteContent },
+        },
+    };
 };
 const buildFootnoteDefinition = ({ children }, ctx) => {
     return {
         children: children.map((node) => {
+            // Convert each node and extract the first result as a paragraph
             const { nodes } = convertNodes([node], ctx);
-            return nodes[0];
+            if (nodes[0] instanceof docx.Paragraph) {
+                return nodes[0];
+            }
+            // For non-paragraph content, wrap in a paragraph
+            return new docx.Paragraph({ children: nodes });
         }),
     };
 };
-const buildFootnoteReference = ({ identifier }) => {
-    // do we need Context?
-    return new docx.FootnoteReferenceRun(parseInt(identifier));
+const buildFootnoteReference = ({ identifier }, ctx) => {
+    const footnoteId = getOrCreateFootnoteId(identifier, ctx.footnoteRegistry || {});
+    return new docx.FootnoteReferenceRun(footnoteId);
 };
 
 const plugin = function (opts = {}) {
@@ -755,7 +834,7 @@ const plugin = function (opts = {}) {
     this.Compiler = (node) => {
         return mdastToDocx(node, opts, images);
     };
-    return (node) => tslib.__awaiter(this, void 0, void 0, function* () {
+    return async (node) => {
         const imageList = [];
         unistUtilVisit.visit(node, "image", (node) => {
             imageList.push(node);
@@ -765,13 +844,13 @@ const plugin = function (opts = {}) {
         }
         const imageResolver = opts.imageResolver;
         invariant(imageResolver, "options.imageResolver is not defined.");
-        const imageDatas = yield Promise.all(imageList.map(({ url }) => imageResolver(url)));
+        const imageDatas = await Promise.all(imageList.map(({ url }) => imageResolver(url)));
         images = imageList.reduce((acc, img, i) => {
             acc[img.url] = imageDatas[i];
             return acc;
         }, {});
         return node;
-    });
+    };
 };
 
 module.exports = plugin;