@zombie-mermaid/svg-renderer 4.2.2 → 5.0.0

package/dist/index.d.cts

@@ -3,14 +3,15 @@ import { ClassRenderOptions } from '@zombie-mermaid/core';
 import { CurveStyle } from '@zombie-mermaid/core';
 import { DiagramColors } from '@zombie-mermaid/core';
 import { Direction } from '@zombie-mermaid/core';
-import { ElkExtendedEdge } from 'elkjs';
-import { ElkLabel } from 'elkjs';
-import { ElkNode } from 'elkjs';
+import { ElkConstructor } from '@zombie-mermaid/core';
+import { ElkExtendedEdge } from '@zombie-mermaid/core';
+import { ElkLabel } from '@zombie-mermaid/core';
+import { ElkNode } from '@zombie-mermaid/core';
 import { ErDiagram } from '@zombie-mermaid/mermaid-parser';
 import { ErRenderOptions } from '@zombie-mermaid/core';
 import { FlowchartRenderOptions } from '@zombie-mermaid/core';
 import { LayoutCache } from '@zombie-mermaid/core';
-import { LayoutOptions } from 'elkjs';
+import { LayoutOptions } from '@zombie-mermaid/core';
 import { MermaidGraph } from '@zombie-mermaid/core';
 import { PieChart } from '@zombie-mermaid/mermaid-parser';
 import { Point } from '@zombie-mermaid/core';
@@ -244,6 +245,11 @@ export declare interface ElkEdgeLabelStyle {
  */
 export declare function elkLayoutSync(graph: ElkNode, cache?: LayoutCache): ElkNode;
 
+/** Thrown when a graph diagram renders and no `elkjs` constructor is available. */
+export declare class ElkNotRegisteredError extends Error {
+    constructor();
+}
+
 /**
  * Format ELK's `elk.padding` value. A single number applies to all four
  * sides; an object sets them individually.
@@ -447,6 +453,19 @@ export declare function pieColorValue(index: number, accent: string | undefined,
  */
 export declare function pointsToPath(points: Point[], curve?: CurveStyle): string;
 
+/**
+ * Register the `elkjs` constructor used for flowchart, state, class, ER and
+ * architecture layout. Call once before rendering, in browsers and bundlers:
+ *
+ *     import ELK from 'elkjs/lib/elk.bundled.js'
+ *     registerElk(ELK)
+ *
+ * Under Node (and Bun) this is optional when `elkjs` is installed: it is
+ * auto-loaded on first use. Calling it again swaps the constructor and drops
+ * the cached instance.
+ */
+export declare function registerElk(ctor: ElkConstructor): void;
+
 /**
  * Render a positioned class diagram as an SVG string.
  *

package/dist/index.d.ts

@@ -3,14 +3,15 @@ import { ClassRenderOptions } from '@zombie-mermaid/core';
 import { CurveStyle } from '@zombie-mermaid/core';
 import { DiagramColors } from '@zombie-mermaid/core';
 import { Direction } from '@zombie-mermaid/core';
-import { ElkExtendedEdge } from 'elkjs';
-import { ElkLabel } from 'elkjs';
-import { ElkNode } from 'elkjs';
+import { ElkConstructor } from '@zombie-mermaid/core';
+import { ElkExtendedEdge } from '@zombie-mermaid/core';
+import { ElkLabel } from '@zombie-mermaid/core';
+import { ElkNode } from '@zombie-mermaid/core';
 import { ErDiagram } from '@zombie-mermaid/mermaid-parser';
 import { ErRenderOptions } from '@zombie-mermaid/core';
 import { FlowchartRenderOptions } from '@zombie-mermaid/core';
 import { LayoutCache } from '@zombie-mermaid/core';
-import { LayoutOptions } from 'elkjs';
+import { LayoutOptions } from '@zombie-mermaid/core';
 import { MermaidGraph } from '@zombie-mermaid/core';
 import { PieChart } from '@zombie-mermaid/mermaid-parser';
 import { Point } from '@zombie-mermaid/core';
@@ -244,6 +245,11 @@ export declare interface ElkEdgeLabelStyle {
  */
 export declare function elkLayoutSync(graph: ElkNode, cache?: LayoutCache): ElkNode;
 
+/** Thrown when a graph diagram renders and no `elkjs` constructor is available. */
+export declare class ElkNotRegisteredError extends Error {
+    constructor();
+}
+
 /**
  * Format ELK's `elk.padding` value. A single number applies to all four
  * sides; an object sets them individually.
@@ -447,6 +453,19 @@ export declare function pieColorValue(index: number, accent: string | undefined,
  */
 export declare function pointsToPath(points: Point[], curve?: CurveStyle): string;
 
+/**
+ * Register the `elkjs` constructor used for flowchart, state, class, ER and
+ * architecture layout. Call once before rendering, in browsers and bundlers:
+ *
+ *     import ELK from 'elkjs/lib/elk.bundled.js'
+ *     registerElk(ELK)
+ *
+ * Under Node (and Bun) this is optional when `elkjs` is installed: it is
+ * auto-loaded on first use. Calling it again swaps the constructor and drops
+ * the cached instance.
+ */
+export declare function registerElk(ctor: ElkConstructor): void;
+
 /**
  * Render a positioned class diagram as an SVG string.
  *