@mono-lit/helper 0.0.1 → 0.0.3

package/dist/src/export/excel/nodes.d.ts

@@ -1,63 +1,64 @@
-import { Root } from 'mdast';
-import { ExcelCellStyle } from '../styles';
-import { MonoExportColumn, MonoExportStyles } from '../types';
+import { MonoExportColumn, MonoExportStyles } from "../types.js";
+import { ExcelCellStyle } from "../styles.js";
+import { Root } from "mdast";
+//#region src/export/excel/nodes.d.ts
 /** A pending image to place once the sheet is written. */
 interface PendingImage {
-    src: string;
-    row: number;
-    col: number;
-    width: number;
-    height: number;
+  src: string;
+  row: number;
+  col: number;
+  width: number;
+  height: number;
 }
 /** A block that should span the sheet's full width (headings, paragraphs). */
 interface PendingSpan {
-    row: number;
-    from: number;
+  row: number;
+  from: number;
 }
 export interface WriterContext {
-    styles: MonoExportStyles;
-    columns?: MonoExportColumn[];
+  styles: MonoExportStyles;
+  columns?: MonoExportColumn[];
 }
 /** Everything the walk produces, handed back to the ExcelJS driver. */
 export interface WorksheetPlan {
-    rows: PlannedRow[];
-    images: PendingImage[];
-    /** Rows to merge across the sheet width (heading / paragraph blocks). */
-    spans: PendingSpan[];
-    /** Explicit merges requested with `{{merge}}`: `[row, col, rowEnd, colEnd]`. */
-    merges: Array<[number, number, number, number]>;
-    /** Widest row, i.e. how many columns the sheet has. */
-    width: number;
-    /** Longest rendered text per column, for auto-fit. */
-    widths: number[];
+  rows: PlannedRow[];
+  images: PendingImage[];
+  /** Rows to merge across the sheet width (heading / paragraph blocks). */
+  spans: PendingSpan[];
+  /** Explicit merges requested with `{{merge}}`: `[row, col, rowEnd, colEnd]`. */
+  merges: Array<[number, number, number, number]>;
+  /** Widest row, i.e. how many columns the sheet has. */
+  width: number;
+  /** Longest rendered text per column, for auto-fit. */
+  widths: number[];
 }
 export interface PlannedCell {
-    /** The value written into the cell (already typed). */
-    value: string | number | Date | null;
-    /** An Excel formula, replacing `value` when present. */
-    formula?: string;
-    style: ExcelCellStyle;
-    /** Number format from a value directive, layered over the style's. */
-    numFmt?: string;
-    /**
-     * A hyperlink target, straight from the Markdown link the template wrote.
-     *
-     * `sheet:<key>` is resolved to an in-workbook reference once every sheet
-     * exists and its final (sanitised, deduped) name is known — a template cannot
-     * know that name, so it references the key instead. Anything else is passed
-     * through as an external URL.
-     */
-    hyperlink?: string;
-    /**
-     * How wide the cell *displays*, in characters — used for auto-fit. Kept
-     * separate from `value` because a Date's `toString()` is ~55 characters while
-     * the cell shows 10, which would blow the column out.
-     */
-    width: number;
+  /** The value written into the cell (already typed). */
+  value: string | number | Date | null;
+  /** An Excel formula, replacing `value` when present. */
+  formula?: string;
+  style: ExcelCellStyle;
+  /** Number format from a value directive, layered over the style's. */
+  numFmt?: string;
+  /**
+   * A hyperlink target, straight from the Markdown link the template wrote.
+   *
+   * `sheet:<key>` is resolved to an in-workbook reference once every sheet
+   * exists and its final (sanitised, deduped) name is known — a template cannot
+   * know that name, so it references the key instead. Anything else is passed
+   * through as an external URL.
+   */
+  hyperlink?: string;
+  /**
+   * How wide the cell *displays*, in characters — used for auto-fit. Kept
+   * separate from `value` because a Date's `toString()` is ~55 characters while
+   * the cell shows 10, which would blow the column out.
+   */
+  width: number;
 }
 export interface PlannedRow {
-    cells: PlannedCell[];
-    height?: number;
+  cells: PlannedCell[];
+  height?: number;
 }
 /**
  * Walks an mdast tree and plans a worksheet. Planning (rather than writing
@@ -65,52 +66,52 @@ export interface PlannedRow {
  * mapping stays testable and a future renderer can reuse the same walk.
  */
 export declare class WorksheetWriter {
-    private readonly ctx;
-    private readonly plan;
-    /** Header captions of the table currently being written, for `{col:Field}`. */
-    private tableColumns;
-    /** 1-based row index of the current table's first body row. */
-    private tableFirstRow;
-    /** 1-based row index of the current table's last body row. */
-    private tableLastRow;
-    constructor(ctx: WriterContext);
-    /** Resolve a named style, or an empty style when the name is unknown. */
-    private named;
-    write(root: Root): WorksheetPlan;
-    private writeBlocks;
-    private writeBlock;
-    private writeBlockquote;
-    /** A one-cell row that will later be merged across the sheet's full width. */
-    private appendSpanningRow;
-    private writeTable;
-    /** Per-column `numFmt` override from `options.columns`. */
-    private columnStyle;
-    /** Collect `{{style}}` directives into one style object. */
-    private styleFrom;
-    /** Collect `{{rowStyle}}` directives into one style object. */
-    private rowStyleFrom;
-    /** Build one planned cell from flattened inline content plus its style. */
-    private toCell;
-    /**
-     * Substitute the placeholders a template couldn't resolve on its own:
-     * `{row}` (the row about to be written), `{prevRow}` (the one above it),
-     * `{firstRow}` / `{lastRow}` (the current table's body range) and
-     * `{col:Caption}` (that header's column letter).
-     *
-     * `{lastRow}` includes *every* body row — so a total row that lives inside
-     * the same Markdown table must sum `{firstRow}:{prevRow}` to avoid a circular
-     * reference to itself.
-     */
-    private resolveFormula;
-    private placeImages;
-    private applyMerge;
-    /**
-     * Append a row and return its 1-based index. `spanning` rows (headings,
-     * paragraphs) are excluded from auto-fit: they get merged across the whole
-     * sheet, so letting a long title set column A's width would leave a 60-wide
-     * first column next to four narrow ones.
-     */
-    private pushRow;
+  private readonly ctx;
+  private readonly plan;
+  /** Header captions of the table currently being written, for `{col:Field}`. */
+  private tableColumns;
+  /** 1-based row index of the current table's first body row. */
+  private tableFirstRow;
+  /** 1-based row index of the current table's last body row. */
+  private tableLastRow;
+  constructor(ctx: WriterContext);
+  /** Resolve a named style, or an empty style when the name is unknown. */
+  private named;
+  write(root: Root): WorksheetPlan;
+  private writeBlocks;
+  private writeBlock;
+  private writeBlockquote;
+  /** A one-cell row that will later be merged across the sheet's full width. */
+  private appendSpanningRow;
+  private writeTable;
+  /** Per-column `numFmt` override from `options.columns`. */
+  private columnStyle;
+  /** Collect `{{style}}` directives into one style object. */
+  private styleFrom;
+  /** Collect `{{rowStyle}}` directives into one style object. */
+  private rowStyleFrom;
+  /** Build one planned cell from flattened inline content plus its style. */
+  private toCell;
+  /**
+   * Substitute the placeholders a template couldn't resolve on its own:
+   * `{row}` (the row about to be written), `{prevRow}` (the one above it),
+   * `{firstRow}` / `{lastRow}` (the current table's body range) and
+   * `{col:Caption}` (that header's column letter).
+   *
+   * `{lastRow}` includes *every* body row — so a total row that lives inside
+   * the same Markdown table must sum `{firstRow}:{prevRow}` to avoid a circular
+   * reference to itself.
+   */
+  private resolveFormula;
+  private placeImages;
+  private applyMerge;
+  /**
+   * Append a row and return its 1-based index. `spanning` rows (headings,
+   * paragraphs) are excluded from auto-fit: they get merged across the whole
+   * sheet, so letting a long title set column A's width would leave a 60-wide
+   * first column next to four narrow ones.
+   */
+  private pushRow;
 }
 /**
  * Give a plain cell string its most useful type. Text that merely *looks*
@@ -120,4 +121,5 @@ export declare class WorksheetWriter {
 export declare function coerceValue(text: string): string | number | Date | null;
 /** 1-based column index → spreadsheet letter (1 → A, 27 → AA). */
 export declare function columnLetter(index: number): string;
