@ahoo-wang/wow-view-engine 9.2.0-rc.0

package/dist/model/chart.d.ts

@@ -0,0 +1,503 @@
+/**
+ * Charts are stored per family: the sub-object of the current `type` is
+ * required and the others are kept, so switching families loses nothing.
+ * Every reference is a group or metric alias; no charting library types.
+ */
+export interface ChartSpec {
+    type: ChartType;
+    /** Shared by bar, line, area and combo. */
+    cartesian?: CartesianSpec;
+    pie?: PieSpec;
+    heatmap?: HeatmapSpec;
+    scatter?: ScatterSpec;
+    funnel?: FunnelSpec;
+    metric?: MetricCardSpec;
+    waterfall?: WaterfallSpec;
+    treemap?: TreemapSpec;
+    boxplot?: BoxplotSpec;
+    candlestick?: CandlestickSpec;
+    gauge?: GaugeSpec;
+    radar?: RadarSpec;
+    parallel?: ParallelSpec;
+    sunburst?: HierarchySpec;
+    tree?: HierarchySpec;
+    sankey?: SankeySpec;
+    calendar?: CalendarSpec;
+    themeRiver?: ThemeRiverSpec;
+    map?: MapSpec;
+    legend?: 'auto' | 'top' | 'bottom' | 'right' | 'none';
+    /**
+     * Whether the values are written on the marks. Left out, the mark
+     * decides (`valueLabelsOn`): a bar writes them — a combo's bars too — a
+     * line, an area and the other families do not; and an upright row of
+     * `PEAKS_ONLY_FROM` bars or more that stand on their own writes only its
+     * highest and lowest (`peaksOnlyLabels`). `true` writes them on every
+     * mark however many there are, and `false` writes none; either is a
+     * choice and stands. A pie writes each slice's share whatever this says,
+     * and `true` writes its value with it.
+     */
+    labels?: boolean;
+    /**
+     * The colours pinned by hand; the theme fills in the rest from its palette.
+     *
+     * A key is the series or slice as the kernel labels it: the category value
+     * of a split or a pie — a number or a boolean as text, `null` as the empty
+     * string — or, where nothing is split, the metric alias. Internal keys are
+     * never addressable, so a numeric category is named `"1"`, not `1`; nor is
+     * the text a chart shows, so an enum is named by its code rather than its
+     * label, and a pinned colour holds in every language.
+     */
+    colors?: Record<string, string>;
+}
+export type ChartType = 'bar' | 'line' | 'area' | 'combo' | 'waterfall' | 'pie' | 'treemap' | 'heatmap' | 'scatter' | 'funnel' | 'metric' | 'gauge' | 'boxplot' | 'candlestick' | 'radar' | 'parallel' | 'sunburst' | 'tree' | 'sankey' | 'calendar' | 'themeRiver' | 'map';
+/**
+ * Every type, in the order the picker lays them out: the everyday ones
+ * first, each new one beside the one it is read against — the gauge after
+ * the metric card, whose number it places on a scale; the boxplot, the
+ * radar and the parallel axes after the scatter, the other charts of
+ * several metrics per group; the sunburst and the tree after the treemap,
+ * the other parts of a whole, and the sankey beside them; the calendar
+ * after the heatmap, whose cells it lays out as days, and the theme river
+ * after the area, whose stack it lets flow; the candlestick after the
+ * boxplot, the other chart that draws several numbers of one field as one
+ * mark.
+ */
+export declare const CHART_TYPES: readonly ChartType[];
+/**
+ * The families a chart type belongs to, each the name of the sub-object of
+ * `ChartSpec` its types share: four cartesian types draw one kind of spec,
+ * every other type is a family of its own.
+ */
+export type ChartFamily = Extract<keyof ChartSpec, 'cartesian' | 'pie' | 'heatmap' | 'scatter' | 'funnel' | 'metric' | 'waterfall' | 'treemap' | 'boxplot' | 'candlestick' | 'gauge' | 'radar' | 'parallel' | 'sunburst' | 'tree' | 'sankey' | 'calendar' | 'themeRiver' | 'map'>;
+/**
+ * How many categorical colours the theme holds: `--chart-1` to `--chart-8`
+ * in `styles.css`, the same eight hues in both modes, in a fixed order.
+ *
+ * It lives here rather than beside the palette in `/ui` because the kernel
+ * shapes to it: a slot handed out twice is two categories wearing one
+ * colour, which a legend cannot tell apart, so a pie folds its tail into
+ * "Other" before a ninth slice would need a colour (`shapeChart`). A number
+ * the projection and the palette both read has to sit where both may import
+ * it, and the theme is held to the same count by a test that reads the
+ * stylesheet. A host can restyle a slot through `--fve-chart-N`; it cannot
+ * add one, so the count is the engine's and not the host's.
+ */
+export declare const CHART_COLOR_SLOTS = 8;
+/** Which sub-object each chart type requires. */
+export declare const CHART_FAMILY: Readonly<Record<ChartType, ChartFamily>>;
+export interface CartesianSeries {
+    /** Metric alias. */
+    metric: string;
+    /** Required per series when the chart type is `combo`. */
+    type?: 'bar' | 'line' | 'area';
+    axis?: 'left' | 'right';
+    /**
+     * Series sharing a stack name are stacked — bars and areas; a line draws
+     * its own values whatever it says (`stacks`).
+     */
+    stack?: string;
+    smooth?: boolean;
+}
+export interface CartesianSpec {
+    /** Group alias. */
+    x: string;
+    /** Second group alias, pivoting one metric into a series per value. */
+    splitBy?: string;
+    series: CartesianSeries[];
+    orientation?: 'vertical' | 'horizontal';
+    yAxis?: {
+        left?: AxisSpec;
+        right?: AxisSpec;
+    };
+    referenceLines?: ReferenceLine[];
+    /**
+     * What a point the rows lack draws as — a bucket missing from a time axis,
+     * a combination missing from a split. Left out or `zero`, the kernel's
+     * rule: 0 where the group is known to have had no records and the metric
+     * adds up, nothing otherwise (`absenceReader`). `gap`: nothing anywhere, a
+     * line broken where the rows are. Drawing only; the query is the same.
+     */
+    missing?: CartesianMissing;
+    /**
+     * Stacked bars or areas drawn as each category's shares of its stack, so
+     * every stack reaches 100%. Only a stack of metrics that add up has a
+     * whole to share; a line or a chart that does not stack ignores it.
+     */
+    percentStack?: boolean;
+    /**
+     * Target bands: a stretch of one value axis shaded behind the marks, from
+     * one number to another — 「目标区间」, where a value should land.
+     */
+    referenceBands?: ReferenceBand[];
+    /**
+     * Marks each drawn series' highest and lowest measured value — never a 0
+     * the kernel filled in. A series drawn inside a stack is not marked: its
+     * mark stands at the stack's height, not at its own value.
+     */
+    extremes?: boolean;
+    /**
+     * Lines computed from one drawn metric over the time axis — a trend, a
+     * moving average, a running total — drawn dashed over the marks, never
+     * stacked and in no colour slot (D33 batch B). The kernel draws one only
+     * over rows that are whole (`derivedGap`, Q53).
+     */
+    derived?: DerivedSeries[];
+}
+/**
+ * What a derived series computes: the least-squares line through the
+ * measured points (`trend`), the mean of each point and the ones before it
+ * (`moving-average`, over `window` points), the running total
+ * (`cumulative`, a metric that adds up only), and the running total as a
+ * share of the whole (`cumulative-share`, 累计占比). The two running kinds
+ * also run along a categorical axis the result is sorted by the metric on —
+ * the Pareto chart (D38).
+ */
+export declare const DERIVED_KINDS: readonly ["trend", "moving-average", "cumulative", "cumulative-share"];
+export type DerivedKind = (typeof DERIVED_KINDS)[number];
+/** The widest window a moving average takes: a year of days. */
+export declare const MAX_MOVING_WINDOW = 366;
+export interface DerivedSeries {
+    kind: DerivedKind;
+    /** The metric alias of the drawn series it is computed from. */
+    metric: string;
+    /** A moving average's points, the current one included; 2 or more. */
+    window?: number;
+}
+/** The two readings of a missing point, the default first. */
+export declare const CARTESIAN_MISSING: readonly ["zero", "gap"];
+export type CartesianMissing = (typeof CARTESIAN_MISSING)[number];
+export interface AxisSpec {
+    label?: string;
+    min?: number;
+    max?: number;
+    format?: ValueFormat;
+    /**
+     * How the axis is stepped: evenly (`linear`, the default) or by powers of
+     * ten (`log`), for numbers that span several orders of magnitude. A log
+     * axis has no place for 0 or a negative number, so over values that hold
+     * one it is drawn linear and says why (D33 batch E).
+     */
+    scale?: 'linear' | 'log';
+}
+/**
+ * A horizontal rule across the plot: at a constant `value`, or at a
+ * `statistic` of one drawn metric's measured values — its average or its
+ * median over the points drawn, a filled-in 0 left out (D33 batch B). One of
+ * the two places it; a statistic names its `metric`.
+ */
+export interface ReferenceLine {
+    axis: 'left' | 'right';
+    value?: number;
+    statistic?: ReferenceStatistic;
+    /** The metric alias a statistic is taken of. */
+    metric?: string;
+    label?: string;
+}
+/** Where a statistic reference line stands: the mean, or the middle value. */
+export declare const REFERENCE_STATISTICS: readonly ["average", "median"];
+export type ReferenceStatistic = (typeof REFERENCE_STATISTICS)[number];
+/** A stretch of one value axis, `from` below `to`, shaded behind the marks. */
+export interface ReferenceBand {
+    axis: 'left' | 'right';
+    from: number;
+    to: number;
+    label?: string;
+}
+export type ValueFormat = 'auto' | 'percent' | 'compact';
+export interface PieSpec {
+    /** Group alias. */
+    category: string;
+    /** Metric alias. */
+    value: string;
+    donut?: boolean;
+    /**
+     * Merges the remainder into "other"; additive metrics only. Left out, an
+     * additive pie still folds at `CHART_COLOR_SLOTS`, and a larger number is
+     * read as that many — past it two slices would share a colour.
+     */
+    maxSlices?: number;
+}
+export interface HeatmapSpec {
+    /** Group alias. */
+    x: string;
+    /** Another group alias. */
+    y: string;
+    /** Metric alias. */
+    value: string;
+    scale?: 'linear' | 'log';
+}
+export interface ScatterSpec {
+    /** Group alias; one point per value. */
+    category: string;
+    /** Metric aliases. */
+    x: string;
+    y: string;
+    size?: string;
+    /** Title, bounds, number format and scale of the horizontal axis. */
+    xAxis?: AxisSpec;
+    /** The same of the vertical axis. */
+    yAxis?: AxisSpec;
+}
+/**
+ * A waterfall: how a total is built up step by step. Each value of one
+ * dimension is a step — its row's number the change it brings — drawn as a
+ * bar floating from where the steps before it left the running total, up
+ * for an increase and down for a decrease; the last bar is the total the
+ * steps arrive at, from zero. The steps are added up, so only a metric that
+ * adds (a record count or a sum) has one: a running total of averages is no
+ * total of anything. It is drawn with bars, stacked on an unseen base.
+ */
+export interface WaterfallSpec {
+    /** Group alias: one step per value, in the rows' order (time runs forward). */
+    x: string;
+    /** Metric alias: each step's change. */
+    value: string;
+    /** Whether the closing bar, the steps' total, is drawn. Left out, it is. */
+    total?: boolean;
+}
+/**
+ * A treemap: a whole cut into tiles whose areas are the groups' shares of
+ * it — the reading for a composition of more categories than the palette
+ * has colours (D33 Q56), since every tile carries its own name. One
+ * dimension is one level of tiles; a second nests them, the tiles of
+ * `category` inside a block for each value of `parent`. Areas are parts of
+ * a sum, so only a metric that adds up draws one.
+ */
+export interface TreemapSpec {
+    /** Group alias: one tile per value. */
+    category: string;
+    /** Group alias of the outer level, when there are two dimensions. */
+    parent?: string;
+    /** Metric alias: a tile's area. */
+    value: string;
+}
+/**
+ * A boxplot: how a number is spread within each group — its lowest and
+ * highest value, its lower and upper quartile and its median, one box per
+ * value of one dimension. The five are five metrics of one field (its
+ * `MIN`, three `PERCENTILE`s from low to high and its `MAX`, under one
+ * condition), which Wow computes in the one query; the kernel only reads
+ * them (`fiveNumberSets`). Wow's percentiles are approximate, and the chart
+ * says so.
+ */
+export interface BoxplotSpec {
+    /** Group alias: one box per value. */
+    category: string;
+    /** Metric alias of the lowest value (the `MIN`). */
+    low: string;
+    /** Metric alias of the lower quartile (the lowest percentile). */
+    q1: string;
+    /** Metric alias of the median (the middle percentile). */
+    median: string;
+    /** Metric alias of the upper quartile (the highest percentile). */
+    q3: string;
+    /** Metric alias of the highest value (the `MAX`). */
+    high: string;
+}
+/**
+ * A candlestick (K 线): how one number moved within each period — where it
+ * opened and closed, and how high and low it went — one candle per bucket
+ * of one time dimension. The four are four metrics of one field under one
+ * condition: its `FIRST` (the open, 期初值), `MAX`, `MIN` and `LAST` (the
+ * close, 期末值), the two ends ordered by one time (N1); the kernel only
+ * reads them (`ohlcSets`). A candle is coloured by whether it closed above
+ * its open, in the host's rise/fall convention.
+ */
+export interface CandlestickSpec {
+    /** Group alias of the time dimension: one candle per bucket. */
+    x: string;
+    /** Metric alias of the opening value (the `FIRST`). */
+    open: string;
+    /** Metric alias of the highest value (the `MAX`). */
+    high: string;
+    /** Metric alias of the lowest value (the `MIN`). */
+    low: string;
+    /** Metric alias of the closing value (the `LAST`). */
+    close: string;
+}
+/**
+ * A gauge: one number placed on a scale, and how far it is from a target —
+ * 「离目标多远」 on a wall screen. The metric card says the number and how
+ * it moved; a gauge says where it stands between two ends. It groups by
+ * nothing.
+ */
+export interface GaugeSpec {
+    /** Metric alias: the needle. */
+    metric: string;
+    /** Where the number should reach, marked on the scale. */
+    target?: number;
+    /** The scale's start. Left out, 0. */
+    min?: number;
+    /**
+     * The scale's end. Left out, a round number at or past the value and the
+     * target (`gaugeScale`), so the needle never leaves the dial.
+     */
+    max?: number;
+    format?: ValueFormat;
+}
+/**
+ * A radar: several metrics per group as one closed shape, an axis per
+ * metric each on its own scale — the outline of each group against the
+ * others. Three metrics at least: two axes enclose nothing.
+ */
+export interface RadarSpec {
+    /** Group alias: one shape per value. */
+    category: string;
+    /** Metric aliases, one axis each, in the order they go round. */
+    metrics: string[];
+}
+/**
+ * Parallel coordinates: several metrics per group as one line across as
+ * many upright axes, each on its own scale — where a group stands on each,
+ * and which move together. Three metrics at least: two are a scatter.
+ */
+export interface ParallelSpec {
+    /** Group alias: one line per value. */
+    category: string;
+    /** Metric aliases, one axis each, left to right. */
+    metrics: string[];
+}
+/** The most levels a hierarchy or a flow draws: past four, rings and columns are slivers. */
+export declare const MAX_CHART_LEVELS = 4;
+/**
+ * A sunburst or a tree: a whole broken down level by level, one dimension a
+ * level, outermost first — 品类 → 子类. Every level's parts add up to their
+ * parent, so only a metric that adds up draws one; a leaf is one row, its
+ * parents the sums of their rows.
+ */
+export interface HierarchySpec {
+    /** Group aliases, outermost level first; two to `MAX_CHART_LEVELS`. */
+    levels: string[];
+    /** Metric alias: a part's size. */
+    value: string;
+}
+/**
+ * A sankey: how an amount flows from one dimension's values to the next's —
+ * 渠道 → 支付方式 — each band as wide as the metric over the rows of that
+ * pair. The bands out of a value add up to it, so only a metric that adds
+ * up draws one.
+ */
+export interface SankeySpec {
+    /** Group aliases, left to right; two to `MAX_CHART_LEVELS`. */
+    levels: string[];
+    /** Metric alias: a band's width. */
+    value: string;
+}
+/**
+ * A calendar heatmap: a number a day, laid out as the calendar lays the
+ * days out — weeks across, weekdays down, a year a block — so a season, a
+ * weekday rhythm and a single odd day are seen at once. Its one dimension
+ * is a daily date bucket.
+ */
+export interface CalendarSpec {
+    /** Alias of the one `DATE_HISTOGRAM` group, by `DAY`. */
+    date: string;
+    /** Metric alias: a day's shade. */
+    value: string;
+}
+/**
+ * A theme river: a stacked stream over time, one stream per value of a
+ * second dimension, each as wide as its number — how a whole's make-up
+ * flows. The streams add up to the river, so only a metric that adds up
+ * draws one.
+ */
+export interface ThemeRiverSpec {
+    /** Alias of the `DATE_HISTOGRAM` group the river runs along. */
+    x: string;
+    /** Alias of the other group: one stream per value. */
+    splitBy: string;
+    /** Metric alias: a stream's width. */
+    value: string;
+}
+/**
+ * A map: a number per region, each region shaded by it — 按地区看. The
+ * region dimension's values, as its column shows them, are the names of the
+ * map's areas. The package ships no map: a host registers the geography it
+ * may lawfully show (`registerChartMap` in `/ui`, D41) and names it here;
+ * left out, the first map the host registered.
+ */
+export interface MapSpec {
+    /** Group alias: one region per value. */
+    region: string;
+    /** Metric alias: a region's shade. */
+    value: string;
+    /** The registered map's name. */
+    map?: string;
+}
+/**
+ * Stages come either from one filtered metric each, or from the values of a
+ * single group with an explicit business order.
+ */
+/**
+ * A funnel: its stages in the business's order. There is no choice of what
+ * a conversion is relative to — the drawing says each stage against the one
+ * before and against the first, and the drop between them (2026-09-25).
+ */
+export interface FunnelSpec {
+    stages: FunnelStages;
+    orientation?: 'vertical' | 'horizontal';
+}
+export type FunnelStages = {
+    from: 'metrics';
+    items: {
+        metric: string;
+        label?: string;
+    }[];
+} | {
+    from: 'group';
+    category: string;
+    value: string;
+    /** Business order of the stages, taken from the group values. */
+    order: string[];
+    /**
+     * Accumulate into "reached at least this stage" — each stage plus
+     * every later one, which is right only when each object sits in
+     * exactly one stage. Defaults to false: each stage is its own rows'
+     * number, the one the table shows.
+     */
+    cumulative?: boolean;
+};
+export interface MetricCardSpec {
+    /** Metric alias. */
+    metric: string;
+    /**
+     * Another metric the headline is compared with, read over the same span
+     * as the headline: the same period's value in the `last` mode of a trend,
+     * the whole's otherwise.
+     */
+    compare?: {
+        metric: string;
+        mode: 'delta' | 'percent';
+    };
+    /**
+     * Rendered as progress towards this value — a goal for the span the
+     * headline covers: one period in the `last` mode of a trend (a daily
+     * goal over a daily trend), the whole otherwise.
+     */
+    target?: number;
+    /** Sparkline; requires exactly one DATE_HISTOGRAM group with this alias. */
+    trend?: MetricTrend;
+    format?: ValueFormat;
+    /**
+     * Whether a fall is the good direction — failures, latency, refunds — so
+     * every change the card draws is coloured the other way round: its change
+     * against the period before and its comparison (`compare`) alike.
+     */
+    lowerIsBetter?: boolean;
+}
+/** The time dimension a metric card draws as its sparkline, and how it reads. */
+export interface MetricTrend {
+    /** Alias of the one DATE_HISTOGRAM group. */
+    x: string;
+    /**
+     * What the headline is. `last`, the default: the last period that had
+     * ended when the question was asked, with its change against the period
+     * before — the reading an operator wants from a trend card. `whole`: every
+     * record in the range, from the ungrouped query (`asksForWhole`).
+     */
+    headline?: MetricHeadline;
+}
+export type MetricHeadline = 'last' | 'whole';
+/** The two readings of a trend card's headline, the default first. */
+export declare const METRIC_HEADLINES: readonly ["last", "whole"];
+//# sourceMappingURL=chart.d.ts.map

