mdast2docx 0.0.0-beta.0 → 0.1.0

package/dist/section.mjs

@@ -1 +1 @@
-import{a}from"./chunk-KRMGJ4HN.mjs";import"./chunk-O6BHSWEF.mjs";export{a as toSection};
+import{a}from"./chunk-GM6UUFDK.mjs";import"./chunk-YKZOUIFR.mjs";import"./chunk-3ZZBJC3M.mjs";export{a as toSection};

package/dist/utils.d.ts

@@ -1,6 +1,13 @@
-import { IImageOptions } from "@mayank1513/docx";
-import { BlockContent, DefinitionContent, RootContent } from "mdast";
+import { ExternalHyperlink, ImageRun, InternalHyperlink, IParagraphOptions, TextRun, Table, Paragraph, IRunOptions, IPropertiesOptions, Math as DOCXMath } from "@mayank1513/docx";
+import * as DOCX from "@mayank1513/docx";
+import { BlockContent, DefinitionContent, Parent, Root, RootContent } from "mdast";
 export { convertInchesToTwip, convertMillimetersToTwip } from "@mayank1513/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 */
@@ -10,6 +17,7 @@ export type FootnoteDefinitions = Record<string, {
 }>;
 /**
  * Extracts definitions and footnote definitions from a list of MDAST nodes.
+ *
  * @param nodes - Array of MDAST nodes.
  * @returns An object containing `definitions` and `footnoteDefinitions`.
  */
@@ -17,39 +25,86 @@ 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 | T;
 /**
- * Type definition for an image resolver function.
+ * 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 type ImageResolver = (src: string) => Promise<IImageOptions>;
+export declare const getTextContent: (node: ExtendedRootContent) => string;
 /**
- * Interface defining properties for MDAST to DOCX conversion.
+ * 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.
  */
-export interface IMdastToDocxSectionProps {
+interface IDefaultMdastToDocxSectionProps {
     /**
      * If true, H1 corresponds to the title, H2 to Heading1, etc.
      * @default true
      */
-    useTitle?: boolean;
+    useTitle: boolean;
     /**
-     * Custom image resolver function. Defaults to assuming client-side code.
+     * List of plugins to extend conversion functionality.
      */
-    imageResolver?: ImageResolver;
+    plugins: Array<IPlugin>;
 }
 /**
- * Determines the MIME type of an image from its binary buffer.
- * @param buffer - The image buffer (ArrayBuffer or Buffer).
- * @returns The detected MIME type as a string.
+ * Interface defining properties for MDAST to DOCX conversion.
+ */
+export type IMdastToDocxSectionProps = Optional<IDefaultMdastToDocxSectionProps>;
+export declare const defaultProps: IDefaultMdastToDocxSectionProps;
+/**
+ * Defines document properties, excluding sections and footnotes (which are managed internally).
  */
-export declare function getImageMimeType(buffer: Buffer | ArrayBuffer): "bmp" | "png" | "gif" | "jpg" | undefined;
+export type IDocxProps = Omit<Mutable<IPropertiesOptions>, "sections" | "footnotes">;
 /**
- * Default properties for MDAST to DOCX conversion.
+ * Mutable version of IRunOptions where all properties are writable.
  */
-interface IDefaultMdastToDocxSectionProps extends IMdastToDocxSectionProps {
-    useTitle: boolean;
-    imageResolver: ImageResolver;
+export type MutableRunOptions = Mutable<Omit<IRunOptions, "children">>;
+export type InlineParentType = "strong" | "emphasis" | "delete" | "link";
+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>, parentSet: 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 defaultProps: IDefaultMdastToDocxSectionProps;
 /**
- * @mayank/docx is a fork of the `docx` library with minor changes,
- * specifically exporting additional types that were not included in the original `docx` library.
+ * @mayank/docx is a fork of the `docx` library with minor modifications,
+ * primarily adding exports for additional types missing from the original `docx` library.
  */