-export {};
+//#endregion
+export {};

package/dist/src/export/expression.d.ts

@@ -1,3 +1,4 @@
+//#region src/export/expression.d.ts
 /**
  * Template source preprocessing — everything that must happen *before*
  * Handlebars sees the template.
@@ -26,7 +27,7 @@ export declare function evaluateExpression(expression: string, context: unknown)
  * code-aware (fenced blocks + inline spans are copied verbatim).
  */
 export declare function preprocessTemplate(src: string, opts?: {
-    escapeTableCells?: boolean;
+  escapeTableCells?: boolean;
 }): string;
 /**
  * Escape an interpolated value for a GFM table cell. Registered as the `esc`
@@ -34,3 +35,4 @@ export declare function preprocessTemplate(src: string, opts?: {
  * {@link preprocessTemplate}; also callable by hand.
  */
 export declare function escapeForCell(value: unknown): string;
+//#endregion

package/dist/src/export/helpers.d.ts

@@ -1,6 +1,8 @@
-import { MonoExportFormatOptions, MonoExportHelper } from './types';
+import { MonoExportFormatOptions, MonoExportHelper } from "./types.js";
+//#region src/export/helpers.d.ts
 /**
  * Build the built-in helper map for one render. Bound to `formatting` so
  * locale/currency choices apply consistently across every helper.
  */
 export declare function createHelpers(formatting?: MonoExportFormatOptions): Record<string, MonoExportHelper>;