package/dist/model/chart.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chart.d.ts","sourceRoot":"","sources":["../../src/model/chart.ts"],"names":[],"mappings":"AAaA;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,SAAS,CAAC;IAChB,2CAA2C;IAC3C,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,MAAM,CAAC,EAAE,cAAc,CAAC;IACxB,SAAS,CAAC,EAAE,aAAa,CAAC;IAC1B,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,WAAW,CAAC,EAAE,eAAe,CAAC;IAC9B,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,QAAQ,CAAC,EAAE,aAAa,CAAC;IACzB,IAAI,CAAC,EAAE,aAAa,CAAC;IACrB,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,OAAO,GAAG,MAAM,CAAC;IACtD;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;;;;;;OASG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC;AAED,MAAM,MAAM,SAAS,GACjB,KAAK,GACL,MAAM,GACN,MAAM,GACN,OAAO,GACP,WAAW,GACX,KAAK,GACL,SAAS,GACT,SAAS,GACT,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,OAAO,GACP,SAAS,GACT,aAAa,GACb,OAAO,GACP,UAAU,GACV,UAAU,GACV,MAAM,GACN,QAAQ,GACR,UAAU,GACV,YAAY,GACZ,KAAK,CAAC;AAEV;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,WAAW,EAAE,SAAS,SAAS,EAuB3C,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,WAAW,GAAG,OAAO,CAC/B,MAAM,SAAS,EACb,WAAW,GACX,KAAK,GACL,SAAS,GACT,SAAS,GACT,QAAQ,GACR,QAAQ,GACR,WAAW,GACX,SAAS,GACT,SAAS,GACT,aAAa,GACb,OAAO,GACP,OAAO,GACP,UAAU,GACV,UAAU,GACV,MAAM,GACN,QAAQ,GACR,UAAU,GACV,YAAY,GACZ,KAAK,CACR,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,iBAAiB,IAAI,CAAC;AAEnC,iDAAiD;AACjD,eAAO,MAAM,YAAY,EAAE,QAAQ,CAAC,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,CAwB9D,CAAC;AAEL,MAAM,WAAW,eAAe;IAC9B,oBAAoB;IACpB,MAAM,EAAE,MAAM,CAAC;IACf,0DAA0D;IAC1D,IAAI,CAAC,EAAE,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;IAC/B,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IACxB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB;AAED,MAAM,WAAW,aAAa;IAC5B,mBAAmB;IACnB,CAAC,EAAE,MAAM,CAAC;IACV,uEAAuE;IACvE,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,eAAe,EAAE,CAAC;IAC1B,WAAW,CAAC,EAAE,UAAU,GAAG,YAAY,CAAC;IACxC,KAAK,CAAC,EAAE;QAAE,IAAI,CAAC,EAAE,QAAQ,CAAC;QAAC,KAAK,CAAC,EAAE,QAAQ,CAAA;KAAE,CAAC;IAC9C,cAAc,CAAC,EAAE,aAAa,EAAE,CAAC;IACjC;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;;OAGG;IACH,cAAc,CAAC,EAAE,aAAa,EAAE,CAAC;IACjC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,aAAa,EAAE,CAAC;CAC3B;AAED;;;;;;;;GAQG;AACH,eAAO,MAAM,aAAa,wEAKY,CAAC;AAEvC,MAAM,MAAM,WAAW,GAAG,CAAC,OAAO,aAAa,CAAC,CAAC,MAAM,CAAC,CAAC;AAEzD,gEAAgE;AAChE,eAAO,MAAM,iBAAiB,MAAM,CAAC;AAErC,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,WAAW,CAAC;IAClB,gEAAgE;IAChE,MAAM,EAAE,MAAM,CAAC;IACf,sEAAsE;IACtE,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,8DAA8D;AAC9D,eAAO,MAAM,iBAAiB,0BAGQ,CAAC;AAEvC,MAAM,MAAM,gBAAgB,GAAG,CAAC,OAAO,iBAAiB,CAAC,CAAC,MAAM,CAAC,CAAC;AAElE,MAAM,WAAW,QAAQ;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB;;;;;OAKG;IACH,KAAK,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IACvB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,kBAAkB,CAAC;IAC/B,gDAAgD;IAChD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,8EAA8E;AAC9E,eAAO,MAAM,oBAAoB,gCAGK,CAAC;AAEvC,MAAM,MAAM,kBAAkB,GAAG,CAAC,OAAO,oBAAoB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEvE,+EAA+E;AAC/E,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,WAAW,GAAG,MAAM,GAAG,SAAS,GAAG,SAAS,CAAC;AAEzD,MAAM,WAAW,OAAO;IACtB,mBAAmB;IACnB,QAAQ,EAAE,MAAM,CAAC;IACjB,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,WAAW;IAC1B,mBAAmB;IACnB,CAAC,EAAE,MAAM,CAAC;IACV,2BAA2B;IAC3B,CAAC,EAAE,MAAM,CAAC;IACV,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC;CAC1B;AAED,MAAM,WAAW,WAAW;IAC1B,wCAAwC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,sBAAsB;IACtB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qEAAqE;IACrE,KAAK,CAAC,EAAE,QAAQ,CAAC;IACjB,qCAAqC;IACrC,KAAK,CAAC,EAAE,QAAQ,CAAC;CAClB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,aAAa;IAC5B,+EAA+E;IAC/E,CAAC,EAAE,MAAM,CAAC;IACV,wCAAwC;IACxC,KAAK,EAAE,MAAM,CAAC;IACd,4EAA4E;IAC5E,KAAK,CAAC,EAAE,OAAO,CAAC;CACjB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,WAAW;IAC1B,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,qEAAqE;IACrE,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAW;IAC1B,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAC;IACjB,oDAAoD;IACpD,GAAG,EAAE,MAAM,CAAC;IACZ,kEAAkE;IAClE,EAAE,EAAE,MAAM,CAAC;IACX,0DAA0D;IAC1D,MAAM,EAAE,MAAM,CAAC;IACf,mEAAmE;IACnE,EAAE,EAAE,MAAM,CAAC;IACX,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,eAAe;IAC9B,gEAAgE;IAChE,CAAC,EAAE,MAAM,CAAC;IACV,uDAAuD;IACvD,IAAI,EAAE,MAAM,CAAC;IACb,qDAAqD;IACrD,IAAI,EAAE,MAAM,CAAC;IACb,oDAAoD;IACpD,GAAG,EAAE,MAAM,CAAC;IACZ,sDAAsD;IACtD,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS;IACxB,gCAAgC;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,0DAA0D;IAC1D,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,WAAW,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,wCAAwC;IACxC,QAAQ,EAAE,MAAM,CAAC;IACjB,iEAAiE;IACjE,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED;;;;GAIG;AACH,MAAM,WAAW,YAAY;IAC3B,uCAAuC;IACvC,QAAQ,EAAE,MAAM,CAAC;IACjB,oDAAoD;IACpD,OAAO,EAAE,MAAM,EAAE,CAAC;CACnB;AAED,6FAA6F;AAC7F,eAAO,MAAM,gBAAgB,IAAI,CAAC;AAElC;;;;;GAKG;AACH,MAAM,WAAW,aAAa;IAC5B,uEAAuE;IACvE,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,UAAU;IACzB,+DAA+D;IAC/D,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,oCAAoC;IACpC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,yDAAyD;IACzD,IAAI,EAAE,MAAM,CAAC;IACb,mCAAmC;IACnC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;GAKG;AACH,MAAM,WAAW,cAAc;IAC7B,gEAAgE;IAChE,CAAC,EAAE,MAAM,CAAC;IACV,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;IAChB,sCAAsC;IACtC,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;;;;;GAMG;AACH,MAAM,WAAW,OAAO;IACtB,yCAAyC;IACzC,MAAM,EAAE,MAAM,CAAC;IACf,sCAAsC;IACtC,KAAK,EAAE,MAAM,CAAC;IACd,iCAAiC;IACjC,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED;;;GAGG;AACH;;;;GAIG;AACH,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,YAAY,CAAC;IACrB,WAAW,CAAC,EAAE,UAAU,GAAG,YAAY,CAAC;CACzC;AAED,MAAM,MAAM,YAAY,GACpB;IAAE,IAAI,EAAE,SAAS,CAAC;IAAC,KAAK,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAA;CAAE,GAChE;IACE,IAAI,EAAE,OAAO,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,iEAAiE;IACjE,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEN,MAAM,WAAW,cAAc;IAC7B,oBAAoB;IACpB,MAAM,EAAE,MAAM,CAAC;IACf;;;;OAIG;IACH,OAAO,CAAC,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,OAAO,GAAG,SAAS,CAAA;KAAE,CAAC;IACxD;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4EAA4E;IAC5E,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB;AAED,iFAAiF;AACjF,MAAM,WAAW,WAAW;IAC1B,6CAA6C;IAC7C,CAAC,EAAE,MAAM,CAAC;IACV;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC;CAC3B;AAED,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,OAAO,CAAC;AAE9C,sEAAsE;AACtE,eAAO,MAAM,gBAAgB,4BAGiB,CAAC"}

