@opendata-ai/openchart-engine 6.5.1 → 6.6.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as _opendata_ai_openchart_core from '@opendata-ai/openchart-core';
-import { LegendLayout, ResolvedChrome, TooltipContent, A11yMetadata, ResolvedTheme, CompileOptions, ChartLayout, LayerSpec, CompileTableOptions, TableLayout, AnimationSpec, ResolvedAnimation, MarkType, MarkDef, DataRow, Encoding, ChromeText, Annotation, LabelConfig, LegendConfig, ThemeConfig, DarkMode, ColumnConfig, GraphSpec, GraphEncoding, GraphLayoutConfig, NodeOverride, VizSpec, ScaleType, EncodingChannel, Rect, LayoutStrategy, Mark, BinTransform, CalculateTransform, ConditionalValueDef, FilterPredicate, TimeUnitTransform, Transform } from '@opendata-ai/openchart-core';
-export { ChartLayout, ChartSpec, CompileOptions, CompileTableOptions, GraphLayout, GraphSpec, LayerSpec, TableLayout, TableSpec, VizSpec } from '@opendata-ai/openchart-core';
+import { LegendLayout, ResolvedChrome, TooltipContent, A11yMetadata, ResolvedTheme, CompileOptions, ChartLayout, LayerSpec, CompileTableOptions, TableLayout, AnimationSpec, ResolvedAnimation, MarkType, MarkDef, DataRow, Encoding, ChromeText, Annotation, LabelConfig, LegendConfig, ThemeConfig, DarkMode, ColumnConfig, GraphSpec, GraphEncoding, GraphLayoutConfig, NodeOverride, SankeyEncoding, SankeyNodeAlign, SankeyLinkColor, VizSpec, ScaleType, EncodingChannel, Rect, LayoutStrategy, Mark, BinTransform, CalculateTransform, ConditionalValueDef, FilterPredicate, TimeUnitTransform, Transform } from '@opendata-ai/openchart-core';
+export { ChartLayout, ChartSpec, CompileOptions, CompileTableOptions, GraphLayout, GraphSpec, LayerSpec, SankeyLayout, SankeySpec, TableLayout, TableSpec, VizSpec } from '@opendata-ai/openchart-core';
 import { ScaleLinear, ScaleTime, ScaleLogarithmic, ScalePower, ScaleSymLog, ScaleBand, ScalePoint, ScaleOrdinal, ScaleQuantile, ScaleQuantize, ScaleThreshold } from 'd3-scale';
 
 /**
@@ -103,19 +103,6 @@ interface GraphCompilation {
     simulationConfig: SimulationConfig;
 }
 
-/**
- * Main compile API: the public entry points for the engine.
- *
- * Pipeline for charts:
- *   validate spec -> normalize -> resolve theme -> dark mode adapt ->
- *   compute legend -> compute dimensions (with legend space) ->
- *   compute scales -> compute axes -> compute gridlines ->
- *   get chart renderer -> compute marks -> compute a11y -> return ChartLayout
- *
- * Table compiler handles full data pipeline (sort, search, pagination, visual enhancements).
- * Graph compiler is a stub for future implementation.
- */
-
 /**
  * Compile a chart spec into a ChartLayout.
  *
@@ -167,6 +154,19 @@ declare function compileTable(spec: unknown, options: CompileTableOptions): Tabl
  * @throws Error if spec is invalid or not a graph type.
  */
 declare function compileGraph(spec: unknown, options: CompileOptions): GraphCompilation;
