@opendata-ai/openchart-engine 8.0.0-rc.23 → 8.0.0-rc.25

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import * as _opendata_ai_openchart_core from '@opendata-ai/openchart-core';
-import { AnimationEase, LegendLayout, ResolvedChrome, TooltipContent, A11yMetadata, ResolvedTheme, LegendEntry, CompileOptions, ChartLayout, LayerSpec, CompileTableOptions, TableLayout, ResolvedAnimationPhase, AnimationSpec, ResolvedAnimation, Point, DataRow, BarListEncoding, ThemeConfig, DarkMode, MapGeo, MapEncoding, LegendConfig, MapPointsLayer, TileMapEncoding, TileMapPalette, MarkType, MarkDef, Encoding, ChromeText, Annotation, LabelConfig, Display, ColumnConfig, GraphSpec, GraphEncoding, GraphLayoutConfig, NodeOverride, GraphAnimationSpec, GraphInteractionConfig, SankeyEncoding, SankeyNodeAlign, SankeyLinkColor, ScaleType, EncodingChannel, FieldFormatContext, Rect, LayoutStrategy, VizSpec, Mark, BinTransform, CalculateTransform, ConditionalValueDef, FilterPredicate, TimeUnitTransform, Transform } from '@opendata-ai/openchart-core';
-export { BarListLayout, BarListSpec, ChartLayout, ChartSpec, CompileOptions, CompileTableOptions, GraphLayout, GraphSpec, LayerSpec, MapLayout, MapSpec, SankeyLayout, SankeySpec, TableLayout, TableSpec, TileMapLayout, TileMapSpec, VizSpec } from '@opendata-ai/openchart-core';
+import { AnimationEase, LegendLayout, ResolvedChrome, TooltipContent, A11yMetadata, ResolvedTheme, LegendEntry, CompileOptions, ChartLayout, LayerSpec, CompileTableOptions, TableLayout, ResolvedAnimationPhase, AnimationSpec, ResolvedAnimation, Point, DataRow, BarListEncoding, ThemeConfig, DarkMode, GeoMapGeo, GeoMapEncoding, LegendConfig, GeoMapPointsLayer, TileMapEncoding, TileMapPalette, MarkType, MarkDef, Encoding, ChromeText, Annotation, LabelConfig, Display, ColumnConfig, GraphSpec, GraphEncoding, GraphLayoutConfig, NodeOverride, GraphAnimationSpec, GraphInteractionConfig, SankeyEncoding, SankeyNodeAlign, SankeyLinkColor, ScaleType, EncodingChannel, FieldFormatContext, Rect, LayoutStrategy, VizSpec, Mark, BinTransform, CalculateTransform, ConditionalValueDef, FilterPredicate, TimeUnitTransform, Transform } from '@opendata-ai/openchart-core';
+export { BarListLayout, BarListSpec, ChartLayout, ChartSpec, CompileOptions, CompileTableOptions, GeoMapLayout, GeoMapSpec, GraphLayout, GraphSpec, LayerSpec, SankeyLayout, SankeySpec, TableLayout, TableSpec, TileMapLayout, TileMapSpec, VizSpec } from '@opendata-ai/openchart-core';
 import { ScaleLinear, ScaleTime, ScaleLogarithmic, ScalePower, ScaleSymLog, ScaleBand, ScalePoint, ScaleOrdinal, ScaleQuantile, ScaleQuantize, ScaleThreshold } from 'd3-scale';
 
 /**
@@ -272,18 +272,18 @@ declare function compileSankey(spec: unknown, options: CompileOptions): _opendat
  */
 declare function compileTileMap(spec: unknown, options: CompileOptions): _opendata_ai_openchart_core.TileMapLayout;
 /**
- * Compile a map spec into a MapLayout.
+ * Compile a map spec into a GeoMapLayout.
  *
  * Takes a raw map spec, validates, normalizes, resolves theme and chrome,
  * projects geo features, joins data, builds feature marks with color fills,
- * and returns a MapLayout ready for rendering.
+ * and returns a GeoMapLayout ready for rendering.
  *
  * @param spec - Raw map spec (validated and normalized internally).
  * @param options - Compile options (width, height, theme, darkMode).
- * @returns MapLayout with computed positions and visual properties.
+ * @returns GeoMapLayout with computed positions and visual properties.
  * @throws Error if spec is invalid or not a map type.
  */