package/dist/model/config.d.ts

@@ -0,0 +1,68 @@
+import { AnalysisViewConfig } from './analysis.js';
+import { DashboardViewConfig } from './dashboard.js';
+import { FilterMode, FilterTree } from './filter.js';
+import { RecordViewConfig } from './record.js';
+/**
+ * What every view kind stores. It belongs to the view rather than to the
+ * person looking at it, so it is saved with the config.
+ */
+export interface ViewConfigBase {
+    refresh: RefreshConfig;
+}
+/**
+ * What a view that asks one question of its own — a record view, an
+ * analysis — stores besides: its conditions, and the editor mode they are
+ * shown in.
+ *
+ * A dashboard has neither (D27). Its panels ask the questions, a reader
+ * narrows them through the board's filters (`DashboardField`), and what no
+ * reader changes is its fixed scope (`DashboardViewConfig.fixed`) — so a
+ * condition of the board's own would be a third place saying the same thing.
+ */
+export interface DataViewConfigBase extends ViewConfigBase {
+    filter: FilterTree;
+    /** The editor mode travels with the view: `simple` cannot show an OR tree. */
+    filterMode: FilterMode;
+}
+/**
+ * Auto-refresh interval in seconds, or `null` when off. A non-null value is a
+ * finite integer between `minRefreshInterval` and `maxRefreshInterval`.
+ */
+export interface RefreshConfig {
+    interval: number | null;
+}
+/** What a user saves: the way of observing, never a data snapshot. */
+export type ViewConfig = RecordViewConfig | AnalysisViewConfig | DashboardViewConfig;
+/**
+ * The two kinds that ask a question of their own (`DataViewConfigBase`) and
+ * that a `ViewRuntime` executes; a dashboard owns child runtimes.
+ */
+export type DataViewConfig = RecordViewConfig | AnalysisViewConfig;
+export type ViewKind = ViewConfig['kind'];
+export declare const VIEW_KINDS: readonly ViewKind[];
+/** Narrows a config union member by its kind. */
+export type ConfigOfKind<K extends ViewKind> = Extract<ViewConfig, {
+    kind: K;
+}>;
+/**
+ * Which members of one kind's config are presentation only — declared beside
+ * the type each is a member of rather than string-compared where they are
+ * read, so a `satisfies` refuses a member the config does not have (A6).
+ *
+ * A config arrives from a store, so its `kind` may be none of the three;
+ * such a config has no member known to only draw, since no member is
+ * presentation for every kind.
+ */
+export declare function presentationMembers(kind: ViewKind): readonly string[];
+/**
+ * Which members of one kind's config run again on their own a moment after
+ * they change (「改了就跑」, D20) — declared beside the type each is a member
+ * of, like `presentationMembers`, so the runtime carries no rule of any one
+ * kind and a kind that runs nothing on its own declares nothing.
+ *
+ * Only an analysis has any: its question. A record view's edits — a sort, a
+ * page size — are cheap to apply and wait for the press as they always did;
+ * a dashboard edits its layout, not a question.
+ */
+export declare function autoRunMembers(kind: ViewKind): readonly string[];
+//# sourceMappingURL=config.d.ts.map

