mviz 1.6.4 → 1.6.7

package/dist/layout/parser-types.d.ts

@@ -0,0 +1,116 @@
+/**
+ * Shared types for the markdown dashboard pipeline.
+ *
+ * The pipeline runs in phases (see parser.ts orchestrator):
+ *   1. Markdown parse  -> RawSection[] (with RawCodeBlockItem for unloaded code blocks)
+ *   2. Block load      -> Section[]    (with ParsedItem; data resolved, spec linted)
+ *   3. Layout resolve  -> Section[]    (auto sizes resolved, print-mode validated)
+ *   4. Render          -> HTML string
+ */
+import type { PageOrientation, Theme } from '../types.js';
+/**
+ * Frontmatter parsed from a markdown dashboard's leading YAML block.
+ */
+export interface ParsedFrontmatter {
+    theme: Theme;
+    pageTitle: string;
+    pageTitleFromFrontmatter: boolean;
+    continuous: boolean;
+    orientation: PageOrientation;
+    printMode: boolean;
+    currency: string | undefined;
+    /** Lines of the markdown body after the closing `---`. */
+    remainingLines: string[];
+    /** Number of lines consumed by frontmatter (for absolute line reporting). */
+    frontmatterEndLine: number;
+}
+/**
+ * A parsed dashboard item with its spec fully resolved.
+ *
+ * Used after the load phase. Code blocks become this once their file
+ * references and inline JSON are merged and converted.
+ */
+export interface ParsedItem {
+    type: string;
+    spec: Record<string, unknown>;
+    size?: [number, number] | 'auto' | null;
+}
+/**
+ * A code-block item before file/JSON have been loaded.
+ * Carries the raw header info and inline body lines so the load phase
+ * can resolve `file=` references and parse the inline JSON.
+ */
+export interface RawCodeBlockItem {
+    kind: 'code';
+    type: string;
+    inlineLines: string[];
+    file: string | null;
+    size: [number, number] | 'auto' | null;
+    /** 1-indexed line number where the opening ``` appeared, for error messages. */
+    startLine: number;
+}
+/**
+ * A non-code item (markdown text, markdown table, inline header) that does not
+ * require loading. Already shaped like a final `ParsedItem`.
+ */
+export interface RawResolvedItem {
+    kind: 'resolved';
+    item: ParsedItem;
+}
+/**
+ * Items emitted by the parse phase, before loading.
+ */
+export type RawItem = RawCodeBlockItem | RawResolvedItem;
+/**
+ * Section in the raw (pre-load) IR.
+ */
+export interface RawSection {
+    title: string;
+    rows: RawItem[][];
+    pageBreak?: boolean;
+    hasDivider?: boolean;
+}
+/**
+ * Section in the resolved (post-load) IR.
+ */
+export interface Section {
+    title: string;
+    rows: ParsedItem[][];
+    pageBreak?: boolean;
+    hasDivider?: boolean;
+}
+/**
+ * Test-harness item tracked while rendering.
+ */
+export interface TestItem {
+    id: string;
+    name: string;
+    type: string;
+    spec: Record<string, unknown>;
+    section: string;
+}
+/**
+ * A mermaid block that needs async rendering after the sync pipeline returns.
+ */
+export interface MermaidBlock {
+    id: string;
+    spec: Record<string, unknown>;
+    theme: string;
+}
+/**
+ * Result returned by parseMarkdownToDashboard / parseMarkdownToTestHarness.
+ */
+export interface ParseResult {
+    html: string;
+    errors: string[];
+    mermaidBlocks: MermaidBlock[];
+}
+/**
+ * Output of the markdown parse phase.
+ */
+export interface ParsedMarkdown {
+    frontmatter: ParsedFrontmatter;
+    sections: RawSection[];
+    pageTitle: string;
+}
+//# sourceMappingURL=parser-types.d.ts.map

package/dist/layout/parser-types.js

@@ -0,0 +1,11 @@
+/**
+ * Shared types for the markdown dashboard pipeline.
+ *
+ * The pipeline runs in phases (see parser.ts orchestrator):
+ *   1. Markdown parse  -> RawSection[] (with RawCodeBlockItem for unloaded code blocks)
+ *   2. Block load      -> Section[]    (with ParsedItem; data resolved, spec linted)
+ *   3. Layout resolve  -> Section[]    (auto sizes resolved, print-mode validated)
+ *   4. Render          -> HTML string
+ */
+export {};
+//# sourceMappingURL=parser-types.js.map

