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

package/src/theme/defaults.ts

@@ -1,110 +0,0 @@
-/**
- * Default theme definition.
- *
- * Editorial design system with cyan-led categorical palette, Inter
- * Variable typography (weights 450/550/590/700), and zinc-based achromatic
- * surfaces. Light is the default surface; dark adaptation lives in
- * dark-mode.ts.
- *
- * resolveTheme() deep-merges user overrides onto this base.
- */
-
-import { CATEGORICAL_PALETTE, DIVERGING_PALETTES, SEQUENTIAL_PALETTES } from '../colors/palettes';
-import { X_AXIS_BAND_HEIGHT } from '../responsive/metrics';
-import type { Theme } from '../types/theme';
-
-/**
- * The default theme. All fields are required and fully specified.
- */
-export const DEFAULT_THEME: Theme = {
-  colors: {
-    categorical: [...CATEGORICAL_PALETTE],
-    sequential: SEQUENTIAL_PALETTES,
-    diverging: DIVERGING_PALETTES,
-    background: 'transparent',
-    text: '#09090b',
-    gridline: 'rgba(0,0,0,0.1)',
-    // Used for axis lines/ticks AND axis tick label fill. Must clear WCAG AA
-    // contrast (4.5:1) on white because tick labels are rendered with this
-    // color. Zinc-500 hits ~5.7:1.
-    axis: '#71717a',
-    annotationFill: 'rgba(0,0,0,0.04)',
-    annotationText: '#71717a',
-    positive: '#16a34a',
-    negative: '#dc2626',
-  },
-  fonts: {
-    family:
-      '"Inter Variable", Inter, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, sans-serif',
-    mono: '"JetBrains Mono", "Fira Code", "Cascadia Code", monospace',
-    sizes: {
-      title: 26,
-      subtitle: 14,
-      body: 13,
-      small: 11,
-      axisTick: 11,
-      metricLabel: 10,
-      metricValue: 22,
-    },
-    weights: {
-      normal: 450,
-      medium: 550,
-      semibold: 590,
-      bold: 700,
-    },
-  },
-  spacing: {
-    padding: 20,
-    chromeGap: 4,
-    chromeToChart: 8,
-    chartToFooter: 8,
-    axisMargin: 6,
-    xAxisHeight: X_AXIS_BAND_HEIGHT,
-    // Gap (px) between the x-axis line and the TOP of the tick labels. The
-    // renderer treats this as a literal top gap and then shifts the label down
-    // by textAscent() to land it on the alphabetic baseline (rather than
-    // dominant-baseline:hanging, which WebKit positions from different metrics),
-    // so the gap holds regardless of font size.
-    xAxisLabelPadding: 4,
-  },
-  borderRadius: 2,
-  chrome: {
-    eyebrow: {
-      fontSize: 11,
-      fontWeight: 510,
-      color: '#06b6d4',
-      lineHeight: 1.4,
-    },
-    title: {
-      fontSize: 26,
-      fontWeight: 590,
-      color: '#09090b',
-      lineHeight: 1.15,
-    },
-    subtitle: {
-      fontSize: 14,
-      fontWeight: 400,
-      color: '#71717a',
-      lineHeight: 1.45,
-    },
-    source: {
-      fontSize: 11,
-      fontWeight: 400,
-      color: '#71717a',
-      lineHeight: 1.4,
-    },
-    byline: {
-      fontSize: 11,
-      fontWeight: 400,
-      color: '#71717a',
-      lineHeight: 1.4,
-    },
-    footer: {
-      fontSize: 11,
-      fontWeight: 400,
-      color: '#71717a',
-      lineHeight: 1.4,
-    },
-  },
-  seriesStrategy: 'palette',
-};

package/src/theme/index.ts

@@ -1,8 +0,0 @@
-/**
- * Theme module barrel export.
- */
-
-export { adaptColorForDarkMode, adaptForLightLineStroke, adaptTheme } from './dark-mode';
-export { DEFAULT_THEME } from './defaults';
-export { editorial, essay, wire } from './presets';
-export { resolveTheme } from './resolve';

