@elaraai/east-ui 1.0.39 → 1.0.41

package/dist/src/collections/calendar/types.js

@@ -2,9 +2,108 @@
  * Copyright (c) 2025 Elara AI Pty Ltd
  * Dual-licensed under AGPL-3.0 and commercial license. See LICENSE for details.
  */
-import { ArrayType, FloatType, FunctionType, NullType, OptionType, StringType, StructType, } from "@elaraai/east";
+import { ArrayType, BooleanType, FloatType, FunctionType, IntegerType, NullType, OptionType, StringType, StructType, VariantType, } from "@elaraai/east";
 import { DensityType } from "../../style.js";
 import { PlotGutterType } from "../../shared/plot-gutter.js";
+/**
+ * A reduction applied across a calendar row (the weekly totals rail) or
+ * column (the aggregate row). Mirrors the Table component's aggregate
+ * vocabulary so the two collections stay consistent.
+ *
+ * @property sum - Numeric sum of the member cell values
+ * @property mean - Numeric mean of the member cell values
+ * @property min - Minimum member value
+ * @property max - Maximum member value
+ * @property count - Number of member cells present
+ */
+export const CalendarAggregateType = VariantType({
+    /** Numeric sum of the member cell values */
+    sum: NullType,
+    /** Numeric mean of the member cell values */
+    mean: NullType,
+    /** Minimum member value */
+    min: NullType,
+    /** Maximum member value */
+    max: NullType,
+    /** Number of member cells present */
+    count: NullType,
+});
+/**
+ * The heatmap colour scale — how a cell value maps to a fill.
+ *
+ * @remarks
+ * `ramp` is a low→high list of CSS colours; when absent the renderer uses
+ * the built-in eight-step teal ramp (theme-aware — it flips to a bright-on-
+ * dark ramp in dark mode). `steps` buckets the domain (default the ramp
+ * length). The intensity domain lives on the root as `domain`.
+ *
+ * @property ramp - Optional low→high colour list (absent = the default ramp)
+ * @property steps - Number of intensity buckets
+ */
+export const CalendarScaleType = StructType({
+    /** Optional low→high colour list (absent = the default ramp) */
+    ramp: OptionType(ArrayType(StringType)),
+    /** Number of intensity buckets */
+    steps: IntegerType,
+});
+/**
+ * The weekly totals rail — a trailing column that reduces each week row and
+ * (optionally) shows a proportion bar against the largest total.
+ *
+ * @property aggregate - The reduction applied across each week's cells
+ * @property label - The rail's column header (e.g. `"Σ wk"`)
+ * @property bar - Whether to draw the proportion bar under each total
+ */
+export const CalendarTotalsType = StructType({
+    /** The reduction applied across each week's cells */
+    aggregate: CalendarAggregateType,
+    /** The rail's column header (e.g. `"Σ wk"`) */
+    label: StringType,
+    /** Whether to draw the proportion bar under each total */
+    bar: BooleanType,
+});
+/**
+ * The aggregate row — a trailing row that reduces each weekday column
+ * (e.g. the per-weekday mean), pinned under the grid with a top rule.
+ *
+ * @property aggregate - The reduction applied across each weekday's cells
+ * @property label - The row's label (e.g. `"mean"`)
+ */
+export const CalendarAggregateRowType = StructType({
+    /** The reduction applied across each weekday's cells */
+    aggregate: CalendarAggregateType,
+    /** The row's label (e.g. `"mean"`) */
+    label: StringType,
+});
+/**
+ * The footer's low→high gradient legend that decodes the heatmap ramp.
+ *
+ * @property low - The low-end caption (e.g. `"low"`)
+ * @property high - The high-end caption (e.g. `"high"`)
+ */
+export const CalendarLegendType = StructType({
+    /** The low-end caption (e.g. `"low"`) */
+    low: StringType,
+    /** The high-end caption (e.g. `"high"`) */
+    high: StringType,
+});
+/**
+ * The selection footer — shown once a cell is selected. Reads the selected
+ * cell's `value` (labelled `valueLabel`) and, when present, its `compare`
+ * baseline (labelled `compareLabel`) plus the computed delta chip.
+ *
+ * @property valueLabel - Label for the cell value (e.g. `"predicted"`)
+ * @property compareLabel - Label for the compare baseline (e.g. `"last yr"`)
+ * @property legend - Optional low→high gradient legend, pinned footer-right
+ */
+export const CalendarFooterType = StructType({
+    /** Label for the cell value (e.g. `"predicted"`) */
+    valueLabel: StringType,
+    /** Label for the compare baseline (e.g. `"last yr"`) */
+    compareLabel: StringType,
+    /** Optional low→high gradient legend, pinned footer-right */
+    legend: OptionType(CalendarLegendType),
+});
 /**
  * A cell reference on the calendar grid — what `onSelect` receives.
  *
@@ -22,15 +121,16 @@ export const CalendarCellRefType = StructType({
  *
  * @remarks
  * One element per (week, day) the data covered; days with no cell render
- * the neutral `−` fill. `summary` / `delta` are the selection-footer facts
- * for this day, resolved from the accessors at authoring time.
+ * the neutral hatched fill. `compare` is the footer's baseline (last year /
+ * forecast) — when present the footer prints it and a computed delta chip;
+ * `summary` is optional extra footer text.
  *
  * @property week - The row's week label (rows appear in first-appearance order)
  * @property day - The day column ("Mon" … "Sun", exact match)
  * @property value - The intensity / printed value
  * @property text - The cell text (formatted value)
- * @property summary - Optional selection-footer text for this day
- * @property delta - Optional signed change (renders as a pos/neg chip)
+ * @property compare - Optional baseline for the footer delta (e.g. last year)
+ * @property summary - Optional extra selection-footer text for this day
  */
 export const CalendarCellType = StructType({
     /** The row's week label (rows appear in first-appearance order) */
@@ -41,32 +141,40 @@ export const CalendarCellType = StructType({
     value: FloatType,
     /** The cell text (formatted value) */
     text: StringType,
-    /** Optional selection-footer text for this day */
+    /** Optional baseline for the footer delta (e.g. last year) */
+    compare: OptionType(FloatType),
+    /** Optional extra selection-footer text for this day */
     summary: OptionType(StringType),
-    /** Optional signed change (renders as a pos/neg chip) */
-    delta: OptionType(FloatType),
 });
 /**
  * East StructType for the Calendar component.
  *
  * @remarks
- * Day-of-week × week grid coloured by intensity — visualisation only: click
- * drills into a day (`onSelect` / the footer `action`), but there are no
- * events, no committed/proposed state, and no drag & drop.
+ * Day-of-week × week heatmap coloured by intensity — visualisation only:
+ * clicking selects/drills a day (`onSelect` / the footer `action`), but
+ * there are no events, no committed/proposed state, and no drag & drop.
+ * Optional chrome: the weekly `totals` rail, the per-weekday `aggregateRow`,
+ * and the selection `footer` (with its gradient legend).
  *
- * @property legend - Intensity caption (decodes the colour ramp)
  * @property cells - The resolved cells
+ * @property values - Whether the numeric value is printed inside each cell
+ * @property scale - Optional heatmap scale override (ramp / steps)
  * @property domain - Optional explicit intensity domain (default: observed min/max)
- * @property actionLabel - Optional footer-right drill label
- * @property onAction - Optional footer-right drill callback (receives the selected cell)
+ * @property totals - Optional weekly totals rail (per-row aggregation)
+ * @property aggregateRow - Optional per-weekday aggregate row (per-column aggregation)
+ * @property footer - Optional selection footer (value / compare / delta + legend)
+ * @property actionLabel - Optional footer drill label
+ * @property onAction - Optional footer drill callback (receives the selected cell)
  * @property onSelect - Optional cell-click callback
  * @property density - Optional density preset (comfortable | compact | condensed)
  */
 export const CalendarRootType = StructType({
-    /** Intensity caption (decodes the colour ramp) */
-    legend: StringType,
     /** The resolved cells */
     cells: ArrayType(CalendarCellType),
+    /** Whether the numeric value is printed inside each cell */
+    values: BooleanType,
+    /** Optional heatmap scale override (ramp / steps) */
+    scale: OptionType(CalendarScaleType),
     /** Optional explicit intensity domain (default: observed min/max) */
     domain: OptionType(StructType({
         /** Domain minimum */
@@ -74,9 +182,15 @@ export const CalendarRootType = StructType({
         /** Domain maximum */
         max: FloatType,
     })),
-    /** Optional footer-right drill label */
+    /** Optional weekly totals rail (per-row aggregation) */
+    totals: OptionType(CalendarTotalsType),
+    /** Optional per-weekday aggregate row (per-column aggregation) */
+    aggregateRow: OptionType(CalendarAggregateRowType),
+    /** Optional selection footer (value / compare / delta + legend) */
+    footer: OptionType(CalendarFooterType),
+    /** Optional footer drill label */
     actionLabel: OptionType(StringType),
-    /** Optional footer-right drill callback (receives the selected cell) */
+    /** Optional footer drill callback (receives the selected cell) */
     onAction: OptionType(FunctionType([CalendarCellRefType], NullType)),
     /** Optional cell-click callback */
     onSelect: OptionType(FunctionType([CalendarCellRefType], NullType)),

package/dist/src/collections/calendar/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/collections/calendar/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,SAAS,EACT,SAAS,EACT,YAAY,EACZ,QAAQ,EACR,UAAU,EACV,UAAU,EACV,UAAU,GACb,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAE7D;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,UAAU,CAAC;IAC1C,2BAA2B;IAC3B,IAAI,EAAE,UAAU;IAChB,qCAAqC;IACrC,GAAG,EAAE,UAAU;CAClB,CAAC,CAAC;AAOH;;;;;;;;;;;;;;GAcG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,UAAU,CAAC;IACvC,mEAAmE;IACnE,IAAI,EAAE,UAAU;IAChB,kDAAkD;IAClD,GAAG,EAAE,UAAU;IACf,oCAAoC;IACpC,KAAK,EAAE,SAAS;IAChB,sCAAsC;IACtC,IAAI,EAAE,UAAU;IAChB,kDAAkD;IAClD,OAAO,EAAE,UAAU,CAAC,UAAU,CAAC;IAC/B,yDAAyD;IACzD,KAAK,EAAE,UAAU,CAAC,SAAS,CAAC;CAC/B,CAAC,CAAC;AAOH;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,UAAU,CAAC;IACvC,kDAAkD;IAClD,MAAM,EAAE,UAAU;IAClB,yBAAyB;IACzB,KAAK,EAAE,SAAS,CAAC,gBAAgB,CAAC;IAClC,qEAAqE;IACrE,MAAM,EAAE,UAAU,CAAC,UAAU,CAAC;QAC1B,qBAAqB;QACrB,GAAG,EAAE,SAAS;QACd,qBAAqB;QACrB,GAAG,EAAE,SAAS;KACjB,CAAC,CAAC;IACH,wCAAwC;IACxC,WAAW,EAAE,UAAU,CAAC,UAAU,CAAC;IACnC,wEAAwE;IACxE,QAAQ,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC,mBAAmB,CAAC,EAAE,QAAQ,CAAC,CAAC;IACnE,mCAAmC;IACnC,QAAQ,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC,mBAAmB,CAAC,EAAE,QAAQ,CAAC,CAAC;IACnE,uFAAuF;IACvF,OAAO,EAAE,UAAU,CAAC,WAAW,CAAC;IAChC,6JAA6J;IAC7J,UAAU,EAAE,UAAU,CAAC,cAAc,CAAC;IACtC,mGAAmG;IACnG,MAAM,EAAE,UAAU,CAAC,UAAU,CAAC;IAC9B,qEAAqE;IACrE,SAAS,EAAE,UAAU,CAAC,UAAU,CAAC;CACpC,CAAC,CAAC"}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/collections/calendar/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EACH,SAAS,EACT,WAAW,EACX,SAAS,EACT,YAAY,EACZ,WAAW,EACX,QAAQ,EACR,UAAU,EACV,UAAU,EACV,UAAU,EACV,WAAW,GACd,MAAM,eAAe,CAAC;AAEvB,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAE7D;;;;;;;;;;GAUG;AACH,MAAM,CAAC,MAAM,qBAAqB,GAAG,WAAW,CAAC;IAC7C,4CAA4C;IAC5C,GAAG,EAAE,QAAQ;IACb,6CAA6C;IAC7C,IAAI,EAAE,QAAQ;IACd,2BAA2B;IAC3B,GAAG,EAAE,QAAQ;IACb,2BAA2B;IAC3B,GAAG,EAAE,QAAQ;IACb,qCAAqC;IACrC,KAAK,EAAE,QAAQ;CAClB,CAAC,CAAC;AAQH;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,iBAAiB,GAAG,UAAU,CAAC;IACxC,gEAAgE;IAChE,IAAI,EAAE,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IACvC,kCAAkC;IAClC,KAAK,EAAE,WAAW;CACrB,CAAC,CAAC;AAKH;;;;;;;GAOG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAC;IACzC,qDAAqD;IACrD,SAAS,EAAE,qBAAqB;IAChC,+CAA+C;IAC/C,KAAK,EAAE,UAAU;IACjB,0DAA0D;IAC1D,GAAG,EAAE,WAAW;CACnB,CAAC,CAAC;AAKH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,wBAAwB,GAAG,UAAU,CAAC;IAC/C,wDAAwD;IACxD,SAAS,EAAE,qBAAqB;IAChC,sCAAsC;IACtC,KAAK,EAAE,UAAU;CACpB,CAAC,CAAC;AAKH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAC;IACzC,yCAAyC;IACzC,GAAG,EAAE,UAAU;IACf,2CAA2C;IAC3C,IAAI,EAAE,UAAU;CACnB,CAAC,CAAC;AAKH;;;;;;;;GAQG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAG,UAAU,CAAC;IACzC,oDAAoD;IACpD,UAAU,EAAE,UAAU;IACtB,wDAAwD;IACxD,YAAY,EAAE,UAAU;IACxB,6DAA6D;IAC7D,MAAM,EAAE,UAAU,CAAC,kBAAkB,CAAC;CACzC,CAAC,CAAC;AAKH;;;;;GAKG;AACH,MAAM,CAAC,MAAM,mBAAmB,GAAG,UAAU,CAAC;IAC1C,2BAA2B;IAC3B,IAAI,EAAE,UAAU;IAChB,qCAAqC;IACrC,GAAG,EAAE,UAAU;CAClB,CAAC,CAAC;AAOH;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,UAAU,CAAC;IACvC,mEAAmE;IACnE,IAAI,EAAE,UAAU;IAChB,kDAAkD;IAClD,GAAG,EAAE,UAAU;IACf,oCAAoC;IACpC,KAAK,EAAE,SAAS;IAChB,sCAAsC;IACtC,IAAI,EAAE,UAAU;IAChB,8DAA8D;IAC9D,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC;IAC9B,wDAAwD;IACxD,OAAO,EAAE,UAAU,CAAC,UAAU,CAAC;CAClC,CAAC,CAAC;AAOH;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,UAAU,CAAC;IACvC,yBAAyB;IACzB,KAAK,EAAE,SAAS,CAAC,gBAAgB,CAAC;IAClC,4DAA4D;IAC5D,MAAM,EAAE,WAAW;IACnB,qDAAqD;IACrD,KAAK,EAAE,UAAU,CAAC,iBAAiB,CAAC;IACpC,qEAAqE;IACrE,MAAM,EAAE,UAAU,CAAC,UAAU,CAAC;QAC1B,qBAAqB;QACrB,GAAG,EAAE,SAAS;QACd,qBAAqB;QACrB,GAAG,EAAE,SAAS;KACjB,CAAC,CAAC;IACH,wDAAwD;IACxD,MAAM,EAAE,UAAU,CAAC,kBAAkB,CAAC;IACtC,kEAAkE;IAClE,YAAY,EAAE,UAAU,CAAC,wBAAwB,CAAC;IAClD,mEAAmE;IACnE,MAAM,EAAE,UAAU,CAAC,kBAAkB,CAAC;IACtC,kCAAkC;IAClC,WAAW,EAAE,UAAU,CAAC,UAAU,CAAC;IACnC,kEAAkE;IAClE,QAAQ,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC,mBAAmB,CAAC,EAAE,QAAQ,CAAC,CAAC;IACnE,mCAAmC;IACnC,QAAQ,EAAE,UAAU,CAAC,YAAY,CAAC,CAAC,mBAAmB,CAAC,EAAE,QAAQ,CAAC,CAAC;IACnE,uFAAuF;IACvF,OAAO,EAAE,UAAU,CAAC,WAAW,CAAC;IAChC,6JAA6J;IAC7J,UAAU,EAAE,UAAU,CAAC,cAAc,CAAC;IACtC,mGAAmG;IACnG,MAAM,EAAE,UAAU,CAAC,UAAU,CAAC;IAC9B,qEAAqE;IACrE,SAAS,EAAE,UAAU,CAAC,UAAU,CAAC;CACpC,CAAC,CAAC"}