mdast2docx 0.2.0 → 0.3.1

package/dist/plugins/math.mjs

@@ -1 +0,0 @@
-import{a,b}from"../chunk-ALSMH2CW.mjs";import"../chunk-Z2MODMIK.mjs";import"../chunk-I5QUWH2X.mjs";export{b as mathPlugin,a as parseLatex};

package/dist/plugins/table.d.ts

@@ -1,26 +0,0 @@
-import { AlignmentType, type ITableCellOptions, type ITableOptions, type ITableRowOptions, VerticalAlign } from "docx";
-import { IPlugin, Optional } from "../utils";
-export type RowProps = Omit<ITableRowOptions, "children">;
-export type TableProps = Omit<ITableOptions, "rows">;
-export type CellProps = Omit<ITableCellOptions, "children">;
-export interface ITableAlignments {
-    defaultVerticalAlign?: (typeof VerticalAlign)[keyof typeof VerticalAlign];
-    defaultHorizontalAlign?: (typeof AlignmentType)[keyof typeof AlignmentType];
-    /**
-     * Use MDAST data for horizontal aligning columns
-     * @default true
-     */
-    preferMdData?: boolean;
-}
-interface IDefaultTablePluginProps {
-    tableProps: TableProps;
-    rowProps: RowProps;
-    cellProps: CellProps;
-    firstRowProps: RowProps;
-    firstRowCellProps: CellProps;
-    alignments: ITableAlignments;
-}
-type ITablePluginProps = Optional<IDefaultTablePluginProps>;
-export declare const defaultTableOptions: IDefaultTablePluginProps;
-export declare const tablePlugin: (options?: ITablePluginProps) => IPlugin;
-export {};

package/dist/plugins/table.js

@@ -1 +0,0 @@
-"use strict";var P=Object.defineProperty;var D=Object.getOwnPropertyDescriptor;var V=Object.getOwnPropertyNames;var z=Object.prototype.hasOwnProperty;var H=(t,l)=>{for(var r in l)P(t,r,{get:l[r],enumerable:!0})},M=(t,l,r,n)=>{if(l&&typeof l=="object"||typeof l=="function")for(let o of V(l))!z.call(t,o)&&o!==r&&P(t,o,{get:()=>l[o],enumerable:!(n=D(l,o))||n.enumerable});return t};var N=t=>M(P({},"__esModule",{value:!0}),t);var S={};H(S,{defaultTableOptions:()=>g,tablePlugin:()=>k});module.exports=N(S);var e=require("docx"),i={style:e.BorderStyle.SINGLE,color:"auto",size:1},g={tableProps:{width:{size:100,type:e.WidthType.PERCENTAGE},margins:{top:(0,e.convertMillimetersToTwip)(2),right:(0,e.convertMillimetersToTwip)(4),bottom:(0,e.convertMillimetersToTwip)(2),left:(0,e.convertMillimetersToTwip)(4)},borders:{top:i,right:i,bottom:i,left:i,insideHorizontal:i,insideVertical:i}},rowProps:{},cellProps:{},firstRowProps:{tableHeader:!0},firstRowCellProps:{shading:{type:e.ShadingType.SOLID,fill:"b79c2f"}},alignments:{defaultVerticalAlign:e.VerticalAlign.CENTER,defaultHorizontalAlign:e.AlignmentType.CENTER,preferMdData:!0}},k=t=>({block:async(l,r,n,o,T)=>{var c;if(r.type!=="table")return[];let{Table:b,TableRow:u,TableCell:m,Paragraph:w}=l,{tableProps:y,firstRowProps:d,firstRowCellProps:R,rowProps:A,cellProps:h,alignments:a}={...g,...t},p=(c=r.align)==null?void 0:c.map(s=>{switch(s){case"left":return l.AlignmentType.LEFT;case"right":return l.AlignmentType.RIGHT;case"center":return l.AlignmentType.CENTER;default:return}}),I=async(s,f)=>new u({...A,...f===0?d:{},children:await Promise.all(s.children.map(async(O,E)=>new m({verticalAlign:a.defaultVerticalAlign,...h,...f===0?R:{},children:[new w({children:await T(O),alignment:a.preferMdData?p==null?void 0:p[E]:a.defaultHorizontalAlign})]})))}),C=await Promise.all(r.children.map(I));return r.type="",[new b({...y,rows:C})]}});0&&(module.exports={defaultTableOptions,tablePlugin});

