@masumdev/markforge 0.2.4 → 0.2.5

package/dist/cli.mjs

@@ -57,7 +57,7 @@ async function main() {
   const cliFormats = options.to ? options.to.split(",").map((f) => f.trim().toLowerCase()).filter(Boolean) : void 0;
   const [{ render }, { App }, { loadConfig }] = await Promise.all([
     import("ink"),
-    import("./App-IJVCGBJM.mjs"),
+    import("./App-GNRUPFM7.mjs"),
     import("./loadConfig-PD6ENMAM.mjs")
   ]);
   const { config: fileConfig } = await loadConfig(

package/dist/index.d.mts

@@ -1,21 +1,147 @@
-type MarkforgeFormat = "docx" | "pdf" | "html" | "png";
-type MarkforgeTheme = "default" | "academic" | "github" | "corporate" | "minimal" | "dracula" | (string & {});
-type DocumentOrientation = "portrait" | "landscape";
-type PaperSize = "A4" | "Letter" | "Legal" | "A3" | "A5";
+declare enum OutputFormat {
+    DOCX = "docx",
+    PDF = "pdf",
+    HTML = "html",
+    PNG = "png"
+}
+type MarkforgeFormat = "docx" | "pdf" | "html" | "png" | OutputFormat;
+interface ThemeProps {
+    /**
+     * Primary brand accent color (e.g. "#33CDCF", "#2563EB", "#7C3AED", "#E11D48").
+     * @default "#33CDCF"
+     */
+    primaryColor?: string;
+    /**
+     * Dark primary tone for headings, active links, and prominent badges.
+     * @default "#009DA0"
+     */
+    primaryDark?: string;
+    /**
+     * Light primary background tint for callouts and active pills.
+     * @default "#ECFDFD"
+     */
+    primaryLight?: string;
+    /**
+     * Document page background color.
+     * @default "#FFFFFF"
+     */
+    backgroundColor?: string;
+    /**
+     * Primary body copy text color.
+     * @default "#0F172A"
+     */
+    textColor?: string;
+    /**
+     * Muted secondary text color for subtitles, dates, and footers.
+     * @default "#64748B"
+     */
+    textMuted?: string;
+    /**
+     * Border color for tables, dividers, and card containers.
+     * @default "#E2E8F0"
+     */
+    borderColor?: string;
+    /**
+     * Background color for cards, table headers, and blockquotes.
+     * @default "#F8FAFC"
+     */
+    cardBackground?: string;
+    /**
+     * Background color for code blocks.
+     * @default "#0F172A"
+     */
+    codeBackground?: string;
+    /**
+     * Text color for code blocks.
+     * @default "#F8FAFC"
+     */
+    codeText?: string;
+    /**
+     * Primary body and heading font family.
+     * @default "-apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif"
+     */
+    fontFamily?: string;
+    /**
+     * Monospace font family for code blocks and inline code.
+     * @default "ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace"
+     */
+    fontMono?: string;
+    /**
+     * Optional custom raw CSS styles appended directly to the stylesheet.
+     */
+    customCss?: string;
+}
+declare enum Theme {
+    CORPORATE = "corporate"
+}
+type MarkforgeTheme = Theme | ThemeProps | "corporate" | (string & {});
+declare enum Orientation {
+    PORTRAIT = "portrait",
+    LANDSCAPE = "landscape"
+}
+type DocumentOrientation = "portrait" | "landscape" | Orientation;
+declare enum PaperSizeEnum {
+    A4 = "A4",
+    LETTER = "Letter",
+    LEGAL = "Legal",
+    A3 = "A3",
+    A5 = "A5"
+}
+type PaperSize = "A4" | "Letter" | "Legal" | "A3" | "A5" | PaperSizeEnum;
+declare enum SyntaxTheme {
+    GITHUB_DARK = "github-dark",
+    GITHUB_LIGHT = "github-light",
+    DRACULA = "dracula",
+    MONOKAI = "monokai",
+    NORD = "nord"
+}
+declare enum WatermarkPosition {
+    DIAGONAL = "diagonal",
+    CENTER = "center",
+    TOP_RIGHT = "top-right",
+    BOTTOM_RIGHT = "bottom-right"
+}
 interface PageMargins {
     top?: string | number;
     bottom?: string | number;
     left?: string | number;
     right?: string | number;
 }
+interface HeaderFooterSlot {
+    /**
+     * Header or footer template text (supports tokens like {title}, {author}, {version}, {date}, {company}, {page}, {pages}).
+     */
+    text: string;
+    /**
+     * Custom text color for this zone (e.g. "#0D998D", "#94A3B8").
+     */
+    color?: string;
+    /**
+     * Custom font size in points (e.g. 9, 10).
+     */
+    fontSize?: number;
+    /**
+     * Custom font family for this zone (e.g. "Segoe UI", "Inter").
+     */
+    fontFamily?: string;
+    /**
+     * Whether to render this zone in bold weight.
+     */
+    bold?: boolean;
+    /**
+     * Whether to render this zone in italics.
+     */
+    italic?: boolean;
+}
 interface HeaderFooterItem {
-    left?: string;
-    center?: string;
-    right?: string;
+    left?: string | HeaderFooterSlot;
+    center?: string | HeaderFooterSlot;
+    right?: string | HeaderFooterSlot;
     font?: string;
     size?: number;
     color?: string;
     divider?: boolean;
+    dividerColor?: string;
 }
 interface WatermarkOptions {
     text: string;
@@ -23,54 +149,38 @@ interface WatermarkOptions {
     opacity?: number;
     fontSize?: number;
     rotate?: number;
-    position?: "diagonal" | "center" | "top-right" | "bottom-right";
+    position?: "diagonal" | "center" | "top-right" | "bottom-right" | WatermarkPosition;
 }
-interface FrontmatterMetadata {
+/**
+ * Pure document metadata dictionary (author, title, date, version, etc.).
+ */
+interface DocumentMetadata {
     title?: string;
     subtitle?: string;
     author?: string | string[];
     date?: string;
     version?: string;
-    theme?: MarkforgeTheme;
-    orientation?: DocumentOrientation;
-    paperSize?: PaperSize;
-    margins?: PageMargins;
-    header?: HeaderFooterItem;
-    footer?: HeaderFooterItem;
-    toc?: boolean;
-    watermark?: string | WatermarkOptions | false;
-    css?: string | string[];
-    coverPage?: boolean;
+    company?: string;
     lang?: string;
+    coverPage?: boolean;
     [key: string]: unknown;
 }
-interface MarkforgeConfig {
-    /**
-     * Target format(s) to compile markdown to.
-     * @default ["docx", "pdf"]
-     */
-    to?: MarkforgeFormat | MarkforgeFormat[];
-    /**
-     * Output directory where compiled documents will be saved.
-     * Defaults to the same directory as the input file.
-     */
-    outputDir?: string;
+/**
+ * Document visual & layout options (theme, orientation, margins, headers, footers, etc.).
+ */
+interface DocumentLayoutConfig {
     /**
      * Built-in visual theme name.
      * @default "default"
      */
     theme?: MarkforgeTheme;
-    /**
-     * Path(s) to custom CSS stylesheets to inject into the document.
-     */
-    css?: string | string[];
     /**
      * Page orientation.
      * @default "portrait"
      */
     orientation?: DocumentOrientation;
     /**
-     * Paper size.
+     * Standard paper size.
      * @default "A4"
      */
     paperSize?: PaperSize;
@@ -79,11 +189,11 @@ interface MarkforgeConfig {
      */
     margins?: PageMargins;
     /**
-     * Header template configuration.
+     * Running header template configuration.
      */
     header?: HeaderFooterItem;
     /**
-     * Footer template configuration.
+     * Running footer template configuration.
      */
     footer?: HeaderFooterItem;
     /**
@@ -93,18 +203,53 @@ interface MarkforgeConfig {
     toc?: boolean;
     /**
      * Optional watermark configuration to display across pages.
-     * By default, no watermark is displayed.
+     * @default false
      */
     watermark?: string | WatermarkOptions | false;
+    /**
+     * Path(s) to custom CSS stylesheets to inject into the document.
+     */
+    css?: string | string[];
+    /**
+     * Code syntax highlighting theme.
+     * @default "github-dark"
+     */
+    syntaxTheme?: "github-dark" | "github-light" | "dracula" | "monokai" | "nord" | SyntaxTheme | (string & {});
+}
+/**
+ * Complete metadata extracted from Markdown frontmatter.
+ * Combines document metadata and layout overrides.
+ */
+type FrontmatterMetadata = DocumentMetadata & DocumentLayoutConfig;
+/**
+ * Top-level MarkForge configuration (from config file, CLI, or API).
+ * Clean, 100% intuitive, and zero-duplicate architecture.
+ */
+interface MarkforgeConfig extends DocumentLayoutConfig {
+    /**
+     * Target format(s) to compile markdown to.
+     * @default ["docx", "pdf"]
+     */
+    to?: MarkforgeFormat | MarkforgeFormat[];
+    /**
+     * Output directory where compiled documents will be saved.
+     * Defaults to the same directory as the input file.
+     */
+    outputDir?: string;
+    /**
+     * Default document metadata (title, author, date, etc.) used when not provided in frontmatter.
+     */
+    metadata?: DocumentMetadata;
     /**
      * Whether to embed all images (local and remote) directly into the document.
      * @default true
      */
     embedImages?: boolean;
     /**
-     * Custom metadata overrides for title, author, date, etc.
+     * Whether to generate standalone self-contained HTML bundle.
+     * @default true
      */
-    metadata?: Partial<FrontmatterMetadata>;
+    bundleHtml?: boolean;
     /**
      * Watch files and automatically recompile on changes.
      * @default false
@@ -125,16 +270,6 @@ interface MarkforgeConfig {
      * @default false
      */
     open?: boolean;
-    /**
-     * Whether to generate standalone self-contained HTML bundle.
-     * @default true
-     */
-    bundleHtml?: boolean;
-    /**
-     * Code syntax highlighting theme.
-     * @default "github-dark"
-     */
-    syntaxTheme?: string;
 }
 interface GeneratedOutputFile {
     format: MarkforgeFormat;
@@ -291,14 +426,11 @@ declare const SYNTAX_COLORS: {
     punctuation: string;
     plain: string;
 };
-/**
- * Tokenizes a single line of code into styled tokens based on language.
- */
-declare function tokenizeCodeLine(line: string, lang?: string, theme?: "dark" | "light"): SyntaxToken[];
+declare function tokenizeCodeLine(line: string, lang?: string, theme?: string): SyntaxToken[];
 /**
  * Converts a code snippet to syntax-highlighted HTML with colored span tokens.
  */
-declare function highlightCodeToHtml(code: string, lang?: string): string;
+declare function highlightCodeToHtml(code: string, lang?: string, theme?: string): string;
 
 /**
  * Renders Mermaid diagram definition into an SVG/PNG buffer for DOCX and HTML embedding.
@@ -306,14 +438,16 @@ declare function highlightCodeToHtml(code: string, lang?: string): string;
 declare function renderMermaidToPng(mermaidCode: string, _baseDir?: string): Promise<Buffer | null>;
 
 /**
- * Default theme — full design system with Blu-by-BCA-Digital cyan palette.
+ * Flagship corporate theme — full design system with Blu-by-BCA-Digital cyan palette.
  */
-declare const THEME_DEFAULT = "\n:root {\n  --mf-bg: #ffffff;\n  --mf-text: #0f172a;\n  --mf-text-muted: #64748b;\n  --mf-primary: #33CDCF;\n  --mf-primary-dark: #009DA0;\n  --mf-primary-light: #ECFDFD;\n  --mf-border: #e2e8f0;\n  --mf-card-bg: #f8fafc;\n  --mf-code-bg: #0f172a;\n  --mf-code-text: #f8fafc;\n  --mf-font-family: -apple-system, BlinkMacSystemFont, \"Segoe UI\", Roboto, Oxygen, Ubuntu, Cantarell, sans-serif;\n  --mf-font-mono: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace;\n}\nbody { background-color: var(--mf-bg); color: var(--mf-text); font-family: var(--mf-font-family); font-size: 15px; line-height: 1.65; margin: 0; padding: 2.5rem; }\n.document-container { max-width: 860px; margin: 0 auto; }\nh1, h2, h3, h4, h5, h6 { color: var(--mf-text); font-weight: 700; margin-top: 1.8rem; margin-bottom: 0.8rem; line-height: 1.25; }\nh1 { font-size: 2.2rem; border-bottom: 2px solid #33CDCF; padding-bottom: 0.5rem; }\nh2 { font-size: 1.6rem; color: #009DA0; border-bottom: 1px solid #CCFBF1; padding-bottom: 0.4rem; }\nh3 { font-size: 1.3rem; }\nh4 { font-size: 1.1rem; }\np  { margin: 0.8rem 0; }\n";
+declare const THEME_CORPORATE = "\n:root {\n  --mf-bg: #ffffff;\n  --mf-text: #0f172a;\n  --mf-text-muted: #64748b;\n  --mf-primary: #33CDCF;\n  --mf-primary-dark: #009DA0;\n  --mf-primary-light: #ECFDFD;\n  --mf-border: #e2e8f0;\n  --mf-card-bg: #f8fafc;\n  --mf-code-bg: #0f172a;\n  --mf-code-text: #f8fafc;\n  --mf-font-family: -apple-system, BlinkMacSystemFont, \"Segoe UI\", Roboto, sans-serif;\n  --mf-font-mono: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace;\n}\nbody { background-color: var(--mf-bg); color: var(--mf-text); font-family: var(--mf-font-family); font-size: 15px; line-height: 1.65; margin: 0; padding: 2.5rem; }\n.document-container { max-width: 860px; margin: 0 auto; position: relative; z-index: 1; }\nh1, h2, h3, h4, h5, h6 { color: var(--mf-text); font-weight: 700; margin-top: 1.8rem; margin-bottom: 0.8rem; line-height: 1.25; }\nh1 { font-size: 2.2rem; border-bottom: 2px solid var(--mf-primary); padding-bottom: 0.5rem; }\nh2 { font-size: 1.6rem; color: var(--mf-primary-dark); border-bottom: 1px solid #CCFBF1; padding-bottom: 0.4rem; }\nh3 { font-size: 1.3rem; }\nh4 { font-size: 1.1rem; }\np  { margin: 0.8rem 0; }\n";
+declare const THEME_DEFAULT = "\n:root {\n  --mf-bg: #ffffff;\n  --mf-text: #0f172a;\n  --mf-text-muted: #64748b;\n  --mf-primary: #33CDCF;\n  --mf-primary-dark: #009DA0;\n  --mf-primary-light: #ECFDFD;\n  --mf-border: #e2e8f0;\n  --mf-card-bg: #f8fafc;\n  --mf-code-bg: #0f172a;\n  --mf-code-text: #f8fafc;\n  --mf-font-family: -apple-system, BlinkMacSystemFont, \"Segoe UI\", Roboto, sans-serif;\n  --mf-font-mono: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace;\n}\nbody { background-color: var(--mf-bg); color: var(--mf-text); font-family: var(--mf-font-family); font-size: 15px; line-height: 1.65; margin: 0; padding: 2.5rem; }\n.document-container { max-width: 860px; margin: 0 auto; position: relative; z-index: 1; }\nh1, h2, h3, h4, h5, h6 { color: var(--mf-text); font-weight: 700; margin-top: 1.8rem; margin-bottom: 0.8rem; line-height: 1.25; }\nh1 { font-size: 2.2rem; border-bottom: 2px solid var(--mf-primary); padding-bottom: 0.5rem; }\nh2 { font-size: 1.6rem; color: var(--mf-primary-dark); border-bottom: 1px solid #CCFBF1; padding-bottom: 0.4rem; }\nh3 { font-size: 1.3rem; }\nh4 { font-size: 1.1rem; }\np  { margin: 0.8rem 0; }\n";
+declare const THEMES: Record<string, string>;
+
 /**
- * Academic theme — serif typography for formal papers/reports.
+ * Resolves theme CSS based on preset name or custom ThemeProps object.
  */
-declare const THEME_ACADEMIC = "\n:root {\n  --mf-bg: #ffffff;\n  --mf-text: #1a1a1a;\n  --mf-text-muted: #555;\n  --mf-primary: #33CDCF;\n  --mf-primary-dark: #009DA0;\n  --mf-primary-light: #ECFDFD;\n  --mf-border: #ccc;\n  --mf-card-bg: #f9f9f9;\n  --mf-code-bg: #1e1e1e;\n  --mf-code-text: #d4d4d4;\n  --mf-font-family: \"Merriweather\", \"Georgia\", \"Times New Roman\", serif;\n  --mf-font-mono: \"Courier New\", Courier, monospace;\n}\nbody { font-family: var(--mf-font-family); font-size: 16px; line-height: 1.8; padding: 3rem; color: var(--mf-text); }\n.document-container { max-width: 780px; margin: 0 auto; text-align: justify; }\nh1, h2, h3 { font-family: \"Times New Roman\", Times, serif; font-weight: bold; text-align: left; }\nh1 { font-size: 2rem; border-bottom: 1px solid #000; padding-bottom: 0.3rem; }\nh2 { font-size: 1.4rem; border-bottom: 1px solid #ccc; padding-bottom: 0.2rem; }\nh3 { font-size: 1.2rem; }\np  { margin: 0.9rem 0; }\n";
-declare const THEMES: Record<string, string>;
+declare function generateThemeCss(theme?: MarkforgeTheme): string;
 
 /**
  * Type-safe configuration helper for markforge.config.ts
@@ -338,12 +472,125 @@ declare function loadConfig(customPath?: string, startDir?: string): Promise<{
     configPath: string | null;
 }>;
 
+/**
+ * Standard paper dimensions in Word Twips (1/20th of a point, 1440 twips = 1 inch).
+ */
+declare const PAPER_DIMENSIONS_TWIP: Record<PaperSize, {
+    width: number;
+    height: number;
+}>;
+interface NormalizedMargins {
+    top: string;
+    bottom: string;
+    left: string;
+    right: string;
+    topTwip: number;
+    bottomTwip: number;
+    leftTwip: number;
+    rightTwip: number;
+}
+interface NormalizedWatermark {
+    text: string;
+    color: string;
+    opacity: number;
+    fontSize: number;
+    rotate: number;
+    position: "diagonal" | "center" | "top-right" | "bottom-right";
+}
+interface NormalizedHeaderFooterZone {
+    text: string;
+    color: string;
+    fontSize: number;
+    fontFamily: string;
+    bold: boolean;
+    italic: boolean;
+}
+interface NormalizedHeaderFooter {
+    left?: NormalizedHeaderFooterZone;
+    center?: NormalizedHeaderFooterZone;
+    right?: NormalizedHeaderFooterZone;
+    font: string;
+    size: number;
+    color: string;
+    divider: boolean;
+    dividerColor: string;
+}
+interface ResolvedDocumentConfig {
+    title: string;
+    subtitle?: string;
+    author?: string;
+    date?: string;
+    version?: string;
+    company?: string;
+    lang: string;
+    theme: MarkforgeTheme;
+    orientation: DocumentOrientation;
+    paperSize: PaperSize;
+    paperDimensions: {
+        widthTwip: number;
+        heightTwip: number;
+    };
+    margins: NormalizedMargins;
+    header?: NormalizedHeaderFooter;
+    footer?: NormalizedHeaderFooter;
+    toc: boolean;
+    watermark?: NormalizedWatermark;
+    css: string[];
+    embedImages: boolean;
+    bundleHtml: boolean;
+    syntaxTheme: string;
+}
+/**
+ * Replaces dynamic variables ({title}, {subtitle}, {author}, {version}, {date}, {company}) in text templates.
+ */
+declare function replaceDocumentTokens(template: string | undefined, meta: {
+    title?: string;
+    subtitle?: string;
+    author?: string;
+    version?: string;
+    date?: string;
+    company?: string;
+}): string;
+/**
+ * Normalizes watermark configuration into a consistent structured object.
+ */
+declare function normalizeWatermark(rawWatermark?: string | WatermarkOptions | false): NormalizedWatermark | undefined;
+/**
+ * Normalizes an individual left, center, or right header/footer zone slot.
+ */
+declare function normalizeHeaderFooterSlot(rawSlot: string | HeaderFooterSlot | undefined, parent: HeaderFooterItem | undefined, meta: {
+    title?: string;
+    subtitle?: string;
+    author?: string;
+    version?: string;
+    date?: string;
+    company?: string;
+}): NormalizedHeaderFooterZone | undefined;
+/**
+ * Normalizes a header or footer item into a structured NormalizedHeaderFooter object.
+ */
+declare function normalizeHeaderFooter(raw: HeaderFooterItem | undefined, meta: {
+    title?: string;
+    subtitle?: string;
+    author?: string;
+    version?: string;
+    date?: string;
+    company?: string;
+}): NormalizedHeaderFooter | undefined;
+/**
+ * Centralized Single Source of Truth for resolving document configuration.
+ * Priority hierarchy: Frontmatter metadata > Project Config File / User Config > DEFAULT_CONFIG
+ */
+declare function resolveDocumentConfig(frontmatter?: Record<string, unknown>, userConfig?: MarkforgeConfig): ResolvedDocumentConfig;
+
 /**
  * Dynamically resolved version — reads from the nearest package.json at runtime.
  * Falls back to the hardcoded FALLBACK_VERSION constant if not found.
  */
 declare const MARKFORGE_VERSION: string;
-/** @deprecated Use MARKFORGE_VERSION directly. */
+/**
+ * Resolves the MarkForge version dynamically from package.json in the specified or current directory.
+ */
 declare function getMarkforgeVersion(fromDir?: string): string;
 
-export { type CompilationResult, DEFAULT_CONFIG, type DocumentOrientation, type FrontmatterMetadata, type GeneratedOutputFile, type HeaderFooterItem, MARKFORGE_VERSION, type MarkdownASTNode, type MarkdownInlineSpan, type MarkdownNodeType, type MarkforgeConfig, type MarkforgeFormat, type MarkforgeTheme, type PageMargins, type PaperSize, type ParsedMarkdownDocument, type ResolvedImage, SYNTAX_COLORS, type SyntaxToken, THEMES, THEME_ACADEMIC, THEME_DEFAULT, type WatermarkOptions, buildDocxDocument, buildHtmlDocument, buildPdfDocument, compileMarkdown, defineConfig, escapeHtml, findChromeExecutable, formatServerTimestamp, getMarkforgeVersion, getMimeType, highlightCodeToHtml, injectPagedMediaStyles, inlineHtmlImages, loadConfig, compileMarkdown as markforge, parseInlineSpans, parseMarginToTwip, parseMarkdownDocument, renderInlinesToHtml, renderMermaidToPng, resolveImage, slugify, tokenizeCodeLine };
+export { type CompilationResult, DEFAULT_CONFIG, type DocumentLayoutConfig, type DocumentMetadata, type DocumentOrientation, type FrontmatterMetadata, type GeneratedOutputFile, type HeaderFooterItem, type HeaderFooterSlot, MARKFORGE_VERSION, type MarkdownASTNode, type MarkdownInlineSpan, type MarkdownNodeType, type MarkforgeConfig, type MarkforgeFormat, type MarkforgeTheme, type NormalizedHeaderFooter, type NormalizedHeaderFooterZone, type NormalizedMargins, type NormalizedWatermark, Orientation, OutputFormat, PAPER_DIMENSIONS_TWIP, type PageMargins, type PaperSize, PaperSizeEnum, type ParsedMarkdownDocument, type ResolvedDocumentConfig, type ResolvedImage, SYNTAX_COLORS, SyntaxTheme, type SyntaxToken, THEMES, THEME_CORPORATE, THEME_DEFAULT, Theme, type ThemeProps, type WatermarkOptions, WatermarkPosition, buildDocxDocument, buildHtmlDocument, buildPdfDocument, compileMarkdown, defineConfig, escapeHtml, findChromeExecutable, formatServerTimestamp, generateThemeCss, getMarkforgeVersion, getMimeType, highlightCodeToHtml, injectPagedMediaStyles, inlineHtmlImages, loadConfig, compileMarkdown as markforge, normalizeHeaderFooter, normalizeHeaderFooterSlot, normalizeWatermark, parseInlineSpans, parseMarginToTwip, parseMarkdownDocument, renderInlinesToHtml, renderMermaidToPng, replaceDocumentTokens, resolveDocumentConfig, resolveImage, slugify, tokenizeCodeLine };