+//#endregion

package/dist/src/export/index.d.ts

@@ -1,8 +1,8 @@
 /// <reference path="../../vue.d.ts" />
-import { MonoExportOptions, MonoExportResult } from './types';
-export type { MonoExportColumn, MonoExportFormat, MonoExportFormatOptions, MonoExportHelper, MonoExportOptions, MonoExportResult, MonoExportStyle, MonoExportStyles, } from './types';
-export { DEFAULT_STYLES } from './styles';
-export type { MonoExportDirective } from './sentinel';
+import { MonoExportColumn, MonoExportFormat, MonoExportFormatOptions, MonoExportHelper, MonoExportOptions, MonoExportResult, MonoExportStyle, MonoExportStyles } from "./types.js";
+import { DEFAULT_STYLES } from "./styles.js";
+import { MonoExportDirective } from "./sentinel.js";
+//#region src/export/index.d.ts
 /**
  * Render a Markdown report template.
  *
@@ -11,3 +11,5 @@ export type { MonoExportDirective } from './sentinel';
  * one, nothing is written — you just get the result object.
  */
 export declare function exportTable(options: MonoExportOptions): Promise<MonoExportResult>;
+//#endregion
+export { DEFAULT_STYLES, type MonoExportColumn, type MonoExportDirective, type MonoExportFormat, type MonoExportFormatOptions, type MonoExportHelper, type MonoExportOptions, type MonoExportResult, type MonoExportStyle, type MonoExportStyles };

package/dist/src/export/markdown.d.ts

@@ -1,6 +1,6 @@
-import { Root, RootContent, PhrasingContent } from 'mdast';
-import { MonoExportDirective } from './sentinel';
-export type { Root, RootContent };
+import { MonoExportDirective } from "./sentinel.js";
+import { PhrasingContent, Root, RootContent } from "mdast";
+//#region src/export/markdown.d.ts
 /**
  * Parse rendered Markdown into an mdast tree, with GFM tables enabled.
  *
@@ -26,20 +26,20 @@ export type { Root, RootContent };
 export declare function parseMarkdown(md: string): Root;
 /** Inline formatting collected while flattening a run of phrasing content. */
 export interface InlineText {
-    text: string;
-    bold: boolean;
-    italic: boolean;
-    code: boolean;
-    strike: boolean;
-    /** Directives found anywhere in the run. */
-    directives: MonoExportDirective[];
-    /** Images found in the run (from `![alt](src)` — `{{image}}` is a directive). */
-    images: Array<{
-        url: string;
-        alt?: string;
-    }>;
-    /** The first link URL in the run, if any. */
-    link?: string;
+  text: string;
+  bold: boolean;
+  italic: boolean;
+  code: boolean;
+  strike: boolean;
+  /** Directives found anywhere in the run. */
+  directives: MonoExportDirective[];
+  /** Images found in the run (from `![alt](src)` — `{{image}}` is a directive). */
+  images: Array<{
+    url: string;
+    alt?: string;
+  }>;
+  /** The first link URL in the run, if any. */
+  link?: string;
 }
 /**
  * Flatten phrasing content (the inline children of a cell, heading, paragraph
@@ -50,3 +50,5 @@ export interface InlineText {
  * report author actually expects from `| **Total** | 123 |`.
  */
 export declare function flattenInline(nodes: readonly PhrasingContent[] | undefined): InlineText;
