@skydesign/tf 0.2.2

package/dist/server.d.ts

@@ -0,0 +1,182 @@
+import * as d3_2 from 'd3';
+
+declare interface DrawOp {
+    op: string;
+    grad?: string;
+    color?: string;
+    points?: number[][];
+    rect?: number[];
+    pt?: number[];
+    align?: string;
+    width?: number;
+    size?: number;
+    face?: string;
+    text?: string;
+    style?: string;
+}
+
+/**
+ * Lightweight edge metadata returned to consumers after rendering.
+ * Provides the essential identifiers needed for edge navigation.
+ */
+declare interface EdgeInfo {
+    /** Internal Graphviz ID */
+    id: number;
+    /** Edge index from EdgeContent (used for selection and navigation) */
+    index: number;
+    /** Source node name */
+    sourceNodeId: string;
+    /** Target node name */
+    targetNodeId: string;
+    /** Displayable label text (null if no label) */
+    label: string | null;
+}
+
+declare interface GraphvizJson {
+    name: string;
+    directed: boolean;
+    strict: boolean;
+    bb?: string;
+    objects?: GraphvizObject[];
+    edges?: GraphvizObject[];
+}
+
+declare interface GraphvizObject {
+    _gvid: number;
+    name: string;
+    _draw_?: DrawOp[];
+    _ldraw_?: DrawOp[];
+    _hdraw_?: DrawOp[];
+    _tdraw_?: DrawOp[];
+    bb?: string;
+    pos?: string;
+    width?: string;
+    height?: string;
+    label?: string;
+    head?: number;
+    tail?: number;
+}
+
+/**
+ * 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). */
+declare interface InitialTransform {
+    x: number;
+    y: number;
+    k: number;
+}
+
+/**
+ * Layout configuration for the Graphviz custom layout renderer.
+ * All layout-related constants are consolidated here for easy customization.
+ */
+declare interface LayoutConfig {
+    /** Horizontal extension at start/end of edges (in pixels) */
+    horizontalExtension: number;
+    /** Minimum distance between edge midY values (in pixels) */
+    minEdgeDistance: number;
+    /** Threshold for skipping vertical segments (in pixels) */
+    minVerticalSegment: number;
+    /** Radius for self-loop edges (in pixels) */
+    loopRadius: number;
+    /** Spacing between edges (in pixels) */
+    edgeSpacing: number;
+    /** Corner radius for edge paths (in pixels) */
+    cornerRadius: number;
+    /** Width of arrowhead (in pixels) */
+    arrowWidth: number;
+    /** Height of arrowhead (in pixels) */
+    arrowHeight: number;
+    /** Extra height for edge labels (in pixels) */
+    labelHeight: number;
+    /** Font size for edge labels (in pixels) */
+    labelFontSize: number;
+    /** Padding around label text (in pixels) */
+    labelPadding: number;
+    /** Corner radius for label background (in pixels) */
+    labelCornerRadius: number;
+    /** Spacing between nodes (in pixels) */
+    nodeSpacing: number;
+    /** Threshold for considering edges as nearly horizontal (in pixels) */
+    nearlyHorizontalThreshold: number;
+    /** Threshold for nearly aligned edges in 3seg path (in pixels) */
+    nearlyAlignedThreshold: number;
+}
+
+/**
+ * Run graphviz layout in Node (no Web Worker). Same call the worker makes:
+ * `graphviz.layout(dot, "json", "dot")`. Deterministic for a given dot + wasm
+ * version, so server and client layouts match.
+ */
+export declare function layoutDot(dot: string): Promise<GraphvizJson>;
+
+declare interface NodeMapping {
+    sourceNodeId: string;
+    targetNodeId: string;
+}
+
+declare type NodeMappingArg = Parameters<typeof renderCustomGraph>[2];
+
+declare function renderCustomGraph(container: HTMLDivElement, json: GraphvizJson, _nodeMapping?: Record<string, NodeMapping>, 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;
+};
+
+/** Convenience: dot string → static SVG string (layout + render in one call). */
+export declare function renderDotToString(dot: string, opts?: RenderToStringOptions): Promise<RenderToStringResult>;
+
+declare interface RenderExtraOptions {
+    /**
+     * 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;
+    /**
+     * 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).
+     */
+    initialTransform?: InitialTransform;
+}
+
+/**
+ * Render a graphviz layout JSON to a static SVG string (headless).
+ * Arguments mirror how `GraphvizRenderer` calls `renderCustomGraph`, so the
+ * output matches the browser render.
+ */
+export declare function renderToString(json: GraphvizJson, opts?: RenderToStringOptions): RenderToStringResult;
+
+export declare interface RenderToStringOptions {
+    nodeMapping?: NodeMappingArg;
+    layoutConfig?: LayoutConfig;
+    /** Base font size; the renderer also lifts it to the max `_ldraw_` size in the JSON (matches GraphvizRenderer). */
+    svgFontSize?: number;
+    nodeWidth?: number;
+    nodeHeight?: number;
+    nodeColumnSpacing?: number;
+}
+
+export declare interface RenderToStringResult {
+    /** Serialized `<svg>…</svg>` markup, ready to inline into HTML. */
+    svg: string;
+    /** Pass to the client `GraphvizRenderer`'s `initialTransform` prop for no-jump hydration. */
+    initialTransform: InitialTransform;
+    viewBoxWidth: number;
+    edges: EdgeInfo[];
+}
+
+export { }