-
Notifications
You must be signed in to change notification settings - Fork 10
Expand file tree
/
Copy pathsdui.manifest.json
More file actions
2339 lines (2339 loc) · 65.3 KB
/
Copy pathsdui.manifest.json
File metadata and controls
2339 lines (2339 loc) · 65.3 KB
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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"components": {
"object-grid": {
"type": "object-grid",
"namespace": "plugin-grid",
"inputs": [
{
"name": "objectName",
"type": "string",
"required": true
},
{
"name": "columns",
"type": "array",
"description": "Columns to show, either field names (`[\"name\", \"email\"]`) or column objects (`[{ field: \"name\", label: \"Full Name\", width: 200 }]`). The canonical spelling — the deprecated `fields` is only read when this is absent."
},
{
"name": "filter",
"type": "array",
"description": "Filter criteria in JSON-rules form. The canonical spelling — the deprecated `defaultFilters` is only read when this is absent."
},
{
"name": "label",
"type": "string",
"description": "Grid label, used as the table caption and as the export file title. The canonical spelling — the deprecated `title` is only read when this is absent."
},
{
"name": "sort",
"type": "array",
"description": "Initial sort order, `[{ field, order }]`. The canonical spelling — the deprecated single-sort `defaultSort` is only read when this is absent."
},
{
"name": "pagination",
"type": "object",
"description": "Pagination config, `{ pageSize, pageSizeOptions, … }`. Its presence is what enables paging; prefer it over the deprecated flat `pageSize` / `showPagination` pair."
},
{
"name": "searchableFields",
"type": "array",
"description": "Fields the toolbar search box queries. A non-empty list is what enables search — prefer it over the deprecated boolean `showSearch`, which cannot say WHICH fields to search."
},
{
"name": "data",
"type": "object",
"description": "Data source configuration — a `ViewData` object discriminated by `provider`: `{ provider: \"object\", object }` (what an omitted `data` falls back to, using `objectName`), `{ provider: \"api\", read, write }`, `{ provider: \"value\", items: [...] }` for inline rows that bypass the object query, or `{ provider: \"schema\", schemaId }`. The canonical spelling — the deprecated `staticData` is the array-only shortcut for the `value` provider, so inline rows go under `items` here rather than in a bare array."
},
{
"name": "rowHeight",
"type": "enum",
"enum": [
"compact",
"short",
"medium",
"tall",
"extra_tall"
],
"description": "Row density. An unrecognised value falls back to `compact` rather than erroring."
},
{
"name": "frozenColumns",
"type": "number",
"description": "How many leading columns stay pinned while the grid scrolls horizontally."
},
{
"name": "resizable",
"type": "boolean",
"description": "Let users drag column borders to resize. The canonical spelling — the deprecated `resizableColumns` is only read when this is absent."
},
{
"name": "reorderableColumns",
"type": "boolean",
"description": "Let users drag columns into a different order."
},
{
"name": "showColumnTypeIcons",
"type": "boolean",
"description": "Show a field-type icon in each column header. Off by default — the type is usually obvious from the cell content, and the icons compete with the column labels."
},
{
"name": "rowColor",
"type": "object",
"description": "Rules that colour whole rows from a field value."
},
{
"name": "conditionalFormatting",
"type": "array",
"description": "Row/cell styling rules. Accepts both the ObjectUI `{ field, operator, value }` form and the spec expression form `{ condition, style }`."
},
{
"name": "grouping",
"type": "object",
"description": "Group rows by one or more fields into collapsible sections."
},
{
"name": "aggregations",
"type": "array",
"description": "Per-group roll-ups shown in group headers, `[{ field, type: \"sum\" | \"count\" | \"avg\" | \"min\" | \"max\" | \"count_distinct\" }]`. Needs `grouping` to have anything to roll up."
},
{
"name": "selection",
"type": "object",
"description": "Selection config, `{ type: \"none\" | \"single\" | \"multiple\" }`. The canonical spelling — the deprecated boolean/string `selectable` is only read when this is absent."
},
{
"name": "rowActions",
"type": "array",
"description": "Names of actions offered on each row’s menu."
},
{
"name": "bulkActions",
"type": "array",
"description": "Names of actions offered once rows are selected. Needs a multi-row `selection` to be reachable."
},
{
"name": "batchActions",
"type": "array",
"description": "Legacy alias of `bulkActions`, and the one the renderer reads FIRST when both are set. Prefer `bulkActions` in new schemas."
},
{
"name": "bulkActionDefs",
"type": "array",
"description": "Full inline bulk-action definitions, for actions that are not named entries in the object’s action set. Use `bulkActions` when the action already exists."
},
{
"name": "editable",
"type": "boolean",
"description": "Enable inline cell editing (double-click or Enter opens a cell)."
},
{
"name": "singleClickEdit",
"type": "boolean",
"description": "With `editable`, a single click opens the cell instead of a double-click. Has no effect on a non-editable grid."
},
{
"name": "navigation",
"type": "object",
"description": "What a row click does, `{ mode: \"page\" | \"drawer\" | \"modal\" | \"split\" | \"none\", … }`."
},
{
"name": "operations",
"type": "object",
"description": "Toggles for the built-in create/read/update/delete/export/import affordances, e.g. `{ delete: false }`."
},
{
"name": "exportOptions",
"type": "object",
"description": "Export config, `{ formats, maxRecords, includeHeaders, fileNamePrefix }`. Needs `operations.export` to be reachable from the toolbar."
}
]
},
"list-view": {
"type": "list-view",
"namespace": "plugin-list",
"inputs": [
{
"name": "objectName",
"type": "string",
"required": true
},
{
"name": "viewType",
"type": "enum",
"enum": [
{
"label": "Grid",
"value": "grid"
},
{
"label": "Kanban",
"value": "kanban"
},
{
"label": "Gallery",
"value": "gallery"
},
{
"label": "Calendar",
"value": "calendar"
},
{
"label": "Timeline",
"value": "timeline"
},
{
"label": "Gantt",
"value": "gantt"
},
{
"label": "Map",
"value": "map"
}
]
},
{
"name": "columns",
"type": "array"
},
{
"name": "filter",
"type": "array"
},
{
"name": "sort",
"type": "array"
},
{
"name": "options",
"type": "object"
}
]
},
"object-form": {
"type": "object-form",
"namespace": "plugin-form",
"inputs": [
{
"name": "objectName",
"type": "string",
"required": true
},
{
"name": "fields",
"type": "array"
},
{
"name": "mode",
"type": "enum",
"enum": [
"create",
"edit",
"view"
]
},
{
"name": "formType",
"type": "enum",
"enum": [
"simple",
"tabbed",
"wizard",
"split",
"drawer",
"modal"
]
},
{
"name": "sections",
"type": "array"
},
{
"name": "title",
"type": "string"
},
{
"name": "description",
"type": "string"
},
{
"name": "layout",
"type": "enum",
"enum": [
"vertical",
"horizontal",
"inline",
"grid"
]
},
{
"name": "columns",
"type": "number"
},
{
"name": "defaultTab",
"type": "string"
},
{
"name": "tabPosition",
"type": "enum",
"enum": [
"top",
"bottom",
"left",
"right"
]
},
{
"name": "allowSkip",
"type": "boolean"
},
{
"name": "showStepIndicator",
"type": "boolean"
},
{
"name": "splitDirection",
"type": "enum",
"enum": [
"horizontal",
"vertical"
]
},
{
"name": "splitSize",
"type": "number"
},
{
"name": "splitResizable",
"type": "boolean"
},
{
"name": "drawerSide",
"type": "enum",
"enum": [
"top",
"bottom",
"left",
"right"
]
},
{
"name": "drawerWidth",
"type": "string"
},
{
"name": "modalSize",
"type": "enum",
"enum": [
"sm",
"default",
"lg",
"xl",
"full"
]
},
{
"name": "modalCloseButton",
"type": "boolean",
"description": "Show the modal presentation’s close button. Read at ObjectForm.tsx:361 and honoured by ModalForm."
},
{
"name": "contentLayout",
"type": "enum",
"enum": [
"simple",
"tabbed"
],
"description": "How the modal presentation lays out sections. `tabbed` needs more than one section to differ from `simple` (ModalForm.tsx:638)."
},
{
"name": "confirmOnDiscard",
"type": "boolean",
"description": "Ask before discarding unsaved edits when a drawer/modal form is dismissed. Set `false` to close immediately."
},
{
"name": "recordId",
"type": "string",
"description": "The record to load in `edit` / `view` mode. Leave unset for `create`."
},
{
"name": "customFields",
"type": "array",
"description": "Field definitions merged over the set generated from object metadata. With inline definitions and no data source, this becomes the only field source."
},
{
"name": "initialValues",
"type": "object",
"description": "Values to prefill in `create` mode."
},
{
"name": "initialData",
"type": "object",
"description": "Alternate spelling of `initialValues` that the drawer/modal presentations read FIRST (`schema.initialData || schema.initialValues`). Prefer `initialValues` in new schemas."
},
{
"name": "readOnly",
"type": "boolean",
"description": "Render every field read-only, whatever `mode` says."
},
{
"name": "submitText",
"type": "string"
},
{
"name": "cancelText",
"type": "string"
},
{
"name": "nextText",
"type": "string",
"description": "Label of the next-step button (wizard)."
},
{
"name": "prevText",
"type": "string",
"description": "Label of the previous-step button (wizard)."
},
{
"name": "showSubmit",
"type": "boolean"
},
{
"name": "showCancel",
"type": "boolean"
},
{
"name": "showReset",
"type": "boolean"
},
{
"name": "submitBehavior",
"type": "object",
"description": "Declarative post-submit behaviour, one of `{ kind: \"thank-you\", title?, message? }`, `{ kind: \"redirect\", url, delayMs? }`, `{ kind: \"continue\" }`, `{ kind: \"next-record\" }`. When present it takes precedence over `successMessage` / `navigateOnSuccess` / `resetOnSuccess`."
},
{
"name": "successMessage",
"type": "string",
"description": "Toast shown after a successful submit. Ignored when `submitBehavior` or `navigateOnSuccess` is set."
},
{
"name": "navigateOnSuccess",
"type": "string",
"description": "Path to navigate to after a successful create/update. Supports `{id}` / `{recordId}` interpolation from the saved record and is same-origin-guarded. Takes precedence over `successMessage`."
},
{
"name": "resetOnSuccess",
"type": "boolean",
"description": "Clear the form after a successful submit instead of keeping the saved values."
},
{
"name": "mobile",
"type": "object",
"description": "Phone-only presentation overrides, e.g. `{ stepper: \"auto\", stepperMinFields: 8, fullscreenLongText: true }`."
}
]
},
"embeddable-form": {
"type": "embeddable-form",
"namespace": "plugin-form",
"inputs": [
{
"name": "formId",
"type": "string",
"required": true
},
{
"name": "objectName",
"type": "string",
"required": true
},
{
"name": "title",
"type": "string"
},
{
"name": "description",
"type": "string"
},
{
"name": "fields",
"type": "array"
},
{
"name": "allowMultiple",
"type": "boolean"
}
]
},
"object-master-detail-form": {
"type": "object-master-detail-form",
"namespace": "plugin-form",
"inputs": [
{
"name": "objectName",
"type": "string",
"required": true
},
{
"name": "mode",
"type": "enum",
"enum": [
"create",
"edit"
]
},
{
"name": "sections",
"type": "array"
},
{
"name": "details",
"type": "array",
"required": true
},
{
"name": "recordId",
"type": "string",
"description": "The parent record to load in `edit` mode. Leave unset for `create`."
},
{
"name": "formType",
"type": "string",
"description": "How the PARENT half of the form is presented. The detail grids below it are unaffected."
},
{
"name": "fields",
"type": "array",
"description": "Which parent fields to show, in order. Ignored when `sections` is given — sections carry their own field lists."
},
{
"name": "title",
"type": "string"
},
{
"name": "submitText",
"type": "string",
"description": "Label of the button that saves the parent and every detail row in one batch."
},
{
"name": "cancelText",
"type": "string"
},
{
"name": "showSubmit",
"type": "boolean"
},
{
"name": "initialValues",
"type": "object",
"description": "Values to prefill on the PARENT record in `create` mode."
},
{
"name": "initialData",
"type": "object",
"description": "Alternate spelling of `initialValues` the renderer also reads (MasterDetailForm.tsx:602). Prefer `initialValues` in new schemas."
},
{
"name": "taxRateField",
"type": "string",
"description": "Name of the field ON THE CHILD object that holds each line’s tax rate. Feeds the line-items totals row; leave unset when the detail rows carry no tax."
}
]
},
"object-kanban": {
"type": "object-kanban",
"namespace": "plugin-kanban",
"inputs": [
{
"name": "objectName",
"type": "string",
"required": true
},
{
"name": "columns",
"type": "array"
}
]
},
"object-calendar": {
"type": "object-calendar",
"namespace": "plugin-calendar",
"inputs": [
{
"name": "objectName",
"type": "string",
"required": true
},
{
"name": "calendar",
"type": "object",
"description": "startDateField, endDateField, titleField, colorField"
}
]
},
"object-gantt": {
"type": "object-gantt",
"namespace": "plugin-gantt",
"inputs": [
{
"name": "objectName",
"type": "string",
"required": true
},
{
"name": "gantt",
"type": "object",
"description": "startDateField, endDateField, titleField, progressField, percentageField, colorField, dependenciesField"
}
]
},
"object-timeline": {
"type": "object-timeline",
"namespace": "plugin-timeline",
"inputs": [
{
"name": "objectName",
"type": "string",
"required": true
},
{
"name": "variant",
"type": "enum",
"enum": [
"vertical",
"horizontal",
"gantt"
]
}
]
},
"object-map": {
"type": "object-map",
"namespace": "plugin-map",
"inputs": [
{
"name": "objectName",
"type": "string",
"required": true
},
{
"name": "map",
"type": "object",
"description": "latitudeField, longitudeField, titleField"
}
]
},
"object-metric": {
"type": "object-metric",
"namespace": "plugin-dashboard",
"inputs": [
{
"name": "objectName",
"type": "string",
"required": true
},
{
"name": "label",
"type": "string"
},
{
"name": "aggregate",
"type": "object",
"description": "Aggregation config: { field, function, groupBy }"
},
{
"name": "icon",
"type": "string"
},
{
"name": "description",
"type": "string",
"description": "Helper text rendered under the value."
},
{
"name": "title",
"type": "string",
"description": "Heading of the drill-down panel. Defaults to `label` — set it only when the records list wants a different name from the tile."
},
{
"name": "filter",
"type": "array",
"description": "Criteria the aggregation is scoped by. The same filter narrows the drill-down list, so the number and the records behind it always agree."
},
{
"name": "colorVariant",
"type": "enum",
"enum": [
"default",
"blue",
"teal",
"orange",
"purple",
"success",
"warning",
"danger"
],
"description": "Colour of the icon container. Semantic, not decorative: `success` / `warning` / `danger` should track what the number means."
},
{
"name": "variant",
"type": "enum",
"enum": [
"card",
"bare"
],
"description": "`card` draws the tile’s own surface; `bare` drops it, for a metric already sitting inside a card."
},
{
"name": "format",
"type": "string",
"description": "Numeral-style format pattern, e.g. `0,0`, `$0,0`, `0%`. Use `currency` instead of hard-coding a currency symbol here."
},
{
"name": "currency",
"type": "string",
"description": "ISO 4217 code, e.g. `USD`. Enables locale-aware currency formatting of the value."
},
{
"name": "prefix",
"type": "string",
"description": "Static text placed before the formatted value."
},
{
"name": "suffix",
"type": "string",
"description": "Static text placed after the formatted value."
},
{
"name": "invert",
"type": "boolean",
"description": "Display `1 - value` — for gauges whose good direction is down, such as error rate shown as uptime."
},
{
"name": "fallbackValue",
"type": "string",
"description": "Value shown when no data source resolves. For static/demo tiles; a bound metric should not need it."
},
{
"name": "trend",
"type": "object",
"description": "Static trend badge: `{ value, label, direction }`. Use `compareTo` instead when the trend should be computed from data."
},
{
"name": "compareTo",
"type": "object",
"description": "Period-over-period comparison, `{ kind: \"previousPeriod\" }` or `{ kind: \"previousYear\" }` — the computed alternative to a static `trend`."
},
{
"name": "drillDown",
"type": "object",
"description": "Click-through config that opens the records behind the number."
}
]
},
"object-chart": {
"type": "object-chart",
"namespace": "plugin-charts",
"inputs": [
{
"name": "objectName",
"type": "string",
"required": true
},
{
"name": "data",
"type": "array",
"description": "Optional static data"
},
{
"name": "filter",
"type": "array"
},
{
"name": "aggregate",
"type": "object",
"description": "Aggregation config: { field, function, groupBy }"
},
{
"name": "drillDown",
"type": "object",
"description": "Segment drill config: { enabled?, filter?, title?, target?: 'drawer' | 'dialog', columns?, maxRows? }. Present = on; {} is enough. Clicking a segment opens the underlying records filtered by the clicked category."
}
]
},
"dashboard": {
"type": "dashboard",
"namespace": "view",
"inputs": [
{
"name": "widgets",
"type": "array",
"description": "The widget tree — the spec’s DashboardWidget[]. Each widget binds a dataset (ADR-0021) and may carry a layout ({ x, y, w, h }) and filterBindings. When omitted the dashboard renders an empty grid."
},
{
"name": "label",
"type": [
"string",
"object"
],
"description": "Display name, shown as the header title when `header` is declared — a string or an inline per-locale map such as { en, \"zh-CN\" }. Spec-canonical spelling; the legacy `title` spelling is not authoring surface."
},
{
"name": "description",
"type": [
"string",
"object"
],
"description": "Header description shown under the title — a string or an inline per-locale map. Rendered only when `header` is declared and `header.showDescription` is not false."
},
{
"name": "header",
"type": "object",
"description": "Header block: { showTitle?, showDescription?, actions? }. Strict — the contract rejects any other key. Renders nothing (zero pixels) when everything it would show is suppressed."
},
{
"name": "globalFilters",
"type": "array",
"description": "Dashboard-level filter bar — the spec’s GlobalFilter[]. Filter values live as dashboard variables (readable in widget expressions as page.<name>) and are AND-merged into each bound widget’s query per its filterBindings."
},
{
"name": "dateRange",
"type": "object",
"description": "Built-in date-range filter: { field?, defaultRange?, allowCustomRange? }. `defaultRange` takes the spec’s date presets plus \"custom\"; the bound field defaults to created_at."
},
{
"name": "refreshInterval",
"type": "number",
"description": "Auto-refresh period in seconds. Zero or a negative value disables the timer, and it only runs when the host wires an onRefresh handler."
},
{
"name": "columns",
"type": "number"
},
{
"name": "gap",
"type": "number"
},
{
"name": "className",
"type": "string"
}
]
},
"object-pivot": {
"type": "object-pivot",
"namespace": "plugin-dashboard",
"inputs": [
{
"name": "objectName",
"type": "string",
"required": true
},
{
"name": "title",
"type": "string"
},
{
"name": "rowField",
"type": "string",
"required": true
},
{
"name": "columnField",
"type": "string",
"required": true
},
{
"name": "valueField",
"type": "string",
"required": true
},
{
"name": "aggregation",
"type": "enum",
"enum": [
{
"label": "Sum",
"value": "sum"
},
{
"label": "Count",
"value": "count"
},
{
"label": "Average",
"value": "avg"
},
{
"label": "Min",
"value": "min"
},
{
"label": "Max",
"value": "max"
}
]
},
{
"name": "showRowTotals",
"type": "boolean"
},
{
"name": "showColumnTotals",
"type": "boolean"
},
{
"name": "filter",
"type": "array"
},
{
"name": "format",
"type": "string"
}
]
},
"record:details": {
"type": "record:details",
"namespace": "record",
"inputs": [
{
"name": "columns",
"type": "enum",
"enum": [
"1",
"2",
"3",
"4"
],
"description": "Number of columns for field layout (1-4)"
},
{
"name": "sections",
"type": "array",
"description": "Field groups rendered as the detail body, in order. Every entry is an OBJECT — `{ name?, label?, columns?, fields }` — a bare section-id string is NOT accepted (the spec retired that spelling in objectstack#5611, and the renderer reads name/label/fields off each entry, so a string entry renders no fields at all). `fields` (required) are the field names shown in this section, in order. `label` is the section heading; omit it for an untitled, borderless section. `name` is a stable snake_case identifier and the i18n anchor — the heading resolves through objects.<object>._sections.<name>.label, so a section without a name shows its authored label in every locale. `columns` (1-4) is THIS section's field-grid width; omit it and the renderer derives the width. Authoring `sections` at all makes it the only source of the detail body; omit it and the body falls back to the object's highlightFields."
},
{
"name": "fields",
"type": "array",
"description": "Explicit field list (overrides highlightFields)"
},
{
"name": "hideFields",
"type": "array",
"description": "Field names to omit from the body — applied to the top-level `fields` list AND to every section's `fields`. Bare field names only. Authors rarely need it: the synth pipeline fills it with the fields already shown in `record:highlights`, and hand-authored pages get the same dedup live from HighlightFieldsContext, so its purpose is suppressing a field you do not want repeated (the page H1 title field is dropped for you too). Hiding every field of a section leaves that section out entirely."
},
{
"name": "inlineEdit",
"type": "boolean",
"description": "Offer the per-field double-click / pencil inline-edit affordances in the detail body. On by default, and an OPT-OUT only: the value is combined with the object's own editability (system, engine-owned, append-only and better-auth objects are not user-editable unless they opened userActions.edit) and with the server's effective API operation set for the object, so `false` always wins while `true` cannot open editing the platform refuses. The edit session and the atomic Save bar are hosted by the page, so one draft spans the highlights strip and this body."
},
{
"name": "showHeader",
"type": "boolean",
"description": "Render the detail body's own title / follow-star / copy-id chip above the fields. Off by default because this block is normally composed under a `page:header` that already draws that chrome, and turning it on there shows the record title twice. Set it true only when this block is the whole page."
}
]
},
"record:highlights": {
"type": "record:highlights",
"namespace": "record",
"inputs": [
{
"name": "fields",
"type": "array",
"required": true,
"description": "Key fields to highlight (1-7), bare names or {name,label?,icon?,type?,readonly?}. Set readonly: true on an entry to render that chip read-only — it suppresses the inline-edit affordance and the HeaderHighlight editability gate enforces it. Use it for hook/automation-maintained columns that must not be hand-edited from the record header; marking the OBJECT field readonly instead would also strip the hook's own write-back."
},
{
"name": "layout",
"type": "enum",
"enum": [
"horizontal",
"vertical"
],
"description": "Layout orientation for highlight fields"
}
]
},
"record:related_list": {
"type": "record:related_list",
"namespace": "record",
"inputs": [
{
"name": "objectName",
"type": "string",
"required": true,
"description": "Related object name (e.g. \"task\")"
},
{
"name": "relationshipField",
"type": "string",
"required": true,
"description": "Field on the related object pointing back to this record"
},
{
"name": "relationshipValueField",
"type": "string",
"description": "Which field OF THIS PARENT record `relationshipField` stores. Defaults to \"id\"; set it to the field a name-keyed junction points at (e.g. \"name\" when sys_user_position.position holds sys_position.name). The resolved value drives three things at once — the list filter, the Add-picker link value, and the pre-filled create form — so they cannot drift apart. While the parent record is still loading, a non-\"id\" field resolves to null and the list holds its fetch rather than querying on an empty value."
},
{
"name": "columns",
"type": "array",
"required": true,
"description": "Fields to display in the related list"
},
{
"name": "sort",
"type": "array"
},
{
"name": "limit",
"type": "number",
"description": "Records to display initially"
},
{
"name": "filter",
"type": "array",
"description": "Additional filter criteria, as spec `ViewFilterRule` entries (`[{ field, operator, value }]`). AND-combined with the parent relationship condition, never a replacement for it: it can only narrow this record's children. Also the key a per-element `dataSource` binding's composed filter lands on."
},
{
"name": "title",