-declare function compileMap(spec: unknown, options: CompileOptions): _opendata_ai_openchart_core.MapLayout;
+declare function compileGeoMap(spec: unknown, options: CompileOptions): _opendata_ai_openchart_core.GeoMapLayout;
 /**
  * Compile a barlist spec into a BarListLayout.
  *
@@ -413,11 +413,11 @@ interface NormalizedBarListSpec {
     valueFormat?: string;
 }
 
-interface NormalizedMapSpec {
+interface NormalizedGeoMapSpec {
     type: 'map';
-    geo: Required<MapGeo>;
+    geo: Required<GeoMapGeo>;
     data: Record<string, unknown>[];
-    encoding: MapEncoding;
+    encoding: GeoMapEncoding;
     chrome: NormalizedChrome;
     legend?: LegendConfig;
     theme: ThemeConfig;
@@ -425,7 +425,7 @@ interface NormalizedMapSpec {
     watermark: boolean;
     animation?: AnimationSpec;
     valueFormat?: string;
-    points?: MapPointsLayer;
+    points?: GeoMapPointsLayer;
 }
 
 /**
@@ -593,7 +593,7 @@ interface NormalizedGraphSpec {
     };
 }
 /** Discriminated union of all normalized spec types. */
-type NormalizedSpec = NormalizedChartSpec | NormalizedTableSpec | NormalizedGraphSpec | NormalizedSankeySpec | NormalizedTileMapSpec | NormalizedMapSpec | NormalizedBarListSpec;
+type NormalizedSpec = NormalizedChartSpec | NormalizedTableSpec | NormalizedGraphSpec | NormalizedSankeySpec | NormalizedTileMapSpec | NormalizedGeoMapSpec | NormalizedBarListSpec;
 /** 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. */
@@ -1058,4 +1058,4 @@ declare function runTimeUnit(data: DataRow[], transform: TimeUnitTransform): Dat
  */
 declare function runTransforms(data: DataRow[], transforms: Transform[]): DataRow[];
 
-export { ARROWHEAD_LENGTH, type AnnotationContext, type AnnotationMeasureTextFn, type ArrowheadPoints, BOLD_SPAN_FONT_WEIGHT, type ChartRenderer, type CompileResult, type CompiledGraphEdge, type CompiledGraphNode, DEFAULT_ANNOTATION_FONT_SIZE, DEFAULT_LINE_HEIGHT, ENTER_DEFAULTS, EXIT_DEFAULTS, type GraphCompilation, type NormalizedBarListSpec, type NormalizedChartSpec, type NormalizedChrome, type NormalizedGraphSpec, type NormalizedMapSpec, type NormalizedSankeySpec, type NormalizedSpec, type NormalizedTableSpec, type NormalizedTileMapSpec, type ObstacleKind, type PlacementObstacle, type RichSpan, type SimulationConfig, UPDATE_DEFAULTS, type ValidationError, type ValidationErrorCode, type ValidationResult, buildAreaPath, buildEdgeTooltip, buildLinePath, clampStaggerDelay, clearRenderers, compile, compileBarList, compileChart, compileGraph, compileLayer, compileMap, compileSankey, compileTable, compileTileMap, computeArrowheadPoints, dedupeKeys, evaluatePredicate, facetMinHeight, getChartRenderer, heuristicMeasure, isConditionalValueDef, legendGap, normalizeSpec, parseAnnotationSpans, registerChartRenderer, resolveAnimation, resolveConditionalValue, runBin, runCalculate, runFilter, runTimeUnit, runTransforms, serializeKeyValue, validateSpec };
+export { ARROWHEAD_LENGTH, type AnnotationContext, type AnnotationMeasureTextFn, type ArrowheadPoints, BOLD_SPAN_FONT_WEIGHT, type ChartRenderer, type CompileResult, type CompiledGraphEdge, type CompiledGraphNode, DEFAULT_ANNOTATION_FONT_SIZE, DEFAULT_LINE_HEIGHT, ENTER_DEFAULTS, EXIT_DEFAULTS, type GraphCompilation, type NormalizedBarListSpec, type NormalizedChartSpec, type NormalizedChrome, type NormalizedGeoMapSpec, type NormalizedGraphSpec, type NormalizedSankeySpec, type NormalizedSpec, type NormalizedTableSpec, type NormalizedTileMapSpec, type ObstacleKind, type PlacementObstacle, type RichSpan, type SimulationConfig, UPDATE_DEFAULTS, type ValidationError, type ValidationErrorCode, type ValidationResult, buildAreaPath, buildEdgeTooltip, buildLinePath, clampStaggerDelay, clearRenderers, compile, compileBarList, compileChart, compileGeoMap, compileGraph, compileLayer, compileSankey, compileTable, compileTileMap, computeArrowheadPoints, dedupeKeys, evaluatePredicate, facetMinHeight, getChartRenderer, heuristicMeasure, isConditionalValueDef, legendGap, normalizeSpec, parseAnnotationSpans, registerChartRenderer, resolveAnimation, resolveConditionalValue, runBin, runCalculate, runFilter, runTimeUnit, runTransforms, serializeKeyValue, validateSpec };