+//#endregion
+export type { Root, RootContent };

package/dist/src/export/resolve-data.d.ts

@@ -1,3 +1,4 @@
+//#region src/export/resolve-data.d.ts
 /**
  * Turning live data sources in `options.data` into plain arrays.
  *
@@ -27,5 +28,6 @@
  * report with three of them shouldn't take three times as long.
  */
 export declare function resolveExportData(data: Record<string, unknown> | undefined, options?: {
-    chunkSize?: number;
+  chunkSize?: number;
 }): Promise<Record<string, unknown>>;
+//#endregion

package/dist/src/export/sentinel.d.ts

@@ -1,3 +1,4 @@
+//#region src/export/sentinel.d.ts
 /**
  * Sentinel directives — how presentation survives the trip through Markdown.
  *
@@ -22,20 +23,20 @@
  */
 /** Apply a named style to the cell (or block) the token sits in. */
 export interface StyleDirective {
-    k: 'style';
-    /** Named style, resolved against the merged style map. */
-    v: string;
+  k: 'style';
+  /** Named style, resolved against the merged style map. */
+  v: string;
 }
 /** Apply a named style to the entire row the token sits in. */
 export interface RowStyleDirective {
-    k: 'rowStyle';
-    v: string;
+  k: 'rowStyle';
+  v: string;
 }
 /** Merge the token's cell across `cols` columns / `rows` rows. */
 export interface MergeDirective {
-    k: 'merge';
-    cols?: number;
-    rows?: number;
+  k: 'merge';
+  cols?: number;
+  rows?: number;
 }
 /**
  * Write an Excel formula into the token's cell. Placeholders are resolved at
@@ -43,15 +44,15 @@ export interface MergeDirective {
  * `resolveFormula` in `excel/nodes.ts`.
  */
 export interface FormulaDirective {
-    k: 'formula';
-    v: string;
+  k: 'formula';
+  v: string;
 }
 /** Anchor an image at the token's cell. `v` is a data URL / base64 / http URL. */
 export interface ImageDirective {
-    k: 'image';
-    v: string;
-    width?: number;
-    height?: number;
+  k: 'image';
+  v: string;
+  width?: number;
+  height?: number;
 }
 /**
  * Carry the *raw* value behind formatted display text, so Excel gets a real
@@ -59,20 +60,20 @@ export interface ImageDirective {
  * string. `f` is an Excel number format.
  */
 export interface ValueDirective {
-    k: 'val';
-    /** Raw numeric value. */
-    n?: number;
-    /** Raw date as an ISO string (JSON has no Date). */
-    d?: string;
-    /** Excel number format, e.g. `#,##0.00` or `yyyy-mm-dd`. */
-    f?: string;
-    /**
-     * The display text this value was emitted with. The renderer swaps in the raw
-     * value only when it matches the cell's *entire* text — otherwise a sentence
-     * like "Rate {{percent 0.155}} this quarter" would collapse to the bare
-     * number `0.155`, losing the prose around it.
-     */
-    t?: string;
+  k: 'val';
+  /** Raw numeric value. */
+  n?: number;
+  /** Raw date as an ISO string (JSON has no Date). */
+  d?: string;
+  /** Excel number format, e.g. `#,##0.00` or `yyyy-mm-dd`. */
+  f?: string;
+  /**
+   * The display text this value was emitted with. The renderer swaps in the raw
+   * value only when it matches the cell's *entire* text — otherwise a sentence
+   * like "Rate {{percent 0.155}} this quarter" would collapse to the bare
+   * number `0.155`, losing the prose around it.
+   */
+  t?: string;
 }
 export type MonoExportDirective = StyleDirective | RowStyleDirective | MergeDirective | FormulaDirective | ImageDirective | ValueDirective;
 /** Wrap a directive in its sentinel token, ready to be emitted by a helper. */
