@skydesign/tf 0.2.3 → 0.3.3

package/dist/index.d.ts

@@ -10,6 +10,9 @@ import { RefAttributes } from 'react';
  */
 export declare function createLayoutConfig(overrides?: Partial<LayoutConfig>): LayoutConfig;
 
+/** Fill a partial option set with the shared defaults (same as GraphvizRenderer's props). */
+export declare function createRenderOptions(overrides?: Partial<RenderOptions>): RenderOptions;
+
 /**
  * Decode a JSON string that may be single or double-encoded.
  * Tries direct parse first, then falls back to double-parse for double-encoded strings.
@@ -180,7 +183,10 @@ export declare interface GraphvizRendererProps {
     nodeWidth?: number;
     /** Custom node height in points (default: 64) */
     nodeHeight?: number;
-    /** Custom spacing between node columns in points */
+    /**
+     * Custom spacing between node columns in points. Omit to auto-compute the
+     * tightest spacing that fits the widest edge label (minimal graph width).
+     */
     nodeColumnSpacing?: number;
     /** Forward click events to elements beneath the SVG (while preserving zoom/pan) */
     clickPassthrough?: boolean;
@@ -193,6 +199,11 @@ export declare interface GraphvizRendererProps {
      * static SVG pixel-for-pixel (no jump on handover).
      */
     initialTransform?: InitialTransform;
+    /**
+     * Show a draggable canvas overview (minimap) in the bottom-left corner.
+     * Dragging or clicking it pans the main canvas (default: false).
+     */
+    showMinimap?: boolean;
 }
 
 /**
@@ -233,13 +244,6 @@ export declare interface GraphvizRendererRef {
     highlightNextEdge: () => void;
 }
 
-/**
- * Render graph using custom SVG based on Graphviz JSON output
- * @param maxDepth - Edge depth to filter by (null = show all)
- * @param includeLesserDepths - If true, show depth <= maxDepth; if false, show only exact depth
- * @param config - Layout configuration
- * @returns Object containing zoom behavior and SVG references for imperative control
- */
 /** Pan/zoom transform: g = translate(x,y) scale(k). */
 export declare interface InitialTransform {
     x: number;
@@ -314,38 +318,69 @@ declare interface NodeMapping_2 {
     targetNodeId: string;
 }
 
-export declare function renderCustomGraph(container: HTMLDivElement, json: GraphvizJson, _nodeMapping?: Record<string, NodeMapping_2>, maxDepth?: number | null, includeLesserDepths?: boolean, config?: LayoutConfig, useOrthogonalRendering?: boolean, svgFontSize?: number, debug?: boolean, selectedEdgeId?: number | null, onEdgeSelect?: (edgeIndex: number | null) => void, nodeWidth?: number, nodeHeight?: number, nodeColumnSpacing?: number, enableWheelZoom?: boolean, extra?: RenderExtraOptions): {
-    zoomBehavior: d3_2.ZoomBehavior<SVGSVGElement, unknown>;
-    svgElement: SVGSVGElement;
-    gElement: SVGGElement;
-    baseFontSize: number;
-    viewBoxWidth: number;
-    edges: EdgeInfo[];
-    initialTransform: InitialTransform;
-};
+/**
+ * Render graph using custom SVG based on Graphviz JSON output.
+ * @returns Zoom behavior and SVG references for imperative control.
+ */
+export declare function renderCustomGraph(container: HTMLDivElement, json: GraphvizJson, options: RenderOptions): RenderResult;
 
-export declare interface RenderExtraOptions {
+/** Complete option set for renderCustomGraph. Build via {@link createRenderOptions}. */
+export declare interface RenderOptions {
+    /** Edge-id → source/target mapping supplied by the consumer (reserved for future use). */
+    nodeMapping: Record<string, NodeMapping_2>;
+    /** Edge depth to filter by (null = show all). */
+    maxDepth: number | null;
+    /** If true, show depth <= maxDepth; if false, show only the exact depth. */
+    includeLesserDepths: boolean;
+    /** Layout configuration (spacing, arrow, label metrics). */
+    config: LayoutConfig;
+    /** Orthogonal edge routing (true) vs direct bezier connections (false). */
+    useOrthogonalRendering: boolean;
+    /** Base font size used for zoom-scale calculations. */
+    svgFontSize: number;
+    /** Render debug markers (base-edge highlighting, midpoints, bounds). */
+    debug: boolean;
+    /** Currently selected edge index, or null. */
+    selectedEdgeId: number | null;
+    /** Edge selection callback; undefined disables click-to-select. */
+    onEdgeSelect: ((edgeIndex: number | null) => void) | undefined;
+    /** Node box width in points; null keeps the graphviz-computed width. */
+    nodeWidth: number | null;
+    /** Node box height in points; null keeps the graphviz-computed height. */
+    nodeHeight: number | null;
+    /**
+     * Fixed column spacing in points; null (default) computes the tightest
+     * spacing that fits the widest edge label, minimizing total graph width.
+     */
+    nodeColumnSpacing: number | null;
+    /** Enable wheel/double-click zoom. */
+    enableWheelZoom: boolean;
     /**
      * Headless (Node / SSR) mode. Skips the d3-zoom attachment and never calls
      * `getBBox`/`getComputedTextLength`; bakes a deterministic initial transform
      * straight onto `<g>` so the SVG can be serialized to a string. Geometry is
      * fully determined by the graphviz JSON, so it matches the browser render.
      */
-    headless?: boolean;
+    headless: boolean;
     /**
      * Use this exact initial transform instead of measuring the fit via
      * `getBBox`. Pass the `initialTransform` returned from a headless render so
      * the hydrated interactive graph lines up with the SSR'd SVG pixel-for-pixel
      * (no jump on handover). When omitted in non-headless mode, the legacy
-     * getBBox-based fit is used (unchanged behavior for existing callers).
+     * getBBox-based fit is used.
      */
-    initialTransform?: InitialTransform;
+    initialTransform: InitialTransform | undefined;
 }
 
-/**
- * Setup zoom and pan for graphviz native SVG rendering
- */
-export declare function setupZoomPan(container: HTMLDivElement): void;
+declare interface RenderResult {
+    zoomBehavior: d3_2.ZoomBehavior<SVGSVGElement, unknown>;
+    svgElement: SVGSVGElement;
+    gElement: SVGGElement;
+    baseFontSize: number;
+    viewBoxWidth: number;
+    edges: EdgeInfo[];
+    initialTransform: InitialTransform;
+}
 
 /**
  * Text element with optional color and background