@opendata-ai/openchart-core 6.0.0 → 6.1.0

package/dist/index.js

@@ -5,64 +5,129 @@ function required(...types) {
 function optional(...types) {
   return { required: false, allowedTypes: types };
 }
-var CHART_ENCODING_RULES = {
+var MARK_ENCODING_RULES = {
+  bar: {
+    x: required("quantitative", "nominal", "ordinal", "temporal"),
+    y: required("quantitative", "nominal", "ordinal"),
+    x2: optional("quantitative"),
+    y2: optional("quantitative"),
+    color: optional("nominal", "ordinal", "quantitative"),
+    size: optional(),
+    opacity: optional("quantitative"),
+    tooltip: optional(),
+    href: optional(),
+    order: optional("quantitative", "ordinal"),
+    detail: optional("nominal")
+  },
   line: {
     x: required("temporal", "ordinal"),
     y: required("quantitative"),
-    color: optional("nominal", "ordinal"),
-    size: optional("quantitative"),
+    color: optional("nominal", "ordinal", "quantitative"),
+    size: optional(),
+    opacity: optional("quantitative"),
+    strokeDash: optional("nominal", "ordinal"),
+    tooltip: optional(),
+    href: optional(),
+    order: optional("quantitative", "ordinal"),
     detail: optional("nominal")
   },
   area: {
     x: required("temporal", "ordinal"),
     y: required("quantitative"),
-    color: optional("nominal", "ordinal"),
-    size: optional("quantitative"),
+    y2: optional("quantitative"),
+    color: optional("nominal", "ordinal", "quantitative"),
+    size: optional(),
+    opacity: optional("quantitative"),
+    tooltip: optional(),
+    href: optional(),
+    order: optional("quantitative", "ordinal"),
     detail: optional("nominal")
   },
-  bar: {
+  point: {
     x: required("quantitative"),
-    y: required("nominal", "ordinal"),
+    y: required("quantitative"),
     color: optional("nominal", "ordinal", "quantitative"),
     size: optional("quantitative"),
+    shape: optional("nominal", "ordinal"),
+    opacity: optional("quantitative"),
+    tooltip: optional(),
+    href: optional(),
+    order: optional("quantitative", "ordinal"),
     detail: optional("nominal")
   },
-  column: {
-    x: required("nominal", "ordinal", "temporal"),
-    y: required("quantitative"),
+  circle: {
+    x: required("quantitative"),
+    y: required("nominal", "ordinal"),
     color: optional("nominal", "ordinal", "quantitative"),
     size: optional("quantitative"),
+    opacity: optional("quantitative"),
+    tooltip: optional(),
+    href: optional(),
+    order: optional("quantitative", "ordinal"),
     detail: optional("nominal")
   },
-  pie: {
+  arc: {
     x: optional(),
     y: required("quantitative"),
     color: required("nominal", "ordinal"),
-    size: optional("quantitative"),
+    size: optional(),
+    opacity: optional("quantitative"),
+    tooltip: optional(),
+    href: optional(),
+    order: optional("quantitative", "ordinal"),
+    theta: optional("quantitative"),
+    radius: optional("quantitative"),
     detail: optional("nominal")
   },
-  donut: {
+  text: {
     x: optional(),
-    y: required("quantitative"),
-    color: required("nominal", "ordinal"),
+    y: optional(),
+    color: optional(),
     size: optional("quantitative"),
+    opacity: optional("quantitative"),
+    text: required(),
+    tooltip: optional(),
+    href: optional(),
     detail: optional("nominal")
   },
-  dot: {
-    x: required("quantitative"),
-    y: required("nominal", "ordinal"),
-    color: optional("nominal", "ordinal"),
-    size: optional("quantitative"),
+  rule: {
+    x: optional(),
+    y: optional(),
+    x2: optional(),
+    y2: optional(),
+    color: optional(),
+    size: optional(),
+    opacity: optional("quantitative"),
+    strokeDash: optional("nominal", "ordinal"),
+    tooltip: optional(),
+    href: optional(),
     detail: optional("nominal")
   },
-  scatter: {
-    x: required("quantitative"),
-    y: required("quantitative"),
-    color: optional("nominal", "ordinal"),
-    size: optional("quantitative"),
+  tick: {
+    x: required(),
+    y: required(),
+    color: optional(),
+    size: optional(),
+    opacity: optional("quantitative"),
+    tooltip: optional(),
+    href: optional(),
+    detail: optional("nominal")
+  },
+  rect: {
+    x: required(),
+    y: required(),
+    x2: optional(),
+    y2: optional(),
+    color: optional(),
+    size: optional(),
+    opacity: optional("quantitative"),
+    tooltip: optional(),
+    href: optional(),
+    order: optional("quantitative", "ordinal"),
     detail: optional("nominal")
   }
 };
+var CHART_ENCODING_RULES = MARK_ENCODING_RULES;
 var GRAPH_ENCODING_RULES = {
   nodeColor: { required: false, allowedTypes: ["nominal", "ordinal"] },
   nodeSize: { required: false, allowedTypes: ["quantitative"] },
@@ -72,24 +137,44 @@ var GRAPH_ENCODING_RULES = {
 };
 
 // src/types/spec.ts
-var CHART_TYPES = /* @__PURE__ */ new Set([
+function isEncodingChannel(def) {
+  if (!def) return false;
+  return "field" in def && !("condition" in def);
+}
+function isConditionalDef(def) {
+  if (!def) return false;
+  return "condition" in def;
+}
+var MARK_TYPES = /* @__PURE__ */ new Set([
+  "bar",
   "line",
   "area",
-  "bar",
-  "column",
-  "pie",
-  "donut",
-  "dot",
-  "scatter"
+  "point",
+  "circle",
+  "arc",
+  "text",
+  "rule",
+  "tick",
+  "rect"
 ]);
+var CHART_TYPES = MARK_TYPES;
+function resolveMarkType(mark) {
+  return typeof mark === "string" ? mark : mark.type;
+}
+function resolveMarkDef(mark) {
+  return typeof mark === "string" ? { type: mark } : mark;
+}
 function isChartSpec(spec) {
-  return CHART_TYPES.has(spec.type);
+  return "mark" in spec && !("layer" in spec);
+}
+function isLayerSpec(spec) {
+  return "layer" in spec && Array.isArray(spec.layer);
 }
 function isTableSpec(spec) {
-  return spec.type === "table";
+  return "type" in spec && spec.type === "table";
 }
 function isGraphSpec(spec) {
-  return spec.type === "graph";
+  return "type" in spec && spec.type === "graph";
 }
 function isTextAnnotation(annotation) {
   return annotation.type === "text";
@@ -100,6 +185,19 @@ function isRangeAnnotation(annotation) {
 function isRefLineAnnotation(annotation) {
   return annotation.type === "refline";
 }
+var MARK_DISPLAY_NAMES = {
+  bar: "Bar chart",
+  line: "Line chart",
+  area: "Area chart",
+  point: "Scatter plot",
+  circle: "Dot plot",
+  arc: "Pie chart",
+  // overridden to "Donut chart" when innerRadius > 0
+  text: "Text chart",
+  rule: "Rule chart",
+  tick: "Tick plot",
+  rect: "Heatmap"
+};
 
 // ../../node_modules/.bun/d3-color@3.1.0/node_modules/d3-color/src/define.js
 function define_default(constructor, factory, prototype) {
@@ -2312,18 +2410,13 @@ function inferGranularity(date) {
 }
 
 // src/accessibility/alt-text.ts
-var CHART_TYPE_NAMES = {
-  line: "Line chart",
-  area: "Area chart",
-  bar: "Bar chart",
-  column: "Column chart",
-  pie: "Pie chart",
-  donut: "Donut chart",
-  dot: "Dot plot",
-  scatter: "Scatter plot"
-};
 function generateAltText(spec, data) {
-  const chartName = CHART_TYPE_NAMES[spec.type] ?? `${spec.type} chart`;
+  const markType = resolveMarkType(spec.mark);
+  const markDef = resolveMarkDef(spec.mark);
+  let chartName = MARK_DISPLAY_NAMES[markType] ?? `${markType} chart`;
+  if (markType === "arc" && markDef.innerRadius && markDef.innerRadius > 0) {
+    chartName = "Donut chart";
+  }
   const parts = [chartName];
   const title = spec.chrome?.title;
   if (title) {
@@ -2351,7 +2444,7 @@ function generateAltText(spec, data) {
       }
     }
   }
-  if (spec.encoding.color && data.length > 0) {
+  if (spec.encoding.color && "field" in spec.encoding.color && data.length > 0) {
     const colorField = spec.encoding.color.field;
     const uniqueSeries = [...new Set(data.map((d) => String(d[colorField])).filter(Boolean))];
     if (uniqueSeries.length > 0) {
@@ -2366,8 +2459,8 @@ function generateDataTable(spec, data) {
   const encoding = spec.encoding;
   if (encoding.x) fields.push(encoding.x.field);
   if (encoding.y) fields.push(encoding.y.field);
-  if (encoding.color) fields.push(encoding.color.field);
-  if (encoding.size) fields.push(encoding.size.field);
+  if (encoding.color && "field" in encoding.color) fields.push(encoding.color.field);
+  if (encoding.size && "field" in encoding.size) fields.push(encoding.size.field);
   const uniqueFields = [...new Set(fields)];
   if (uniqueFields.length === 0) return [];
   const headers = uniqueFields;
@@ -2468,8 +2561,8 @@ function buildEncoding(channels, options, data) {
   }
   return encoding;
 }
-function buildChartSpec(type, data, encoding, options) {
-  const spec = { type, data, encoding };
+function buildChartSpec(mark, data, encoding, options) {
+  const spec = { mark, data, encoding };
   if (options?.chrome) spec.chrome = options.chrome;
   if (options?.annotations) spec.annotations = options.annotations;
   if (options?.responsive !== void 0) spec.responsive = options.responsive;
@@ -2493,7 +2586,7 @@ function columnChart(data, x, y, options) {
   const xChannel = resolveField(x, data);
   const yChannel = resolveField(y, data);
   const encoding = buildEncoding({ x: xChannel, y: yChannel }, options, data);
-  return buildChartSpec("column", data, encoding, options);
+  return buildChartSpec({ type: "bar" }, data, encoding, options);
 }
 function pieChart(data, category, value, options) {
   const categoryChannel = resolveField(category, data);
@@ -2505,7 +2598,7 @@ function pieChart(data, category, value, options) {
   if (options?.size && data) {
     encoding.size = resolveField(options.size, data);
   }
-  return buildChartSpec("pie", data, encoding, options);
+  return buildChartSpec("arc", data, encoding, options);
 }
 function areaChart(data, x, y, options) {
   const xChannel = resolveField(x, data);
@@ -2523,19 +2616,19 @@ function donutChart(data, category, value, options) {
   if (options?.size && data) {
     encoding.size = resolveField(options.size, data);
   }
-  return buildChartSpec("donut", data, encoding, options);
+  return buildChartSpec({ type: "arc", innerRadius: 40 }, data, encoding, options);
 }
 function dotChart(data, x, y, options) {
   const xChannel = resolveField(x, data);
   const yChannel = resolveField(y, data);
   const encoding = buildEncoding({ x: xChannel, y: yChannel }, options, data);
-  return buildChartSpec("dot", data, encoding, options);
+  return buildChartSpec("circle", data, encoding, options);
 }
 function scatterChart(data, x, y, options) {
   const xChannel = resolveField(x, data);
   const yChannel = resolveField(y, data);
   const encoding = buildEncoding({ x: xChannel, y: yChannel }, options, data);
-  return buildChartSpec("scatter", data, encoding, options);
+  return buildChartSpec("point", data, encoding, options);
 }
 function dataTable(data, options) {
   let columns = options?.columns;
@@ -2574,6 +2667,9 @@ export {
   DEFAULT_THEME,
   DIVERGING_PALETTES,
   GRAPH_ENCODING_RULES,
+  MARK_DISPLAY_NAMES,
+  MARK_ENCODING_RULES,
+  MARK_TYPES,
   SEQUENTIAL_PALETTES,
   abbreviateNumber,
   adaptColorForDarkMode,
@@ -2602,7 +2698,10 @@ export {
   getLayoutStrategy,
   inferFieldType,
   isChartSpec,
+  isConditionalDef,
+  isEncodingChannel,
   isGraphSpec,
+  isLayerSpec,
   isRangeAnnotation,
   isRefLineAnnotation,
   isTableSpec,
@@ -2611,6 +2710,8 @@ export {
   meetsAA,
   pieChart,
   resolveCollisions,
+  resolveMarkDef,
+  resolveMarkType,
   resolveTheme,
   scatterChart,
   simulateColorBlindness