@opendata-ai/openchart-core 8.0.0-rc.9 → 8.1.0

package/src/types/table.ts

@@ -1,108 +0,0 @@
-/**
- * Table column configuration types.
- *
- * These types define how individual columns in a TableSpec are displayed,
- * formatted, and enhanced with visual features like heatmaps, bars,
- * sparklines, images, and category colors.
- */
-
-// ---------------------------------------------------------------------------
-// Column visual feature configs
-// ---------------------------------------------------------------------------
-
-/** Heatmap coloring configuration for a table column. */
-export interface HeatmapColumnConfig {
-  /**
-   * Color palette name or array of color stops.
-   * Uses sequential palette from theme if a string name is provided.
-   */
-  palette?: string | string[];
-  /** Explicit domain [min, max] for the color scale. Auto-derived from data if omitted. */
-  domain?: [number, number];
-  /**
-   * Use a different field's values for coloring while displaying this column's values.
-   * Useful for coloring a label column based on a numeric column.
-   */
-  colorByField?: string;
-}
-
-/** Inline bar configuration for a table column. */
-export interface BarColumnConfig {
-  /** Maximum value for the bar scale. Auto-derived from data if omitted. */
-  maxValue?: number;
-  /** Bar fill color. Uses the first categorical palette color if omitted. */
-  color?: string;
-}
-
-/** Inline sparkline configuration for a table column. */
-export interface SparklineColumnConfig {
-  /** Sparkline chart type. Defaults to "line". */
-  type?: 'line' | 'bar' | 'column';
-  /** Field containing the array of values to plot. */
-  valuesField?: string;
-  /** Sparkline color. Uses the first categorical palette color if omitted. */
-  color?: string;
-}
-
-/** Image cell configuration for a table column. */
-export interface ImageColumnConfig {
-  /** Image width in pixels. Defaults to 24. */
-  width?: number;
-  /** Image height in pixels. Defaults to 24. */
-  height?: number;
-  /** Whether to apply border-radius for rounded/circular images. */
-  rounded?: boolean;
-}
-
-/** Category color mapping for a table column. Maps category values to CSS colors. */
-export type CategoryColorsConfig = Record<string, string>;
-
-// ---------------------------------------------------------------------------
-// Column config
-// ---------------------------------------------------------------------------
-
-/**
- * Configuration for a single table column.
- *
- * At minimum, `key` identifies the data field. All other properties
- * control display, sorting, formatting, and visual features.
- *
- * Only one visual feature (heatmap, bar, sparkline, image, flag, categoryColors)
- * should be active per column. If multiple are provided, the engine picks
- * the first one in this precedence order: sparkline > bar > heatmap > image > flag > categoryColors.
- */
-export interface ColumnConfig {
-  /** Data field key (must match a key in the data rows). */
-  key: string;
-  /** Display label for the column header. Defaults to the key if omitted. */
-  label?: string;
-  /** Whether this column is sortable. Defaults to true. */
-  sortable?: boolean;
-  /** Text alignment in the column. Defaults to "left" for text, "right" for numbers. */
-  align?: 'left' | 'center' | 'right';
-  /** Explicit column width (CSS value like "200px" or "20%"). Auto-sized if omitted. */
-  width?: string;
-  /**
-   * Number/date format string (d3-format or d3-time-format), or semantic
-   * keyword `'percent'` / `'currency'`. e.g. ",.0f", "%Y-%m-%d", "percent".
-   * Tables always show full precision (no compact notation).
-   */
-  format?: string;
-
-  // Visual features (pick at most one per column)
-
-  /** Heatmap: color the cell background based on numeric value. */
-  heatmap?: HeatmapColumnConfig;
-  /** Inline bar: render a proportional bar in the cell. */
-  bar?: BarColumnConfig;
-  /** Sparkline: render a mini line/bar chart in the cell. */
-  sparkline?: SparklineColumnConfig;
-  /** Image: render the cell value as an image URL. */
-  image?: ImageColumnConfig;
-  /** Flag: render the cell value as a country flag emoji or image. */
-  flag?: boolean;
-  /** Category colors: color-code the cell based on its categorical value. */
-  categoryColors?: CategoryColorsConfig;
-  /** When true, auto-assign palette colors to values not in categoryColors. Default: false. */
-  autoAssign?: boolean;
-}