package/dist/plugins/table.mjs

@@ -1 +0,0 @@
-import{a,b}from"../chunk-Q6Q2NBIZ.mjs";import"../chunk-I5QUWH2X.mjs";export{a as defaultTableOptions,b as tablePlugin};

package/dist/section.d.ts

@@ -1,26 +0,0 @@
-import type { Root } from "mdast";
-import type { Definitions, FootnoteDefinitions, ISectionProps } from "./utils";
-import { Paragraph } from "docx";
-import * as docx from "docx";
-/**
- * Converts an MDAST tree to a DOCX document section.
- * @param node - The root MDAST node
- * @param definitions - Definitions mapping
- * @param footnoteDefinitions - Footnote definitions mapping
- * @param props - Section properties (optional)
- * @returns A DOCX section representation
- */
-export declare const toSection: (node: Root, definitions: Definitions, footnoteDefinitions: FootnoteDefinitions, props?: ISectionProps) => Promise<{
-    children: (Paragraph | docx.Table)[];
-    headers?: {
-        readonly default?: docx.Header;
-        readonly first?: docx.Header;
-        readonly even?: docx.Header;
-    };
-    footers?: {
-        readonly default?: docx.Footer;
-        readonly first?: docx.Footer;
-        readonly even?: docx.Footer;
-    };
-    properties?: docx.ISectionPropertiesOptions;
-}>;

package/dist/section.js