+/**
+ * Compile a sankey spec into a SankeyLayout.
+ *
+ * Takes a raw sankey spec, validates, normalizes, resolves theme and chrome,
+ * runs the d3-sankey layout algorithm, builds node/link marks with colors and
+ * labels, and returns a SankeyLayout ready for rendering.
+ *
+ * @param spec - Raw sankey spec (validated and normalized internally).
+ * @param options - Compile options (width, height, theme, darkMode).
+ * @returns SankeyLayout with computed positions and visual properties.
+ * @throws Error if spec is invalid or not a sankey type.
+ */
+declare function compileSankey(spec: unknown, options: CompileOptions): _opendata_ai_openchart_core.SankeyLayout;
 
 /**
  * Animation resolver: normalizes AnimationSpec into fully resolved config.
@@ -249,7 +249,7 @@ interface NormalizedGraphSpec {
     darkMode: DarkMode;
 }
 /** Discriminated union of all normalized spec types. */
-type NormalizedSpec = NormalizedChartSpec | NormalizedTableSpec | NormalizedGraphSpec;
+type NormalizedSpec = NormalizedChartSpec | NormalizedTableSpec | NormalizedGraphSpec | NormalizedSankeySpec;
 /** Machine-readable error code for programmatic handling. */
 type ValidationErrorCode = 'MISSING_FIELD' | 'INVALID_TYPE' | 'INVALID_VALUE' | 'ENCODING_MISMATCH' | 'DATA_FIELD_MISSING' | 'EMPTY_DATA';
 /** A single validation error with context. */
@@ -280,6 +280,31 @@ interface CompileResult {
     warnings: string[];
 }
 
+/**
+ * Internal normalized sankey spec type used by the compilation pipeline.
+ *
+ * This mirrors NormalizedChartSpec/NormalizedGraphSpec: all optional fields
+ * have been filled with sensible defaults. It's an engine implementation
+ * detail, not a public contract.
+ */
+
+/** A SankeySpec with all optional fields filled with defaults. */
+interface NormalizedSankeySpec {
+    type: 'sankey';
+    data: Record<string, unknown>[];
+    encoding: SankeyEncoding;
+    nodeWidth: number;
+    nodePadding: number;
+    nodeAlign: SankeyNodeAlign;
+    iterations: number;
+    linkStyle: SankeyLinkColor;
+    chrome: NormalizedChrome;
+    legend?: LegendConfig;
+    theme: ThemeConfig;
+    darkMode: DarkMode;
+    animation?: AnimationSpec;
+}
+
 /**
  * Normalize a validated VizSpec, filling in all defaults.
  *
@@ -530,4 +555,4 @@ declare function runTimeUnit(data: DataRow[], transform: TimeUnitTransform): Dat
  */
 declare function runTransforms(data: DataRow[], transforms: Transform[]): DataRow[];
 
-export { type ChartRenderer, type CompileResult, type CompiledGraphEdge, type CompiledGraphNode, type GraphCompilation, type NormalizedChartSpec, type NormalizedChrome, type NormalizedGraphSpec, type NormalizedSpec, type NormalizedTableSpec, type SimulationConfig, type ValidationError, type ValidationErrorCode, type ValidationResult, clampStaggerDelay, clearRenderers, compile, compileChart, compileGraph, compileLayer, compileTable, evaluatePredicate, getChartRenderer, isConditionalValueDef, normalizeSpec, registerChartRenderer, resolveAnimation, resolveConditionalValue, runBin, runCalculate, runFilter, runTimeUnit, runTransforms, validateSpec };
+export { type ChartRenderer, type CompileResult, type CompiledGraphEdge, type CompiledGraphNode, type GraphCompilation, type NormalizedChartSpec, type NormalizedChrome, type NormalizedGraphSpec, type NormalizedSankeySpec, type NormalizedSpec, type NormalizedTableSpec, type SimulationConfig, type ValidationError, type ValidationErrorCode, type ValidationResult, clampStaggerDelay, clearRenderers, compile, compileChart, compileGraph, compileLayer, compileSankey, compileTable, evaluatePredicate, getChartRenderer, isConditionalValueDef, normalizeSpec, registerChartRenderer, resolveAnimation, resolveConditionalValue, runBin, runCalculate, runFilter, runTimeUnit, runTransforms, validateSpec };