@@ -85,8 +86,8 @@ export declare function hasDirectives(text: string): boolean;
  * never take down a whole report.
  */
 export declare function extractDirectives(text: string): {
-    text: string;
-    directives: MonoExportDirective[];
+  text: string;
+  directives: MonoExportDirective[];
 };
 /** Remove every directive token, leaving only the display text (Markdown output). */
 export declare function stripDirectives(text: string): string;
@@ -95,3 +96,4 @@ export declare function stripDirectives(text: string): string;
  * tokens are skipped — they are base64 and must arrive byte-identical.
  */
 export declare function escapeCellText(text: string): string;
+//#endregion

package/dist/src/export/sheet-name.d.ts

@@ -1,3 +1,4 @@
+//#region src/export/sheet-name.d.ts
 /**
  * Worksheet names, which Excel is fussier about than anything else in a
  * workbook — and every rule below is one it enforces by refusing to open the
@@ -37,9 +38,10 @@ export declare function sheetRef(name: string, cell?: string): string;
  * ` (2)`. One registry, one `take()`, no second opinion.
  */
 export declare class SheetNames {
-    /** Lower-cased claimed names: Excel's uniqueness is case-insensitive. */
-    private readonly used;
-    constructor(existing?: Iterable<string>);
-    /** Claim a legal, unique name derived from `raw`. */
-    take(raw: unknown, fallback?: string): string;
+  /** Lower-cased claimed names: Excel's uniqueness is case-insensitive. */
+  private readonly used;
+  constructor(existing?: Iterable<string>);
+  /** Claim a legal, unique name derived from `raw`. */
+  take(raw: unknown, fallback?: string): string;
 }
+//#endregion

package/dist/src/export/styles.d.ts

@@ -1,4 +1,5 @@
-import { MonoExportStyle, MonoExportStyles } from './types';
+import { MonoExportStyle, MonoExportStyles } from "./types.js";
+//#region src/export/styles.d.ts
 /**
  * Built-in styles. Consumers override individual keys via `options.styles`
  * without having to redefine a whole style.
@@ -15,19 +16,20 @@ export declare function combineStyles(...styles: Array<MonoExportStyle | undefin
 export declare function toArgb(color: string | undefined): string | undefined;
 /** One ExcelJS border edge. */
 interface ExcelBorderEdge {
-    style: 'thin';
-    color: {
-        argb: string;
-    };
+  style: 'thin';
+  color: {
+    argb: string;
+  };
 }
 /** The subset of ExcelJS cell style options this engine produces. */
 export interface ExcelCellStyle {
-    font?: Record<string, unknown>;
-    fill?: Record<string, unknown>;
-    alignment?: Record<string, unknown>;
-    border?: Record<string, ExcelBorderEdge>;
-    numFmt?: string;
+  font?: Record<string, unknown>;
+  fill?: Record<string, unknown>;
+  alignment?: Record<string, unknown>;
+  border?: Record<string, ExcelBorderEdge>;
+  numFmt?: string;
 }
 /** Translate a semantic style into ExcelJS cell options. */
 export declare function toExcelStyle(style: MonoExportStyle): ExcelCellStyle;
-export {};
+//#endregion
+export {};

package/dist/src/export/template.d.ts

@@ -1,4 +1,5 @@
-import { MonoExportOptions } from './types';
+import { MonoExportOptions } from "./types.js";
+//#region src/export/template.d.ts
 /**
  * Render a report template to Markdown (still carrying directive tokens).
  *
@@ -8,3 +9,4 @@ import { MonoExportOptions } from './types';
  * preprocessor injects only where it matters (see `expression.ts`).
  */
 export declare function renderTemplate(options: Pick<MonoExportOptions, 'md' | 'data' | 'helpers' | 'partials' | 'formatting'>): Promise<string>;
+//#endregion