package/dist/model/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/model/config.ts"],"names":[],"mappings":"AAaA,OAAO,EAGL,KAAK,kBAAkB,EACxB,MAAM,eAAe,CAAC;AACvB,OAAO,EAEL,KAAK,mBAAmB,EACzB,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAC1D,OAAO,EAEL,KAAK,gBAAgB,EACtB,MAAM,aAAa,CAAC;AAErB;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,aAAa,CAAC;CACxB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD,MAAM,EAAE,UAAU,CAAC;IACnB,8EAA8E;IAC9E,UAAU,EAAE,UAAU,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;CACzB;AAED,sEAAsE;AACtE,MAAM,MAAM,UAAU,GACpB,gBAAgB,GAAG,kBAAkB,GAAG,mBAAmB,CAAC;AAE9D;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,gBAAgB,GAAG,kBAAkB,CAAC;AAEnE,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC,MAAM,CAAC,CAAC;AAE1C,eAAO,MAAM,UAAU,EAAE,SAAS,QAAQ,EAIzC,CAAC;AAEF,iDAAiD;AACjD,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,QAAQ,IAAI,OAAO,CAAC,UAAU,EAAE;IAAE,IAAI,EAAE,CAAC,CAAA;CAAE,CAAC,CAAC;AAyBhF;;;;;;;;GAQG;AACH,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,MAAM,EAAE,CAErE;AAQD;;;;;;;;;GASG;AACH,wBAAgB,cAAc,CAAC,IAAI,EAAE,QAAQ,GAAG,SAAS,MAAM,EAAE,CAEhE"}

