1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
|
import type { InvokeMessage, SurfaceSpec } from "@dispatch/ui-contract";
import type {
FieldView,
NumberFieldView,
RenderGroup,
StatFieldView,
SurfaceRenderPlan,
} from "./types";
const KNOWN_KINDS = new Set([
"toggle",
"progress",
"selector",
"stat",
"number",
"button",
"custom",
]);
/**
* Validate and normalise a SurfaceSpec into a renderable plan.
* Keeps known field kinds in order (including `custom`, carried through verbatim
* for the renderer to dispatch on `rendererId`); drops unknown kinds — graceful
* skip, never throw. Whether a `custom` field actually renders is a RENDER-time
* decision (unknown `rendererId` → skipped there), not a planning one.
*/
export function planSurface(spec: SurfaceSpec): SurfaceRenderPlan {
const fields: FieldView[] = [];
for (const field of spec.fields) {
if (!KNOWN_KINDS.has(field.kind)) continue;
switch (field.kind) {
case "toggle":
fields.push({
kind: "toggle",
label: field.label,
value: field.value,
action: field.action,
});
break;
case "progress":
fields.push({
kind: "progress",
label: field.label,
value: field.value,
});
break;
case "selector":
fields.push({
kind: "selector",
label: field.label,
value: field.value,
options: field.options,
action: field.action,
});
break;
case "stat":
fields.push({
kind: "stat",
label: field.label,
value: field.value,
});
break;
case "number": {
// Carry optional hints only when present (exactOptionalPropertyTypes).
const view: NumberFieldView = {
kind: "number",
label: field.label,
value: field.value,
action: field.action,
...(field.min !== undefined ? { min: field.min } : {}),
...(field.max !== undefined ? { max: field.max } : {}),
...(field.step !== undefined ? { step: field.step } : {}),
...(field.unit !== undefined ? { unit: field.unit } : {}),
};
fields.push(view);
break;
}
case "button":
fields.push({
kind: "button",
label: field.label,
action: field.action,
});
break;
case "custom":
fields.push({
kind: "custom",
rendererId: field.rendererId,
payload: field.payload,
});
break;
}
}
return { fields };
}
/**
* Coalesce a field list into render groups: maximal runs of consecutive `stat`
* fields become one `stats` group (rendered as a single aligned table), every
* other field stays a standalone `field` group. Order is preserved. Pure.
*/
export function groupRenderFields(fields: readonly FieldView[]): RenderGroup[] {
const groups: RenderGroup[] = [];
let run: StatFieldView[] = [];
const flush = (): void => {
if (run.length > 0) {
groups.push({ type: "stats", stats: run });
run = [];
}
};
for (const field of fields) {
if (field.kind === "stat") {
run.push(field);
} else {
flush();
groups.push({ type: "field", field });
}
}
flush();
return groups;
}
/**
* Construct a typed `invoke` client message for an actionable field.
* For toggle the payload is the new boolean; for selector the chosen value;
* for button the payload is omitted.
*/
export function buildInvoke(
surfaceId: string,
field: Extract<FieldView, { action: unknown }>,
value?: unknown,
): InvokeMessage {
const base = { type: "invoke" as const, surfaceId, actionId: field.action.actionId };
if (value !== undefined) {
return { ...base, payload: value };
}
return base;
}
|