package/dist/index.js

@@ -9719,6 +9719,16 @@ function stripIgnoredKeys(spec, warnings) {
   const { $schema: _schema, ...rest } = spec;
   return rest;
 }
+function stripRemovedMarkRender(spec, warnings) {
+  const mark = spec.mark;
+  if (!mark || typeof mark !== "object" || Array.isArray(mark)) return spec;
+  if (!("render" in mark)) return spec;
+  warnings.push(
+    "[openchart] mark.render was removed in v8. This field is stripped for backward compatibility. Pass { renderer } to createChart() or the compile options instead."
+  );
+  const { render: _render, ...restMark } = mark;
+  return { ...spec, mark: restMark };
+}
 function applyFixedSizeDefault(spec) {
   if (typeof spec.width === "number" && typeof spec.height === "number" && spec.responsive === void 0) {
     return { ...spec, responsive: false };
@@ -9989,6 +9999,7 @@ function expandChartSugar(spec, warnings, inheritedData) {
   out = expandTopLevelTitle(out);
   out = expandDescriptionSugar(out);
   out = stripIgnoredKeys(out, warnings);
+  out = stripRemovedMarkRender(out, warnings);
   out = applyFixedSizeDefault(out);
   out = expandAnnotationSugar(out, warnings);
   out = expandChannelSugar(out, warnings);
@@ -10152,9 +10163,9 @@ function resolveStagger(stagger, defaults) {
 import {
   isBarListSpec,
   isChartSpec,
+  isGeoMapSpec,
   isGraphSpec,
   isLayerSpec,
-  isMapSpec,
   isSankeySpec,
   isTableSpec,
   isTileMapSpec,
@@ -10652,7 +10663,7 @@ function normalizeTileMapSpec(spec, warnings) {
     valueFormat: spec.valueFormat
   };
 }
-function normalizeMapSpec(spec, _warnings) {
+function normalizeGeoMapSpec(spec, _warnings) {
   return {
     type: "map",
     geo: {
@@ -10712,8 +10723,8 @@ function normalizeSpec(spec, warnings = []) {
   if (isTileMapSpec(spec)) {
     return normalizeTileMapSpec(spec, warnings);
   }
-  if (isMapSpec(spec)) {
-    return normalizeMapSpec(spec, warnings);
+  if (isGeoMapSpec(spec)) {
+    return normalizeGeoMapSpec(spec, warnings);
   }
   if (isBarListSpec(spec)) {
     return normalizeBarListSpec(spec, warnings);
@@ -11029,19 +11040,38 @@ function validateCalendarSpec(spec, errors) {
     seenDays.set(dayKey, i);
   }
 }
-var VALID_RENDER_MODES = /* @__PURE__ */ new Set(["auto", "svg", "canvas"]);
-function validateMarkRenderMode(spec, errors) {
-  const mark = spec.mark;
-  if (!mark || typeof mark !== "object" || Array.isArray(mark)) return;
-  const render = mark.render;
-  if (render === void 0) return;
-  if (typeof render !== "string" || !VALID_RENDER_MODES.has(render)) {
-    errors.push({
-      message: `Spec error: mark.render ${JSON.stringify(render)} is not valid. Must be one of: auto, svg, canvas`,
-      path: "mark.render",
-      code: "INVALID_VALUE",
-      suggestion: 'Use mark: { type: "point", render: "auto" } (default), "canvas" to force the canvas mark layer, or "svg" to force one circle per point.'
-    });
+var MAX_PLAUSIBLE_POINT_RADIUS = 50;
+function pointSizeError(path2, value2) {
+  const radius = Math.max(1, Math.round(Math.sqrt(value2 / Math.PI)));
+  return {
+    message: `Spec error: ${path2} is a radius in pixels, and ${value2} would draw a ${Math.round(value2 * 2)}px-wide circle. This usually means the value was written in Vega-Lite's units, where point size is an area in px^2.`,
+    path: path2,
+    code: "INVALID_VALUE",
+    suggestion: `Point sizes are radii in px (default 5, typical 2-12). For the dot a Vega-Lite size of ${value2} draws, use ${radius} (r = sqrt(area / pi)).`
+  };
+}
+function validatePointSize(spec, errors) {
+  const markType = typeof spec.mark === "string" ? spec.mark : spec.mark?.type;
+  if (markType !== "point") return;
+  if (spec.mark && typeof spec.mark === "object") {
+    const size = spec.mark.size;
+    if (typeof size === "number" && size > MAX_PLAUSIBLE_POINT_RADIUS) {
+      errors.push(pointSizeError("mark.size", size));
+    }
+  }
+  const sizeEnc = spec.encoding && typeof spec.encoding === "object" ? spec.encoding.size : void 0;
+  if (!sizeEnc || typeof sizeEnc !== "object") return;
+  if (typeof sizeEnc.value === "number" && sizeEnc.value > MAX_PLAUSIBLE_POINT_RADIUS) {
+    errors.push(pointSizeError("encoding.size.value", sizeEnc.value));
+  }
+  const range3 = sizeEnc.scale && typeof sizeEnc.scale === "object" ? sizeEnc.scale.range : void 0;
+  if (Array.isArray(range3)) {
+    const worst = range3.find(
+      (entry) => typeof entry === "number" && entry > MAX_PLAUSIBLE_POINT_RADIUS
+    );
+    if (typeof worst === "number") {
+      errors.push(pointSizeError("encoding.size.scale.range", worst));
+    }
   }
 }
 function validateChartSpec(spec, errors) {
@@ -11149,7 +11179,7 @@ function validateChartSpec(spec, errors) {
   if (markType === "calendar") {
     validateCalendarSpec(spec, errors);
   }
-  validateMarkRenderMode(spec, errors);
+  validatePointSize(spec, errors);
   if (Array.isArray(spec.transform)) {
     const transforms = spec.transform;
     for (let i = 0; i < transforms.length; i++) {
@@ -11887,7 +11917,7 @@ function validateTileMapSpec(spec, errors) {
     });
   }
 }
-function validateMapSpec(spec, errors) {
+function validateGeoMapSpec(spec, errors) {
   if (!spec.geo || typeof spec.geo !== "object") {
     errors.push({
       message: 'Spec error: map spec requires a "geo" object with a TopoJSON "features" field',
@@ -12387,7 +12417,7 @@ function validateSpec(spec) {
   } else if (isTileMap) {
     validateTileMapSpec(obj, errors);
   } else if (isMap) {
-    validateMapSpec(obj, errors);
+    validateGeoMapSpec(obj, errors);
   } else if (isBarList) {
     validateBarListSpec(obj, errors);
   }
@@ -15985,22 +16015,20 @@ function collectContrastWarnings(scales, markType, theme) {
 
 // src/compiler/mark-render-mode.ts
 var AUTO_CANVAS_THRESHOLD = 1e3;
-var AUTO_ENABLED = true;
 function resolveMarkRenderMode(args, warnings = []) {
-  const { markDef, markType, pointCount, display, faceted, layered } = args;
-  const requested = markDef?.render ?? "auto";
+  const { markType, pointCount, display, faceted, layered } = args;
+  const requested = args.requested ?? "auto";
   if (requested === "svg") return "svg";
   const refusal = describeRefusal(markType, display, faceted, layered);
   if (refusal) {
     if (requested === "canvas") {
       warnings.push(
-        `Chart warning: mark.render "canvas" is not supported ${refusal}; rendering marks as SVG instead.`
+        `Chart warning: renderer "canvas" is not supported ${refusal}; rendering marks as SVG instead.`
       );
     }
     return "svg";
   }
   if (requested === "canvas") return "canvas";
-  if (!AUTO_ENABLED) return "svg";
   return pointCount > AUTO_CANVAS_THRESHOLD ? "canvas" : "svg";
 }
 function describeRefusal(markType, display, faceted, layered) {
@@ -16077,7 +16105,7 @@ function buildSparklineAreaGradient(baseColor) {
   };
 }
 
-// src/geo/compile-map.ts
+// src/geo/compile-geo-map.ts
 import {
   adaptTheme as adaptTheme2,
   buildD3Formatter as buildD3Formatter2,
@@ -17978,7 +18006,7 @@ function identity_default4() {
   return projection2;
 }
 
-// src/geo/compile-map.ts
+// src/geo/compile-geo-map.ts
 import { feature as topoFeature, mesh as topoMesh } from "topojson-client";
 
 // src/geo/join.ts
@@ -18111,7 +18139,7 @@ function excludePolarFeatures(geojson) {
   return { type: "FeatureCollection", features: filtered };
 }
 
-// src/geo/compile-map.ts
+// src/geo/compile-geo-map.ts
 var OVERLAY_LEGEND_INSET = 18;
 function validateGeoFeatures(geo) {
   if (!geo.features) {
@@ -18133,14 +18161,14 @@ function validateGeoFeatures(geo) {
   }
   return topo;
 }
-function compileMap(spec, options) {
+function compileGeoMap(spec, options) {
   const sugarWarnings = [];
   const expandedSpec = spec && typeof spec === "object" && !Array.isArray(spec) ? expandSpecSugar(spec, sugarWarnings) : spec;
   const { spec: normalized, warnings } = compile(expandedSpec);
   emitSpecWarnings([...sugarWarnings, ...warnings], options.onWarn);
   if (!("type" in normalized) || normalized.type !== "map") {
     throw new Error(
-      "compileMap received a non-map spec. Use compileChart, compileTileMap, compileSankey, or compileBarList instead."
+      "compileGeoMap received a non-map spec. Use compileChart, compileTileMap, compileSankey, or compileBarList instead."
     );
   }
   const mapSpec = normalized;
@@ -23410,7 +23438,7 @@ function compileChart(spec, optionsInput) {
     throw new Error("compileChart received a sankey spec. Use compileSankey instead.");
   }
   if ("type" in normalized && normalized.type === "map") {
-    throw new Error("compileChart received a map spec. Use compileMap instead.");
+    throw new Error("compileChart received a map spec. Use compileGeoMap instead.");
   }
   let chartSpec = normalized;
   const rawWatermark = expandedSpec.watermark;
@@ -23708,7 +23736,7 @@ function compileChart(spec, optionsInput) {
   const markRenderModeWarnings = [];
   const markRenderMode = resolveMarkRenderMode(
     {
-      markDef: chartSpec.markDef,
+      requested: options.renderer,
       markType: chartSpec.markType,
       pointCount: marks.reduce((n, m) => m.type === "point" ? n + 1 : n, 0),
       display: chartSpec.display,
@@ -24150,8 +24178,8 @@ function compileSankey2(spec, options) {
 function compileTileMap2(spec, options) {
   return compileTileMap(spec, options);
 }
-function compileMap2(spec, options) {
-  return compileMap(spec, options);
+function compileGeoMap2(spec, options) {
+  return compileGeoMap(spec, options);
 }
 function compileBarList2(spec, options) {
   return compileBarList(spec, options);
@@ -24172,9 +24200,9 @@ export {
   compile,
   compileBarList2 as compileBarList,
   compileChart,
+  compileGeoMap2 as compileGeoMap,
   compileGraph2 as compileGraph,
   compileLayer2 as compileLayer,
-  compileMap2 as compileMap,
   compileSankey2 as compileSankey,
   compileTable,
   compileTileMap2 as compileTileMap,