@viewkitjs/views 0.0.0-stage → 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +420 -0
- package/LICENSE.md +7 -0
- package/README.md +50 -2
- package/dist/atoms/CommandMenu.d.ts +2 -0
- package/dist/atoms/CommandMenu.js +20 -0
- package/dist/atoms/List.d.ts +2 -0
- package/dist/atoms/List.js +6 -0
- package/dist/atoms/LoadMore.d.ts +2 -0
- package/dist/atoms/LoadMore.js +25 -0
- package/dist/atoms/Loading.d.ts +2 -0
- package/dist/atoms/Loading.js +7 -0
- package/dist/atoms/PlatformMark.d.ts +2 -0
- package/dist/atoms/PlatformMark.js +4 -0
- package/dist/atoms/RelationLink.d.ts +2 -0
- package/dist/atoms/RelationLink.js +6 -0
- package/dist/atoms/Row.d.ts +3 -0
- package/dist/atoms/Row.js +30 -0
- package/dist/atoms/RowMenu.d.ts +2 -0
- package/dist/atoms/RowMenu.js +101 -0
- package/dist/atoms/StatusBadge.d.ts +2 -0
- package/dist/atoms/StatusBadge.js +7 -0
- package/dist/atoms/StatusMarker.d.ts +2 -0
- package/dist/atoms/StatusMarker.js +19 -0
- package/dist/atoms/Tag.d.ts +2 -0
- package/dist/atoms/Tag.js +13 -0
- package/dist/atoms/TickBox.d.ts +2 -0
- package/dist/atoms/TickBox.js +8 -0
- package/dist/atoms/defaults.d.ts +2 -0
- package/dist/atoms/defaults.js +27 -0
- package/dist/atoms/tones.d.ts +5 -0
- package/dist/atoms/tones.js +28 -0
- package/dist/atoms/types.d.ts +178 -0
- package/dist/atoms/types.js +3 -0
- package/dist/cells/cell-format.d.ts +138 -0
- package/dist/cells/cell-format.js +16 -0
- package/dist/cells/cell-title.d.ts +17 -0
- package/dist/cells/cell-title.js +8 -0
- package/dist/cells/cell-values.d.ts +28 -0
- package/dist/cells/cell-values.js +87 -0
- package/dist/cells/index.d.ts +4 -0
- package/dist/cells/index.js +4 -0
- package/dist/cells/legacy-field.d.ts +52 -0
- package/dist/cells/legacy-field.js +164 -0
- package/dist/cells/relation-wrap.d.ts +3 -0
- package/dist/cells/relation-wrap.js +24 -0
- package/dist/cells/use-cell-format.d.ts +5 -0
- package/dist/cells/use-cell-format.js +10 -0
- package/dist/contract.d.ts +431 -0
- package/dist/contract.js +663 -0
- package/dist/display/actor.d.ts +4 -0
- package/dist/display/actor.js +26 -0
- package/dist/display/boolean.d.ts +18 -0
- package/dist/display/boolean.js +43 -0
- package/dist/display/breakdown.d.ts +15 -0
- package/dist/display/breakdown.js +32 -0
- package/dist/display/currency.d.ts +9 -0
- package/dist/display/currency.js +29 -0
- package/dist/display/date.d.ts +12 -0
- package/dist/display/date.js +26 -0
- package/dist/display/display-cores.d.ts +31 -0
- package/dist/display/display-cores.js +57 -0
- package/dist/display/entity-chip.d.ts +26 -0
- package/dist/display/entity-chip.js +9 -0
- package/dist/display/format.d.ts +51 -0
- package/dist/display/format.js +181 -0
- package/dist/display/index.d.ts +8 -0
- package/dist/display/index.js +7 -0
- package/dist/display/link.d.ts +29 -0
- package/dist/display/link.js +48 -0
- package/dist/display/location.d.ts +7 -0
- package/dist/display/location.js +15 -0
- package/dist/display/multi-value.d.ts +18 -0
- package/dist/display/multi-value.js +28 -0
- package/dist/display/name.d.ts +6 -0
- package/dist/display/name.js +14 -0
- package/dist/display/number.d.ts +11 -0
- package/dist/display/number.js +27 -0
- package/dist/display/options.d.ts +153 -0
- package/dist/display/options.js +1 -0
- package/dist/display/percent.d.ts +4 -0
- package/dist/display/percent.js +33 -0
- package/dist/display/phone.d.ts +10 -0
- package/dist/display/phone.js +38 -0
- package/dist/display/range.d.ts +6 -0
- package/dist/display/range.js +29 -0
- package/dist/display/relation.d.ts +4 -0
- package/dist/display/relation.js +29 -0
- package/dist/display/rich-text.d.ts +10 -0
- package/dist/display/rich-text.js +34 -0
- package/dist/display/select.d.ts +6 -0
- package/dist/display/select.js +38 -0
- package/dist/display/text-class.d.ts +23 -0
- package/dist/display/text-class.js +5 -0
- package/dist/display/text.d.ts +19 -0
- package/dist/display/text.js +8 -0
- package/dist/display/use-display-options.d.ts +2 -0
- package/dist/display/use-display-options.js +14 -0
- package/dist/display/user.d.ts +11 -0
- package/dist/display/user.js +10 -0
- package/dist/display/value-list.d.ts +10 -0
- package/dist/display/value-list.js +12 -0
- package/dist/display/viewer.d.ts +4 -0
- package/dist/display/viewer.js +11 -0
- package/dist/display/web-href.d.ts +8 -0
- package/dist/display/web-href.js +12 -0
- package/dist/editors/ChipsEditor.d.ts +59 -0
- package/dist/editors/ChipsEditor.js +73 -0
- package/dist/editors/DateEditor.d.ts +25 -0
- package/dist/editors/DateEditor.js +122 -0
- package/dist/editors/LocationEditor.d.ts +22 -0
- package/dist/editors/LocationEditor.js +229 -0
- package/dist/editors/NameEditor.d.ts +22 -0
- package/dist/editors/NameEditor.js +91 -0
- package/dist/editors/NumberEditor.d.ts +67 -0
- package/dist/editors/NumberEditor.js +86 -0
- package/dist/editors/RangeEditor.d.ts +22 -0
- package/dist/editors/RangeEditor.js +70 -0
- package/dist/editors/RelationEditor.d.ts +65 -0
- package/dist/editors/RelationEditor.js +64 -0
- package/dist/editors/SelectEditor.d.ts +72 -0
- package/dist/editors/SelectEditor.js +59 -0
- package/dist/editors/ValueListEditor.d.ts +38 -0
- package/dist/editors/ValueListEditor.js +217 -0
- package/dist/editors/edit-cores.d.ts +83 -0
- package/dist/editors/edit-cores.js +38 -0
- package/dist/editors/edit-session.d.ts +74 -0
- package/dist/editors/edit-session.js +35 -0
- package/dist/editors/open-values.d.ts +28 -0
- package/dist/editors/open-values.js +26 -0
- package/dist/editors/relation-source.d.ts +66 -0
- package/dist/editors/relation-source.js +102 -0
- package/dist/fields/binding.d.ts +87 -0
- package/dist/fields/binding.js +117 -0
- package/dist/fields/currency.d.ts +92 -0
- package/dist/fields/currency.js +55 -0
- package/dist/fields/denomination.d.ts +42 -0
- package/dist/fields/denomination.js +11 -0
- package/dist/fields/edit-core-types.d.ts +40 -0
- package/dist/fields/edit-core-types.js +29 -0
- package/dist/fields/format-knobs.d.ts +34 -0
- package/dist/fields/format-knobs.js +36 -0
- package/dist/fields/menus.d.ts +28 -0
- package/dist/fields/menus.js +1 -0
- package/dist/fields/money.d.ts +59 -0
- package/dist/fields/money.js +77 -0
- package/dist/fields/number-edit.d.ts +11 -0
- package/dist/fields/number-edit.js +17 -0
- package/dist/fields/prepare-write.d.ts +55 -0
- package/dist/fields/prepare-write.js +67 -0
- package/dist/fields/relation-source-types.d.ts +54 -0
- package/dist/fields/relation-source-types.js +1 -0
- package/dist/figures.d.ts +52 -0
- package/dist/figures.js +63 -0
- package/dist/filters/date-filter.d.ts +2 -0
- package/dist/filters/date-filter.js +1 -0
- package/dist/filters/filter-model.d.ts +177 -0
- package/dist/filters/filter-model.js +41 -0
- package/dist/filters/number-filter.d.ts +2 -0
- package/dist/filters/number-filter.js +1 -0
- package/dist/filters/range-filter.d.ts +2 -0
- package/dist/filters/range-filter.js +1 -0
- package/dist/filters/registry.d.ts +136 -0
- package/dist/filters/registry.js +46 -0
- package/dist/filters/relation-filter.d.ts +16 -0
- package/dist/filters/relation-filter.js +53 -0
- package/dist/filters/text-filter.d.ts +2 -0
- package/dist/filters/text-filter.js +1 -0
- package/dist/filters/types.d.ts +27 -0
- package/dist/filters/types.js +1 -0
- package/dist/grouping/sort-groups.d.ts +18 -0
- package/dist/grouping/sort-groups.js +33 -0
- package/dist/grouping/types.d.ts +10 -0
- package/dist/grouping/types.js +1 -0
- package/dist/index.d.ts +29 -0
- package/dist/index.js +29 -0
- package/dist/internal/chip.d.ts +4 -0
- package/dist/internal/chip.js +3 -0
- package/dist/internal/cx.d.ts +3 -0
- package/dist/internal/cx.js +3 -0
- package/dist/model/aggregates.d.ts +59 -0
- package/dist/model/aggregates.js +186 -0
- package/dist/model/card-density.d.ts +8 -0
- package/dist/model/card-density.js +10 -0
- package/dist/model/card-layout.d.ts +85 -0
- package/dist/model/card-layout.js +90 -0
- package/dist/model/column-capabilities.d.ts +162 -0
- package/dist/model/column-capabilities.js +233 -0
- package/dist/model/column-filters.d.ts +106 -0
- package/dist/model/column-filters.js +321 -0
- package/dist/model/column-format.d.ts +103 -0
- package/dist/model/column-format.js +1 -0
- package/dist/model/column-from.d.ts +28 -0
- package/dist/model/column-from.js +160 -0
- package/dist/model/column-inspect.d.ts +18 -0
- package/dist/model/column-inspect.js +6 -0
- package/dist/model/column-knobs.d.ts +20 -0
- package/dist/model/column-knobs.js +16 -0
- package/dist/model/column-money.d.ts +13 -0
- package/dist/model/column-money.js +27 -0
- package/dist/model/column-order.d.ts +36 -0
- package/dist/model/column-order.js +68 -0
- package/dist/model/column-schema.d.ts +335 -0
- package/dist/model/column-schema.js +1 -0
- package/dist/model/column-sort.d.ts +17 -0
- package/dist/model/column-sort.js +11 -0
- package/dist/model/column-state.d.ts +77 -0
- package/dist/model/column-state.js +95 -0
- package/dist/model/column-types.d.ts +109 -0
- package/dist/model/column-types.js +50 -0
- package/dist/model/column-warnings.d.ts +44 -0
- package/dist/model/column-warnings.js +24 -0
- package/dist/model/density.d.ts +3 -0
- package/dist/model/density.js +13 -0
- package/dist/model/field-type-of.d.ts +21 -0
- package/dist/model/field-type-of.js +11 -0
- package/dist/model/filter-capabilities.d.ts +1 -0
- package/dist/model/filter-capabilities.js +1 -0
- package/dist/model/filter-pushdown.d.ts +106 -0
- package/dist/model/filter-pushdown.js +147 -0
- package/dist/model/index.d.ts +40 -0
- package/dist/model/index.js +21 -0
- package/dist/model/part-rows.d.ts +28 -0
- package/dist/model/part-rows.js +40 -0
- package/dist/model/preferences.d.ts +151 -0
- package/dist/model/preferences.js +84 -0
- package/dist/model/prefs-buckets.d.ts +173 -0
- package/dist/model/prefs-buckets.js +71 -0
- package/dist/model/relation-filters.d.ts +45 -0
- package/dist/model/relation-filters.js +78 -0
- package/dist/model/render-count.d.ts +2 -0
- package/dist/model/render-count.js +24 -0
- package/dist/model/row-icon.d.ts +23 -0
- package/dist/model/row-icon.js +5 -0
- package/dist/model/view-rules.d.ts +73 -0
- package/dist/model/view-rules.js +216 -0
- package/dist/provider/ViewsProvider.d.ts +26 -0
- package/dist/provider/ViewsProvider.js +12 -0
- package/dist/provider/components.d.ts +222 -0
- package/dist/provider/components.js +3 -0
- package/dist/provider/context.d.ts +19 -0
- package/dist/provider/context.js +10 -0
- package/dist/provider/icons.d.ts +6 -0
- package/dist/provider/icons.js +1 -0
- package/dist/provider/ports.d.ts +35 -0
- package/dist/provider/ports.js +8 -0
- package/dist/react.d.ts +9 -0
- package/dist/react.js +4 -0
- package/dist/selection/SelectCheckbox.d.ts +17 -0
- package/dist/selection/SelectCheckbox.js +11 -0
- package/dist/selection/index.d.ts +7 -0
- package/dist/selection/index.js +6 -0
- package/dist/selection/model.d.ts +55 -0
- package/dist/selection/model.js +86 -0
- package/dist/selection/row-click.d.ts +35 -0
- package/dist/selection/row-click.js +20 -0
- package/dist/selection/types.d.ts +17 -0
- package/dist/selection/types.js +1 -0
- package/dist/selection/useCheckDragSelect.d.ts +61 -0
- package/dist/selection/useCheckDragSelect.js +165 -0
- package/dist/selection/useListSelection.d.ts +39 -0
- package/dist/selection/useListSelection.js +48 -0
- package/dist/selection/useListSelectionShortcuts.d.ts +6 -0
- package/dist/selection/useListSelectionShortcuts.js +14 -0
- package/dist/selection/useRestIntent.d.ts +18 -0
- package/dist/selection/useRestIntent.js +35 -0
- package/docs/contract.md +453 -0
- package/docs/install.md +105 -0
- package/docs/reshaping.md +19 -0
- package/package.json +114 -3
- package/skills/views/SKILL.md +87 -0
|
@@ -0,0 +1,103 @@
|
|
|
1
|
+
import type { ReactNode } from "react";
|
|
2
|
+
import type { PercentDisplay } from "@viewkitjs/fields";
|
|
3
|
+
import type { DurationStyle } from "@viewkitjs/fields/format/time";
|
|
4
|
+
export type ListDateStyle = "short" | "long" | "numeric" | "relative";
|
|
5
|
+
/** How a duration reads. Defined in `lib/format/time` beside the formatter
|
|
6
|
+
* that implements it, re-exported here so a column declares it in list
|
|
7
|
+
* vocabulary without two unions drifting apart. */
|
|
8
|
+
export type ListDurationStyle = DurationStyle;
|
|
9
|
+
export type ListNumberFormatState = {
|
|
10
|
+
decimals?: number;
|
|
11
|
+
/** A convertible money column's reading in force, and the readings the
|
|
12
|
+
* header menu offers (Original first). Absent on a column that reads one way. */
|
|
13
|
+
currency?: string;
|
|
14
|
+
currencyOptions?: {
|
|
15
|
+
value: string;
|
|
16
|
+
label: string;
|
|
17
|
+
}[];
|
|
18
|
+
};
|
|
19
|
+
export type ListNumberFormatOverrides = Record<string, ListNumberFormatState>;
|
|
20
|
+
export type ListDateStyleOverrides = Record<string, ListDateStyle>;
|
|
21
|
+
export type ListDurationStyleOverrides = Record<string, ListDurationStyle>;
|
|
22
|
+
export type ListShowTimeOverrides = Record<string, boolean>;
|
|
23
|
+
export type ListPercentDisplayOverrides = Record<string, PercentDisplay>;
|
|
24
|
+
export type ListColumnFormat = {
|
|
25
|
+
/**
|
|
26
|
+
* A `number` column's one denomination that is not a type: `duration` is
|
|
27
|
+
* always milliseconds, everywhere — the cell, the filter rule and the
|
|
28
|
+
* aggregate all carry ms and only the presentation is human (`1.2s`,
|
|
29
|
+
* `3m 04s`). That is what keeps it a number rather than a type of its own —
|
|
30
|
+
* comparison, sorting, sum/avg/min/max, paste and the cursor all work on it
|
|
31
|
+
* unchanged, and a column declaring it inherits every one of them.
|
|
32
|
+
*
|
|
33
|
+
* Percent and currency are TYPES; a legacy `number` column wearing one of
|
|
34
|
+
* those styles is retyped, not restyled.
|
|
35
|
+
*/
|
|
36
|
+
style?: "plain" | "duration";
|
|
37
|
+
/** `duration` only: the unit the value is STORED in (default `ms`) — `NumberFormat.unit`. */
|
|
38
|
+
unit?: "ms" | "s";
|
|
39
|
+
/** ONE code for every number in the column. On a convertible column (one
|
|
40
|
+
* whose binding states rates) the SURFACE writes what the column opens on —
|
|
41
|
+
* a currency, or `"default"` for the reader's own — and `readMoneyColumn`
|
|
42
|
+
* rewrites it to the reading in force (absent under Original). */
|
|
43
|
+
currency?: string;
|
|
44
|
+
signed?: boolean;
|
|
45
|
+
/**
|
|
46
|
+
* Whether a POSITIVE signed number should read as good (tinted) or as merely
|
|
47
|
+
* larger. Defaults to "positive-good", which is right for money in; set
|
|
48
|
+
* "neutral" for a column where up is not an improvement (churn, error rate,
|
|
49
|
+
* days overdue) so the cell stops colouring bad news green.
|
|
50
|
+
*/
|
|
51
|
+
signedTone?: "positive-good" | "neutral";
|
|
52
|
+
/**
|
|
53
|
+
* This column has a custom `render` that does NOT read the workspace's
|
|
54
|
+
* format settings (decimals, display, date style…). Declared so the header
|
|
55
|
+
* menu and the Columns drill-in withhold knobs the cell would ignore. The
|
|
56
|
+
* default is the other way: a bound column's custom cell is expected to
|
|
57
|
+
* thread the options it is handed, as the subscriptions cost cell does.
|
|
58
|
+
*/
|
|
59
|
+
ignoresOverrides?: boolean;
|
|
60
|
+
decimals?: number;
|
|
61
|
+
suffix?: string;
|
|
62
|
+
dateStyle?: ListDateStyle;
|
|
63
|
+
/**
|
|
64
|
+
* Which of the three duration renderings this column defaults to. Only read
|
|
65
|
+
* when `style: "duration"`. The user's per-column override wins over it,
|
|
66
|
+
* exactly as it does for `dateStyle` — the column picks the sensible default
|
|
67
|
+
* for what it measures, the reader picks what they want to see.
|
|
68
|
+
*/
|
|
69
|
+
durationStyle?: ListDurationStyle;
|
|
70
|
+
/** percent: the column's default drawing, from the field's `format.display`.
|
|
71
|
+
* The workspace's field setting wins over it, as `dateStyle`'s does. */
|
|
72
|
+
percentDisplay?: PercentDisplay;
|
|
73
|
+
withTime?: boolean;
|
|
74
|
+
long?: boolean;
|
|
75
|
+
/**
|
|
76
|
+
* boolean — this knob is a WRITE POLICY as much as a look. Four looks:
|
|
77
|
+
* - `checkbox` (default) — both states are real information; drawn either
|
|
78
|
+
* way; the write is a two-way flip.
|
|
79
|
+
* - `icon` — a two-way flip like `checkbox`, drawn with the column's own
|
|
80
|
+
* glyph instead of a box (a star for a favourite, a pin, a bell). Supply
|
|
81
|
+
* `format.icon`; without it this falls back to the checkbox glyph.
|
|
82
|
+
* - `text` — the column's own two words as plain, read-only text, from its
|
|
83
|
+
* `options` keyed `"true"`/`"false"` ("True"/"False" with none declared).
|
|
84
|
+
* An observed fact — "Configured" / "Missing" — never a switch.
|
|
85
|
+
* - `marker` — `true` is an EXCEPTION raised elsewhere (a pipeline flag, a
|
|
86
|
+
* review hold). Nothing is drawn when false, and the only write is
|
|
87
|
+
* `true → false` ("resolve").
|
|
88
|
+
* Display and verb are one knob because a marker draws nothing when false:
|
|
89
|
+
* there is no affordance to click to turn it ON, so the shape dictates the
|
|
90
|
+
* verb. Which one a column is comes down to: is `false` worth drawing?
|
|
91
|
+
* None of the four is a pill: a value that reads as a STATE on screen is a
|
|
92
|
+
* `status` column, and says so in its type.
|
|
93
|
+
*/
|
|
94
|
+
booleanDisplay?: "checkbox" | "icon" | "text" | "marker";
|
|
95
|
+
/**
|
|
96
|
+
* The glyph for a `booleanDisplay: "icon"` column, given the current state —
|
|
97
|
+
* so one column can draw a filled star for `true` and a hollow one for
|
|
98
|
+
* `false`. A render fn rather than a pair of icon slots, matching
|
|
99
|
+
* `ListCellAction.icon(row)`; the cell owns nothing about which library the
|
|
100
|
+
* glyph comes from.
|
|
101
|
+
*/
|
|
102
|
+
icon?: (on: boolean) => ReactNode;
|
|
103
|
+
};
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export {};
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { ReactNode } from "react";
|
|
2
|
+
import { type FieldBinding } from "../fields/binding.js";
|
|
3
|
+
import { type FieldDef } from "@viewkitjs/fields";
|
|
4
|
+
import type { ListColumn } from "./column-schema.js";
|
|
5
|
+
/** Everything a column declares that neither the field nor the binding can
|
|
6
|
+
* know. `type`, `options`, `field`, `binding`, `custom`, `command` and `ratio`
|
|
7
|
+
* are derived; `header` defaults to the field's label; the reading keys come
|
|
8
|
+
* from the binding. */
|
|
9
|
+
export type ColumnPresentation<Row> = Omit<ListColumn<Row>, "type" | "options" | "field" | "binding" | "header" | "accessor" | "editAccessor" | "editUnit" | "currencyAccessor" | "surfaceOwnsCurrency" | "money" | "reading" | "relation" | "multiple" | "chips" | "icon" | "custom" | "command" | "ratio"> & {
|
|
10
|
+
header?: ReactNode;
|
|
11
|
+
/** A surface that READS differently than the binding (an FX-converted amount
|
|
12
|
+
* for display-currency sorting) may override; the binding's `write` still
|
|
13
|
+
* maps the commit.
|
|
14
|
+
*
|
|
15
|
+
* `null` means "this surface draws the value itself and offers no comparable
|
|
16
|
+
* value": the column then carries NO accessor at all — the key stays absent,
|
|
17
|
+
* which is what the readers that key on its absence look for (the filter
|
|
18
|
+
* panel lists the column but leaves it inert, paste-option and relation-value
|
|
19
|
+
* harvesting skip it). The editor still opens on the stored value, because
|
|
20
|
+
* `editAccessor` is carried from the binding either way.
|
|
21
|
+
*
|
|
22
|
+
* Either shape — an override or `null` — means the number this column shows
|
|
23
|
+
* is not the one the binding reads, so the binding's `unit` stops being that
|
|
24
|
+
* number's denomination and no `currencyAccessor` is derived. */
|
|
25
|
+
accessor?: ((row: Row) => unknown) | null;
|
|
26
|
+
editAccessor?: (row: Row) => unknown;
|
|
27
|
+
};
|
|
28
|
+
export declare function columnFrom<Row, D extends FieldDef>(binding: FieldBinding<Row, D>, presentation: ColumnPresentation<Row>): ListColumn<Row>;
|
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
import { bindingWritable } from "../fields/binding.js";
|
|
2
|
+
import { readMoneyColumn, resolveOpensOn } from "../fields/money.js";
|
|
3
|
+
import { moneyDeclarationFor } from "./column-money.js";
|
|
4
|
+
import { derivedReason, FieldDefinitionError, isDerived, isIntegerField, isMultipleType, normalizerFor, presentedDef, relationKinds, valueTypeOf, } from "@viewkitjs/fields";
|
|
5
|
+
import { typeRule } from "./column-types.js";
|
|
6
|
+
const NUMERIC_TYPES = new Set(["number", "percent", "currency"]);
|
|
7
|
+
function typeOf(field) {
|
|
8
|
+
if (field.identity)
|
|
9
|
+
return "title";
|
|
10
|
+
return valueTypeOf(field);
|
|
11
|
+
}
|
|
12
|
+
function formatOf(field) {
|
|
13
|
+
const def = presentedDef(field);
|
|
14
|
+
const integer = isIntegerField(def);
|
|
15
|
+
switch (def.type) {
|
|
16
|
+
case "number": {
|
|
17
|
+
const f = def.format ?? {};
|
|
18
|
+
const out = { style: f.style ?? "plain" };
|
|
19
|
+
if ("decimals" in f && f.decimals !== undefined)
|
|
20
|
+
out.decimals = f.decimals;
|
|
21
|
+
if ("suffix" in f && f.suffix !== undefined)
|
|
22
|
+
out.suffix = f.suffix;
|
|
23
|
+
if ("signed" in f && f.signed !== undefined)
|
|
24
|
+
out.signed = f.signed;
|
|
25
|
+
if ("signedTone" in f && f.signedTone !== undefined)
|
|
26
|
+
out.signedTone = f.signedTone;
|
|
27
|
+
if ("durationStyle" in f && f.durationStyle !== undefined)
|
|
28
|
+
out.durationStyle = f.durationStyle;
|
|
29
|
+
if ("unit" in f && f.unit)
|
|
30
|
+
out.unit = f.unit;
|
|
31
|
+
if (integer && out.style !== "duration" && out.decimals === undefined)
|
|
32
|
+
out.decimals = 0;
|
|
33
|
+
if (!def.format && !integer)
|
|
34
|
+
return undefined;
|
|
35
|
+
return out;
|
|
36
|
+
}
|
|
37
|
+
case "percent": {
|
|
38
|
+
const out = { decimals: integer ? 0 : (def.format?.decimals ?? 0) };
|
|
39
|
+
if (def.format?.display)
|
|
40
|
+
out.percentDisplay = def.format.display;
|
|
41
|
+
return out;
|
|
42
|
+
}
|
|
43
|
+
case "currency": {
|
|
44
|
+
const out = { decimals: integer ? 0 : (def.format?.decimals ?? 2) };
|
|
45
|
+
if ("fixed" in def.code)
|
|
46
|
+
out.currency = def.code.fixed;
|
|
47
|
+
if (def.format?.suffix !== undefined)
|
|
48
|
+
out.suffix = def.format.suffix;
|
|
49
|
+
if (def.format?.signed !== undefined)
|
|
50
|
+
out.signed = def.format.signed;
|
|
51
|
+
if (def.format?.signedTone !== undefined)
|
|
52
|
+
out.signedTone = def.format.signedTone;
|
|
53
|
+
return out;
|
|
54
|
+
}
|
|
55
|
+
case "date":
|
|
56
|
+
return def.format?.dateStyle ? { dateStyle: def.format.dateStyle } : undefined;
|
|
57
|
+
case "datetime": {
|
|
58
|
+
const out = {};
|
|
59
|
+
if (def.format?.dateStyle)
|
|
60
|
+
out.dateStyle = def.format.dateStyle;
|
|
61
|
+
if (def.format?.withTime)
|
|
62
|
+
out.withTime = true;
|
|
63
|
+
return Object.keys(out).length ? out : undefined;
|
|
64
|
+
}
|
|
65
|
+
case "boolean":
|
|
66
|
+
return def.format?.style ? { booleanDisplay: def.format.style } : undefined;
|
|
67
|
+
case "text":
|
|
68
|
+
return def.format?.long ? { long: true } : undefined;
|
|
69
|
+
default:
|
|
70
|
+
return undefined;
|
|
71
|
+
}
|
|
72
|
+
}
|
|
73
|
+
export function columnFrom(binding, presentation) {
|
|
74
|
+
const field = binding.field;
|
|
75
|
+
const { header, reasons, format, editable, clearable, accessor, editAccessor, ...rest } = presentation;
|
|
76
|
+
if (presentation.custom) {
|
|
77
|
+
throw new FieldDefinitionError(field.key, `column "${rest.id}" hand-writes custom on a bound column — a derived value is a rollup or formula field`);
|
|
78
|
+
}
|
|
79
|
+
if (rest.aggAccessor && accessor === undefined) {
|
|
80
|
+
throw new FieldDefinitionError(field.key, `column "${rest.id}" passes aggAccessor without its own accessor — the footer totals the binding's read; declare both or neither`);
|
|
81
|
+
}
|
|
82
|
+
const writable = bindingWritable(binding);
|
|
83
|
+
if (editable === true && !writable) {
|
|
84
|
+
throw new FieldDefinitionError(field.key, `column "${rest.id}" claims editable but its binding has no write (or the field is ${field.edit?.mutability})`);
|
|
85
|
+
}
|
|
86
|
+
if (editable === true && reasons?.editable) {
|
|
87
|
+
throw new FieldDefinitionError(field.key, `column "${rest.id}" cannot both refuse and offer an edit — it states reasons.editable ("${reasons.editable}") and asks for editable: true`);
|
|
88
|
+
}
|
|
89
|
+
const derivedFormat = formatOf(field);
|
|
90
|
+
const mergedFormat = derivedFormat || format ? { ...derivedFormat, ...format } : undefined;
|
|
91
|
+
const presented = presentedDef(field);
|
|
92
|
+
const mergedReasons = presented.edit?.reasons || reasons ? { ...presented.edit?.reasons, ...reasons } : undefined;
|
|
93
|
+
const options = "options" in presented && presented.options ? [...presented.options] : undefined;
|
|
94
|
+
const column = {
|
|
95
|
+
...rest,
|
|
96
|
+
header: header ?? field.label,
|
|
97
|
+
type: typeOf(field),
|
|
98
|
+
...(rest.align === undefined && NUMERIC_TYPES.has(valueTypeOf(field))
|
|
99
|
+
? { align: "right" }
|
|
100
|
+
: {}),
|
|
101
|
+
field,
|
|
102
|
+
binding,
|
|
103
|
+
};
|
|
104
|
+
const displayRead = accessor === null ? undefined : (accessor ?? binding.read);
|
|
105
|
+
if (displayRead)
|
|
106
|
+
column.accessor = displayRead;
|
|
107
|
+
const editRead = editAccessor ?? binding.editRead;
|
|
108
|
+
if (editRead)
|
|
109
|
+
column.editAccessor = editRead;
|
|
110
|
+
if (options)
|
|
111
|
+
column.options = options;
|
|
112
|
+
if (mergedFormat)
|
|
113
|
+
column.format = mergedFormat;
|
|
114
|
+
if (mergedReasons)
|
|
115
|
+
column.reasons = mergedReasons;
|
|
116
|
+
if (isDerived(field))
|
|
117
|
+
column.custom = { from: derivedReason(field) };
|
|
118
|
+
if (field.edit?.mutability === "command")
|
|
119
|
+
column.command = true;
|
|
120
|
+
if (binding.ratio)
|
|
121
|
+
column.ratio = binding.ratio;
|
|
122
|
+
const hasEditor = typeRule(column.type)?.editor != null || column.type === "boolean";
|
|
123
|
+
if (writable && hasEditor && editable !== false && !reasons?.editable)
|
|
124
|
+
column.editable = true;
|
|
125
|
+
const money = moneyDeclarationFor(binding, { id: rest.id, accessor, aggAccessor: rest.aggAccessor, format });
|
|
126
|
+
if (money && binding.unit) {
|
|
127
|
+
column.editUnit = { value: binding.unit.read, options: [...binding.unit.options] };
|
|
128
|
+
column.money = money;
|
|
129
|
+
}
|
|
130
|
+
const surfaceOwnsShownCode = accessor !== undefined || format?.currency !== undefined;
|
|
131
|
+
const surfaceOwnsCurrency = accessor !== null && (accessor !== undefined || format?.currency !== undefined);
|
|
132
|
+
if (surfaceOwnsCurrency && valueTypeOf(field) === "currency" && !column.money)
|
|
133
|
+
column.surfaceOwnsCurrency = true;
|
|
134
|
+
if (binding.unit && !column.money) {
|
|
135
|
+
column.editUnit = { value: binding.unit.read, options: [...binding.unit.options] };
|
|
136
|
+
if (!surfaceOwnsShownCode)
|
|
137
|
+
column.currencyAccessor = binding.unit.read;
|
|
138
|
+
}
|
|
139
|
+
const clear = clearable ?? (field.nullable || field.emptiable ? true : undefined);
|
|
140
|
+
if (clear !== undefined)
|
|
141
|
+
column.clearable = clear;
|
|
142
|
+
const shown = presentedDef(field);
|
|
143
|
+
if (shown.type === "relation" || shown.type === "user") {
|
|
144
|
+
const source = binding.relation;
|
|
145
|
+
column.relation = {
|
|
146
|
+
entity: shown.type === "user" ? "user" : relationKinds(shown)[0],
|
|
147
|
+
...(source ? { source } : {}),
|
|
148
|
+
...(source?.kind === "static" ? { options: source.items } : {}),
|
|
149
|
+
};
|
|
150
|
+
}
|
|
151
|
+
if (isMultipleType(shown.type) && "multiple" in shown && shown.multiple)
|
|
152
|
+
column.multiple = true;
|
|
153
|
+
if (binding.labels === false)
|
|
154
|
+
column.labels = false;
|
|
155
|
+
if (shown.type === "multiselect")
|
|
156
|
+
column.chips = { normalize: normalizerFor(shown) };
|
|
157
|
+
if (column.money)
|
|
158
|
+
return readMoneyColumn(column, resolveOpensOn(column.money.opensOn, "EUR"));
|
|
159
|
+
return column;
|
|
160
|
+
}
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
import type { ListColumn } from "./column-schema.js";
|
|
2
|
+
/**
|
|
3
|
+
* The grid's READ capability — whether a cell opens a panel to be read in full,
|
|
4
|
+
* independent of whether it can be written.
|
|
5
|
+
*
|
|
6
|
+
* `column-capabilities` answers the write questions (does this column mount an
|
|
7
|
+
* editor, can it be written, in what shape). This file answers the one read
|
|
8
|
+
* question the mount gestures (click-on-focused, double-click, Enter) ask
|
|
9
|
+
* beside them: a long text you cannot edit is still worth reading in full, and
|
|
10
|
+
* the anchored panel is the one reading surface the grid has. Today only long
|
|
11
|
+
* text qualifies.
|
|
12
|
+
*/
|
|
13
|
+
/** A text column whose value is a paragraph, not a phrase — the field said so
|
|
14
|
+
* with `format.long`. It edits (and reads) in the anchored long-text panel
|
|
15
|
+
* rather than the one-line inline input. */
|
|
16
|
+
export declare function isLongTextColumn<Row>(col: ListColumn<Row>): boolean;
|
|
17
|
+
/** Whether a cell opens a PANEL to be READ, whatever its write state. */
|
|
18
|
+
export declare function gridColumnInspectable<Row>(col: ListColumn<Row>): boolean;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { type FormatKnobKind } from "../fields/format-knobs.js";
|
|
2
|
+
import type { ListColumn } from "./column-schema.js";
|
|
3
|
+
/**
|
|
4
|
+
* WHICH KNOBS THIS COLUMN OFFERS — one answer for the header menu and the
|
|
5
|
+
* Columns drill-in, so the two doors cannot disagree (they used to, by a
|
|
6
|
+
* comment asking them to move together).
|
|
7
|
+
*
|
|
8
|
+
* The TYPE answers (`formatKnobsForField`: a percent's display and decimals,
|
|
9
|
+
* a datetime's style and time toggle, an integer's nothing-to-argue). The
|
|
10
|
+
* column may only SUBTRACT: a plain number has no duration style; a duration
|
|
11
|
+
* has no decimals; a currency's Display-in exists only on a column whose
|
|
12
|
+
* binding states rates (`money`) — a fixed-code or rate-less money column
|
|
13
|
+
* reads one way and offers nothing to pick; a custom render that cannot honour
|
|
14
|
+
* a knob says so (`format.ignoresOverrides`) — the default is that it does,
|
|
15
|
+
* because a bound column's cell reads the same options the typed cell does.
|
|
16
|
+
*
|
|
17
|
+
* A field-less column offers nothing: a knob writes a field's shared setting,
|
|
18
|
+
* and there is no field to write it against.
|
|
19
|
+
*/
|
|
20
|
+
export declare function columnKnobs<Row>(col: ListColumn<Row>): ReadonlySet<FormatKnobKind>;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { formatKnobsForField } from "../fields/format-knobs.js";
|
|
2
|
+
export function columnKnobs(col) {
|
|
3
|
+
if (!col.field)
|
|
4
|
+
return new Set();
|
|
5
|
+
if (col.render && col.format?.ignoresOverrides)
|
|
6
|
+
return new Set();
|
|
7
|
+
const knobs = new Set(formatKnobsForField(col.field));
|
|
8
|
+
const duration = col.format?.style === "duration";
|
|
9
|
+
if (!duration)
|
|
10
|
+
knobs.delete("durationStyle");
|
|
11
|
+
if (duration)
|
|
12
|
+
knobs.delete("decimals");
|
|
13
|
+
if (!col.money)
|
|
14
|
+
knobs.delete("currency");
|
|
15
|
+
return knobs;
|
|
16
|
+
}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { type FieldDef } from "@viewkitjs/fields";
|
|
2
|
+
import type { FieldBinding } from "../fields/binding.js";
|
|
3
|
+
import { type MoneyDeclaration } from "../fields/money.js";
|
|
4
|
+
/** The declaration, or `undefined` for a binding with no rates. Throws at build
|
|
5
|
+
* time — never at read time — for a shape that cannot be convertible. */
|
|
6
|
+
export declare function moneyDeclarationFor<Row, D extends FieldDef>(binding: FieldBinding<Row, D>, presentation: {
|
|
7
|
+
id: string;
|
|
8
|
+
accessor?: ((row: Row) => unknown) | null;
|
|
9
|
+
aggAccessor?: (row: Row) => number | null;
|
|
10
|
+
format?: {
|
|
11
|
+
currency?: string;
|
|
12
|
+
};
|
|
13
|
+
}): MoneyDeclaration<Row> | undefined;
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import { FieldDefinitionError, presentedDef, valueTypeOf } from "@viewkitjs/fields";
|
|
2
|
+
import { isMoneyOpensOn } from "../fields/money.js";
|
|
3
|
+
import { ORIGINAL_READING } from "../fields/currency.js";
|
|
4
|
+
export function moneyDeclarationFor(binding, presentation) {
|
|
5
|
+
const unit = binding.unit;
|
|
6
|
+
const rates = unit?.rates;
|
|
7
|
+
if (!unit || !rates)
|
|
8
|
+
return undefined;
|
|
9
|
+
const field = binding.field;
|
|
10
|
+
if (valueTypeOf(field) !== "currency")
|
|
11
|
+
throw new FieldDefinitionError(field.key, "only a currency field can carry rates");
|
|
12
|
+
const presented = presentedDef(field);
|
|
13
|
+
if (presented.type !== "currency" || !("field" in presented.code))
|
|
14
|
+
throw new FieldDefinitionError(field.key, "rates on a fixed-code field: there is nothing to convert from");
|
|
15
|
+
if (presentation.accessor === null)
|
|
16
|
+
throw new FieldDefinitionError(field.key, `column "${presentation.id}" is convertible but draws its own cell — a convertible amount must expose a comparable value`);
|
|
17
|
+
const opensOn = presentation.format?.currency ?? ORIGINAL_READING;
|
|
18
|
+
if (!isMoneyOpensOn(opensOn))
|
|
19
|
+
throw new FieldDefinitionError(field.key, `column "${presentation.id}" opens on "${String(opensOn)}", which is not a reading — Original, EUR, USD, RON or default`);
|
|
20
|
+
return {
|
|
21
|
+
amount: presentation.accessor ?? binding.read,
|
|
22
|
+
...(presentation.aggAccessor ? { total: presentation.aggAccessor } : {}),
|
|
23
|
+
code: unit.read,
|
|
24
|
+
rates,
|
|
25
|
+
opensOn,
|
|
26
|
+
};
|
|
27
|
+
}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import { type FieldDef } from "@viewkitjs/fields";
|
|
2
|
+
import type { OrderDir } from "../grouping/sort-groups.js";
|
|
3
|
+
import type { ListColumn } from "./column-schema.js";
|
|
4
|
+
/** Whether a column offers Group by on a saved view: it presents a field of a type that splits a list, and the
|
|
5
|
+
* list has not taken it out (`bucketable: false`). */
|
|
6
|
+
export declare function columnGroupable<Row>(col: ListColumn<Row>): boolean;
|
|
7
|
+
/** A Sort option: its key, the column it sorts by and, for one order of a value, that order (`by`). The sort a host
|
|
8
|
+
* stores is `{ fieldKey: column.field.key, direction, by }`. */
|
|
9
|
+
export type SortableEntry<Row> = {
|
|
10
|
+
key: string;
|
|
11
|
+
column: ListColumn<Row>;
|
|
12
|
+
by?: string;
|
|
13
|
+
};
|
|
14
|
+
/** The columns a saved view can sort by, one per sort key, in the columns' order: the first column that presents
|
|
15
|
+
* a key keeps it. With `parts`, each order of a value beyond its whole sort (`SORT_PART_ROWS`) follows its column,
|
|
16
|
+
* keyed `partKey(fieldKey, by)` (VK-57). */
|
|
17
|
+
export declare function sortableColumns<Row>(columns: readonly ListColumn<Row>[], opts?: {
|
|
18
|
+
parts?: boolean;
|
|
19
|
+
}): SortableEntry<Row>[];
|
|
20
|
+
/** The columns a saved view can group by, one per field, in the columns' order. */
|
|
21
|
+
export declare function groupableColumns<Row>(columns: readonly ListColumn<Row>[]): ListColumn<Row>[];
|
|
22
|
+
/** A Group dimension: its key, the column it groups by and, for one order of a value, that order (`by`). The axis a
|
|
23
|
+
* host stores is `{ fieldKey: column.field.key, by }`. */
|
|
24
|
+
export type GroupableEntry<Row> = {
|
|
25
|
+
key: string;
|
|
26
|
+
column: ListColumn<Row>;
|
|
27
|
+
by?: string;
|
|
28
|
+
};
|
|
29
|
+
/** The Group dimensions, one per field and, with `parts`, one per order a type groups by (`GROUP_PART_ROWS`), keyed
|
|
30
|
+
* `partKey(fieldKey, by)` (VK-57); without `parts`, exactly `groupableColumns`' columns, keyed by field key. */
|
|
31
|
+
export declare function groupableOrders<Row>(columns: readonly ListColumn<Row>[], opts?: {
|
|
32
|
+
parts?: boolean;
|
|
33
|
+
}): GroupableEntry<Row>[];
|
|
34
|
+
/** The direction a sort by `field` opens in: a date newest first, a number or a yes/no largest first, text and
|
|
35
|
+
* options A to Z; a date that looks ahead (a due date) soonest first. */
|
|
36
|
+
export declare function sortDirFor(field: FieldDef): OrderDir;
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import { looksAhead, valueTypeOf } from "@viewkitjs/fields";
|
|
2
|
+
import { canGroupBy } from "@viewkitjs/fields/query";
|
|
3
|
+
import { effectiveSortKey } from "./column-sort.js";
|
|
4
|
+
import { GROUP_PART_ROWS, SORT_PART_ROWS, partKey } from "./part-rows.js";
|
|
5
|
+
export function columnGroupable(col) {
|
|
6
|
+
return !!col.field && col.bucketable !== false && canGroupBy(valueTypeOf(col.field));
|
|
7
|
+
}
|
|
8
|
+
export function sortableColumns(columns, opts) {
|
|
9
|
+
const seen = new Set();
|
|
10
|
+
const out = [];
|
|
11
|
+
const add = (entry) => {
|
|
12
|
+
if (seen.has(entry.key))
|
|
13
|
+
return;
|
|
14
|
+
seen.add(entry.key);
|
|
15
|
+
out.push(entry);
|
|
16
|
+
};
|
|
17
|
+
for (const column of columns) {
|
|
18
|
+
const key = effectiveSortKey(column, true);
|
|
19
|
+
if (key)
|
|
20
|
+
add({ key, column });
|
|
21
|
+
if (!opts?.parts || !column.field || !column.accessor || column.sortable === false)
|
|
22
|
+
continue;
|
|
23
|
+
for (const by of SORT_PART_ROWS[valueTypeOf(column.field)] ?? [])
|
|
24
|
+
add({ key: partKey(column.field.key, by), column, by });
|
|
25
|
+
}
|
|
26
|
+
return out;
|
|
27
|
+
}
|
|
28
|
+
export function groupableColumns(columns) {
|
|
29
|
+
const seen = new Set();
|
|
30
|
+
return columns.filter((column) => {
|
|
31
|
+
if (!columnGroupable(column))
|
|
32
|
+
return false;
|
|
33
|
+
const key = column.field.key;
|
|
34
|
+
if (seen.has(key))
|
|
35
|
+
return false;
|
|
36
|
+
seen.add(key);
|
|
37
|
+
return true;
|
|
38
|
+
});
|
|
39
|
+
}
|
|
40
|
+
export function groupableOrders(columns, opts) {
|
|
41
|
+
const seen = new Set();
|
|
42
|
+
const out = [];
|
|
43
|
+
const add = (entry) => {
|
|
44
|
+
if (seen.has(entry.key))
|
|
45
|
+
return;
|
|
46
|
+
seen.add(entry.key);
|
|
47
|
+
out.push(entry);
|
|
48
|
+
};
|
|
49
|
+
for (const column of columns) {
|
|
50
|
+
if (!column.field)
|
|
51
|
+
continue;
|
|
52
|
+
if (columnGroupable(column))
|
|
53
|
+
add({ key: column.field.key, column });
|
|
54
|
+
if (!opts?.parts || !column.accessor || column.bucketable === false)
|
|
55
|
+
continue;
|
|
56
|
+
const type = valueTypeOf(column.field);
|
|
57
|
+
for (const by of GROUP_PART_ROWS[type] ?? [])
|
|
58
|
+
if (canGroupBy(type, by))
|
|
59
|
+
add({ key: partKey(column.field.key, by), column, by });
|
|
60
|
+
}
|
|
61
|
+
return out;
|
|
62
|
+
}
|
|
63
|
+
const LARGEST_FIRST = new Set(["date", "datetime", "number", "percent", "currency", "boolean"]);
|
|
64
|
+
export function sortDirFor(field) {
|
|
65
|
+
if (looksAhead(field))
|
|
66
|
+
return "asc";
|
|
67
|
+
return LARGEST_FIRST.has(valueTypeOf(field)) ? "desc" : "asc";
|
|
68
|
+
}
|