package/dist/model/currency.d.ts

@@ -0,0 +1,55 @@
+import { NumberFormat } from './field.js';
+import { RecordData } from './record.js';
+/**
+ * What currency an amount — one record's, or an aggregate over several —
+ * is in, for money whose currency each record holds (`RowMoneyNumeric`):
+ *
+ * - `one`: every record it was read from is in `code`, so it reads in it;
+ * - `mixed`: the records are in `count` currencies, so the aggregate is a
+ *   sum of unlike amounts — no number at all, and said as such
+ *   (「多种货币」), never printed as if it were one.
+ *
+ * Absent where nothing could be told: no record had a currency.
+ */
+export type CurrencyReading = {
+    type: 'one';
+    code: string;
+} | {
+    type: 'mixed';
+    count: number;
+};
+/** Whether a value is an ISO 4217 code the engine can format in. */
+export declare function isCurrencyCode(value: unknown): value is string;
+/**
+ * `format` in `code`: the digits it says, in that currency. What a
+ * row-currency amount reads as once its currency is known.
+ */
+export declare function inCurrency(format: NumberFormat | undefined, code: string): NumberFormat;
+/**
+ * The currency of an amount held at `path` on each row, read off the
+ * rows themselves (`currencyPath`): one when every row holding an amount
+ * holds the same code, mixed when they hold several. A row with no amount
+ * adds nothing to a sum, so its currency is not asked; a row with an amount
+ * and no readable code makes the whole unknown — an amount in no one's
+ * currency cannot be added to the others either.
+ */
+export declare function currencyOfRows(rows: readonly RecordData[], amount: (row: RecordData) => unknown, currency: (row: RecordData) => unknown): CurrencyReading | undefined;
+/**
+ * Several readings as one: the same currency throughout is that currency,
+ * and anything else — two currencies, or one of them mixed already — is
+ * mixed. Unknown when any is: nothing can be said of an amount made of one
+ * nobody could read.
+ */
+export declare function joinCurrencies(readings: readonly (CurrencyReading | undefined)[]): CurrencyReading | undefined;
+/**
+ * What an aggregate's companions say about its currency: `count`, the
+ * distinct count of the currency field over the records it read, and
+ * `code`, one of those currencies. Asked beside a sum of money whose
+ * currency each record holds (the analysis's `currencyCompanions`, the
+ * record totals' `summaryCurrency`).
+ */
+export declare function companionReading(row: RecordData | undefined, companion: {
+    code: string;
+    count: string;
+}): CurrencyReading | undefined;
+//# sourceMappingURL=currency.d.ts.map

