@silverpoint/core 0.1.1 → 0.2.0

package/dist/types-D1hjElfL.d.ts

@@ -0,0 +1,719 @@
+/** A row of data. Charts reach its fields through accessors. */
+type Datum = Readonly<Record<string, unknown>>;
+/** Access to a field: key name or pure function. */
+type Accessor<T = number> = string | ((d: Datum, i: number) => T);
+/** Inking mode. `precision` amounts to using NullInker (REQ-021). */
+type InkMode = 'ink' | 'precision';
+/** Seed. A string is converted to an integer stably (REQ-003). */
+type Seed = number | string;
+/** Prepared substrates of the silverpoint ground (REQ-046). */
+type SubstrateName = 'cream' | 'green' | 'blue' | 'ochre';
+/** Active item resolved by the interaction engine (REQ-140). */
+interface ActiveItem {
+    readonly seriesKey: string;
+    readonly index: number;
+    readonly datum: Datum;
+    readonly value: number;
+    /** Coordinates in SVG space, not screen space. */
+    readonly point: Readonly<{
+        x: number;
+        y: number;
+    }>;
+}
+
+/** What a stroke is. Determines whether the Inker may touch it (REQ-022). */
+type StrokeRole = 'encoding' | 'ornament' | 'hatch';
+/** Semantic paint slot; maps to a CSS variable (API Spec §10). */
+type StrokePart = 'ink' | 'ink-secondary' | 'heighten' | 'rule' | 'grid' | 'axis';
+/**
+ * How the stylesheet paints the shape: its outline, its interior with the part colour, its
+ * interior with a hatch tile, or nothing — a toned shape whose edges other strokes draw, so the
+ * Inker hatches it and no outline covers those edges.
+ * @internal
+ */
+type StrokePaint = 'stroke' | 'fill' | 'tile' | 'none';
+/** Tonal level on the ground's ramp; 0 is no fill (Data Model §3.4). */
+type ToneLevel = 0 | 1 | 2 | 3 | 4;
+/** Stroke instruction. It carries no color: color comes from CSS (REQ-042). */
+interface Stroke {
+    /** SVG path data, already rounded to 2 decimals (REQ-002). */
+    readonly d: string;
+    readonly role: StrokeRole;
+    readonly part: StrokePart;
+    /** Relative weight, resolved against the ground's token. */
+    readonly weight?: number;
+    /** @internal Defaults to `'stroke'`. */
+    readonly paint?: StrokePaint;
+    /** @internal Dash pattern, resolved by the stylesheet. */
+    readonly dash?: 'dotted';
+    /** @internal Tonal level a closed shape asks the Inker to hatch. */
+    readonly tone?: ToneLevel;
+    /** @internal Id of the tile in `Geometry.defs` that fills this shape. */
+    readonly tile?: string;
+    /**
+     * @internal The tonal level a `weight` ground's Inker drew as line weight in place of hatching;
+     * written as `data-weight` and resolved by the stylesheet to a stroke width (REQ-028).
+     */
+    readonly tonalWeight?: Exclude<ToneLevel, 0>;
+}
+/** Kind of text a label carries; the stylesheet sets type by it. */
+type LabelKind = 'title' | 'badge' | 'value' | 'unit' | 'footer' | 'tick' | 'empty';
+interface TextLabel {
+    readonly x: number;
+    readonly y: number;
+    readonly text: string;
+    readonly kind: LabelKind;
+    /** Paint slot: `text` for primary labels, `axis` for muted ones. */
+    readonly part: 'text' | 'axis';
+    readonly anchor: 'start' | 'middle' | 'end';
+}
+/** A datum's position, as the interaction engine sees it (REQ-140). */
+interface HitArea {
+    readonly seriesKey: string;
+    readonly index: number;
+    readonly datum: Datum;
+    readonly value: number;
+    readonly x: number;
+    readonly y: number;
+    /** The item's area, when it has one — a bar, a cell, a tile. A pointer inside it wins. */
+    readonly box?: Rect;
+    /**
+     * The item's place in a grid, when the chart is one. When every item has one, the arrow keys
+     * move by column (left, right) and by row (up, down) across the whole grid (REQ-122).
+     */
+    readonly cell?: Readonly<{
+        column: number;
+        row: number;
+    }>;
+}
+/**
+ * A hatch tile shared by every shape of one tonal level (REQ-029).
+ * @internal
+ */
+interface Tile {
+    /** Scoped to the chart instance (REQ-030). */
+    readonly id: string;
+    readonly width: number;
+    readonly height: number;
+    /** Rotation of the tile in degrees. */
+    readonly angle: number;
+    readonly strokes: readonly Stroke[];
+}
+interface Rect {
+    readonly x: number;
+    readonly y: number;
+    readonly width: number;
+    readonly height: number;
+}
+/** Everything a chart needs in order to draw itself. Serializable (REQ-011). */
+interface Geometry {
+    readonly viewBox: Rect;
+    readonly strokes: readonly Stroke[];
+    readonly labels: readonly TextLabel[];
+    readonly hitAreas: readonly HitArea[];
+    /** @internal Hatch tiles referenced by strokes painted with `'tile'`. */
+    readonly defs: readonly Tile[];
+    /** @internal The drawing area; the interaction engine ignores anything outside it. */
+    readonly plot: Rect;
+}
+
+/** One step of a `hatch` ground's tonal ramp (Data Model §3.4). */
+interface HatchToneSpec {
+    readonly style: 'hachure' | 'cross-hatch';
+    readonly gap: number;
+    /** Hatch angle in degrees; cross-hatch adds the perpendicular. */
+    readonly angle: number;
+}
+/** One step of a `weight` ground's tonal ramp (Data Model §3.7, REQ-028). */
+interface WeightToneSpec {
+    readonly style: 'weight';
+    /** Stroke width of a toned shape's outline, times `--sp-stroke-width`. */
+    readonly weight: number;
+}
+/** One step of a ground's tonal ramp: a hatch under `hatch`, a line weight under `weight`. */
+type ToneSpec = HatchToneSpec | WeightToneSpec;
+type TonalRamp = Readonly<Record<Exclude<ToneLevel, 0>, ToneSpec>>;
+interface InkOptions {
+    readonly seed: number;
+    readonly roughness: number;
+    readonly bowing: number;
+    readonly hatchAngle: number;
+    readonly hatchGap: number;
+    readonly fillWeight: number;
+    /** Upper bound of nodes the Inker must not exceed. */
+    readonly nodeBudget: number;
+    /** @internal `tile` shares one hatch tile per tonal level (REQ-029). */
+    readonly hatchFill?: 'tile' | 'per-shape';
+    /** @internal The ground's tonal ramp. */
+    readonly tonalRamp?: TonalRamp;
+    /** @internal Prefix that scopes generated ids to the chart instance (REQ-030). */
+    readonly scope?: string;
+}
+interface Inker {
+    readonly name: string;
+    /** Receives exact geometry and returns the inked geometry. */
+    ink(geometry: Geometry, options: InkOptions): Geometry;
+}
+
+/** Name of a registered ground. */
+type GroundName = 'silverpoint' | (string & {});
+/** Declarative token set of a style ground (API Spec §6, Art. 7). */
+interface Ground {
+    readonly name: string;
+    /** How it builds tonal value. `wash` is the anticipated exception to Art. 6. */
+    readonly tonalMechanism: 'hatch' | 'weight' | 'wash';
+    /** Name of the registered Inker that inks it. */
+    readonly inker: string;
+    readonly substrates: Readonly<Record<string, string>>;
+    readonly ink: Readonly<{
+        primary: string;
+        secondary: string;
+        heighten: string;
+        rule: string;
+        grid: string;
+        text: string;
+        textMuted: string;
+    }>;
+    readonly inkOptions: Omit<InkOptions, 'seed' | 'nodeBudget' | 'hatchFill' | 'tonalRamp' | 'scope'>;
+    /** Hatch density bound, to stay within the node budget. */
+    readonly maxHatchDensity: number;
+    /** Tonal levels 1-4 (Data Model §3.4). */
+    readonly tonalRamp: TonalRamp;
+    readonly typography: Readonly<{
+        display: string;
+        scale: number;
+    }>;
+    /** What to draw when there is no data (REQ-007). */
+    readonly emptyState: Readonly<{
+        text: string;
+        rule: boolean;
+    }>;
+    /** Expansion of degenerate domains (REQ-010). */
+    readonly domainPadding: number;
+}
+/** Name of a registered ground, or a complete ground. */
+type GroundRef = GroundName | Ground;
+
+/** Props present in every chart, identical in React and Angular (REQ-094). */
+interface CommonChartProps {
+    /**
+     * Rows to draw. If omitted, the demo dataset is rendered (REQ-093): accessor props (`…Key`,
+     * `keys`, `names`) are ignored, every other prop applies.
+     */
+    data?: readonly Datum[];
+    /** Style ground. Defaults to the app provider's, or `silverpoint`. */
+    ground?: GroundRef;
+    /** Prepared substrate within the ground (REQ-046). */
+    substrate?: SubstrateName;
+    /** `ink` by default; `precision` disables inking (REQ-021). */
+    mode?: InkMode;
+    /** Seed. If omitted, it is derived from `id` stably (REQ-003). */
+    seed?: Seed;
+    /** Stable identifier. If omitted, it is generated deterministically. */
+    id?: string;
+    /** Height of the drawing area in px. Width is the container's unless pinned. */
+    height?: number;
+    width?: number;
+    /** `card` draws the full frame; `bare` only the drawing area (REQ-095). */
+    chrome?: 'card' | 'bare';
+    /** How areas are filled (REQ-029). */
+    hatchFill?: 'tile' | 'per-shape';
+    title?: string;
+    badge?: string;
+    value?: string | number;
+    unit?: string;
+    footerLeft?: string;
+    footerRight?: string;
+    /** Accessible name. If omitted, it is derived from `title` (REQ-120). */
+    label?: string;
+    /** Long description for screen readers (REQ-120). */
+    description?: string;
+    /** Tabular alternative; `hidden` leaves it for assistive technology only (REQ-121). */
+    dataTable?: 'visible' | 'hidden' | 'none';
+    locale?: string;
+    numberFormat?: Intl.NumberFormatOptions;
+    className?: string;
+}
+type LineCurve = 'monotone' | 'linear' | 'natural' | 'step';
+/** `LineChart` (REQ-060): spline with an optional dotted baseline series. */
+interface LineChartProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    xKey?: Accessor<string | number>;
+    /** Ignored without `data`. */
+    valueKey?: Accessor<number | null | undefined>;
+    /** Ignored without `data`. */
+    secondaryKey?: Accessor<number | null | undefined>;
+    curve?: LineCurve;
+    /** `all` draws the secondary series when there is one; `primary` omits it. */
+    series?: 'all' | 'primary';
+    /** Whether a gap left by a missing value is bridged (REQ-008). */
+    connectNulls?: boolean;
+}
+/** Configuration an application sets once for every chart (API Spec §8). */
+interface ProviderConfig {
+    ground?: GroundRef;
+    substrate?: SubstrateName;
+    mode?: InkMode;
+    locale?: string;
+}
+/** `BulletChart` (REQ-069): one bar per target, with a marker at the target. Values in 0-100. */
+interface BulletChartProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    titleKey?: Accessor<string>;
+    /** Ignored without `data`. */
+    actualKey?: Accessor<number | null | undefined>;
+    /** Ignored without `data`. */
+    targetKey?: Accessor<number | null | undefined>;
+}
+/** `PyramidChart` (REQ-070): stacked tiers whose width encodes the value (0-100). */
+interface PyramidChartProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    labelKey?: Accessor<string>;
+    /** Ignored without `data`. */
+    widthKey?: Accessor<number | null | undefined>;
+    /** Ignored without `data`. */
+    toneKey?: Accessor<number | null | undefined>;
+}
+/** `HeatmapChart` (REQ-084): labelled rows of values, normalised against `scaleMax`. */
+interface HeatmapChartProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    labelKey?: Accessor<string>;
+    /** Ignored without `data`. */
+    valuesKey?: Accessor<readonly (number | null)[] | null | undefined>;
+    /** Value that maps to the darkest tone; 100 by default. */
+    scaleMax?: number;
+    /** Names of the columns, in order; missing ones fall back to `#k` (delta-006). */
+    columnLabels?: readonly string[];
+}
+/** `TreemapChart` (REQ-085): tiles of `cols × rows` cells placed in a `columns × rows` grid. */
+interface TreemapChartProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    labelKey?: Accessor<string>;
+    /** Ignored without `data`. */
+    shareKey?: Accessor<number | null | undefined>;
+    columns?: number;
+    rows?: number;
+}
+/** `SankeyChart` (REQ-086): flow bands between layered nodes. */
+interface SankeyChartProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    sourceKey?: Accessor<string>;
+    /** Ignored without `data`. */
+    targetKey?: Accessor<string>;
+    /** Ignored without `data`. */
+    valueKey?: Accessor<number | null | undefined>;
+}
+/** `ActivityGrid` (REQ-087): one cell per day, a column per week. */
+interface ActivityGridProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    dateKey?: Accessor<string>;
+    /** Ignored without `data`. */
+    countKey?: Accessor<number | null | undefined>;
+    /** Ignored without `data`. */
+    levelKey?: Accessor<number | null | undefined>;
+    /** Weeks shown, the most recent last; 26 by default. */
+    weeks?: number;
+}
+/** `StepChart` (REQ-061): a series drawn as steps. */
+interface StepChartProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    xKey?: Accessor<string | number>;
+    /** Ignored without `data`. */
+    valueKey?: Accessor<number | null | undefined>;
+    /** Where the step sits between two points; `after` by default. */
+    step?: 'after' | 'before' | 'middle';
+}
+/** `SparklineRows` (REQ-062): one row per series — name, sparkline, readout (delta-008). */
+interface SparklineRowsProps extends CommonChartProps {
+    /** Rows shown, from the first; all by default. */
+    rows?: number;
+    /** Ignored without `data`. */
+    nameKey?: Accessor<string>;
+    /** The printed readout; the last value of the series by default. Ignored without `data`. */
+    readoutKey?: Accessor<string | number | null | undefined>;
+    /** The row's points: an array. Ignored without `data`. */
+    seriesKey?: Accessor<readonly unknown[] | null | undefined>;
+    /** The value of one point; the point itself when it is a number, else its `value`. Ignored without `data`. */
+    pointKey?: Accessor<number | null | undefined>;
+}
+/** `KpiCard` (REQ-063): a metric, its delta, and an area sparkline of the series. */
+interface KpiCardProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    valueKey?: Accessor<number | null | undefined>;
+    /** The metric's name, printed under the figure. */
+    metric?: string;
+    /** Signed change, printed with its sign and a direction mark. */
+    delta?: number;
+    /** Direction of the mark; from the sign of `delta` by default. */
+    deltaTone?: 'up' | 'down' | 'flat';
+}
+/** `BarChart` (REQ-064): pill bars, as columns or rows, with an optional second series. */
+interface BarChartProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    xKey?: Accessor<string | number>;
+    /** Ignored without `data`. */
+    valueKey?: Accessor<number | null | undefined>;
+    /** Ignored without `data`. */
+    secondaryKey?: Accessor<number | null | undefined>;
+    orientation?: 'columns' | 'rows';
+}
+/** `StackedBarChart` (REQ-065): one stacked segment per key. */
+interface StackedBarChartProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    xKey?: Accessor<string | number>;
+    /** Ignored without `data`. */
+    keys?: readonly string[];
+    /** Display names of the keys, in order; the keys themselves by default. Ignored without `data`. */
+    names?: readonly string[];
+}
+/** `ComposedChart` (REQ-066): columns and a spline on one value scale. */
+interface ComposedChartProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    xKey?: Accessor<string | number>;
+    /** Ignored without `data`. */
+    barKey?: Accessor<number | null | undefined>;
+    /** Ignored without `data`. */
+    lineKey?: Accessor<number | null | undefined>;
+    showLine?: boolean;
+}
+/** `WaterfallChart` (REQ-067): totals from zero and floating deltas from the running total. */
+interface WaterfallChartProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    stepKey?: Accessor<string>;
+    /** An absolute total: the bar starts at zero and resets the running total. Ignored without `data`. */
+    baseKey?: Accessor<number | null | undefined>;
+    /** A change from the running total. Ignored without `data`. */
+    deltaKey?: Accessor<number | null | undefined>;
+}
+/** `FunnelChart` (REQ-068): horizontal, centred stages. */
+interface FunnelChartProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    stageKey?: Accessor<string>;
+    /** Ignored without `data`. */
+    valueKey?: Accessor<number | null | undefined>;
+}
+/** `CandlestickChart` (REQ-071): OHLC bodies and wicks (Data Model §2.6). */
+interface CandlestickChartProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    timeKey?: Accessor<string | number>;
+    /** Ignored without `data`. */
+    openKey?: Accessor<number | null | undefined>;
+    /** Ignored without `data`. */
+    highKey?: Accessor<number | null | undefined>;
+    /** Ignored without `data`. */
+    lowKey?: Accessor<number | null | undefined>;
+    /** Ignored without `data`. */
+    closeKey?: Accessor<number | null | undefined>;
+    /** Price bounds of the scale; derived from the data when omitted (REQ-097). */
+    bounds?: readonly [number, number];
+}
+/** `AreaChart` (REQ-072): a curved, toned area under its line. */
+interface AreaChartProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    xKey?: Accessor<string | number>;
+    /** Ignored without `data`. */
+    valueKey?: Accessor<number | null | undefined>;
+    curve?: LineCurve;
+}
+/** `RangeBandChart` (REQ-073): the band between a low and a high series. */
+interface RangeBandChartProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    xKey?: Accessor<string | number>;
+    /** Ignored without `data`. */
+    lowKey?: Accessor<number | null | undefined>;
+    /** Ignored without `data`. */
+    highKey?: Accessor<number | null | undefined>;
+}
+/** `StreamChart` (REQ-074): two waves, overlaid or stacked. */
+interface StreamChartProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    xKey?: Accessor<string | number>;
+    /** Ignored without `data`. */
+    keys?: readonly string[];
+    stacked?: boolean;
+}
+/** `ScatterChart` (REQ-082): points on two linear scales, optionally sized. */
+interface ScatterChartProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    xKey?: Accessor<number | null | undefined>;
+    /** Ignored without `data`. */
+    yKey?: Accessor<number | null | undefined>;
+    /** Ignored without `data`. */
+    sizeKey?: Accessor<number | null | undefined>;
+    /** Marker area in px², smallest to largest; `[60, 240]` by default. */
+    sizeRange?: readonly [number, number];
+}
+/** `BubbleChart` (REQ-083): circles whose area encodes `sizeKey`. */
+interface BubbleChartProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    xKey?: Accessor<number | null | undefined>;
+    /** Ignored without `data`. */
+    yKey?: Accessor<number | null | undefined>;
+    /** Ignored without `data`. */
+    sizeKey?: Accessor<number | null | undefined>;
+    /** Circle area in px², smallest to largest; `[100, 500]` by default. */
+    sizeRange?: readonly [number, number];
+}
+/** `DonutChart` (REQ-075): sectors ∝ value around a central readout (Data Model §2.2). */
+interface DonutChartProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    nameKey?: Accessor<string | number>;
+    /** Ignored without `data`. */
+    valueKey?: Accessor<number | null | undefined>;
+    /** Printed in the centre; the total by default. */
+    centerValue?: string | number;
+    /** A line under the centre value. */
+    centerLabel?: string;
+    /** Names every sector with its share beside the ring; `true` by default. */
+    legend?: boolean;
+}
+/** `RadarChart` (REQ-076): one spoke per subject, a closed polygon of values (Data Model §2.2). */
+interface RadarChartProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    subjectKey?: Accessor<string | number>;
+    /** Ignored without `data`. */
+    valueKey?: Accessor<number | null | undefined>;
+    /** The value range along a spoke; `[0, the largest value]`, niced, by default. */
+    domain?: readonly [number, number];
+}
+/** `PolarBarChart` (REQ-077): 360° bars out from a hole, length ∝ value (Data Model §2.2). */
+interface PolarBarChartProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    nameKey?: Accessor<string | number>;
+    /** Ignored without `data`. */
+    valueKey?: Accessor<number | null | undefined>;
+}
+/** `CoxcombChart` (REQ-088): equal angles, sector **area** ∝ value (Data Model §2.2). */
+interface CoxcombChartProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    nameKey?: Accessor<string | number>;
+    /** Ignored without `data`. */
+    valueKey?: Accessor<number | null | undefined>;
+    /** Where the first sector starts, in degrees clockwise from 12 o'clock; 0 by default. */
+    startAngle?: number;
+}
+/** `RadialArcGroup` (REQ-078): concentric 180° tracks, sweep ∝ value / the largest (Data Model §2.2). */
+interface RadialArcGroupProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    nameKey?: Accessor<string | number>;
+    /** Ignored without `data`. */
+    valueKey?: Accessor<number | null | undefined>;
+}
+/** `RadialRings` (REQ-079): concentric progress rings, sweep ∝ value in 0-100 (Data Model §2.2). */
+interface RadialRingsProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    nameKey?: Accessor<string | number>;
+    /** Ignored without `data`. */
+    valueKey?: Accessor<number | null | undefined>;
+}
+/** `GaugeArc` (REQ-080): a 240° arc swept to a percent (Data Model §2.3). */
+interface GaugeArcProps extends CommonChartProps {
+    /** 0 to 100; saturated at the ends outside it. */
+    percent?: number;
+    /** Names the measure under the readout. */
+    caption?: string;
+    /** Printed in place of the percent. */
+    readout?: string;
+}
+/** `MeterChart` (REQ-081): a semicircular meter with a needle at a percent (Data Model §2.3). */
+interface MeterChartProps extends CommonChartProps {
+    /** 0 to 100; saturated at the ends outside it. */
+    percent?: number;
+    /** Names the measure under the readout. */
+    caption?: string;
+    /** Printed in place of the percent. */
+    readout?: string;
+}
+/** `WindRose` (REQ-089): observations of (bearing, speed) binned by compass sector and speed. */
+interface WindRoseProps extends CommonChartProps {
+    /** Where the wind blows from, in degrees clockwise from north. Ignored without `data`. */
+    bearingKey?: Accessor<number | null | undefined>;
+    /** The wind speed; 0 is a calm, which has no direction. Ignored without `data`. */
+    valueKey?: Accessor<number | null | undefined>;
+    /** Compass sectors: 4, 8, 16 or 32; 16 by default. */
+    sectors?: number;
+    /** Ascending speed thresholds that split each sector; `[5, 10, 15, 20]` by default. */
+    bins?: readonly number[];
+}
+/** `ChordRing` (REQ-091): directed flows between categories around a circle (Data Model §2.7). */
+interface ChordRingProps extends CommonChartProps {
+    /** Ignored without `data`. */
+    sourceKey?: Accessor<string | number>;
+    /** Ignored without `data`. */
+    targetKey?: Accessor<string | number>;
+    /** Ignored without `data`. */
+    valueKey?: Accessor<number | null | undefined>;
+    /** Categories drawn; past it the smallest merge into "Other" (`SP010`). 12 by default. */
+    maxCategories?: number;
+}
+/** `OrbitChart` (REQ-092): nested elliptical orbits with markers along them (Data Model §2.10, delta-009). */
+interface OrbitChartProps extends CommonChartProps {
+    /** Orbits shown, from the inside out; all by default. */
+    orbits?: number;
+    /** A row's markers; `'markers'` by default. Ignored without `data`. */
+    markerKey?: Accessor<readonly unknown[] | null | undefined>;
+    /** A marker's period, 0-1 over the cycle; `'period'` by default. Ignored without `data`. */
+    periodKey?: Accessor<number | null | undefined>;
+}
+/** `VolvelleChart` (REQ-090): concentric categorical rings read against one index (delta-010). */
+interface VolvelleChartProps extends CommonChartProps {
+    /** Rings shown, from the inside out; all by default. */
+    rings?: number;
+    /**
+     * The ring whose segment is brought under the index, 0-based; 0 by default. Without `data`, it
+     * addresses the demo’s rings: `Day`, `Shift`, `Team`.
+     */
+    indexRing?: number;
+    /**
+     * The segment of `indexRing` under the index; its first segment by default. Without `data`, it
+     * addresses the demo’s rings: `Day`, `Shift`, `Team`.
+     */
+    indexValue?: string;
+}
+
+/** The three container breakpoints; their widths are fixed (TD DD-014). */
+type DashboardBreakpoint = 'sm' | 'md' | 'lg';
+/** A value that may differ per breakpoint; a bare number applies to all three. */
+type PerBreakpoint<T> = T | Partial<Record<DashboardBreakpoint, T>>;
+/** Serialisable layout (REQ-201). No functions, no DOM, no chart references. */
+interface DashboardLayout {
+    /** Columns per breakpoint. Default `{ sm: 1, md: 2, lg: 4 }` (REQ-208). */
+    columns?: PerBreakpoint<number>;
+    /** Height of one row unit, in px, card chrome included. Default `240`. */
+    rowHeight?: number;
+    /** Gap between cells, in px. Default `16`. */
+    gap?: number;
+    /** Cells in reading order (REQ-203). Omitted: every child, span 1. */
+    cells?: readonly DashboardCellLayout[];
+}
+interface DashboardCellLayout {
+    /** Matches `DashboardCell`'s `cell` prop; unique within the dashboard (REQ-205). */
+    id: string;
+    /** Default `1`. Clamped to the breakpoint's columns with `SP014` (REQ-204). */
+    colSpan?: PerBreakpoint<number>;
+    /** Default `1`. */
+    rowSpan?: PerBreakpoint<number>;
+}
+/** Link on a category key across the dashboard's charts (REQ-216). */
+interface DashboardLink {
+    /** The datum field whose value is matched, e.g. `'hour'`. */
+    key: string;
+}
+/** Name is required by the type: `title` or `label` (REQ-214). */
+type DashboardName = {
+    title: string;
+    label?: string;
+} | {
+    title?: undefined;
+    label: string;
+};
+type DashboardProps = DashboardName & {
+    /** Stable identifier; seeds of unnamed charts derive from it (REQ-209). Required. */
+    id: string;
+    layout?: DashboardLayout;
+    /** Long description, exposed as the region's description (REQ-214). */
+    description?: string;
+    /** Heading level of `title`. Default `2`. */
+    headingLevel?: 2 | 3 | 4 | 5 | 6;
+    /** Width in px used for nominal cell boxes on the server and at hydration (REQ-207). Default `1200`. */
+    ssrWidth?: number;
+    /** Linked interaction (REQ-216); client entry points only. */
+    link?: DashboardLink;
+    /** Inherited by every chart inside, below the chart's own prop (REQ-212). */
+    ground?: GroundRef;
+    substrate?: SubstrateName;
+    mode?: InkMode;
+    locale?: string;
+    className?: string;
+};
+interface DashboardCellProps {
+    /** The layout cell this child fills. Omitted: next in source order, span 1. */
+    cell?: string;
+}
+/** A cell's spans at every breakpoint. */
+type ResolvedSpan = Readonly<Record<DashboardBreakpoint, {
+    readonly col: number;
+    readonly row: number;
+}>>;
+/** The layout with every default applied and every per-breakpoint value expanded (internal surface). */
+interface ResolvedLayout {
+    readonly columns: Readonly<Record<DashboardBreakpoint, number>>;
+    readonly rowHeight: number;
+    readonly gap: number;
+    /** The layout's own cells, in its order; children are matched to them by `resolveDashboard`. */
+    readonly cells: readonly {
+        readonly id: string;
+        readonly span: ResolvedSpan;
+    }[];
+}
+/** The resolved dashboard (internal surface, API Spec §2). */
+interface DashboardModel {
+    readonly id: string;
+    /** In reading order. */
+    readonly cells: readonly ResolvedCell[];
+    /** The CSS custom properties of the wrapper, e.g. `--sp-dashboard-columns-md: 2`. */
+    readonly style: Readonly<Record<string, string>>;
+}
+interface ResolvedCell {
+    /** The layout cell's id; for a child placed in source order, its source index. */
+    readonly id: string;
+    /** The child this cell holds: its index in `childCells`, so the adapter emits it here (I-11). */
+    readonly child: number;
+    /** Derived chart id: `${dashboard.id}--${cell.id}` (REQ-209). */
+    readonly chartId: string;
+    readonly span: ResolvedSpan;
+    /** Outer box at `ssrWidth`, 2 decimals (REQ-002, REQ-206). */
+    readonly nominal: {
+        readonly width: number;
+        readonly height: number;
+    };
+    /** The cell's CSS custom properties, e.g. `--sp-cell-col-lg: 2`. */
+    readonly style: Readonly<Record<string, string>>;
+}
+/**
+ * What a cell hands its chart (TD §3.3): the derived id, the nominal box and the configuration the
+ * dashboard sets. Plain data, so it crosses a React Server Components boundary as a prop.
+ */
+interface DashboardCellContext {
+    readonly chartId: string;
+    readonly box: {
+        readonly width: number;
+        readonly height: number;
+    };
+    /** Only the keys the dashboard sets; the chart's own props and then the provider come around it. */
+    readonly config: Readonly<ProviderConfig>;
+}
+/** Everything an adapter writes for a dashboard: attributes, texts and cells, all from the core (Art. 2). */
+interface DashboardView {
+    readonly model: DashboardModel;
+    readonly section: {
+        readonly className: string;
+        readonly substrate: SubstrateName;
+        /** The heading's id, when there is a title. */
+        readonly labelledby?: string;
+        readonly describedby?: string;
+        /** `aria-label`, when only `label` names the dashboard. */
+        readonly label?: string;
+        readonly style: Readonly<Record<string, string>>;
+    };
+    readonly heading?: {
+        readonly level: 2 | 3 | 4 | 5 | 6;
+        readonly id: string;
+        readonly text: string;
+    };
+    readonly description?: {
+        readonly id: string;
+        readonly text: string;
+    };
+    /** In reading order. */
+    readonly cells: readonly {
+        /** Index of the child this cell holds. */
+        readonly child: number;
+        /** The chart's title id: `aria-labelledby` of the `article` (REQ-214). */
+        readonly labelledby: string;
+        readonly style: Readonly<Record<string, string>>;
+        readonly context: DashboardCellContext;
+    }[];
+}
+
+export type { DashboardModel as $, ActiveItem as A, BulletChartProps as B, CommonChartProps as C, DashboardProps as D, AreaChartProps as E, FunnelChartProps as F, Geometry as G, HeatmapChartProps as H, InkMode as I, RangeBandChartProps as J, KpiCardProps as K, LineChartProps as L, MeterChartProps as M, StreamChartProps as N, OrbitChartProps as O, ProviderConfig as P, ScatterChartProps as Q, Rect as R, Seed as S, TextLabel as T, BubbleChartProps as U, VolvelleChartProps as V, WaterfallChartProps as W, PerBreakpoint as X, DashboardBreakpoint as Y, DashboardLayout as Z, ResolvedLayout as _, Ground as a, DashboardView as a0, DashboardCellContext as a1, Accessor as a2, DashboardCellLayout as a3, DashboardCellProps as a4, DashboardLink as a5, GroundName as a6, HatchToneSpec as a7, HitArea as a8, InkOptions as a9, LabelKind as aa, LineCurve as ab, ResolvedCell as ac, ResolvedSpan as ad, StrokePart as ae, StrokeRole as af, Tile as ag, TonalRamp as ah, ToneLevel as ai, ToneSpec as aj, WeightToneSpec as ak, Stroke as b, StrokePaint as c, Inker as d, GroundRef as e, SubstrateName as f, Datum as g, PyramidChartProps as h, TreemapChartProps as i, SankeyChartProps as j, ActivityGridProps as k, StepChartProps as l, SparklineRowsProps as m, BarChartProps as n, StackedBarChartProps as o, ComposedChartProps as p, DonutChartProps as q, RadarChartProps as r, PolarBarChartProps as s, CoxcombChartProps as t, RadialArcGroupProps as u, RadialRingsProps as v, GaugeArcProps as w, WindRoseProps as x, ChordRingProps as y, CandlestickChartProps as z };