@happyvertical/smrt-svelte 0.55.23 → 0.55.24

package/dist/components/overview/widgets/RecordTable.svelte

@@ -0,0 +1,167 @@
+<script lang="ts">
+/**
+ * RecordTable (internal): the compact records table shared by the `records`
+ * widget (with columns), each tab of `related`, and `lineItems`. Columns
+ * render by role (identifier monospace, status badge, date, money and
+ * quantity right-aligned); the first column links to the row. The footer is
+ * smrt-ui `DataTable`'s `summaries`: the count in the first column and the
+ * sums of the money and quantity columns. A sum covers EVERY matching record
+ * only when the host sent `summaryValues` or every record is loaded;
+ * otherwise that cell stays empty rather than adding up a partial page.
+ */
+
+import type {
+  DataTableColumn,
+  DataTableSummary,
+} from '@happyvertical/smrt-ui/data';
+import { DataTable } from '@happyvertical/smrt-ui/data';
+import { useI18n } from '@happyvertical/smrt-ui/i18n';
+import { Badge } from '@happyvertical/smrt-ui/ui';
+import { M } from '../../../i18n/strings.overview.js';
+import { safeHref } from '../markdown.js';
+import type {
+  RecordListColumn,
+  RecordListRow,
+  RecordStatusTone,
+} from './data.js';
+import {
+  formatRecordCell,
+  isSummedColumn,
+  isSummedRole,
+  statusTone,
+} from './record-table.js';
+
+interface Props {
+  rows: readonly RecordListRow[];
+  columns: readonly RecordListColumn[];
+  locale: string;
+  currency?: string;
+  timeZone?: string;
+  /** Render the footer (count and sums). */
+  summaries?: boolean;
+  /** Footer values over every matching record, keyed by column (money in minor units). */
+  summaryValues?: Readonly<Record<string, number>>;
+  /** Every matching record; more than `rows.length` means the rows are a page. */
+  total?: number | null;
+  statusTones?: Readonly<Record<string, RecordStatusTone>>;
+  /** Accessible name of the table. */
+  label?: string;
+}
+
+let {
+  rows,
+  columns,
+  locale,
+  currency,
+  timeZone,
+  summaries = false,
+  summaryValues,
+  total = null,
+  statusTones,
+  label,
+}: Props = $props();
+
+const { t } = useI18n();
+
+interface TableRow {
+  id: string;
+  title: string;
+  href: string | null;
+  cells: Record<string, unknown>;
+}
+
+const tableRows = $derived(
+  rows.map(
+    (row): TableRow => ({
+      id: row.id,
+      title: row.title,
+      href: typeof row.href === 'string' ? safeHref(row.href) : null,
+      cells: row.cells ?? {},
+    }),
+  ),
+);
+
+const byKey = $derived(new Map(columns.map((c) => [c.key, c])));
+const firstKey = $derived(columns[0]?.key);
+const complete = $derived(total === null || total <= rows.length);
+const context = $derived({ currency, locale, timeZone });
+
+const tableColumns = $derived(
+  columns.map(
+    (column): DataTableColumn<TableRow> => ({
+      id: column.key,
+      label: column.label,
+      accessor: `cells.${column.key}`,
+      ...(isSummedRole(column.role) ? { align: 'right' as const } : {}),
+      summaryFormat: (value: number) =>
+        formatRecordCell(column, value, context),
+    }),
+  ),
+);
+
+const tableSummaries = $derived.by(() => {
+  if (!summaries || columns.length === 0) return undefined;
+  const out: Record<string, DataTableSummary<TableRow>> = {};
+  const count = total ?? rows.length;
+  if (firstKey && !isSummedRole(byKey.get(firstKey)?.role)) {
+    out[firstKey] = () =>
+      t(M['ui.overview.records.total'], {
+        count: new Intl.NumberFormat(locale).format(count),
+      });
+  }
+  for (const column of columns) {
+    if (!isSummedColumn(column)) continue;
+    const hosted = summaryValues?.[column.key];
+    if (typeof hosted === 'number' && Number.isFinite(hosted)) {
+      out[column.key] = () => formatRecordCell(column, hosted, context);
+    } else if (complete) {
+      out[column.key] = 'sum';
+    } else {
+      out[column.key] = () => '';
+    }
+  }
+  return out;
+});
+</script>
+
+{#snippet cell({ column, row, value }: { column: DataTableColumn<TableRow>; row: TableRow; value: unknown })}
+  {@const meta = byKey.get(column.id)}
+  {@const text = meta ? formatRecordCell(meta, value, context) : String(value ?? '')}
+  {@const shown = text === '' && column.id === firstKey ? row.title : text}
+  {#if column.id === firstKey && row.href && shown !== ''}
+    <a class="smrt-record-table__link" href={row.href}>
+      {#if meta?.role === 'identifier'}<code>{shown}</code>{:else}{shown}{/if}
+    </a>
+  {:else if meta?.role === 'status' && shown !== ''}
+    <Badge size="sm" variant={statusTone(value, statusTones)}>{shown}</Badge>
+  {:else if meta?.role === 'identifier' && shown !== ''}
+    <code>{shown}</code>
+  {:else}
+    {shown}
+  {/if}
+{/snippet}
+
+<div class="smrt-record-table" data-smrt-component="RecordTable" role="group" aria-label={label}>
+  <DataTable
+    data={tableRows}
+    columns={tableColumns}
+    rowKey="id"
+    {cell}
+    dense
+    size="sm"
+    hoverable={false}
+    phoneLayout="cards"
+    summaries={tableSummaries}
+    summaryLabel={t(M['ui.overview.table.total'])}
+  />
+</div>
+
+<style>
+@layer smrt.reset, smrt.structure, smrt.theme;
+@layer smrt.theme {
+  .smrt-record-table { min-inline-size: 0; font-variant-numeric: tabular-nums; }
+  .smrt-record-table code { font-family: var(--smrt-font-family-mono); }
+  .smrt-record-table__link { color: var(--smrt-color-primary); text-decoration: none; }
+  .smrt-record-table__link:hover { text-decoration: underline; }
+}
+</style>

package/dist/components/overview/widgets/RecordTable.svelte.d.ts

@@ -0,0 +1,21 @@
+import type { RecordListColumn, RecordListRow, RecordStatusTone } from './data.js';
+interface Props {
+    rows: readonly RecordListRow[];
+    columns: readonly RecordListColumn[];
+    locale: string;
+    currency?: string;
+    timeZone?: string;
+    /** Render the footer (count and sums). */
+    summaries?: boolean;
+    /** Footer values over every matching record, keyed by column (money in minor units). */
+    summaryValues?: Readonly<Record<string, number>>;
+    /** Every matching record; more than `rows.length` means the rows are a page. */
+    total?: number | null;
+    statusTones?: Readonly<Record<string, RecordStatusTone>>;
+    /** Accessible name of the table. */
+    label?: string;
+}
+declare const RecordTable: import("svelte").Component<Props, {}, "">;
+type RecordTable = ReturnType<typeof RecordTable>;
+export default RecordTable;
+//# sourceMappingURL=RecordTable.svelte.d.ts.map

package/dist/components/overview/widgets/RecordTable.svelte.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RecordTable.svelte.d.ts","sourceRoot":"","sources":["../../../../src/components/overview/widgets/RecordTable.svelte.ts"],"names":[],"mappings":"AAsBA,OAAO,KAAK,EACV,gBAAgB,EAChB,aAAa,EACb,gBAAgB,EACjB,MAAM,WAAW,CAAC;AASnB,UAAU,KAAK;IACb,IAAI,EAAE,SAAS,aAAa,EAAE,CAAC;IAC/B,OAAO,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACrC,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,0CAA0C;IAC1C,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,wFAAwF;IACxF,aAAa,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACjD,gFAAgF;IAChF,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,WAAW,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC,CAAC;IACzD,oCAAoC;IACpC,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAoHD,QAAA,MAAM,WAAW,2CAAwC,CAAC;AAC1D,KAAK,WAAW,GAAG,UAAU,CAAC,OAAO,WAAW,CAAC,CAAC;AAClD,eAAe,WAAW,CAAC"}

package/dist/components/overview/widgets/RelatedWidget.svelte

@@ -0,0 +1,117 @@
+<script lang="ts">
+/**
+ * Related widget (#3718 record page): one tab per `children` relation, the
+ * tab label carrying the count ("Orders 6"), each tab a records table with
+ * role-chosen columns and a totals footer (`RecordTable`), and that tab's
+ * one "View all". Relations with no records are hidden; when every one is
+ * empty the widget says so once.
+ */
+import { Tabs } from '@happyvertical/smrt-ui';
+import { useI18n } from '@happyvertical/smrt-ui/i18n';
+import { M } from '../../../i18n/strings.overview.js';
+import { safeHref } from '../markdown.js';
+import type { WidgetComponentProps } from '../types.js';
+import { isRecord, type RelatedWidgetData } from './data.js';
+import RecordTable from './RecordTable.svelte';
+import { readRecordRows, resolveRecordColumns } from './record-table.js';
+
+let { data, locale, title }: WidgetComponentProps<RelatedWidgetData> = $props();
+
+const { t } = useI18n();
+
+const tabs = $derived.by(() => {
+  if (!isRecord(data) || !Array.isArray(data.tabs)) return [];
+  const out = [];
+  for (const tab of data.tabs) {
+    if (!isRecord(tab) || typeof tab.key !== 'string') continue;
+    const rows = readRecordRows(tab);
+    const total =
+      typeof tab.total === 'number' && Number.isFinite(tab.total)
+        ? tab.total
+        : rows.length;
+    if (rows.length === 0 || total === 0) continue;
+    const columns = resolveRecordColumns([], tab.columns);
+    const summaries: Record<string, number> = {};
+    if (isRecord(tab.summaries)) {
+      for (const [key, value] of Object.entries(tab.summaries)) {
+        if (typeof value === 'number' && Number.isFinite(value))
+          summaries[key] = value;
+      }
+    }
+    out.push({
+      key: tab.key,
+      label: typeof tab.label === 'string' ? tab.label : tab.key,
+      rows,
+      total,
+      columns,
+      href: typeof tab.href === 'string' ? safeHref(tab.href) : null,
+      currency: typeof tab.currency === 'string' ? tab.currency : undefined,
+      timeZone: typeof tab.timeZone === 'string' ? tab.timeZone : undefined,
+      summaries,
+    });
+  }
+  return out;
+});
+
+let selected = $state<string | null>(null);
+const current = $derived(tabs.find((tab) => tab.key === selected) ?? tabs[0]);
+</script>
+
+{#if !current}
+  <p class="smrt-related__empty" data-smrt-component="RelatedWidget">{t(M['ui.overview.related.empty'])}</p>
+{:else}
+  <div class="smrt-related" data-smrt-component="RelatedWidget">
+    <Tabs
+      tabs={tabs.map((tab) => ({ id: tab.key, label: tab.label, count: tab.total }))}
+      active={current.key}
+      onchange={(id) => (selected = id)}
+      size="sm"
+      variant="secondary"
+      aria-label={title}
+    >
+      {#key current.key}
+        {#if current.columns.length > 0}
+          <RecordTable
+            rows={current.rows}
+            columns={current.columns}
+            {locale}
+            label={current.label}
+            currency={current.currency}
+            timeZone={current.timeZone}
+            summaries
+            summaryValues={current.summaries}
+            total={current.total}
+          />
+        {:else}
+          <ul class="smrt-related__list">
+            {#each current.rows as row (row.id)}
+              <li>
+                {#if row.href && safeHref(row.href)}
+                  <a href={safeHref(row.href)}>{row.title}</a>
+                {:else}
+                  {row.title}
+                {/if}
+              </li>
+            {/each}
+          </ul>
+        {/if}
+        {#if current.href}
+          <p class="smrt-related__foot">
+            <a href={current.href}>{t(M['ui.overview.records.view_all'])}</a>
+          </p>
+        {/if}
+      {/key}
+    </Tabs>
+  </div>
+{/if}
+
+<style>
+@layer smrt.reset, smrt.structure, smrt.theme;
+@layer smrt.theme {
+  .smrt-related { min-inline-size: 0; }
+  .smrt-related__list { display: grid; gap: var(--smrt-spacing-2); margin: var(--smrt-spacing-2) 0 0; padding: 0; list-style: none; }
+  .smrt-related__foot { display: flex; justify-content: flex-end; margin: var(--smrt-spacing-2) 0 0; font-size: var(--smrt-typography-body-medium-size, 0.875rem); }
+  .smrt-related__foot a { color: var(--smrt-color-primary); }
+  .smrt-related__empty { margin: 0; color: var(--smrt-color-on-surface-variant); }
+}
+</style>

package/dist/components/overview/widgets/RelatedWidget.svelte.d.ts

@@ -0,0 +1,6 @@
+import type { WidgetComponentProps } from '../types.js';
+import { type RelatedWidgetData } from './data.js';
+declare const RelatedWidget: import("svelte").Component<WidgetComponentProps<RelatedWidgetData>, {}, "">;
+type RelatedWidget = ReturnType<typeof RelatedWidget>;
+export default RelatedWidget;
+//# sourceMappingURL=RelatedWidget.svelte.d.ts.map

package/dist/components/overview/widgets/RelatedWidget.svelte.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RelatedWidget.svelte.d.ts","sourceRoot":"","sources":["../../../../src/components/overview/widgets/RelatedWidget.svelte.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAY,KAAK,iBAAiB,EAAE,MAAM,WAAW,CAAC;AA4F7D,QAAA,MAAM,aAAa,6EAAwC,CAAC;AAC5D,KAAK,aAAa,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;AACtD,eAAe,aAAa,CAAC"}

package/dist/components/overview/widgets/core.d.ts

@@ -14,7 +14,12 @@
 import { type WidgetRegistry } from '../registry.js';
 import type { WidgetDefinition, WidgetLoad } from '../types.js';
 import type { ChartWidgetData, MetricWidgetData, RecordListWidgetData, ShortcutsWidgetData } from './data.js';
-/** Metric: one number from a model. Options: model, measure, field, filter. */
+/**
+ * Metric: one number from a model. Options: model, measure, field, filter,
+ * parentField. Under `filter: 'parent'` the FK to the record is
+ * `parentField` when given (and `field` is then the measured field, a `sum`
+ * of `totalAmount`), else `field` (a count).
+ */
 export declare function createMetricWidget(load: WidgetLoad<MetricWidgetData>): WidgetDefinition<MetricWidgetData>;
 /** Chart option-schema version: 2 added the `table`, `pie` and `stat` styles. */
 export declare const CHART_OPTIONS_VERSION = 2;
@@ -26,7 +31,13 @@ export declare function migrateChartOptions(options: Record<string, unknown>, fr
  * the renderer half of the runtime-report chart hints (#3878).
  */
 export declare function createChartWidget(load: WidgetLoad<ChartWidgetData>): WidgetDefinition<ChartWidgetData>;
-/** Record list: the latest or top records of a model. */
+/**
+ * Record list: the latest or top records of a model. `field` names the FK on
+ * the model for `filter: 'parent'` (a record view's related-records panel).
+ * `columns` (comma-separated field names) renders the rows as a table of
+ * their `cells` with a totals footer (`summaries`); the loader receives the
+ * option and fills `cells` for those keys.
+ */
 export declare function createRecordListWidget(load: WidgetLoad<RecordListWidgetData>): WidgetDefinition<RecordListWidgetData>;
 /**
  * Shortcuts: the section-overview cards. The default widget of a section

package/dist/components/overview/widgets/core.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../../../src/components/overview/widgets/core.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAyB,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC5E,OAAO,KAAK,EACV,gBAAgB,EAChB,UAAU,EAEX,MAAM,aAAa,CAAC;AAErB,OAAO,KAAK,EACV,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,mBAAmB,EACpB,MAAM,WAAW,CAAC;AA2CnB,+EAA+E;AAC/E,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC,GACjC,gBAAgB,CAAC,gBAAgB,CAAC,CAgBpC;AAED,iFAAiF;AACjF,eAAO,MAAM,qBAAqB,IAAI,CAAC;AAEvC,mFAAmF;AACnF,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,WAAW,EAAE,MAAM,GAClB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAIhC;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,UAAU,CAAC,eAAe,CAAC,GAChC,gBAAgB,CAAC,eAAe,CAAC,CAiDnC;AAED,yDAAyD;AACzD,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,UAAU,CAAC,oBAAoB,CAAC,GACrC,gBAAgB,CAAC,oBAAoB,CAAC,CAkCxC;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,UAAU,CAAC,mBAAmB,CAAC,GACpC,gBAAgB,CAAC,mBAAmB,CAAC,CAmBvC;AAED,sDAAsD;AACtD,wBAAgB,gBAAgB,IAAI,gBAAgB,CAoBnD;AAED,2EAA2E;AAC3E,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAC;IACtC,KAAK,CAAC,EAAE,UAAU,CAAC,eAAe,CAAC,CAAC;IACpC,OAAO,CAAC,EAAE,UAAU,CAAC,oBAAoB,CAAC,CAAC;IAC3C,SAAS,CAAC,EAAE,UAAU,CAAC,mBAAmB,CAAC,CAAC;CAC7C;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,GAAE,cAAsC,EAChD,OAAO,GAAE,iBAAsB,EAC/B,OAAO,GAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAO,GAClC,MAAM,IAAI,CAyBZ"}
+{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../../../src/components/overview/widgets/core.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAEH,OAAO,EAAyB,KAAK,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAC5E,OAAO,KAAK,EACV,gBAAgB,EAChB,UAAU,EAEX,MAAM,aAAa,CAAC;AAErB,OAAO,KAAK,EACV,eAAe,EACf,gBAAgB,EAChB,oBAAoB,EACpB,mBAAmB,EACpB,MAAM,WAAW,CAAC;AAqEnB;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAChC,IAAI,EAAE,UAAU,CAAC,gBAAgB,CAAC,GACjC,gBAAgB,CAAC,gBAAgB,CAAC,CAiBpC;AAED,iFAAiF;AACjF,eAAO,MAAM,qBAAqB,IAAI,CAAC;AAEvC,mFAAmF;AACnF,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAChC,WAAW,EAAE,MAAM,GAClB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAIhC;AAED;;;;GAIG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,UAAU,CAAC,eAAe,CAAC,GAChC,gBAAgB,CAAC,eAAe,CAAC,CAiDnC;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CACpC,IAAI,EAAE,UAAU,CAAC,oBAAoB,CAAC,GACrC,gBAAgB,CAAC,oBAAoB,CAAC,CAqCxC;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,UAAU,CAAC,mBAAmB,CAAC,GACpC,gBAAgB,CAAC,mBAAmB,CAAC,CAmBvC;AAED,sDAAsD;AACtD,wBAAgB,gBAAgB,IAAI,gBAAgB,CAoBnD;AAED,2EAA2E;AAC3E,MAAM,WAAW,iBAAiB;IAChC,MAAM,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,CAAC;IACtC,KAAK,CAAC,EAAE,UAAU,CAAC,eAAe,CAAC,CAAC;IACpC,OAAO,CAAC,EAAE,UAAU,CAAC,oBAAoB,CAAC,CAAC;IAC3C,SAAS,CAAC,EAAE,UAAU,CAAC,mBAAmB,CAAC,CAAC;CAC7C;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CACjC,QAAQ,GAAE,cAAsC,EAChD,OAAO,GAAE,iBAAsB,EAC/B,OAAO,GAAE;IAAE,OAAO,CAAC,EAAE,OAAO,CAAA;CAAO,GAClC,MAAM,IAAI,CAyBZ"}

package/dist/components/overview/widgets/core.js

@@ -43,6 +43,32 @@ const fieldField = {
     label: 'ui.overview.opt.field',
     help: 'ui.overview.opt.field_help',
 };
+/** The FK to the record under `filter: 'parent'`, when `field` is the measured field. */
+const parentFieldField = {
+    key: 'parentField',
+    type: 'identifier',
+    label: 'ui.overview.opt.parent_field',
+    help: 'ui.overview.opt.parent_field_help',
+};
+/**
+ * Table columns: field names, comma-separated (`number,status,issuedAt`).
+ * Options are flat JSON primitives, so the list travels as text;
+ * `parseColumnsOption` reads it.
+ */
+const columnsField = {
+    key: 'columns',
+    type: 'text',
+    label: 'ui.overview.opt.columns',
+    help: 'ui.overview.opt.columns_help',
+    maxLength: 400,
+};
+/** Totals row; unset means on when a money or quantity column exists. */
+const summariesField = {
+    key: 'summaries',
+    type: 'boolean',
+    label: 'ui.overview.opt.summaries',
+    help: 'ui.overview.opt.summaries_help',
+};
 const measureField = (choices) => ({
     key: 'measure',
     type: 'enum',
@@ -53,7 +79,12 @@ const measureField = (choices) => ({
         label: `ui.overview.opt.measure_${value}`,
     })),
 });
-/** Metric: one number from a model. Options: model, measure, field, filter. */
+/**
+ * Metric: one number from a model. Options: model, measure, field, filter,
+ * parentField. Under `filter: 'parent'` the FK to the record is
+ * `parentField` when given (and `field` is then the measured field, a `sum`
+ * of `totalAmount`), else `field` (a count).
+ */
 export function createMetricWidget(load) {
     return {
         type: 'metric',
@@ -66,6 +97,7 @@ export function createMetricWidget(load) {
             measureField(['count', 'sum', 'avg', 'min', 'max']),
             fieldField,
             filterField,
+            parentFieldField,
         ],
         component: MetricWidget,
         load,
@@ -134,7 +166,13 @@ export function createChartWidget(load) {
         defaultSpan: 2,
     };
 }
-/** Record list: the latest or top records of a model. */
+/**
+ * Record list: the latest or top records of a model. `field` names the FK on
+ * the model for `filter: 'parent'` (a record view's related-records panel).
+ * `columns` (comma-separated field names) renders the rows as a table of
+ * their `cells` with a totals footer (`summaries`); the loader receives the
+ * option and fills `cells` for those keys.
+ */
 export function createRecordListWidget(load) {
     return {
         type: 'records',
@@ -145,6 +183,7 @@ export function createRecordListWidget(load) {
             titleField,
             modelField,
             { key: 'sort', type: 'identifier', label: 'ui.overview.opt.sort' },
+            fieldField,
             {
                 key: 'direction',
                 type: 'enum',
@@ -164,6 +203,8 @@ export function createRecordListWidget(load) {
                 max: 20,
             },
             filterField,
+            columnsField,
+            summariesField,
         ],
         component: RecordListWidget,
         load,

package/dist/components/overview/widgets/data.d.ts

@@ -4,6 +4,7 @@
  * backed by runtime reports, a collection query or the planner's in-browser
  * source without this package depending on any of them.
  */
+import type { FieldRole } from '../../screens/roles.js';
 import type { WidgetValueFormat } from '../format.js';
 /** `metric`: one number. `money` values are integer minor units. */
 export interface MetricWidgetData {
@@ -33,19 +34,107 @@ export interface ChartWidgetData {
      */
     delta?: number | null;
 }
-/** `records`: the rows to list. The loader chooses the title field. */
+/** Badge tone of a status value (`statusTone`). */
+export type RecordStatusTone = 'default' | 'primary' | 'success' | 'warning' | 'error' | 'info';
+/**
+ * One column of a records table: the cell key (a field name of the listed
+ * model) and how it renders, by role: `identifier` monospace, `status` a
+ * badge, `date` a date without a time, `money` integer minor units as
+ * currency, `quantity` a number; anything else as text. `money` and
+ * `quantity` columns are right-aligned and summed in the footer.
+ */
+export interface RecordListColumn {
+    key: string;
+    label: string;
+    role?: FieldRole;
+    /**
+     * Sum this column in the footer. Defaults to true for `money` and
+     * `quantity`; a unit price sets `false` (a sum of unit prices means
+     * nothing).
+     */
+    summarize?: boolean;
+}
+/** One listed record. `cells` carries the column values, keyed by column key. */
+export interface RecordListRow {
+    id: string;
+    title: string;
+    subtitle?: string;
+    meta?: string;
+    href?: string;
+    /**
+     * Column values (`columns`), raw: money in integer minor units, dates as
+     * ISO strings (or preformatted text), a party as its display label.
+     */
+    cells?: Record<string, unknown>;
+}
+/**
+ * `records`: the rows to list. The loader chooses the title field. With
+ * columns (the widget's `columns` option or `columns` here) the rows render
+ * as a table of `cells`; without, as the title list.
+ */
 export interface RecordListWidgetData {
-    rows: {
-        id: string;
-        title: string;
-        subtitle?: string;
-        meta?: string;
-        href?: string;
-    }[];
+    rows: RecordListRow[];
     /** Total matching records, when more than `rows`. */
     total?: number;
     /** Link to the full list. */
     href?: string;
+    /** Column labels and roles; keys not listed here get a humanized label. */
+    columns?: RecordListColumn[];
+    /** ISO 4217 code of the money cells (default USD). */
+    currency?: string;
+    /** Time zone a date cell is shown in (default UTC, so SSR and the browser agree). */
+    timeZone?: string;
+    /**
+     * Footer values over EVERY matching record, keyed by column key (money in
+     * minor units). Without them the footer sums the loaded rows, and only
+     * when they are all the matching records (`total` absent or not more).
+     */
+    summaries?: Record<string, number>;
+}
+/** One tab of the `related` widget: one relation's records table. */
+export interface RelatedWidgetTab {
+    /** The relation's key (`relationKey`, `Order-customerId`). */
+    key: string;
+    /** Tab label; the widget appends the count ("Orders 6"). */
+    label: string;
+    rows: RecordListRow[];
+    /** Every matching record; the tab count. Defaults to `rows.length`. */
+    total?: number;
+    columns: RecordListColumn[];
+    /** The tab's one "View all" link. */
+    href?: string;
+    currency?: string;
+    timeZone?: string;
+    /** Footer values over every matching record (money in minor units). */
+    summaries?: Record<string, number>;
+}
+/** `related`: one tab per `children` relation; empty relations are hidden. */
+export interface RelatedWidgetData {
+    tabs: RelatedWidgetTab[];
+}
+/**
+ * `line-items`: a document's lines (item, quantity, unit price, amount)
+ * with a footer, then the totals block from the parent record's own
+ * subtotal / discount / tax / total (`totals`), computed from the lines
+ * where the record has none, and flagged where they disagree.
+ */
+export interface LineItemsWidgetData {
+    rows: RecordListRow[];
+    columns: RecordListColumn[];
+    /** Every line; more than `rows` means the rows are a page. */
+    total?: number;
+    /** The parent record's own totals, integer minor units. */
+    totals?: {
+        subtotal?: number | null;
+        discount?: number | null;
+        tax?: number | null;
+        total?: number | null;
+    };
+    currency?: string;
+    /** Footer values over every line (money in minor units). */
+    summaries?: Record<string, number>;
+    /** Link to every line. */
+    href?: string;
 }
 /** One page a shortcut links to (#3888). `count` is the record count, when known. */
 export interface ShortcutEntry {

package/dist/components/overview/widgets/data.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../../../../src/components/overview/widgets/data.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAGtD,oEAAoE;AACpE,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,iCAAiC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iEAAiE;IACjE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sEAAsE;IACtE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,qFAAqF;AACrF,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC3C,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,uEAAuE;AACvE,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE;QACJ,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,EAAE,CAAC;IACJ,qDAAqD;IACrD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,6BAA6B;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,qFAAqF;AACrF,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,6CAA6C;AAC7C,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,CAAC,aAAa,GAAG;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,EAAE,CAAC;CAC3C;AAED,sEAAsE;AACtE,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,SAAS;QACd,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,IAAI,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAC;YAAC,WAAW,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;KAC7D,EAAE,CAAC;CACL;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,SAAS,kBAAkB,EAAE,EACvC,SAAS,CAAC,EAAE,MAAM,GACjB,mBAAmB,CAoBrB;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEzE"}
+{"version":3,"file":"data.d.ts","sourceRoot":"","sources":["../../../../src/components/overview/widgets/data.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,cAAc,CAAC;AAGtD,oEAAoE;AACpE,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,iCAAiC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iEAAiE;IACjE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,sEAAsE;IACtE,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,qFAAqF;AACrF,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAC3C,MAAM,CAAC,EAAE,iBAAiB,CAAC;IAC3B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,mDAAmD;AACnD,MAAM,MAAM,gBAAgB,GACxB,SAAS,GACT,SAAS,GACT,SAAS,GACT,SAAS,GACT,OAAO,GACP,MAAM,CAAC;AAEX;;;;;;GAMG;AACH,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;;;OAIG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED,iFAAiF;AACjF,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACjC;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,aAAa,EAAE,CAAC;IACtB,qDAAqD;IACrD,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,6BAA6B;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,2EAA2E;IAC3E,OAAO,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC7B,sDAAsD;IACtD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,qFAAqF;IACrF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACpC;AAED,qEAAqE;AACrE,MAAM,WAAW,gBAAgB;IAC/B,8DAA8D;IAC9D,GAAG,EAAE,MAAM,CAAC;IACZ,4DAA4D;IAC5D,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,aAAa,EAAE,CAAC;IACtB,uEAAuE;IACvE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC5B,qCAAqC;IACrC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,uEAAuE;IACvE,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACpC;AAED,8EAA8E;AAC9E,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,gBAAgB,EAAE,CAAC;CAC1B;AAED;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,EAAE,aAAa,EAAE,CAAC;IACtB,OAAO,EAAE,gBAAgB,EAAE,CAAC;IAC5B,8DAA8D;IAC9D,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,2DAA2D;IAC3D,MAAM,CAAC,EAAE;QACP,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACzB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QACpB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;KACvB,CAAC;IACF,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4DAA4D;IAC5D,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,0BAA0B;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,qFAAqF;AACrF,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,6CAA6C;AAC7C,MAAM,WAAW,mBAAmB;IAClC,KAAK,EAAE,CAAC,aAAa,GAAG;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,CAAC,EAAE,CAAC;CAC3C;AAED,sEAAsE;AACtE,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,SAAS;QACd,EAAE,EAAE,MAAM,CAAC;QACX,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,CAAC,EAAE,OAAO,CAAC;QACjB,IAAI,EAAE;YAAE,IAAI,EAAE,MAAM,CAAC;YAAC,IAAI,CAAC,EAAE,MAAM,CAAC;YAAC,WAAW,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;KAC7D,EAAE,CAAC;CACL;AAED;;;;;GAKG;AACH,wBAAgB,gBAAgB,CAC9B,QAAQ,EAAE,SAAS,kBAAkB,EAAE,EACvC,SAAS,CAAC,EAAE,MAAM,GACjB,mBAAmB,CAoBrB;AAED,wBAAgB,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAEzE"}

package/dist/components/overview/widgets/line-totals.d.ts

@@ -0,0 +1,48 @@
+/**
+ * The totals block of a document's line items (#3718 record page), pure and
+ * Node-tested. The record's own subtotal / discount / tax / total are
+ * authoritative and shown as they are; a missing one is computed from the
+ * lines (subtotal = sum of line amounts, total = subtotal - discount + tax).
+ * Lines that add up to the recorded total are tax-inclusive and agree.
+ * When the record's figures disagree with the lines, the block flags it
+ * ("Lines add up to $X") instead of silently overriding either side.
+ *
+ * Money is integer minor units throughout.
+ */
+/** The record's own totals fields (`subtotal` / `discount` / `tax` / `total` roles). */
+export interface LineItemsTotals {
+    subtotal?: number | null;
+    discount?: number | null;
+    tax?: number | null;
+    total?: number | null;
+}
+export type LineTotalKey = 'subtotal' | 'discount' | 'tax' | 'total';
+export interface LineTotalLine {
+    key: LineTotalKey;
+    value: number;
+    /** Computed here (the record has no such field or value), not read from the record. */
+    computed: boolean;
+}
+export interface LineTotalsMismatch {
+    /** The record figure the lines disagree with. */
+    field: 'subtotal' | 'total';
+    /** The record's value. */
+    recorded: number;
+    /** What the lines add up to for that figure. */
+    lines: number;
+}
+export interface LineTotalsResult {
+    /** Subtotal, then discount and tax when present and non-zero, then total. */
+    lines: LineTotalLine[];
+    /** Sum of the line amounts, `null` when not every line is known. */
+    lineSum: number | null;
+    mismatch: LineTotalsMismatch | null;
+}
+/** Sum of integer minor-unit amounts; `null` on a non-integer or past the safe range. */
+export declare function sumLineAmounts(amounts: readonly unknown[]): number | null;
+/**
+ * The totals block for `record` totals over lines summing to `lineSum`
+ * (`null` when the lines are a partial page and the host sent no sum).
+ */
+export declare function lineItemTotals(record: LineItemsTotals | undefined, lineSum: number | null): LineTotalsResult;
+//# sourceMappingURL=line-totals.d.ts.map

package/dist/components/overview/widgets/line-totals.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"line-totals.d.ts","sourceRoot":"","sources":["../../../../src/components/overview/widgets/line-totals.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;GAUG;AAEH,wFAAwF;AACxF,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,MAAM,YAAY,GAAG,UAAU,GAAG,UAAU,GAAG,KAAK,GAAG,OAAO,CAAC;AAErE,MAAM,WAAW,aAAa;IAC5B,GAAG,EAAE,YAAY,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,uFAAuF;IACvF,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,kBAAkB;IACjC,iDAAiD;IACjD,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC;IAC5B,0BAA0B;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,gDAAgD;IAChD,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gBAAgB;IAC/B,6EAA6E;IAC7E,KAAK,EAAE,aAAa,EAAE,CAAC;IACvB,oEAAoE;IACpE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,QAAQ,EAAE,kBAAkB,GAAG,IAAI,CAAC;CACrC;AAQD,yFAAyF;AACzF,wBAAgB,cAAc,CAAC,OAAO,EAAE,SAAS,OAAO,EAAE,GAAG,MAAM,GAAG,IAAI,CAUzE;AAED;;;GAGG;AACH,wBAAgB,cAAc,CAC5B,MAAM,EAAE,eAAe,GAAG,SAAS,EACnC,OAAO,EAAE,MAAM,GAAG,IAAI,GACrB,gBAAgB,CA2DlB"}