remark-docx 0.1.2 → 0.1.4

package/README.md

@@ -24,7 +24,7 @@ If you have some feature requests or improvements, please create a [issue](https
 - [ ] yaml
 - [ ] toml
 - [ ] definition
-- [ ] footnoteDefinition
+- [x] footnoteDefinition
 - [x] text
 - [x] emphasis
 - [x] strong
@@ -35,8 +35,8 @@ If you have some feature requests or improvements, please create a [issue](https
 - [x] image
 - [ ] linkReference
 - [ ] imageReference
-- [ ] footnote
-- [ ] footnoteReference
+- [x] footnote
+- [x] footnoteReference
 - [x] LaTeX support with math and inlineMath ([remark-math](https://github.com/remarkjs/remark-math) is required)
 
 ## Demo
@@ -89,21 +89,21 @@ const text = "# hello world";
 })();
 ```
 
-## Options
-
-| Key            | Default   | Type                        | Description                                                                                                                                                                                                                                      |
-| -------------- | --------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| output         | "buffer"  | `"buffer"` `"blob"`         | Set output type of `VFile.result`. `buffer` is `Promise<Buffer>`. `blob` is `Promise<Blob>`.                                                                                                                                                     |
-| imageResolver  | undefined | ImageResolver?              | **You must set** if your markdown includes images. See example for [browser](https://github.com/inokawa/remark-docx/blob/main/stories/playground.stories.tsx) and [Node.js](https://github.com/inokawa/remark-docx/blob/main/src/index.spec.ts). |
-| title          | undefined | string?                     |                                                                                                                                                                                                                                                  |
-| subject        | undefined | string?                     |                                                                                                                                                                                                                                                  |
-| creator        | undefined | string?                     |                                                                                                                                                                                                                                                  |
-| keywords       | undefined | string?                     |                                                                                                                                                                                                                                                  |
-| description    | undefined | string?                     |                                                                                                                                                                                                                                                  |
-| lastModifiedBy | undefined | string?                     |                                                                                                                                                                                                                                                  |
-| revision       | undefined | number?                     |                                                                                                                                                                                                                                                  |
-| styles         | undefined | IStylesOptions?             |                                                                                                                                                                                                                                                  |
-| background     | undefined | IDocumentBackgroundOptions? |                                                                                                                                                                                                                                                  |
+## Documentation
+
+- [API reference](./docs/API.md)
+
+## Contribute
+
+All contributions are welcome.
+If you find a problem, feel free to create an [issue](https://github.com/inokawa/remark-docx/issues) or a [PR](https://github.com/inokawa/remark-docx/pulls).
+
+### Making a Pull Request
+
+1. Clone this repo.
+2. Run `npm install`.
+3. Commit your fix.
+4. Make a PR and confirm all the CI checks passed.
 
 ## Related projects
 

package/lib/index.d.ts

@@ -1,2 +1,2 @@
 export { default } from "./plugin";
-export type { Options as DocxOptions } from "./plugin";
+export type { DocxOptions } from "./plugin";

package/lib/index.js

@@ -5,26 +5,6 @@ var unistUtilVisit = require('unist-util-visit');
 var docx = require('docx');
 var unifiedLatexUtilParse = require('@unified-latex/unified-latex-util-parse');
 
-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);
-
 const unreachable = (_) => {
     throw new Error("unreachable");
 };
@@ -39,7 +19,7 @@ const hasSquareBrackets = (arg) => {
 const hasCurlyBrackets = (arg) => {
     return !!arg && arg.openMark === "{" && arg.closeMark === "}";
 };
-const mapString = (s) => new docx__namespace.MathRun(s);
+const mapString = (s) => new docx.MathRun(s);
 const mapMacro = (n, runs) => {
     var _a, _b, _c, _d, _e, _f, _g, _h;
     switch (n.content) {
@@ -249,7 +229,7 @@ const mapMacro = (n, runs) => {
             const prev = runs.pop();
             if (!prev)
                 break;
-            return new docx__namespace.MathSuperScript({
+            return new docx.MathSuperScript({
                 children: [prev],
                 superScript: mapGroup((_c = (_b = (_a = n.args) === null || _a === void 0 ? void 0 : _a[0]) === null || _b === void 0 ? void 0 : _b.content) !== null && _c !== void 0 ? _c : []),
             });
@@ -258,7 +238,7 @@ const mapMacro = (n, runs) => {
             const prev = runs.pop();
             if (!prev)
                 break;
-            return new docx__namespace.MathSubScript({
+            return new docx.MathSubScript({
                 children: [prev],
                 subScript: mapGroup((_f = (_e = (_d = n.args) === null || _d === void 0 ? void 0 : _d[0]) === null || _e === void 0 ? void 0 : _e.content) !== null && _f !== void 0 ? _f : []),
             });
@@ -271,7 +251,7 @@ const mapMacro = (n, runs) => {
             break;
         case "sum": {
             // TODO: support superscript and subscript
-            return new docx__namespace.MathSum({
+            return new docx.MathSum({
                 children: [],
             });
         }
@@ -284,7 +264,7 @@ const mapMacro = (n, runs) => {
             if (args.length === 2 &&
                 hasCurlyBrackets(args[0]) &&
                 hasCurlyBrackets(args[1])) {
-                return new docx__namespace.MathFraction({
+                return new docx.MathFraction({
                     numerator: mapGroup(args[0].content),
                     denominator: mapGroup(args[1].content),
                 });
@@ -294,14 +274,14 @@ const mapMacro = (n, runs) => {
         case "sqrt": {
             const args = (_h = n.args) !== null && _h !== void 0 ? _h : [];
             if (args.length === 1 && hasCurlyBrackets(args[0])) {
-                return new docx__namespace.MathRadical({
+                return new docx.MathRadical({
                     children: mapGroup(args[0].content),
                 });
             }
             if (args.length === 2 &&
                 hasSquareBrackets(args[0]) &&
                 hasCurlyBrackets(args[1])) {
-                return new docx__namespace.MathRadical({
+                return new docx.MathRadical({
                     children: mapGroup(args[1].content),
                     degree: mapGroup(args[0].content),
                 });
@@ -379,15 +359,15 @@ const INDENT = 0.5;
 const DEFAULT_NUMBERINGS = [
     {
         level: 0,
-        format: docx__namespace.LevelFormat.DECIMAL,
+        format: docx.LevelFormat.DECIMAL,
         text: "%1.",
-        alignment: docx__namespace.AlignmentType.START,
+        alignment: docx.AlignmentType.START,
     },
     {
         level: 1,
-        format: docx__namespace.LevelFormat.DECIMAL,
+        format: docx.LevelFormat.DECIMAL,
         text: "%2.",
-        alignment: docx__namespace.AlignmentType.START,
+        alignment: docx.AlignmentType.START,
         style: {
             paragraph: {
                 indent: { start: docx.convertInchesToTwip(INDENT * 1) },
@@ -396,9 +376,9 @@ const DEFAULT_NUMBERINGS = [
     },
     {
         level: 2,
-        format: docx__namespace.LevelFormat.DECIMAL,
+        format: docx.LevelFormat.DECIMAL,
         text: "%3.",
-        alignment: docx__namespace.AlignmentType.START,
+        alignment: docx.AlignmentType.START,
         style: {
             paragraph: {
                 indent: { start: docx.convertInchesToTwip(INDENT * 2) },
@@ -407,9 +387,9 @@ const DEFAULT_NUMBERINGS = [
     },
     {
         level: 3,
-        format: docx__namespace.LevelFormat.DECIMAL,
+        format: docx.LevelFormat.DECIMAL,
         text: "%4.",
-        alignment: docx__namespace.AlignmentType.START,
+        alignment: docx.AlignmentType.START,
         style: {
             paragraph: {
                 indent: { start: docx.convertInchesToTwip(INDENT * 3) },
@@ -418,9 +398,9 @@ const DEFAULT_NUMBERINGS = [
     },
     {
         level: 4,
-        format: docx__namespace.LevelFormat.DECIMAL,
+        format: docx.LevelFormat.DECIMAL,
         text: "%5.",
-        alignment: docx__namespace.AlignmentType.START,
+        alignment: docx.AlignmentType.START,
         style: {
             paragraph: {
                 indent: { start: docx.convertInchesToTwip(INDENT * 4) },
@@ -429,9 +409,9 @@ const DEFAULT_NUMBERINGS = [
     },
     {
         level: 5,
-        format: docx__namespace.LevelFormat.DECIMAL,
+        format: docx.LevelFormat.DECIMAL,
         text: "%6.",
-        alignment: docx__namespace.AlignmentType.START,
+        alignment: docx.AlignmentType.START,
         style: {
             paragraph: {
                 indent: { start: docx.convertInchesToTwip(INDENT * 5) },
@@ -439,13 +419,13 @@ const DEFAULT_NUMBERINGS = [
         },
     },
 ];
-const mdastToDocx = (node, { output = "buffer", title, subject, creator, keywords, description, lastModifiedBy, revision, styles, background, }, images) => {
-    const nodes = convertNodes(node.children, {
+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 { nodes, footnotes } = convertNodes(node.children, {
         deco: {},
         images,
         indent: 0,
     });
-    const doc = new docx__namespace.Document({
+    const doc = new docx.Document({
         title,
         subject,
         creator,
@@ -455,6 +435,7 @@ const mdastToDocx = (node, { output = "buffer", title, subject, creator, keyword
         revision,
         styles,
         background,
+        footnotes,
         sections: [{ children: nodes }],
         numbering: {
             config: [
@@ -467,13 +448,18 @@ const mdastToDocx = (node, { output = "buffer", title, subject, creator, keyword
     });
     switch (output) {
         case "buffer":
-            return docx.Packer.toBuffer(doc);
+            const bufOut = yield 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.
+            return typeof Buffer === "function" ? Buffer.from(bufOut) : bufOut;
         case "blob":
             return docx.Packer.toBlob(doc);
     }
-};
+});
 const convertNodes = (nodes, ctx) => {
     const results = [];
+    let footnotes = {};
     for (const node of nodes) {
         switch (node.type) {
             case "paragraph":
@@ -516,7 +502,7 @@ const convertNodes = (nodes, ctx) => {
                 // FIXME: unimplemented
                 break;
             case "footnoteDefinition":
-                // FIXME: unimplemented
+                footnotes[node.identifier] = buildFootnoteDefinition(node, ctx);
                 break;
             case "text":
                 results.push(buildText(node.value, ctx.deco));
@@ -525,7 +511,8 @@ const convertNodes = (nodes, ctx) => {
             case "strong":
             case "delete": {
                 const { type, children } = node;
-                results.push(...convertNodes(children, Object.assign(Object.assign({}, ctx), { deco: Object.assign(Object.assign({}, ctx.deco), { [type]: true }) })));
+                const { nodes } = convertNodes(children, Object.assign(Object.assign({}, ctx), { deco: Object.assign(Object.assign({}, ctx.deco), { [type]: true }) }));
+                results.push(...nodes);
                 break;
             }
             case "inlineCode":
@@ -551,7 +538,8 @@ const convertNodes = (nodes, ctx) => {
                 results.push(buildFootnote(node, ctx));
                 break;
             case "footnoteReference":
-                // FIXME: unimplemented
+                // do we need context here?
+                results.push(buildFootnoteReference(node));
                 break;
             case "math":
                 results.push(...buildMath(node));
@@ -564,11 +552,15 @@ const convertNodes = (nodes, ctx) => {
                 break;
         }
     }
-    return results;
+    return {
+        nodes: results,
+        footnotes,
+    };
 };
 const buildParagraph = ({ children }, ctx) => {
     const list = ctx.list;
-    return new docx__namespace.Paragraph(Object.assign({ children: convertNodes(children, ctx), indent: ctx.indent > 0
+    const { nodes } = convertNodes(children, ctx);
+    return new docx.Paragraph(Object.assign({ children: nodes, indent: ctx.indent > 0
             ? {
                 start: docx.convertInchesToTwip(INDENT * ctx.indent),
             }
@@ -590,36 +582,38 @@ const buildHeading = ({ children, depth }, ctx) => {
     let heading;
     switch (depth) {
         case 1:
-            heading = docx__namespace.HeadingLevel.TITLE;
+            heading = docx.HeadingLevel.TITLE;
             break;
         case 2:
-            heading = docx__namespace.HeadingLevel.HEADING_1;
+            heading = docx.HeadingLevel.HEADING_1;
             break;
         case 3:
-            heading = docx__namespace.HeadingLevel.HEADING_2;
+            heading = docx.HeadingLevel.HEADING_2;
             break;
         case 4:
-            heading = docx__namespace.HeadingLevel.HEADING_3;
+            heading = docx.HeadingLevel.HEADING_3;
             break;
         case 5:
-            heading = docx__namespace.HeadingLevel.HEADING_4;
+            heading = docx.HeadingLevel.HEADING_4;
             break;
         case 6:
-            heading = docx__namespace.HeadingLevel.HEADING_5;
+            heading = docx.HeadingLevel.HEADING_5;
             break;
     }
-    return new docx__namespace.Paragraph({
+    const { nodes } = convertNodes(children, ctx);
+    return new docx.Paragraph({
         heading,
-        children: convertNodes(children, ctx),
+        children: nodes,
     });
 };
 const buildThematicBreak = (_) => {
-    return new docx__namespace.Paragraph({
+    return new docx.Paragraph({
         thematicBreak: true,
     });
 };
 const buildBlockquote = ({ children }, ctx) => {
-    return convertNodes(children, Object.assign(Object.assign({}, ctx), { indent: ctx.indent + 1 }));
+    const { nodes } = convertNodes(children, Object.assign(Object.assign({}, ctx), { indent: ctx.indent + 1 }));
+    return nodes;
 };
 const buildList = ({ children, ordered, start: _start, spread: _spread }, ctx) => {
     const list = {
@@ -632,72 +626,74 @@ const buildList = ({ children, ordered, start: _start, spread: _spread }, ctx) =
     }, []);
 };
 const buildListItem = ({ children, checked: _checked, spread: _spread }, ctx) => {
-    return convertNodes(children, ctx);
+    const { nodes } = convertNodes(children, ctx);
+    return nodes;
 };
 const buildTable = ({ children, align }, ctx) => {
     const cellAligns = align === null || align === void 0 ? void 0 : align.map((a) => {
         switch (a) {
             case "left":
-                return docx__namespace.AlignmentType.LEFT;
+                return docx.AlignmentType.LEFT;
             case "right":
-                return docx__namespace.AlignmentType.RIGHT;
+                return docx.AlignmentType.RIGHT;
             case "center":
-                return docx__namespace.AlignmentType.CENTER;
+                return docx.AlignmentType.CENTER;
             default:
-                return docx__namespace.AlignmentType.LEFT;
+                return docx.AlignmentType.LEFT;
         }
     });
-    return new docx__namespace.Table({
+    return new docx.Table({
         rows: children.map((r) => {
             return buildTableRow(r, ctx, cellAligns);
         }),
     });
 };
 const buildTableRow = ({ children }, ctx, cellAligns) => {
-    return new docx__namespace.TableRow({
+    return new docx.TableRow({
         children: children.map((c, i) => {
             return buildTableCell(c, ctx, cellAligns === null || cellAligns === void 0 ? void 0 : cellAligns[i]);
         }),
     });
 };
 const buildTableCell = ({ children }, ctx, align) => {
-    return new docx__namespace.TableCell({
+    const { nodes } = convertNodes(children, ctx);
+    return new docx.TableCell({
         children: [
-            new docx__namespace.Paragraph({
+            new docx.Paragraph({
                 alignment: align,
-                children: convertNodes(children, ctx),
+                children: nodes,
             }),
         ],
     });
 };
 const buildHtml = ({ value }) => {
     // FIXME: transform to text for now
-    return new docx__namespace.Paragraph({
+    return new docx.Paragraph({
         children: [buildText(value, {})],
     });
 };
 const buildCode = ({ value, lang: _lang, meta: _meta }) => {
     // FIXME: transform to text for now
-    return new docx__namespace.Paragraph({
+    return new docx.Paragraph({
         children: [buildText(value, {})],
     });
 };
 const buildMath = ({ value }) => {
-    return parseLatex(value).map((runs) => new docx__namespace.Paragraph({
+    return parseLatex(value).map((runs) => new docx.Paragraph({
         children: [
-            new docx__namespace.Math({
+            new docx.Math({
                 children: runs,
             }),
         ],
     }));
 };
 const buildInlineMath = ({ value }) => {
-    return new docx__namespace.Math({
+    return new docx.Math({
         children: parseLatex(value).flatMap((runs) => runs),
     });
 };
 const buildText = (text, deco) => {
-    return new docx__namespace.TextRun({
+    return new docx.TextRun({
         text,
         bold: deco.strong,
         italics: deco.emphasis,
@@ -705,19 +701,20 @@ const buildText = (text, deco) => {
     });
 };
 const buildBreak = (_) => {
-    return new docx__namespace.TextRun({ text: "", break: 1 });
+    return new docx.TextRun({ text: "", break: 1 });
 };
 const buildLink = ({ children, url, title: _title }, ctx) => {
-    return new docx__namespace.ExternalHyperlink({
+    const { nodes } = convertNodes(children, ctx);
+    return new docx.ExternalHyperlink({
         link: url,
-        children: convertNodes(children, ctx),
+        children: nodes,
     });
 };
 const buildImage = ({ url, title: _title, alt: _alt }, images) => {
     const img = images[url];
     invariant(img, `Fetch image was failed: ${url}`);
     const { image, width, height } = img;
-    return new docx__namespace.ImageRun({
+    return new docx.ImageRun({
         data: image,
         transformation: {
             width,
@@ -727,10 +724,23 @@ const buildImage = ({ url, title: _title, alt: _alt }, images) => {
 };
 const buildFootnote = ({ children }, ctx) => {
     // FIXME: transform to paragraph for now
-    return new docx__namespace.Paragraph({
-        children: convertNodes(children, ctx),
+    const { nodes } = convertNodes(children, ctx);
+    return new docx.Paragraph({
+        children: nodes,
     });
 };
+const buildFootnoteDefinition = ({ children }, ctx) => {
+    return {
+        children: children.map((node) => {
+            const { nodes } = convertNodes([node], ctx);
+            return nodes[0];
+        }),
+    };
+};
+const buildFootnoteReference = ({ identifier }) => {
+    // do we need Context?
+    return new docx.FootnoteReferenceRun(parseInt(identifier));
+};
 
 const plugin = function (opts = {}) {
     let images = {};