package/src/types/theme.ts

@@ -1,209 +0,0 @@
-/**
- * Theme types: color palettes, typography, spacing, and chrome defaults.
- *
- * Theme is the user-facing partial config (all optional).
- * ResolvedTheme is the engine-internal fully resolved version (no optionals).
- */
-
-// ---------------------------------------------------------------------------
-// Token value (light/dark pair)
-// ---------------------------------------------------------------------------
-
-/**
- * A color token value: either a plain CSS color string, or a light/dark pair.
- * When a pair is given, the resolver picks the appropriate value based on
- * dark mode state. When a plain string is given, dark-mode adaptation
- * derives the dark value algorithmically (existing behavior).
- */
-export type TokenValue = string | { light: string; dark: string };
-
-// ---------------------------------------------------------------------------
-// Series strategy
-// ---------------------------------------------------------------------------
-
-/**
- * Series color assignment strategy.
- *
- * - `'palette'` — always assign from the full categorical palette (current
- *   default, zero visual drift).
- * - `'accent-neutral'` — assign by series count: a single series gets the
- *   accent (first categorical color) only; 2-4 series get accent for the
- *   first and neutral grays for the rest; 5+ fall back to the full palette.
- */
-export type SeriesStrategy = 'palette' | 'accent-neutral';
-
-// ---------------------------------------------------------------------------
-// Color palette types
-// ---------------------------------------------------------------------------
-
-/** Color palettes for the visualization. */
-export interface ThemeColors {
-  /** Categorical palette for nominal data. Array of CSS color strings. */
-  categorical: string[];
-  /** Sequential palettes keyed by name. Each is an array of color stops from light to dark. */
-  sequential: Record<string, string[]>;
-  /** Diverging palettes keyed by name. Each is an array of color stops with a neutral midpoint. */
-  diverging: Record<string, string[]>;
-  /** Background color for the visualization container. */
-  background: string;
-  /** Default text color. */
-  text: string;
-  /** Gridline color. */
-  gridline: string;
-  /** Axis line and tick color. */
-  axis: string;
-  /** Annotation fill color. */
-  annotationFill: string;
-  /** Annotation text color. */
-  annotationText: string;
-  /** Semantic color for positive/up-trend values (e.g. sparkline trend coloring). */
-  positive: string;
-  /** Semantic color for negative/down-trend values (e.g. sparkline trend coloring). */
-  negative: string;
-}
-
-// ---------------------------------------------------------------------------
-// Typography types
-// ---------------------------------------------------------------------------
-
-/** Font size presets for the typography scale. */
-export interface ThemeFontSizes {
-  /** Title font size in pixels. */
-  title: number;
-  /** Subtitle font size in pixels. */
-  subtitle: number;
-  /** Body/label font size in pixels. */
-  body: number;
-  /** Small text (source, footer) font size in pixels. */
-  small: number;
-  /** Axis tick label font size in pixels. */
-  axisTick: number;
-  /** KPI metric uppercase label font size in pixels. */
-  metricLabel: number;
-  /** KPI metric primary value font size in pixels. The delta and secondary
-   *  values derive from this (each ~0.55x), so scaling this scales the whole cell. */
-  metricValue: number;
-}
-
-/** Font weight presets. */
-export interface ThemeFontWeights {
-  /** Normal text weight. */
-  normal: number;
-  /** Medium text weight (subtitles). */
-  medium: number;
-  /** Semibold text weight (titles). */
-  semibold: number;
-  /** Bold text weight. */
-  bold: number;
-}
-
-/** Complete typography configuration. */
-export interface ThemeFonts {
-  /** Primary font family. */
-  family: string;
-  /** Monospace font family (for tabular numbers). */
-  mono: string;
-  /** Font sizes. */
-  sizes: ThemeFontSizes;
-  /** Font weights. */
-  weights: ThemeFontWeights;
-}
-
-// ---------------------------------------------------------------------------
-// Spacing types
-// ---------------------------------------------------------------------------
-
-/** Spacing configuration in pixels. */
-export interface ThemeSpacing {
-  /** Padding inside the visualization container (all sides). */
-  padding: number;
-  /** Gap between chrome elements (title to subtitle, subtitle to chart, etc.). */
-  chromeGap: number;
-  /** Gap between the last chrome element and the chart area. */
-  chromeToChart: number;
-  /** Gap between chart area and source/footer below. */
-  chartToFooter: number;
-  /** Internal padding within the chart area (axes margins). */
-  axisMargin: number;
-  /** Height reserved below the chart area for x-axis tick labels (and optional axis title). */
-  xAxisHeight: number;
-  /** Gap in pixels between the x-axis line and the top of non-rotated tick label text. */
-  xAxisLabelPadding: number;
-}
-
-// ---------------------------------------------------------------------------
-// Chrome default styles
-// ---------------------------------------------------------------------------
-
-/** Default style configuration for a chrome text element. */
-export interface ChromeDefaults {
-  /** Font size in pixels. */
-  fontSize: number;
-  /** Font weight. */
-  fontWeight: number;
-  /** Text color (CSS color string). */
-  color: string;
-  /** Line height multiplier. */
-  lineHeight: number;
-}
-
-/** Default chrome styles for each element type. */
-export interface ThemeChromeDefaults {
-  eyebrow: ChromeDefaults;
-  title: ChromeDefaults;
-  subtitle: ChromeDefaults;
-  source: ChromeDefaults;
-  byline: ChromeDefaults;
-  footer: ChromeDefaults;
-}
-
-// ---------------------------------------------------------------------------
-// Theme (user-facing, all optional)
-// ---------------------------------------------------------------------------
-
-/**
- * Complete theme interface. Used internally after merging user overrides
- * onto defaults. All fields are required here (this is what the engine
- * works with).
- *
- * Users provide ThemeConfig (from spec.ts) which is the partial/optional
- * version. The theme resolver deep-merges ThemeConfig onto the default Theme
- * to produce a ResolvedTheme.
- */
-export interface Theme {
-  /** Color palettes. */
-  colors: ThemeColors;
-  /** Typography settings. */
-  fonts: ThemeFonts;
-  /** Spacing values in pixels. */
-  spacing: ThemeSpacing;
-  /** Border radius for containers and tooltips. */
-  borderRadius: number;
-  /** Default chrome text styles. */
-  chrome: ThemeChromeDefaults;
-  /** Series color assignment strategy. Default: 'palette' (full categorical). */
-  seriesStrategy: SeriesStrategy;
-}
-
-/**
- * Fully resolved theme with no optional fields.
- *
- * This is the result of resolveTheme(): the default theme with user
- * overrides deep-merged in. Every property is guaranteed to have a value.
- * The engine uses ResolvedTheme internally so it never needs null checks.
- *
- * Structurally identical to Theme (both have all required fields), but
- * exists as a separate type for semantic clarity: Theme is the default
- * definition, ResolvedTheme is the runtime-resolved instance.
- */
-export interface ResolvedTheme extends Theme {
-  /** Whether dark mode adaptations have been applied to this theme. */
-  isDark: boolean;
-  /**
-   * Original light/dark token pairs from the user's ThemeConfig. Used
-   * by adaptTheme() to skip algorithmic adaptation for tokens with
-   * explicit dark values. Engine-internal, not part of the public API.
-   * @internal
-   */
-  _tokenPairs?: Record<string, { light: string; dark: string }>;
-}