@zombie-mermaid/core 4.0.0 → 4.2.0

package/dist/index.d.cts

@@ -63,22 +63,15 @@ export declare function applyInitConfig(options: RenderOptions, config: InitConf
  * Any other value is treated as a literal font name: sanitized and quoted
  * exactly as before.
  *
- * `hasMonoFont`'s `.mono` rule (class-diagram method signatures, ER-diagram
- * attribute types) never reaches out to Google Fonts at all — it used to
- * `@import` 'JetBrains Mono' from Google's CDN, a third-party network
- * dependency a published library's default SVG output had no business
- * making (#1061, filed as a follow-up from #1059's ASCII-side self-hosting
- * fix). It now embeds {@link SVG_MONO_FONT_FACE_CSS} — a small, subsetted
- * (Basic Latin + Latin-1 Supplement), self-hosted `@font-face` as a base64
- * `woff2` data URI, generated by scripts/build-mono-font-subset.ts into
- * ./generated/mono-font-subset.ts — directly in the SVG's own `<style>`
- * block. Unlike `font` above, this isn't caller-configurable: it's the same
- * embed for every consumer, on by default, with no network request either
- * way — a strict improvement over the dead-or-alive CDN fetch it replaces,
- * and the only way a *standalone* SVG (no surrounding host page providing
- * its own copy of the font) renders `.mono` text correctly out of the box.
+ * `mono`'s `.mono` rule (class-diagram method signatures, ER-diagram
+ * attribute types) never reaches out to Google Fonts at all. The caller
+ * supplies a self-hosted {@link MonoFontEmbed} (a base64 `woff2` `@font-face`
+ * plus its family name), which is inlined directly in the SVG's own `<style>`
+ * block (#1061). The font data itself lives in `@zombie-mermaid/svg-renderer`
+ * (see its `buildSvgStyleBlock`), not here, so ASCII-only consumers of
+ * `core` never carry it (#1319). Pass `false` to omit the `.mono` rule.
  */
-export declare function buildStyleBlock(font: string, hasMonoFont: boolean, nonce?: string): string;
+export declare function buildStyleBlock(font: string, mono: MonoFontEmbed | false, nonce?: string): string;
 
 /**
  * Options applicable to class diagrams (`classDiagram`). Class diagrams use
@@ -99,6 +92,23 @@ export declare type CommonRenderOptions = Pick<RenderOptions, 'bg' | 'fg' | 'lin
 /** How an edge path is interpolated between its routed points. */
 export declare type CurveStyle = 'linear' | 'basis' | 'natural' | 'step' | 'stepBefore' | 'stepAfter';
 
+/**
+ * Decode Mermaid's entity codes (`#quot;`, `#lt;`, `#35;`, `#x5B;`), the way
+ * Mermaid writes characters that would otherwise end a label or break its
+ * syntax. Call it on a single already-parsed label, never on diagram source:
+ * decoding up front would let the characters it produces (`<`, `"`, `[`)
+ * change how the line parses, and would hit `#fff;` colors in style lines.
+ * Unknown names and out-of-range numbers are left untouched.
+ */
+export declare function decodeMermaidEntities(text: string): string;
+
+/**
+ * Decode HTML/XML entities (`&quot;`, `&lt;`, `&#35;`, `&#x5B;`) in one label,
+ * in a single pass so `&amp;lt;` becomes `&lt;` rather than `<`. Used by the
+ * ASCII renderer, which (unlike SVG) has no source-level decode step.
+ */
+export declare function decodeXmlEntitiesInLabel(text: string): string;
+
 /** Default bg/fg when no colors are provided (zinc light) */
 export declare const DEFAULTS: Readonly<{
     bg: string;
@@ -125,7 +135,7 @@ export declare function detectDiagramType(text: string): DiagramType;
  * need to enumerate the types (e.g. the MCP `list_diagram_types` tool) never
  * keep a duplicate list that could drift.
  */
-export declare const DIAGRAM_TYPES: readonly ["flowchart", "sequence", "class", "er", "xychart", "architecture", "c4"];
+export declare const DIAGRAM_TYPES: readonly ["flowchart", "sequence", "class", "er", "xychart", "architecture", "c4", "pie"];
 
 /**
  * Diagram color configuration.
@@ -292,6 +302,15 @@ export declare interface InitConfig {
 /** True when `value` is one of the five directions Mermaid recognizes. */
 export declare function isDirection(value: string): value is Direction;
 
+/**
+ * True when one endpoint of `edge` is a subgraph id and the other is a node or
+ * subgraph nested inside it, at any depth.
+ */
+export declare function isEdgeWithinOwnCluster(edge: {
+    source: string;
+    target: string;
+}, subgraphById: Map<string, MermaidSubgraph>): boolean;
+
 /** True if `line` is an init directive. */
 export declare function isInitDirective(line: string): boolean;
 
@@ -451,6 +470,17 @@ export declare function mixHexColors(fg: string, bg: string, pct: number): strin
  */
 export declare function mixSrgb(c1: RgbaColor, c2: RgbaColor, p1?: number, p2?: number): RgbaColor | null;
 
+/**
+ * A self-hosted monospace font a caller embeds in the SVG `<style>` block
+ * for the `.mono` rule. See `buildStyleBlock`.
+ */
+export declare interface MonoFontEmbed {
+    /** Font family name, listed first in the `.mono` rule's font stack. */
+    family: string;
+    /** The complete `@font-face { ... }` rule (typically a base64 data URI). */
+    faceCss: string;
+}
+
 /** Metrics for multi-line text measurement */
 export declare interface MultilineMetrics {
     /** Maximum line width in pixels */
@@ -1136,8 +1166,13 @@ export declare interface SvgEmitOptions {
  *                              See #239 — forces no root `role` so the link
  *                              stays reachable, regardless of `decorative`.
  * @param styleAttribute - Emit the root `style="…"` attribute. Default true.
+ * @param description - Accessible description: a `<desc id="zm-desc-N">`
+ *                      after the title plus `aria-describedby` on the root.
+ *                      Follows the same rules as `title` (dropped when
+ *                      decorative without interactive links). Used for
+ *                      Mermaid's `accDescr`.
  */
-export declare function svgOpenTag(width: number, height: number, colors: DiagramColors, transparent?: boolean, title?: string, decorative?: boolean, hasInteractiveLinks?: boolean, styleAttribute?: boolean): string;
+export declare function svgOpenTag(width: number, height: number, colors: DiagramColors, transparent?: boolean, title?: string, decorative?: boolean, hasInteractiveLinks?: boolean, styleAttribute?: boolean, description?: string): string;
 
 export declare type ThemeName = keyof typeof THEMES;
 
@@ -1243,6 +1278,16 @@ export declare function withDirectionOverride<T extends {
     direction?: Direction;
 }>(diagram: T, override: Direction | undefined): T;
 
+/**
+ * `graph` without its edges between a node and a subgraph that contains it.
+ * The parser also registers a subgraph id used as an edge endpoint as a
+ * placeholder entry in `graph.nodes`; one no remaining edge refers to is
+ * removed too, so the result equals the graph parsed without those edges.
+ * Returns `graph` itself (same reference) when it has none, and never mutates
+ * its input.
+ */
+export declare function withoutOwnClusterEdges(graph: MermaidGraph): MermaidGraph;
+
 /**
  * Options applicable to XY charts (`xychart-beta`). XY charts have no
  * spacing/`direction`/`curve`/`fontSizes`/`layoutCache` concept (layout is

package/dist/index.d.ts

@@ -63,22 +63,15 @@ export declare function applyInitConfig(options: RenderOptions, config: InitConf
  * Any other value is treated as a literal font name: sanitized and quoted
  * exactly as before.
  *
- * `hasMonoFont`'s `.mono` rule (class-diagram method signatures, ER-diagram
- * attribute types) never reaches out to Google Fonts at all — it used to
- * `@import` 'JetBrains Mono' from Google's CDN, a third-party network
- * dependency a published library's default SVG output had no business
- * making (#1061, filed as a follow-up from #1059's ASCII-side self-hosting
- * fix). It now embeds {@link SVG_MONO_FONT_FACE_CSS} — a small, subsetted
- * (Basic Latin + Latin-1 Supplement), self-hosted `@font-face` as a base64
- * `woff2` data URI, generated by scripts/build-mono-font-subset.ts into
- * ./generated/mono-font-subset.ts — directly in the SVG's own `<style>`
- * block. Unlike `font` above, this isn't caller-configurable: it's the same
- * embed for every consumer, on by default, with no network request either
- * way — a strict improvement over the dead-or-alive CDN fetch it replaces,
- * and the only way a *standalone* SVG (no surrounding host page providing
- * its own copy of the font) renders `.mono` text correctly out of the box.
+ * `mono`'s `.mono` rule (class-diagram method signatures, ER-diagram
+ * attribute types) never reaches out to Google Fonts at all. The caller
+ * supplies a self-hosted {@link MonoFontEmbed} (a base64 `woff2` `@font-face`
+ * plus its family name), which is inlined directly in the SVG's own `<style>`
+ * block (#1061). The font data itself lives in `@zombie-mermaid/svg-renderer`
+ * (see its `buildSvgStyleBlock`), not here, so ASCII-only consumers of
+ * `core` never carry it (#1319). Pass `false` to omit the `.mono` rule.
  */
-export declare function buildStyleBlock(font: string, hasMonoFont: boolean, nonce?: string): string;
+export declare function buildStyleBlock(font: string, mono: MonoFontEmbed | false, nonce?: string): string;
 
 /**
  * Options applicable to class diagrams (`classDiagram`). Class diagrams use
@@ -99,6 +92,23 @@ export declare type CommonRenderOptions = Pick<RenderOptions, 'bg' | 'fg' | 'lin
 /** How an edge path is interpolated between its routed points. */
 export declare type CurveStyle = 'linear' | 'basis' | 'natural' | 'step' | 'stepBefore' | 'stepAfter';
 
+/**
+ * Decode Mermaid's entity codes (`#quot;`, `#lt;`, `#35;`, `#x5B;`), the way
+ * Mermaid writes characters that would otherwise end a label or break its
+ * syntax. Call it on a single already-parsed label, never on diagram source:
+ * decoding up front would let the characters it produces (`<`, `"`, `[`)
+ * change how the line parses, and would hit `#fff;` colors in style lines.
+ * Unknown names and out-of-range numbers are left untouched.
+ */
+export declare function decodeMermaidEntities(text: string): string;
+
+/**
+ * Decode HTML/XML entities (`&quot;`, `&lt;`, `&#35;`, `&#x5B;`) in one label,
+ * in a single pass so `&amp;lt;` becomes `&lt;` rather than `<`. Used by the
+ * ASCII renderer, which (unlike SVG) has no source-level decode step.
+ */
+export declare function decodeXmlEntitiesInLabel(text: string): string;
+
 /** Default bg/fg when no colors are provided (zinc light) */
 export declare const DEFAULTS: Readonly<{
     bg: string;
@@ -125,7 +135,7 @@ export declare function detectDiagramType(text: string): DiagramType;
  * need to enumerate the types (e.g. the MCP `list_diagram_types` tool) never
  * keep a duplicate list that could drift.
  */
-export declare const DIAGRAM_TYPES: readonly ["flowchart", "sequence", "class", "er", "xychart", "architecture", "c4"];
+export declare const DIAGRAM_TYPES: readonly ["flowchart", "sequence", "class", "er", "xychart", "architecture", "c4", "pie"];
 
 /**
  * Diagram color configuration.
@@ -292,6 +302,15 @@ export declare interface InitConfig {
 /** True when `value` is one of the five directions Mermaid recognizes. */
 export declare function isDirection(value: string): value is Direction;
 
+/**
+ * True when one endpoint of `edge` is a subgraph id and the other is a node or
+ * subgraph nested inside it, at any depth.
+ */
+export declare function isEdgeWithinOwnCluster(edge: {
+    source: string;
+    target: string;
+}, subgraphById: Map<string, MermaidSubgraph>): boolean;
+
 /** True if `line` is an init directive. */
 export declare function isInitDirective(line: string): boolean;
 
@@ -451,6 +470,17 @@ export declare function mixHexColors(fg: string, bg: string, pct: number): strin
  */
 export declare function mixSrgb(c1: RgbaColor, c2: RgbaColor, p1?: number, p2?: number): RgbaColor | null;
 
+/**
+ * A self-hosted monospace font a caller embeds in the SVG `<style>` block
+ * for the `.mono` rule. See `buildStyleBlock`.
+ */
+export declare interface MonoFontEmbed {
+    /** Font family name, listed first in the `.mono` rule's font stack. */
+    family: string;
+    /** The complete `@font-face { ... }` rule (typically a base64 data URI). */
+    faceCss: string;
+}
+
 /** Metrics for multi-line text measurement */
 export declare interface MultilineMetrics {
     /** Maximum line width in pixels */
@@ -1136,8 +1166,13 @@ export declare interface SvgEmitOptions {
  *                              See #239 — forces no root `role` so the link
  *                              stays reachable, regardless of `decorative`.
  * @param styleAttribute - Emit the root `style="…"` attribute. Default true.
+ * @param description - Accessible description: a `<desc id="zm-desc-N">`
+ *                      after the title plus `aria-describedby` on the root.
+ *                      Follows the same rules as `title` (dropped when
+ *                      decorative without interactive links). Used for
+ *                      Mermaid's `accDescr`.
  */
-export declare function svgOpenTag(width: number, height: number, colors: DiagramColors, transparent?: boolean, title?: string, decorative?: boolean, hasInteractiveLinks?: boolean, styleAttribute?: boolean): string;
+export declare function svgOpenTag(width: number, height: number, colors: DiagramColors, transparent?: boolean, title?: string, decorative?: boolean, hasInteractiveLinks?: boolean, styleAttribute?: boolean, description?: string): string;
 
 export declare type ThemeName = keyof typeof THEMES;
 
@@ -1243,6 +1278,16 @@ export declare function withDirectionOverride<T extends {
     direction?: Direction;
 }>(diagram: T, override: Direction | undefined): T;
 
+/**
+ * `graph` without its edges between a node and a subgraph that contains it.
+ * The parser also registers a subgraph id used as an edge endpoint as a
+ * placeholder entry in `graph.nodes`; one no remaining edge refers to is
+ * removed too, so the result equals the graph parsed without those edges.
+ * Returns `graph` itself (same reference) when it has none, and never mutates
+ * its input.
+ */
+export declare function withoutOwnClusterEdges(graph: MermaidGraph): MermaidGraph;
+
 /**
  * Options applicable to XY charts (`xychart-beta`). XY charts have no
  * spacing/`direction`/`curve`/`fontSizes`/`layoutCache` concept (layout is