package/dist/layout/parser.d.ts

@@ -1,42 +1,51 @@
 /**
- * Markdown dashboard parser for mviz
+ * Markdown dashboard parser for mviz — orchestrator.
  *
- * Parses markdown files with embedded chart/component specs and generates HTML.
+ * Pipeline:
+ *   1. parseMarkdown          (markdown-parser.ts) — markdown -> raw IR
+ *   2. loadSections           (block-loader.ts)    — resolve file refs, parse JSON, lint specs
+ *   3. resolveLayout          (layout-resolver.ts) — resolve auto sizes + print-mode validation
+ *   4. renderSections         (renderer.ts)        — IR -> componentsHtml + chartScripts
+ *   5. generate{Dashboard,TestHarness}Html (templates.ts) — final page assembly
+ *
+ * Public surface (these are imported by cli.ts / index.ts):
+ *   - parseMarkdownToDashboard
+ *   - parseMarkdownToDashboardAsync
+ *   - parseMarkdownToTestHarness
+ *   - parseMarkdownToTestHarnessAsync
+ *   - parseMarkdownLayout (legacy)
+ *   - MermaidBlock, ParseResult (types)
  */
-import type { DashboardSpec, CustomTheme } from '../types.js';
+import type { CustomTheme, DashboardSpec } from '../types.js';
+import type { ParseResult } from './parser-types.js';
+export type { MermaidBlock, ParseResult } from './parser-types.js';
 /**
- * Parse markdown layout and return HTML
+ * Parse a markdown dashboard into HTML.
+ *
+ * Synchronous variant — mermaid blocks are emitted as placeholders and must be
+ * resolved by `parseMarkdownToDashboardAsync` for final rendering.
  */
-/** Mermaid block to be rendered */
-export interface MermaidBlock {
-    id: string;
-    spec: Record<string, unknown>;
-    theme: string;
-}
-/** Result from parsing markdown to dashboard */
-export interface ParseResult {
-    html: string;
-    errors: string[];
-    mermaidBlocks: MermaidBlock[];
-}
-export declare function parseMarkdownToDashboard(markdown: string, baseTheme?: string, _baseDir?: string, strict?: boolean, testMode?: boolean, customTheme?: CustomTheme): ParseResult;
+export declare function parseMarkdownToDashboard(markdown: string, baseTheme?: string, baseDir?: string, strict?: boolean, testMode?: boolean, customTheme?: CustomTheme, lintMode?: 'generate' | 'lint'): ParseResult;
 /**
- * Async version that renders mermaid blocks with beautiful-mermaid
+ * Async variant that resolves mermaid placeholders to inline SVG.
  */
-export declare function parseMarkdownToDashboardAsync(markdown: string, baseTheme?: string, baseDir?: string, strict?: boolean, testMode?: boolean, customTheme?: CustomTheme): Promise<{
+export declare function parseMarkdownToDashboardAsync(markdown: string, baseTheme?: string, baseDir?: string, strict?: boolean, testMode?: boolean, customTheme?: CustomTheme, lintMode?: 'generate' | 'lint'): Promise<{
     html: string;
     errors: string[];
 }>;
 /**
- * Parse markdown layout into dashboard spec (legacy API for compatibility)
+ * Parse markdown layout into a DashboardSpec (legacy API for compatibility).
+ *
+ * Returns frontmatter only; the row IR is intentionally empty since this
+ * legacy path was only ever consumed for its frontmatter.
  */
 export declare function parseMarkdownLayout(markdown: string, _baseDir?: string): DashboardSpec;
 /**
- * Parse markdown into test harness HTML with navigation and summary
+ * Parse markdown into test-harness HTML with navigation and summary.
  */
 export declare function parseMarkdownToTestHarness(markdown: string, baseTheme?: string, baseDir?: string, strict?: boolean): ParseResult;
 /**
- * Async version of parseMarkdownToTestHarness that renders mermaid blocks
+ * Async variant of parseMarkdownToTestHarness.
  */
 export declare function parseMarkdownToTestHarnessAsync(markdown: string, baseTheme?: string, baseDir?: string, strict?: boolean): Promise<{
     html: string;