@@ -1,2 +0,0 @@
-"use strict";var O=Object.create;var m=Object.defineProperty;var M=Object.getOwnPropertyDescriptor;var N=Object.getOwnPropertyNames;var S=Object.getPrototypeOf,B=Object.prototype.hasOwnProperty;var v=(e,o)=>{for(var l in o)m(e,l,{get:o[l],enumerable:!0})},D=(e,o,l,f)=>{if(o&&typeof o=="object"||typeof o=="function")for(let a of N(o))!B.call(e,a)&&a!==l&&m(e,a,{get:()=>o[a],enumerable:!(f=M(o,a))||f.enumerable});return e};var E=(e,o,l)=>(l=e!=null?O(S(e)):{},D(o||!e||!e.__esModule?m(l,"default",{value:e,enumerable:!0}):l,e)),F=e=>D(m({},"__esModule",{value:!0}),e);var j={};v(j,{toSection:()=>X});module.exports=F(j);var R=require("docx");var y=e=>{var o,l;return(o=e.children)!=null&&o.length?e.children.map(y).join(""):(l=e.value)!=null?l:""};var k={useTitle:!0,plugins:[]};var T=E(require("docx")),H=(e,o,l)=>{let f=async(i,h)=>{var t,u,p;let s=Object.assign({},h),c=(await Promise.all(l.map(r=>{var P,x;return(x=(P=r.inline)==null?void 0:P.call(r,T,i,h,e,o,a))!=null?x:[]}))).flat(),d=(u=i.url)!=null?u:e[(t=i.identifier)==null?void 0:t.toUpperCase()];switch(i.type){case"text":return[...c,new R.TextRun({text:i.value,...s})];case"break":return[...c,new R.TextRun({break:1})];case"inlineCode":return[...c,new R.TextRun({text:i.value,...s,style:"code",font:{name:"Consolas"}})];case"emphasis":return s.italics=!0,[...c,...await a(i,s)];case"strong":return s.bold=!0,[...c,...await a(i,s)];case"delete":return s.strike=!0,[...c,...await a(i,s)];case"link":case"linkReference":return[...c,d.startsWith("#")?new R.InternalHyperlink({anchor:d.slice(1),children:await a(i,s)}):new R.ExternalHyperlink({link:d,children:await a(i,s)})];case"footnoteReference":return[...c,new R.FootnoteReferenceRun((p=o[i.identifier].id)!=null?p:0)];case"":return[...c];default:return console.warn(`Unsupported inline node type: ${i.type}`),[...c]}},a=async(i,h={})=>{var s,c;return(await Promise.all((c=(s=i.children)==null?void 0:s.map(d=>f(d,h)))!=null?c:[])).flat()};return a},X=async(e,o,l,f)=>{let{plugins:a,useTitle:i,...h}={...k,...f},s=H(o,l,a),c=async(t,u)=>{var P,x,b,C;let p=Object.assign({},u),r=(await Promise.all(a.map(g=>{var I,w;return(w=(I=g.block)==null?void 0:I.call(g,T,t,p,d,s))!=null?w:[]}))).flat();switch(t.type){case"root":return[...r,...await d(t,p)];case"paragraph":return[...r,new R.Paragraph({...u,children:await s(t)})];case"heading":return[new R.Paragraph({...r,heading:i?t.depth===1?"Title":`Heading${t.depth-1}`:`Heading${t.depth}`,children:[new R.Bookmark({id:y(t).replace(/[. ]+/g,"-").toLowerCase(),children:await s(t)})]})];case"code":return[...r,new R.Paragraph({alignment:"start",style:"blockCode",children:t.value.split(`
-`).map(g=>new R.TextRun({text:g,break:1,style:"code",font:{name:"Consolas"}}))})];case"list":return t.ordered?(p.bullet={level:((x=(P=p.bullet)==null?void 0:P.level)!=null?x:-1)+1},console.warn("Please add numbering plugin to support ordered lists. For now, we use only bullets for both the ordered and the unordered list.")):p.bullet={level:((C=(b=p.bullet)==null?void 0:b.level)!=null?C:-1)+1},[...r,...await d(t,p)];case"blockquote":return[...r,...await d(t,p)];case"listItem":return[...r,...await d(t,p)];case"thematicBreak":return[...r,new R.Paragraph({border:{top:{style:R.BorderStyle.SINGLE,size:6}}})];case"definition":case"footnoteDefinition":return r;case"table":return console.warn("Please add table plugin to support tables."),r;case"":return r;case"yaml":case"html":default:return console.warn(`May be an unsupported node type: ${t.type}`,t),r}},d=async(t,u)=>{var p;return(await Promise.all((p=t.children)==null?void 0:p.map(r=>c(r,u)))).flat()};return{...h,children:await d(e,{})}};0&&(module.exports={toSection});

package/dist/section.mjs

@@ -1 +0,0 @@
-import{a}from"./chunk-ECHPYCZC.mjs";import"./chunk-MSGIMOZN.mjs";import"./chunk-I5QUWH2X.mjs";export{a as toSection};

package/dist/utils.d.ts