package/src/theme/presets.ts

@@ -1,64 +0,0 @@
-/**
- * Named theme presets built on the design token system.
- *
- * Each preset is a ThemeConfig object that can be passed to createChart()
- * or the React/Svelte/Vue Chart component. The engine deep-merges them
- * onto DEFAULT_THEME, so only the deltas are specified here.
- */
-
-import type { ThemeConfig } from '../types/spec';
-
-/** Editorial preset: the current default look. Exported for explicit selection. */
-export const editorial: ThemeConfig = {};
-
-/** Essay preset: serif display titles, warmer background, generous spacing. */
-export const essay: ThemeConfig = {
-  colors: {
-    background: { light: '#faf8f5', dark: '#1a1816' },
-    text: { light: '#1c1917', dark: '#e7e5e4' },
-    gridline: { light: 'rgba(0,0,0,0.08)', dark: 'rgba(255,255,255,0.06)' },
-    axis: { light: '#78716c', dark: '#a8a29e' },
-  },
-  fonts: {
-    family: '"Source Serif 4", "Source Serif Pro", Georgia, "Times New Roman", serif',
-    sizes: { title: 28, subtitle: 15, body: 14, small: 12 },
-    weights: { normal: 400, medium: 500, semibold: 600, bold: 700 },
-  },
-  spacing: {
-    padding: 24,
-    chromeGap: 6,
-    chromeToChart: 12,
-    chartToFooter: 12,
-  },
-  chrome: {
-    title: { fontWeight: 600, lineHeight: 1.2 },
-    subtitle: { fontWeight: 400, lineHeight: 1.5 },
-  },
-  borderRadius: 0,
-};
-
-/** Wire preset: dense, mono numerals, tighter chrome. Dashboard/agency feel. */
-export const wire: ThemeConfig = {
-  colors: {
-    background: { light: '#ffffff', dark: '#0a0a0a' },
-    text: { light: '#171717', dark: '#ededed' },
-    gridline: { light: 'rgba(0,0,0,0.06)', dark: 'rgba(255,255,255,0.06)' },
-    axis: { light: '#737373', dark: '#a3a3a3' },
-  },
-  fonts: {
-    family: '"JetBrains Mono", "Fira Code", "Cascadia Code", monospace',
-    sizes: { title: 16, subtitle: 12, body: 11, small: 10, axisTick: 10 },
-    weights: { normal: 400, medium: 500, semibold: 600, bold: 700 },
-  },
-  spacing: {
-    padding: 12,
-    chromeGap: 2,
-    chromeToChart: 4,
-    chartToFooter: 4,
-  },
-  chrome: {
-    title: { fontWeight: 600, lineHeight: 1.25 },
-    subtitle: { fontWeight: 400, lineHeight: 1.3 },
-  },
-  borderRadius: 2,
-};

package/src/theme/resolve.ts

