@illusions-lab/mdi-to-docx 2.0.12 → 2.0.13

package/dist/index.cjs

@@ -32,7 +32,14 @@ async function mdiToDocx(tree, profile) {
     profile,
     tree.data?.frontmatter?.writingMode
   );
-  const children = tree.children.flatMap((node) => block(node, options));
+  const definitions = tree.children.filter(
+    (node) => node.type === "footnoteDefinition"
+  );
+  const footnoteIds = new Map(
+    definitions.map((definition, index) => [definition.identifier, index + 1])
+  );
+  const context = { footnoteIds };
+  const children = tree.children.flatMap((node) => block(node, options, context));
   const dimensions = import_mdi_export_profile.PAGE_DIMENSIONS[options.pagination.pageSize];
   const widthMm = options.pagination.landscape ? dimensions.height : dimensions.width;
   const heightMm = options.pagination.landscape ? dimensions.width : dimensions.height;
@@ -46,6 +53,16 @@ async function mdiToDocx(tree, profile) {
   const document = new import_docx.Document({
     title: options.metadata.title ?? tree.data?.frontmatter?.title,
     creator: options.metadata.author ?? tree.data?.frontmatter?.author,
+    footnotes: Object.fromEntries(
+      definitions.map((definition, index) => [
+        String(index + 1),
+        {
+          children: definition.children.flatMap(
+            (child) => child.type === "paragraph" ? [new import_docx.Paragraph({ children: inline(child.children, context) })] : []
+          )
+        }
+      ])
+    ),
     styles: {
       default: {
         document: {
@@ -176,7 +193,7 @@ function pageNumberSection(options, size) {
   const paragraph2 = new import_docx.Paragraph({ alignment, children: runs });
   return page.position.startsWith("top-") ? { headers: { default: new import_docx.Header({ children: [paragraph2] }) } } : { footers: { default: new import_docx.Footer({ children: [paragraph2] }) } };
 }
-function block(node, options) {
+function block(node, options, context) {
   if (node.type === "heading")
     return [
       new import_docx.Paragraph({
@@ -188,23 +205,23 @@ function block(node, options) {
           import_docx.HeadingLevel.HEADING_5,
           import_docx.HeadingLevel.HEADING_6
         ][node.depth - 1],
-        children: inline(node.children)
+        children: inline(node.children, context)
       })
     ];
-  if (node.type === "paragraph") return [paragraph(node.children, options)];
+  if (node.type === "paragraph") return [paragraph(node.children, options, void 0, context)];
   if (node.type === "list")
     return node.children.flatMap(
       (item) => item.children.filter((n) => n.type === "paragraph").map(
         (n) => new import_docx.Paragraph({
           style: "MdiList",
-          children: inline(n.children),
+          children: inline(n.children, context),
           bullet: { level: 0 }
         })
       )
     );
   if (node.type === "blockquote")
     return node.children.flatMap(
-      (child) => child.type === "paragraph" ? [paragraph(child.children, options, "MdiQuote")] : block(child, options)
+      (child) => child.type === "paragraph" ? [paragraph(child.children, options, "MdiQuote", context)] : block(child, options, context)
     );
   if (node.type === "code")
     return [
@@ -227,13 +244,13 @@ function block(node, options) {
         children: [new import_docx.TextRun("\u2014 \u2014 \u2014")]
       })
     ];
-  if (node.type === "table") return [tableBlock(node, options)];
+  if (node.type === "table") return [tableBlock(node, options, context)];
   if (node.type === "mdiPagebreak")
     return [new import_docx.Paragraph({ children: [new import_docx.PageBreak()] })];
   if (node.type === "mdiBlank") return [new import_docx.Paragraph("")];
   return [];
 }
-function tableBlock(node, options) {
+function tableBlock(node, options, context) {
   const columns = Math.max(1, ...node.children.map((row) => row.children.length));
   const dimensions = import_mdi_export_profile.PAGE_DIMENSIONS[options.pagination.pageSize];
   const pageWidth = options.pagination.landscape ? dimensions.height : dimensions.width;
@@ -253,7 +270,7 @@ function tableBlock(node, options) {
             width: { size: columnWidth, type: import_docx.WidthType.DXA },
             children: [
               new import_docx.Paragraph({
-                children: rowIndex === 0 ? [new import_docx.TextRun({ bold: true, children: inline(cell.children) })] : inline(cell.children)
+                children: rowIndex === 0 ? [new import_docx.TextRun({ text: inlineText(cell.children), bold: true })] : inline(cell.children, context)
               })
             ]
           })
@@ -262,7 +279,7 @@ function tableBlock(node, options) {
     )
   });
 }
-function paragraph(nodes, options, style) {
+function paragraph(nodes, options, style, context) {
   const fontSizeMm = (() => {
     const dimensions = import_mdi_export_profile.PAGE_DIMENSIONS[options.pagination.pageSize];
     const primary = options.typesetting.writingMode === "vertical" ? (options.pagination.landscape ? dimensions.width : dimensions.height) - options.pagination.margins.top - options.pagination.margins.bottom : (options.pagination.landscape ? dimensions.height : dimensions.width) - options.pagination.margins.left - options.pagination.margins.right;
@@ -278,26 +295,35 @@ function paragraph(nodes, options, style) {
         )
       }
     },
-    children: [...prefix, ...inline(nodes)]
+    children: [...prefix, ...inline(nodes, context)]
   });
 }
-function inline(nodes) {
+function inline(nodes, context) {
   return nodes.flatMap((node) => {
     if (node.type === "text") return [new import_docx.TextRun(node.value)];
     if (node.type === "break" || node.type === "mdiBreak")
       return [new import_docx.TextRun({ break: 1 })];
     if (node.type === "emphasis")
-      return [new import_docx.TextRun({ italics: true, children: inline(node.children) })];
+      return [new import_docx.TextRun({ italics: true, children: inline(node.children, context) })];
     if (node.type === "strong")
-      return [new import_docx.TextRun({ bold: true, children: inline(node.children) })];
+      return [new import_docx.TextRun({ bold: true, children: inline(node.children, context) })];
     if (node.type === "delete")
-      return [new import_docx.TextRun({ strike: true, children: inline(node.children) })];
+      return [new import_docx.TextRun({ strike: true, children: inline(node.children, context) })];
     if (node.type === "inlineCode")
       return [new import_docx.TextRun({ text: node.value, font: "Courier New" })];
     if (node.type === "image")
       return [new import_docx.TextRun({ text: node.alt ? `[Image: ${node.alt}]` : "[Image]" })];
-    if (node.type === "footnoteReference")
-      return [new import_docx.TextRun({ text: `[${node.label ?? node.identifier}]`, superScript: true })];
+    if (node.type === "link")
+      return [
+        new import_docx.ExternalHyperlink({
+          link: node.url,
+          children: inline(node.children, context)
+        })
+      ];
+    if (node.type === "footnoteReference") {
+      const id = context.footnoteIds.get(node.identifier);
+      return id ? [new import_docx.FootnoteReferenceRun(id)] : [];
+    }
     if (node.type === "mdiRuby") return [rawRun(rubyXml(node.base, node.ruby))];
     if (node.type === "mdiTcy")
       return [
@@ -307,10 +333,13 @@ function inline(nodes) {
           )}</w:t></w:r>`
         )
       ];
-    if ("children" in node) return inline(node.children);
+    if ("children" in node) return inline(node.children, context);
     return [];
   });
 }
+function inlineText(nodes) {
+  return nodes.map((node) => node.type === "text" ? node.value : "children" in node ? inlineText(node.children) : "").join("");
+}
 function mmToTwips(mm) {
   return Math.round(mm / 25.4 * 1440);
 }

package/dist/index.js

@@ -2,7 +2,9 @@
 import {
   AlignmentType,
   Document,
+  ExternalHyperlink,
   Footer,
+  FootnoteReferenceRun,
   HeadingLevel,
   Header,
   ImportedXmlComponent,
@@ -28,7 +30,14 @@ async function mdiToDocx(tree, profile) {
     profile,
     tree.data?.frontmatter?.writingMode
   );
-  const children = tree.children.flatMap((node) => block(node, options));
+  const definitions = tree.children.filter(
+    (node) => node.type === "footnoteDefinition"
+  );
+  const footnoteIds = new Map(
+    definitions.map((definition, index) => [definition.identifier, index + 1])
+  );
+  const context = { footnoteIds };
+  const children = tree.children.flatMap((node) => block(node, options, context));
   const dimensions = PAGE_DIMENSIONS[options.pagination.pageSize];
   const widthMm = options.pagination.landscape ? dimensions.height : dimensions.width;
   const heightMm = options.pagination.landscape ? dimensions.width : dimensions.height;
@@ -42,6 +51,16 @@ async function mdiToDocx(tree, profile) {
   const document = new Document({
     title: options.metadata.title ?? tree.data?.frontmatter?.title,
     creator: options.metadata.author ?? tree.data?.frontmatter?.author,
+    footnotes: Object.fromEntries(
+      definitions.map((definition, index) => [
+        String(index + 1),
+        {
+          children: definition.children.flatMap(
+            (child) => child.type === "paragraph" ? [new Paragraph({ children: inline(child.children, context) })] : []
+          )
+        }
+      ])
+    ),
     styles: {
       default: {
         document: {
@@ -172,7 +191,7 @@ function pageNumberSection(options, size) {
   const paragraph2 = new Paragraph({ alignment, children: runs });
   return page.position.startsWith("top-") ? { headers: { default: new Header({ children: [paragraph2] }) } } : { footers: { default: new Footer({ children: [paragraph2] }) } };
 }
-function block(node, options) {
+function block(node, options, context) {
   if (node.type === "heading")
     return [
       new Paragraph({
@@ -184,23 +203,23 @@ function block(node, options) {
           HeadingLevel.HEADING_5,
           HeadingLevel.HEADING_6
         ][node.depth - 1],
-        children: inline(node.children)
+        children: inline(node.children, context)
       })
     ];
-  if (node.type === "paragraph") return [paragraph(node.children, options)];
+  if (node.type === "paragraph") return [paragraph(node.children, options, void 0, context)];
   if (node.type === "list")
     return node.children.flatMap(
       (item) => item.children.filter((n) => n.type === "paragraph").map(
         (n) => new Paragraph({
           style: "MdiList",
-          children: inline(n.children),
+          children: inline(n.children, context),
           bullet: { level: 0 }
         })
       )
     );
   if (node.type === "blockquote")
     return node.children.flatMap(
-      (child) => child.type === "paragraph" ? [paragraph(child.children, options, "MdiQuote")] : block(child, options)
+      (child) => child.type === "paragraph" ? [paragraph(child.children, options, "MdiQuote", context)] : block(child, options, context)
     );
   if (node.type === "code")
     return [
@@ -223,13 +242,13 @@ function block(node, options) {
         children: [new TextRun("\u2014 \u2014 \u2014")]
       })
     ];
-  if (node.type === "table") return [tableBlock(node, options)];
+  if (node.type === "table") return [tableBlock(node, options, context)];
   if (node.type === "mdiPagebreak")
     return [new Paragraph({ children: [new PageBreak()] })];
   if (node.type === "mdiBlank") return [new Paragraph("")];
   return [];
 }
-function tableBlock(node, options) {
+function tableBlock(node, options, context) {
   const columns = Math.max(1, ...node.children.map((row) => row.children.length));
   const dimensions = PAGE_DIMENSIONS[options.pagination.pageSize];
   const pageWidth = options.pagination.landscape ? dimensions.height : dimensions.width;
@@ -249,7 +268,7 @@ function tableBlock(node, options) {
             width: { size: columnWidth, type: WidthType.DXA },
             children: [
               new Paragraph({
-                children: rowIndex === 0 ? [new TextRun({ bold: true, children: inline(cell.children) })] : inline(cell.children)
+                children: rowIndex === 0 ? [new TextRun({ text: inlineText(cell.children), bold: true })] : inline(cell.children, context)
               })
             ]
           })
@@ -258,7 +277,7 @@ function tableBlock(node, options) {
     )
   });
 }
-function paragraph(nodes, options, style) {
+function paragraph(nodes, options, style, context) {
   const fontSizeMm = (() => {
     const dimensions = PAGE_DIMENSIONS[options.pagination.pageSize];
     const primary = options.typesetting.writingMode === "vertical" ? (options.pagination.landscape ? dimensions.width : dimensions.height) - options.pagination.margins.top - options.pagination.margins.bottom : (options.pagination.landscape ? dimensions.height : dimensions.width) - options.pagination.margins.left - options.pagination.margins.right;
@@ -274,26 +293,35 @@ function paragraph(nodes, options, style) {
         )
       }
     },
-    children: [...prefix, ...inline(nodes)]
+    children: [...prefix, ...inline(nodes, context)]
   });
 }
-function inline(nodes) {
+function inline(nodes, context) {
   return nodes.flatMap((node) => {
     if (node.type === "text") return [new TextRun(node.value)];
     if (node.type === "break" || node.type === "mdiBreak")
       return [new TextRun({ break: 1 })];
     if (node.type === "emphasis")
-      return [new TextRun({ italics: true, children: inline(node.children) })];
+      return [new TextRun({ italics: true, children: inline(node.children, context) })];
     if (node.type === "strong")
-      return [new TextRun({ bold: true, children: inline(node.children) })];
+      return [new TextRun({ bold: true, children: inline(node.children, context) })];
     if (node.type === "delete")
-      return [new TextRun({ strike: true, children: inline(node.children) })];
+      return [new TextRun({ strike: true, children: inline(node.children, context) })];
     if (node.type === "inlineCode")
       return [new TextRun({ text: node.value, font: "Courier New" })];
     if (node.type === "image")
       return [new TextRun({ text: node.alt ? `[Image: ${node.alt}]` : "[Image]" })];
-    if (node.type === "footnoteReference")
-      return [new TextRun({ text: `[${node.label ?? node.identifier}]`, superScript: true })];
+    if (node.type === "link")
+      return [
+        new ExternalHyperlink({
+          link: node.url,
+          children: inline(node.children, context)
+        })
+      ];
+    if (node.type === "footnoteReference") {
+      const id = context.footnoteIds.get(node.identifier);
+      return id ? [new FootnoteReferenceRun(id)] : [];
+    }
     if (node.type === "mdiRuby") return [rawRun(rubyXml(node.base, node.ruby))];
     if (node.type === "mdiTcy")
       return [
@@ -303,10 +331,13 @@ function inline(nodes) {
           )}</w:t></w:r>`
         )
       ];
-    if ("children" in node) return inline(node.children);
+    if ("children" in node) return inline(node.children, context);
     return [];
   });
 }
+function inlineText(nodes) {
+  return nodes.map((node) => node.type === "text" ? node.value : "children" in node ? inlineText(node.children) : "").join("");
+}
 function mmToTwips(mm) {
   return Math.round(mm / 25.4 * 1440);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@illusions-lab/mdi-to-docx",
-  "version": "2.0.12",
+  "version": "2.0.13",
   "description": "Render MDI (.mdi) documents to DOCX",
   "license": "MIT",
   "repository": {
@@ -25,8 +25,8 @@
   "dependencies": {
     "docx": "^9.0.0",
     "@types/mdast": "^4.0.0",
-    "@illusions-lab/mdi-export-profile": "2.0.7",
-    "mdast-util-mdi": "2.0.11"
+    "@illusions-lab/mdi-export-profile": "2.0.8",
+    "mdast-util-mdi": "2.0.12"
   },
   "devDependencies": {
     "remark-parse": "^11.0.0",
@@ -36,7 +36,7 @@
     "typescript": "^5.6.0",
     "vitest": "^2.1.0",
     "@types/node": "^20.0.0",
-    "@illusions-lab/mdi-remark": "2.0.12"
+    "@illusions-lab/mdi-remark": "2.0.13"
   },
   "scripts": {
     "build": "tsup src/index.ts --format esm,cjs --dts",