@@ -1,113 +0,0 @@
-import { ExternalHyperlink, ImageRun, InternalHyperlink, IParagraphOptions, TextRun, Table, Paragraph, IRunOptions, IPropertiesOptions, Math as DOCXMath } from "docx";
-import * as DOCX from "docx";
-import { BlockContent, DefinitionContent, Parent, Root, RootContent } from "mdast";
-export { convertInchesToTwip, convertMillimetersToTwip } from "docx";
-export type Optional<T> = {
-    [K in keyof T]?: T[K];
-};
-export type Mutable<T> = {
-    -readonly [K in keyof T]: T[K] extends object ? Mutable<T> : T[K];
-};
-/** Type representing definition mappings */
-export type Definitions = Record<string, string>;
-/** Type representing footnote definitions */
-export type FootnoteDefinitions = Record<string, {
-    children: (BlockContent | DefinitionContent)[];
-    id?: number;
-}>;
-/**
- * Extracts definitions and footnote definitions from a list of MDAST nodes.
- *
- * @param nodes - Array of MDAST nodes.
- * @returns An object containing `definitions` and `footnoteDefinitions`.
- */
-export declare const getDefinitions: (nodes: RootContent[]) => {
-    definitions: Definitions;
-    footnoteDefinitions: FootnoteDefinitions;
-};
-/** Type representing an extended RootContent node
- * - this type is used to avoid type errors when setting type to empty string (in case you want to avoid reprocessing that node.) in plugins
- */
-type ExtendedRootContent<T extends {
-    type: string;
-} = {
-    type: "";
-}> = RootContent | Root | T;
-/**
- * Extracts the textual content from a given MDAST node.
- * Recursively processes child nodes if present.
- *
- * @param node - The MDAST node to extract text from.
- * @returns The combined text content of the node and its children.
- */
-export declare const getTextContent: (node: ExtendedRootContent) => string;
-/**
- * Creates a random string - used to add as a random suffix to make style/numbering reference names unique
- * @returns
- */
-export declare const uuid: () => string;
-/**
- * Default configuration for converting MDAST to DOCX, including title handling and plugin extensions.
- */
-interface IDefaultMdastToDocxSectionProps extends Omit<DOCX.ISectionOptions, "children"> {
-    /**
-     * If true, H1 corresponds to the title, H2 to Heading1, etc.
-     * @default true
-     */
-    useTitle: boolean;
-    /**
-     * List of plugins to extend conversion functionality.
-     */
-    plugins: Array<IPlugin>;
-}
-/**
- * Defines properties for a document section, omitting the "children" property from ISectionOptions.
- * Also defining properties for MDAST to DOCX conversion
- */
-export type ISectionProps = Optional<IDefaultMdastToDocxSectionProps>;
-export declare const defaultSectionProps: IDefaultMdastToDocxSectionProps;
-/**
- * Defines document properties, excluding sections and footnotes (which are managed internally).
- */
-export type IDocxProps = Omit<Mutable<IPropertiesOptions>, "sections" | "footnotes">;
-export declare const defaultDocxProps: IDocxProps;
-/**
- * Mutable version of IRunOptions where all properties are writable.
- */
-export type MutableRunOptions = Mutable<Omit<IRunOptions, "children">>;
-export type InlineDocxNodes = TextRun | ImageRun | InternalHyperlink | ExternalHyperlink | DOCXMath;
-export type InlineProcessor = (node: ExtendedRootContent, runProps: MutableRunOptions) => Promise<InlineDocxNodes[]>;
-export type InlineChildrenProcessor = (node: Parent, runProps?: MutableRunOptions) => Promise<InlineDocxNodes[]>;
-/**
- * Mutable version of IParagraphOptions where all properties are writable.
- */
-export type MutableParaOptions = Omit<Mutable<IParagraphOptions>, "children">;
-export type BlockNodeProcessor = (node: ExtendedRootContent, paraProps: MutableParaOptions) => Promise<(Paragraph | Table)[]>;
-export type BlockNodeChildrenProcessor = (node: Parent | Root, paraProps: MutableParaOptions) => Promise<(Paragraph | Table)[]>;
-/**
- * Interface for extending MDAST to DOCX conversion using plugins.
- */
-export interface IPlugin<T extends {
-    type: string;
-} = {
-    type: "";
-}> {
-    /**
-     * Processes block-level nodes.
-     */
-    block?: (docx: typeof DOCX, node: ExtendedRootContent<T>, paraProps: MutableParaOptions, blockChildrenProcessor: BlockNodeChildrenProcessor, inlineChildrenProcessor: InlineChildrenProcessor) => Promise<(Paragraph | Table)[]>;
-    /**
-     * Processes inline-level nodes.
-     */
-    inline?: (docx: typeof DOCX, node: ExtendedRootContent<T>, runProps: MutableRunOptions, definitions: Definitions, footnoteDefinitions: FootnoteDefinitions, inlineChildrenProcessor: InlineChildrenProcessor) => Promise<InlineDocxNodes[]>;
-    /**
-     * Allows plugins to modify document-level DOCX properties, such as styles, numbering, headers, and footers. This is useful for global formatting customizations.
-     */
-    root?: (props: IDocxProps) => void;
-}
-export declare const inlineMdastNodes: string[];
-export declare const standardize_color: (str: string) => string;
-/**
- * @mayank/docx is a fork of the `docx` library with minor modifications,
- * primarily adding exports for additional types missing from the original `docx` library.
- */