package/dist/model/currency.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"currency.d.ts","sourceRoot":"","sources":["../../src/model/currency.ts"],"names":[],"mappings":"AAaA,OAAO,EAAyB,KAAK,YAAY,EAAE,MAAM,YAAY,CAAC;AACtE,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAE9C;;;;;;;;;;GAUG;AACH,MAAM,MAAM,eAAe,GACzB;IAAE,IAAI,EAAE,KAAK,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,IAAI,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAEnE,oEAAoE;AACpE,wBAAgB,cAAc,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAE9D;AAED;;;GAGG;AACH,wBAAgB,UAAU,CACxB,MAAM,EAAE,YAAY,GAAG,SAAS,EAChC,IAAI,EAAE,MAAM,GACX,YAAY,CAEd;AAED;;;;;;;GAOG;AACH,wBAAgB,cAAc,CAC5B,IAAI,EAAE,SAAS,UAAU,EAAE,EAC3B,MAAM,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,OAAO,EACpC,QAAQ,EAAE,CAAC,GAAG,EAAE,UAAU,KAAK,OAAO,GACrC,eAAe,GAAG,SAAS,CAY7B;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,SAAS,CAAC,eAAe,GAAG,SAAS,CAAC,EAAE,GACjD,eAAe,GAAG,SAAS,CAW7B;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAC9B,GAAG,EAAE,UAAU,GAAG,SAAS,EAC3B,SAAS,EAAE;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GACzC,eAAe,GAAG,SAAS,CAQ7B"}