@markii/ansi 0.0.1

package/dist/render.d.ts

@@ -0,0 +1,69 @@
+import { parse } from '@markii/core';
+import type { MarkNode } from '@markii/core';
+import { type ColorOption } from './ansi.js';
+import { type AnsiTheme } from './theme.js';
+import type { AnsiRegistry } from './registry.js';
+import { type OnDiagnostic } from '@markii/stdlib';
+import { type ResolveImageSrc } from './image-resolve.js';
+import { type ResolveHref } from './href-resolve.js';
+import type { AnsiValueStore, AnsiVaultStore } from './value-types.js';
+type MarkRoot = ReturnType<typeof parse>;
+/**
+ * Options for `renderMarkToAnsi`/`renderMarkNodeToAnsi`/`renderMarkInlineToAnsi`.
+ * `store`/`vault` are offered both here and as positional parameters; when
+ * both are given, the option wins (matching `@markii/html`'s
+ * `RenderMarkOptions`).
+ */
+export interface RenderMarkOptions {
+    readonly width?: number;
+    readonly color?: ColorOption;
+    readonly theme?: AnsiTheme;
+    readonly resolveImageSrc?: ResolveImageSrc;
+    readonly resolveHref?: ResolveHref;
+    readonly onDiagnostic?: OnDiagnostic;
+    readonly store?: AnsiValueStore;
+    readonly vault?: AnsiVaultStore;
+}
+/**
+ * Renders Markii text to a plain string (optionally carrying ANSI SGR/OSC 8
+ * escapes) using `registry` to resolve directive names. `registry` is
+ * OPTIONAL here, unlike the other two engines' required parameter, and
+ * defaults to `defaultAnsiRegistry` (empty in this phase; every directive
+ * therefore renders the unknown-component fallback).
+ *
+ * Pipeline: `@markii/core`'s `toHast` (parse -> tag directive nodes ->
+ * remark-rehype -> sanitize URLs) -> a width-aware hast walk that swaps
+ * directive elements for registry components (or the unknown-directive
+ * fallback), folds script fences into a one-line marker, and wraps every
+ * paragraph, heading, and list item to `options.width` (default 80). Pure
+ * and never-throwing: parsing is tolerant, unknown names always render a
+ * fallback, and any unexpected internal error degrades to the "failed to
+ * render document" line.
+ *
+ * `options.color` resolves via `./ansi.js`'s `resolveColorOption`: `'auto'`
+ * and `undefined` both mean "no escapes" here, since this engine has no
+ * environment knowledge of its own — a caller that wants automatic
+ * detection calls `detectColorLevel` itself and passes the result as
+ * `'16'`/`'256'`/`'truecolor'`.
+ *
+ * `store`/`vault` and `resolveImageSrc`/`resolveHref`/`onDiagnostic` carry
+ * the same meaning as `@markii/html`'s identical options.
+ */
+export declare function renderMarkToAnsi(text: string, registry?: AnsiRegistry, store?: AnsiValueStore, vault?: AnsiVaultStore, options?: RenderMarkOptions): string;
+/**
+ * The block-level twin of `renderMarkToAnsi`: renders one already-parsed
+ * mdast node OR a whole already-parsed mdast document (`@markii/core`'s
+ * `MarkNode`, or the `Root` `parse` itself returns) instead of raw document
+ * text. Same registry resolution, same fallbacks, same purity and
+ * never-throw guarantees, same options.
+ */
+export declare function renderMarkNodeToAnsi(node: MarkNode | MarkRoot, registry?: AnsiRegistry, store?: AnsiValueStore, vault?: AnsiVaultStore, options?: RenderMarkOptions): string;
+/**
+ * Renders `text` as a single, standalone inline directive when that is all
+ * it is, mirroring `@markii/html`'s identical `renderMarkInlineToHtml`: a
+ * source whose only parsed block is a paragraph holding exactly one text
+ * directive renders that directive alone. Any other source falls back to
+ * the exact same rendering `renderMarkToAnsi` would produce.
+ */
+export declare function renderMarkInlineToAnsi(text: string, registry?: AnsiRegistry, store?: AnsiValueStore, vault?: AnsiVaultStore, options?: RenderMarkOptions): string;
+export {};