@@ -1,312 +0,0 @@
-/**
- * Theme resolver: deep-merges user overrides onto default theme.
- *
- * Produces a ResolvedTheme where every property is guaranteed to have
- * a value. The engine uses ResolvedTheme internally so it never needs
- * null checks on theme properties.
- *
- * Auto-detects dark backgrounds and adapts chrome text colors so
- * custom themes with dark canvases are readable without explicitly
- * enabling darkMode.
- */
-
-import type { ChromeThemeOverride, ThemeConfig } from '../types/spec';
-import type { ChromeDefaults, ResolvedTheme, Theme, TokenValue } from '../types/theme';
-import { DEFAULT_THEME } from './defaults';
-
-/**
- * Deep merge source into target, creating a new object.
- * Only merges plain objects; arrays and primitives replace directly.
- */
-// biome-ignore lint/suspicious/noExplicitAny: recursive object merge requires dynamic typing
-function deepMerge(target: any, source: any): any {
-  const result = { ...target };
-
-  for (const key of Object.keys(source)) {
-    const sourceVal = source[key];
-    const targetVal = target[key];
-
-    if (
-      sourceVal !== undefined &&
-      sourceVal !== null &&
-      typeof sourceVal === 'object' &&
-      !Array.isArray(sourceVal) &&
-      typeof targetVal === 'object' &&
-      targetVal !== null &&
-      !Array.isArray(targetVal)
-    ) {
-      result[key] = deepMerge(targetVal, sourceVal);
-    } else if (sourceVal !== undefined) {
-      result[key] = sourceVal;
-    }
-  }
-
-  return result;
-}
-
-/** Extract the light-mode string from a TokenValue. */
-function resolveTokenLight(v: TokenValue): string {
-  return typeof v === 'string' ? v : v.light;
-}
-
-/**
- * Convert a user-facing ThemeConfig (partial) into the full Theme shape
- * that deepMerge can work with.
- */
-function themeConfigToPartial(config: ThemeConfig): Partial<Theme> {
-  const partial: Partial<Theme> = {};
-
-  if (config.colors) {
-    const colors: Partial<Theme['colors']> = {};
-    // Shorthand: flat string[] is treated as categorical palette
-    if (Array.isArray(config.colors)) {
-      colors.categorical = config.colors;
-    } else {
-      if (config.colors.categorical) colors.categorical = config.colors.categorical;
-      if (config.colors.sequential) colors.sequential = config.colors.sequential;
-      if (config.colors.diverging) colors.diverging = config.colors.diverging;
-      if (config.colors.background) colors.background = resolveTokenLight(config.colors.background);
-      if (config.colors.text) colors.text = resolveTokenLight(config.colors.text);
-      if (config.colors.gridline) colors.gridline = resolveTokenLight(config.colors.gridline);
-      if (config.colors.axis) colors.axis = resolveTokenLight(config.colors.axis);
-      if (config.colors.annotationFill)
-        colors.annotationFill = resolveTokenLight(config.colors.annotationFill);
-      if (config.colors.annotationText)
-        colors.annotationText = resolveTokenLight(config.colors.annotationText);
-      if (config.colors.positive) colors.positive = resolveTokenLight(config.colors.positive);
-      if (config.colors.negative) colors.negative = resolveTokenLight(config.colors.negative);
-    }
-    partial.colors = colors as Theme['colors'];
-  }
-
-  if (config.fonts) {
-    const fonts: Partial<Theme['fonts']> = {};
-    if (config.fonts.family) fonts.family = config.fonts.family;
-    if (config.fonts.mono) fonts.mono = config.fonts.mono;
-    if (config.fonts.sizes) fonts.sizes = config.fonts.sizes as Theme['fonts']['sizes'];
-    if (config.fonts.weights) fonts.weights = config.fonts.weights as Theme['fonts']['weights'];
-    partial.fonts = fonts as Theme['fonts'];
-  }
-
-  if (config.spacing) {
-    const spacing: Partial<Theme['spacing']> = {};
-    if (config.spacing.padding !== undefined) spacing.padding = config.spacing.padding;
-    if (config.spacing.chromeGap !== undefined) spacing.chromeGap = config.spacing.chromeGap;
-    if (config.spacing.chromeToChart !== undefined)
-      spacing.chromeToChart = config.spacing.chromeToChart;
-    if (config.spacing.chartToFooter !== undefined)
-      spacing.chartToFooter = config.spacing.chartToFooter;
-    if (config.spacing.axisMargin !== undefined) spacing.axisMargin = config.spacing.axisMargin;
-    if (config.spacing.xAxisHeight !== undefined) spacing.xAxisHeight = config.spacing.xAxisHeight;
-    if (config.spacing.xAxisLabelPadding !== undefined)
-      spacing.xAxisLabelPadding = config.spacing.xAxisLabelPadding;
-    partial.spacing = spacing as Theme['spacing'];
-  }
-
-  if (config.borderRadius !== undefined) {
-    partial.borderRadius = config.borderRadius;
-  }
-
-  if (config.chrome) {
-    const chrome: Record<string, Partial<ChromeDefaults>> = {};
-    for (const [element, value] of Object.entries(config.chrome)) {
-      if (value === undefined) continue;
-      if (typeof value === 'string') {
-        chrome[element] = { color: value };
-      } else {
-        const override: Partial<ChromeDefaults> = {};
-        const obj = value as ChromeThemeOverride;
-        if (obj.color !== undefined) override.color = resolveTokenLight(obj.color);
-        if (obj.fontSize !== undefined) override.fontSize = obj.fontSize;
-        if (obj.fontWeight !== undefined) override.fontWeight = obj.fontWeight;
-        if (obj.lineHeight !== undefined) override.lineHeight = obj.lineHeight;
-        chrome[element] = override;
-      }
-    }
-    partial.chrome = chrome as unknown as Theme['chrome'];
-  }
-
-  if (config.seriesStrategy) {
-    partial.seriesStrategy = config.seriesStrategy;
-  }
-
-  return partial;
-}
-
-/**
- * Collect TokenValue pairs from the user's ThemeConfig so adaptTheme()
- * can use explicit dark values instead of algorithmic adaptation.
- */
-function collectTokenPairs(
-  config: ThemeConfig,
-): Record<string, { light: string; dark: string }> | undefined {
-  const pairs: Record<string, { light: string; dark: string }> = {};
-  if (config.colors && !Array.isArray(config.colors)) {
-    const colorFields = [
-      'background',
-      'text',
-      'gridline',
-      'axis',
-      'annotationFill',
-      'annotationText',
-      'positive',
-      'negative',
-    ] as const;
-    for (const field of colorFields) {
-      const v = config.colors[field];
-      if (v && typeof v === 'object' && 'light' in v) {
-        pairs[`colors.${field}`] = v;
-      }
-    }
-  }
-  if (config.chrome) {
-    for (const [element, value] of Object.entries(config.chrome)) {
-      if (
-        value &&
-        typeof value === 'object' &&
-        'color' in value &&
-        value.color &&
-        typeof value.color === 'object' &&
-        'light' in value.color
-      ) {
-        pairs[`chrome.${element}.color`] = value.color;
-      }
-    }
-  }
-  return Object.keys(pairs).length > 0 ? pairs : undefined;
-}
-
-/**
- * Parse a hex color to sRGB relative luminance (WCAG 2.1).
- * Returns 0 for invalid/unparseable colors.
- */
-function relativeLuminance(hex: string): number {
-  const m = /^#?([0-9a-f]{6})$/i.exec(hex.trim());
-  if (!m) return 0;
-  const r = parseInt(m[1].slice(0, 2), 16) / 255;
-  const g = parseInt(m[1].slice(2, 4), 16) / 255;
-  const b = parseInt(m[1].slice(4, 6), 16) / 255;
-  const toLinear = (c: number) => (c <= 0.03928 ? c / 12.92 : ((c + 0.055) / 1.055) ** 2.4);
-  return 0.2126 * toLinear(r) + 0.7152 * toLinear(g) + 0.0722 * toLinear(b);
-}
-
-/** Returns true if the hex color is perceptually dark (luminance < 0.2). */
-function isDarkBackground(hex: string): boolean {
-  // Transparent has no intrinsic luminance — don't treat it as dark so
-  // light-mode chrome text defaults don't get inverted.
-  if (hex === 'transparent') return false;
-  return relativeLuminance(hex) < 0.2;
-}
-
-/**
- * Adapt chrome text colors for a dark background.
- * Only overrides values that still match the light-mode defaults,
- * so explicit user overrides are preserved.
- */
-function adaptChromeForDarkBg(theme: Theme, textColor: string): Theme {
-  const light = DEFAULT_THEME.chrome;
-  return {
-    ...theme,
-    chrome: {
-      // Eyebrow keeps its accent tint regardless of surface mode.
-      eyebrow: theme.chrome.eyebrow,
-      title: {
-        ...theme.chrome.title,
-        color:
-          theme.chrome.title.color === light.title.color ? textColor : theme.chrome.title.color,
-      },
-      subtitle: {
-        ...theme.chrome.subtitle,
-        color:
-          theme.chrome.subtitle.color === light.subtitle.color
-            ? adjustOpacity(textColor, 0.7)
-            : theme.chrome.subtitle.color,
-      },
-      source: {
-        ...theme.chrome.source,
-        color:
-          theme.chrome.source.color === light.source.color
-            ? adjustOpacity(textColor, 0.5)
-            : theme.chrome.source.color,
-      },
-      byline: {
-        ...theme.chrome.byline,
-        color:
-          theme.chrome.byline.color === light.byline.color
-            ? adjustOpacity(textColor, 0.5)
-            : theme.chrome.byline.color,
-      },
-      footer: {
-        ...theme.chrome.footer,
-        color:
-          theme.chrome.footer.color === light.footer.color
-            ? adjustOpacity(textColor, 0.5)
-            : theme.chrome.footer.color,
-      },
-    },
-  };
-}
-
-/** Blend a hex color toward white/black by a factor to simulate opacity. */
-function adjustOpacity(hex: string, opacity: number): string {
-  const m = /^#?([0-9a-f]{6})$/i.exec(hex.trim());
-  if (!m) return hex;
-  const r = parseInt(m[1].slice(0, 2), 16);
-  const g = parseInt(m[1].slice(2, 4), 16);
-  const b = parseInt(m[1].slice(4, 6), 16);
-  // Blend toward mid-gray for muted secondary text
-  const mix = (c: number) => Math.round(c * opacity + 128 * (1 - opacity));
-  const toHex = (n: number) => n.toString(16).padStart(2, '0');
-  return `#${toHex(mix(r))}${toHex(mix(g))}${toHex(mix(b))}`;
-}
-
-/**
- * Resolve a theme by deep-merging user overrides onto a base theme.
- *
- * Auto-detects dark backgrounds: if the resolved background color is
- * perceptually dark and chrome text colors are still the light-mode
- * defaults, they're adapted for readability.
- *
- * @param userTheme - Optional partial theme overrides from the spec.
- * @param base - Base theme to merge onto. Defaults to DEFAULT_THEME.
- * @returns A ResolvedTheme with all properties guaranteed.
- */
-export function resolveTheme(userTheme?: ThemeConfig, base: Theme = DEFAULT_THEME): ResolvedTheme {
-  let merged: Theme = userTheme ? deepMerge(base, themeConfigToPartial(userTheme)) : { ...base };
-
-  // Propagate fonts.sizes overrides onto the chrome element fontSizes.
-  // The chrome defaults hard-code fontSize independently from fonts.sizes,
-  // so we sync them here after merging so a single sizes override applies everywhere.
-  if (userTheme?.fonts?.sizes) {
-    const s = userTheme.fonts.sizes;
-    merged = {
-      ...merged,
-      chrome: {
-        ...merged.chrome,
-        ...(s.title !== undefined && {
-          title: { ...merged.chrome.title, fontSize: s.title },
-        }),
-        ...(s.subtitle !== undefined && {
-          subtitle: { ...merged.chrome.subtitle, fontSize: s.subtitle },
-        }),
-        ...(s.small !== undefined && {
-          source: { ...merged.chrome.source, fontSize: s.small },
-          byline: { ...merged.chrome.byline, fontSize: s.small },
-          footer: { ...merged.chrome.footer, fontSize: s.small },
-        }),
-      },
-    };
-  }
-
-  // Auto-adapt chrome for dark backgrounds
-  const dark = isDarkBackground(merged.colors.background);
-  if (dark) {
-    merged = adaptChromeForDarkBg(merged, merged.colors.text);
-  }
-
-  return {
-    ...merged,
-    isDark: dark,
-    _tokenPairs: userTheme ? collectTokenPairs(userTheme) : undefined,
-  } as ResolvedTheme;
-}