package/dist/utils.js

@@ -1 +0,0 @@
-"use strict";var a=Object.defineProperty;var l=Object.getOwnPropertyDescriptor;var c=Object.getOwnPropertyNames;var d=Object.prototype.hasOwnProperty;var f=(t,e)=>{for(var n in e)a(t,n,{get:e[n],enumerable:!0})},u=(t,e,n,o)=>{if(e&&typeof e=="object"||typeof e=="function")for(let r of c(e))!d.call(t,r)&&r!==n&&a(t,r,{get:()=>e[r],enumerable:!(o=l(e,r))||o.enumerable});return t};var x=t=>u(a({},"__esModule",{value:!0}),t);var b={};f(b,{convertInchesToTwip:()=>i.convertInchesToTwip,convertMillimetersToTwip:()=>i.convertMillimetersToTwip,defaultDocxProps:()=>h,defaultSectionProps:()=>g,getDefinitions:()=>s,getTextContent:()=>p,inlineMdastNodes:()=>y,standardize_color:()=>D,uuid:()=>P});module.exports=x(b);var i=require("docx"),s=t=>{let e={},n={};return t.forEach(o=>{var r;o.type==="definition"?e[o.identifier.toUpperCase()]=o.url:o.type==="footnoteDefinition"?n[o.identifier.toUpperCase()]={children:o.children}:(r=o.children)!=null&&r.length&&Object.assign(e,s(o.children))}),{definitions:e,footnoteDefinitions:n}},p=t=>{var e,n;return(e=t.children)!=null&&e.length?t.children.map(p).join(""):(n=t.value)!=null?n:""},P=()=>Math.random().toString(16).slice(2),g={useTitle:!0,plugins:[]},h={styles:{default:{document:{paragraph:{spacing:{before:175,line:300},alignment:"thaiDistribute"},run:{size:24}},heading1:{paragraph:{spacing:{before:350}}},heading2:{paragraph:{spacing:{before:350}}},heading3:{paragraph:{spacing:{before:350}}},heading4:{paragraph:{spacing:{before:350}}},heading5:{paragraph:{spacing:{before:350}}},heading6:{paragraph:{spacing:{before:350}}}}}},y=["text","break","inlineCode","image","emphasis","strong","delete","link","linkReference","footnoteReference"],D=t=>{let e=document.createElement("canvas").getContext("2d");return e?(e.fillStyle=t,e.fillStyle):t.startsWith("#")?t:"auto"};0&&(module.exports={convertInchesToTwip,convertMillimetersToTwip,defaultDocxProps,defaultSectionProps,getDefinitions,getTextContent,inlineMdastNodes,standardize_color,uuid});

package/dist/utils.mjs

@@ -1 +0,0 @@
-import{a,b,c,d,e,f,g,h,i}from"./chunk-MSGIMOZN.mjs";import"./chunk-I5QUWH2X.mjs";export{h as convertInchesToTwip,i as convertMillimetersToTwip,e as defaultDocxProps,d as defaultSectionProps,a as getDefinitions,b as getTextContent,f as inlineMdastNodes,g as standardize_color,c as uuid};