-
Notifications
You must be signed in to change notification settings - Fork 17
Expand file tree
/
Copy pathsdui.manifest.json
More file actions
3911 lines (3911 loc) · 133 KB
/
Copy pathsdui.manifest.json
File metadata and controls
3911 lines (3911 loc) · 133 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",
"object"
],
"description": "Grid label, used as the table caption, as the export file title and in the record-detail overlay heading. The canonical spelling — the deprecated `title` is only read when this is absent. Accepts either a plain string or an inline per-locale map (`{ en: \"Accounts\", \"zh-CN\": \"客户\" }`) — the `I18nLabel` union the contract admits on this key — and the grid resolves the map against the display locale (the workspace's regional default when one is configured, otherwise the active UI language), falling back through base language, a region-qualified sibling, `default`, then `en`, and finally to any remaining entry."
},
{
"name": "sort",
"type": "array",
"description": "Initial sort order, `[{ field, order }]`. The only sort spelling this block reads — the retired single-sort `defaultSort` is refused by the protocol and ignored by the renderer."
},
{
"name": "pagination",
"type": "object",
"description": "Pagination config, `{ pageSize, pageSizeOptions, … }`. Presence enables paging with the object's settings, and an explicit off wins — the deprecated flat `showPagination: false` turns paging off even beside this object, because this object declares no off switch of its own. Prefer it over the deprecated flat `pageSize` / `showPagination` pair."
},
{
"name": "searchableFields",
"type": "array",
"of": "string",
"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\" }`. Presence enables selection — an object with no `type` selects multiple rows — and an explicit off wins: `type: \"none\"` turns selection off even beside a declared `bulkActions`. 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, streaming }`. `streaming` (default true) picks server-side streaming vs browser-side assembly for the export — a behaviour fork, not decoration; set it to `false` to force browser-side assembly. Needs `operations.export` to be reachable from the toolbar."
},
{
"name": "dataSource",
"type": "object",
"binding": "object",
"description": "Per-element data binding: { object, view, filter, sort, limit }. Overrides the page-level object context for this block; `view` names a saved view of `object`, and `filter` is ANDed with the view’s own rather than replacing it."
}
]
},
"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"
},
{
"label": "Chart",
"value": "chart"
},
{
"label": "Tree",
"value": "tree"
}
]
},
{
"name": "columns",
"type": "array"
},
{
"name": "filter",
"type": "array"
},
{
"name": "sort",
"type": "array"
},
{
"name": "options",
"type": "object"
},
{
"name": "dataSource",
"type": "object",
"binding": "object",
"description": "Per-element data binding: { object, view, filter, sort, limit }. Overrides the page-level object context for this block; `view` names a saved view of `object`, and `filter` is ANDed with the view’s own rather than replacing it."
}
]
},
"object-form": {
"type": "object-form",
"namespace": "plugin-form",
"inputs": [
{
"name": "objectName",
"type": "string",
"required": true
},
{
"name": "fields",
"type": "array",
"description": "Bare field names to show, in order (each looked up in the object schema; `{ name }` is tolerated). NOT the same vocabulary as `sections[].fields`, which also accepts the spec `FormFieldSchema` object (identity key `field`, e.g. `{ field: \"note\", colSpan: 2 }`) — that shape resolves to no name HERE and is silently skipped (SimpleObjectForm in ObjectForm.tsx; buildFlatFields in flatFields.ts for the drawer/modal presentations)."
},
{
"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",
"object"
],
"description": "Heading of the drawer and modal presentations (`formType: \"drawer\"` / `\"modal\"`). Accepts either a plain string or an inline per-locale map (`{ en: \"New order\", \"zh-CN\": \"新建订单\" }`) — the `I18nLabel` union the contract admits on this key — and the form resolves the map against the active UI language, falling back through base language, a region-qualified sibling, `default`, then `en`, and finally to any remaining entry."
},
{
"name": "description",
"type": [
"string",
"object"
],
"description": "Subtitle under the drawer and modal heading. Accepts either a plain string or an inline per-locale map (`{ en: \"Enter the order details\", \"zh-CN\": \"填写订单信息\" }`), resolved against the active UI language with the same fallback chain as `title`."
},
{
"name": "layout",
"type": "enum",
"enum": [
"vertical",
"horizontal"
],
"description": "Label placement: `vertical` puts each label above its field (the default), `horizontal` beside it."
},
{
"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 (X) button. Default `true`; `false` hides it. Forwarded by `ObjectForm`’s modal route and honoured by `ModalForm` on both of its dialog arms. With the button hidden the modal still closes on Escape, and on the Cancel action when that is shown."
},
{
"name": "contentLayout",
"type": "enum",
"enum": [
"simple",
"tabbed"
],
"description": "How the modal presentation lays out sections. `tabbed` differs from `simple` only when more than one section has a field to show (`ModalForm` tests `schema.contentLayout === \"tabbed\" && groups.length > 1`)."
},
{
"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 — PER MEMBER (`{ ...initialValues, ...initialData }`), so a member this key says nothing about keeps its `initialValues` value. Prefer `initialValues` in new schemas."
},
{
"name": "readOnly",
"type": "boolean",
"description": "Render every field read-only, whatever `mode` says."
},
{
"name": "submitText",
"type": [
"string",
"object"
],
"description": "Label of the Save button. A map no locale limb resolves shows the default label. Accepts either a plain string or an inline per-locale map (`{ en: \"Save order\", \"zh-CN\": \"保存订单\" }`), resolved against the active UI language with the same fallback chain as `title`."
},
{
"name": "cancelText",
"type": [
"string",
"object"
],
"description": "Label of the Cancel button. Accepts either a plain string or an inline per-locale map (`{ en: \"Back\", \"zh-CN\": \"返回\" }`), resolved against the active UI language with the same fallback chain as `title`."
},
{
"name": "nextText",
"type": [
"string",
"object"
],
"description": "Label of the next-step button (wizard). Accepts either a plain string or an inline per-locale map (`{ en: \"Continue\", \"zh-CN\": \"继续\" }`), resolved against the active UI language with the same fallback chain as `title`."
},
{
"name": "prevText",
"type": [
"string",
"object"
],
"description": "Label of the previous-step button (wizard). Accepts either a plain string or an inline per-locale map (`{ en: \"Previous\", \"zh-CN\": \"上一步\" }`), resolved against the active UI language with the same fallback chain as `title`."
},
{
"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",
"object"
],
"description": "Toast shown after a successful submit. Ignored when `submitBehavior` or `navigateOnSuccess` is set. Accepts either a plain string or an inline per-locale map (`{ en: \"Order saved\", \"zh-CN\": \"订单已保存\" }`), resolved against the active UI language with the same fallback chain as `title`."
},
{
"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 }`."
},
{
"name": "dataSource",
"type": "object",
"binding": "object",
"description": "Per-element data binding: { object, view, filter, sort, limit }. Overrides the page-level object context for this block; `view` names a saved view of `object`, and `filter` is ANDed with the view’s own rather than replacing it."
}
]
},
"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",
"description": "Bare field names to show, in order (each looked up in the object schema; `{ name }` is tolerated). NOT the same vocabulary as `sections[].fields`, which also accepts the spec `FormFieldSchema` object (identity key `field`, e.g. `{ field: \"note\", colSpan: 2 }`) — that shape resolves to no name HERE and is silently skipped (`EmbeddableForm` passes this array straight through to `<ObjectForm>` with no `sections`, so it renders through the same `SimpleObjectForm` as `object-form` above — see its `fields` description)."
},
{
"name": "allowMultiple",
"type": "boolean"
},
{
"name": "dataSource",
"type": "object",
"binding": "object",
"description": "Per-element data binding: { object, view, filter, sort, limit }. Overrides the page-level object context for this block; `view` names a saved view of `object`, and `filter` is ANDed with the view’s own rather than replacing it."
}
]
},
"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": "enum",
"enum": [
"simple",
"tabbed"
],
"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 — and it is NOT ignored when `sections` is given: the two INTERSECT. The parent field pool is built from this key first and every section then resolves its own members against that pool, so a section member this key does not list is dropped from the rendered form, and a section that loses EVERY member that way disappears with its heading. Each such drop is reported once via `console.warn` (objectui#9884); it is not repaired, because this key bounds what the form DRAWS and edits, not what Save writes: on a create, the submitted set is the drawn fields plus any parent value seeded through `initialValues` (or its alternate spelling `initialData`), drawn or not. A seed for an undeclared, server-owned, computed or read-only field is still stripped, as on any save. Author one or the other, or list every section member here too. Members are bare field names (`{ name }` tolerated); NOT the spec `FormFieldSchema` object `sections[].fields` accepts (identity key `field`) — that shape resolves to no name here and is silently skipped (the parent form renders through the same `ObjectForm` / `SimpleObjectForm` as `object-form` — see its `fields` description)."
},
{
"name": "title",
"type": [
"string",
"object"
],
"description": "Names the record in the built-in \"… saved\" toast after an edit save, which shows only when the host supplies no `onSuccess`. Accepts either a plain string or an inline per-locale map (`{ en: \"Purchase order\", \"zh-CN\": \"采购单\" }`) — the `I18nLabel` union the contract admits on this key — and the renderer resolves the map against the active UI language, falling back through base language, a region-qualified sibling, `default`, then `en`, and finally to any remaining entry."
},
{
"name": "submitText",
"type": [
"string",
"object"
],
"description": "Label of the button that saves the parent and every detail row in one batch. Defaults to \"Save\" when editing a record (`mode: \"edit\"` with a `recordId`) and to \"Create\" otherwise, in the active UI language; an empty string, or a map no locale limb resolves, shows the default too. Accepts either a plain string or an inline per-locale map (`{ en: \"Save order\", \"zh-CN\": \"保存订单\" }`), resolved against the active UI language with the same fallback chain as `title`."
},
{
"name": "cancelText",
"type": [
"string",
"object"
],
"description": "Label of the Cancel button, which renders only when the host supplies an `onCancel` callback (a runtime slot, not authorable in a JSON document). Defaults to \"Cancel\", in the active UI language; an empty string, or a map no locale limb resolves, shows the default too. Accepts either a plain string or an inline per-locale map (`{ en: \"Back\", \"zh-CN\": \"返回\" }`), resolved against the active UI language with the same fallback chain as `title`."
},
{
"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: the `parentSchema` memo carries both keys onto the parent form, which merges them PER MEMBER with this one winning. 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."
},
{
"name": "dataSource",
"type": "object",
"binding": "object",
"description": "Per-element data binding: { object, view, filter, sort, limit }. Overrides the page-level object context for this block; `view` names a saved view of `object`, and `filter` is ANDed with the view’s own rather than replacing it."
}
]
},
"object-kanban": {
"type": "object-kanban",
"namespace": "plugin-kanban",
"inputs": [
{
"name": "objectName",
"type": "string",
"required": true
},
{
"name": "columns",
"type": "array"
},
{
"name": "filter",
"type": "array",
"description": "Filter criteria in JSON-rules form, narrowing the records the board fetches. Lowered to `$filter` on the query."
},
{
"name": "limit",
"type": "number",
"description": "Row cap — the most records the board fetches, lowered to the query’s top-level `$top` (renderer default 100). The board renders every fetched record into a lane and offers no pagination, so this is the author’s window on the object rather than a page size. PRECEDENCE: a node-level `dataSource` binding’s own `limit` wins outright; the `pagination.pageSize` of a view that binding names fills this key only when the node leaves it unset."
},
{
"name": "groupBy",
"type": "string",
"description": "Record field whose value buckets cards into lanes. Its picklist options become the lanes when `columns` is absent, and a drag between lanes writes the target lane’s value back to the record. A value matching no lane lands in the trailing “Uncategorized” lane rather than disappearing."
},
{
"name": "cardTitle",
"type": "string",
"description": "Record field rendered as the card title. Read AHEAD of `titleField`, which is the legacy spelling of the same choice; when neither yields a value the shared record-display resolver names the card."
},
{
"name": "titleField",
"type": "string",
"description": "Legacy spelling of `cardTitle` — the record field rendered as the card title. `cardTitle` wins when both are authored."
},
{
"name": "swimlaneField",
"type": "string",
"description": "Record field that splits the board into horizontal swimlanes. When absent the board falls back to `grouping.fields[0].field`."
},
{
"name": "coverImageField",
"type": "string",
"description": "Record field holding a card cover image — a URL string, or a file object carrying a `url`. Any other value leaves the card without a cover."
},
{
"name": "data",
"type": "array",
"description": "Inline records to render instead of fetching. Authoring it SUPPRESSES the board’s own query entirely. Members are records: the board reads `id` (or `_id`) as the card identity, the `groupBy` field’s value as the lane, the card-title field, `coverImageField`, and every `cardFields` entry. Records handed down by a parent view and a `bind` expression both take priority over it."
},
{
"name": "cardFields",
"type": "array",
"description": "Record field NAMES rendered as cells on each card, in the order written. Members are bare names, not entry objects. An explicit list wins over the object’s `highlightFields` role; unlike that fallback it is NOT filtered against the object definition, so a name the object no longer declares simply renders no cell. An empty array reads as omitted."
},
{
"name": "grouping",
"type": "object",
"description": "Only `grouping.fields[0].field` is read, and only as the FALLBACK for `swimlaneField`: it names the record field that splits the board into horizontal swimlanes when no `swimlaneField` is authored. An explicit `swimlaneField` wins. Every other position inside `grouping`, later `fields` entries included, is inert on this board."
},
{
"name": "conditionalFormatting",
"type": "array",
"description": "Per-card style rules, each evaluated against that card’s own record. Two member dialects are accepted: the native `{ field, operator, value, backgroundColor?, borderColor? }` and the spec CEL `{ condition, backgroundColor?, borderColor? }`. A matching rule colours that card alone. A rule comparing a relation field sees the stored foreign key rather than the expanded record."
},
{
"name": "navigation",
"type": "object",
"description": "What a card click opens — the `{ mode, size, openNewTab, preventNavigation }` block a list view declares. With the key ABSENT a click opens the record in a drawer. `mode` is an overlay (`drawer`, `modal`, `split`, `popover`), `new_window`, `page` or `none`; write it whenever the block is written, because a block without `mode` takes the spec’s `page` default and `page` opens nothing on a board no parent view navigates for. `openNewTab: true` opens the record page in a new tab and outranks the mode, `preventNavigation: true` opens nothing, and `size` sets the overlay width. A click handler from a parent view outranks the whole key."
},
{
"name": "dataSource",
"type": "object",
"binding": "object",
"description": "Per-element data binding: { object, view, filter, sort, limit }. Overrides the page-level object context for this block; `view` names a saved view of `object`, and `filter` is ANDed with the view’s own rather than replacing it."
}
]
},
"object-calendar": {
"type": "object-calendar",
"namespace": "plugin-calendar",
"inputs": [
{
"name": "objectName",
"type": "string",
"description": "ObjectQL object name. The record source is one of `data`, `staticData` and `objectName`; the `object-calendar` schema refuses a block that declares none of them, unless the node's `dataSource.object` names the object, which then lands on this key."
},
{
"name": "calendar",
"type": "object",
"description": "startDateField, endDateField, titleField, colorField"
},
{
"name": "filter",
"type": "array",
"description": "Filter criteria in JSON-rules form, narrowing the records the calendar fetches. Lowered to `$filter` on the query."
},
{
"name": "sort",
"type": "array",
"description": "Sort order in `[{ field, order }]` form, ordering the records the calendar fetches. Lowered to `$orderby` on the query."
},
{
"name": "defaultView",
"type": "enum",
"enum": [
"month",
"week",
"day"
],
"description": "The grid the calendar opens on. A narrow viewport downgrades `day` to `month`; the author’s choice is otherwise honoured on first render."
},
{
"name": "locale",
"type": "string",
"description": "BCP-47 tag used to format the dates and times this calendar renders. A tag `Intl` refuses is dropped — the same answer as an absent key — rather than passed through to throw out of render."
},
{
"name": "data",
"type": "array",
"description": "Pre-fetched records drawn as-is, IN PLACE OF the calendar’s own query — `objectName`, `filter` and `sort` are then unused and `staticData` is never reached. Each member is a RECORD, read for the fields the `calendar` config names plus its `id`; a member with no value in the start field is counted in the unscheduled area rather than dropped."
},
{
"name": "staticData",
"type": "array",
"description": "Inline records, read SECOND on the record-source ladder: an authored `data` wins and this key is then never reached, while `objectName` is read AFTER it, so a calendar carrying both draws these rows and issues no query. Members are records read exactly as `data`’s are."
},
{
"name": "loading",
"type": "boolean",
"description": "External loading state, honoured ONLY alongside an array `data`: it then replaces the calendar with its loading placeholder. On a calendar fed by `staticData` or by `objectName` it is dropped, because that calendar owns its own loading state."
},
{
"name": "navigation",
"type": "object",
"description": "What an event click opens — the `{ mode, size, openNewTab, preventNavigation }` block a list view declares. With the key ABSENT a click opens the record in a drawer. `mode` is an overlay (`drawer`, `modal`, `split`, `popover`), `new_window`, `page` or `none`; write it whenever the block is written, because a block without `mode` takes the spec’s `page` default and `page` opens nothing on a calendar no parent view navigates for. `openNewTab: true` opens the record page in a new tab and outranks the mode, `preventNavigation: true` opens nothing, and `size` sets the overlay width. An overlay mode wins over a parent view’s click handler; any other mode hands the click to it."
},
{
"name": "dataSource",
"type": "object",
"binding": "object",
"description": "Per-element data binding: { object, view, filter, sort, limit }. Overrides the page-level object context for this block; `view` names a saved view of `object`, and `filter` is ANDed with the view’s own rather than replacing it."
}
]
},
"object-gantt": {
"type": "object-gantt",
"namespace": "plugin-gantt",
"inputs": [
{
"name": "objectName",
"type": "string",
"description": "ObjectQL object name. The record source is one of `data`, `staticData` and `objectName`; the `object-gantt` schema refuses a block that declares none of them, unless the node's `dataSource.object` names the object, which then lands on this key."
},
{
"name": "gantt",
"type": "object",
"description": "startDateField, endDateField, titleField, progressField, percentageField, colorField, dependenciesField"
},
{
"name": "data",
"type": "object",
"description": "A `{ provider, … }` data-source configuration, read FIRST on the record-source ladder: a gantt carrying one never reaches `staticData` and never queries `objectName`. `{ provider: 'value', items }` charts those rows, `{ provider: 'object', object }` queries that object and `{ provider: 'api', read }` reads through that request. A bare array is not this key’s shape and is not a record source: the gantt falls through to `staticData`, then `objectName`, so inline rows belong under `staticData`."
},
{
"name": "staticData",
"type": "array",
"description": "Inline records, read SECOND on the record-source ladder: a `data` configuration wins and this key is then never reached, while `objectName` is read AFTER it, so a gantt carrying both charts these rows and never queries that object. `filter` and `sort` narrow and order these rows exactly as they do fetched ones."
},
{
"name": "filter",
"type": "array",
"description": "Base query filter in the rule-array form `[{ field, operator, value }, ...]`, narrowing the tasks the gantt charts — from every record source it reads: the object, an `api` request, or inline rows. Context tokens such as `{current_user_id}` are resolved first, then the filter is lowered to `$filter` on the query. The MongoDB-style record form is not this key’s shape."
},
{
"name": "sort",
"type": "array",
"description": "Task order in `[{ field, order }]` form, ordering the rows the gantt charts. Lowered to `$orderby` on the same query."
},
{
"name": "dataSource",
"type": "object",
"binding": "object",
"description": "Per-element data binding: { object, view, filter, sort, limit }. Overrides the page-level object context for this block; `view` names a saved view of `object`, and `filter` is ANDed with the view’s own rather than replacing it."
}
]
},
"object-timeline": {
"type": "object-timeline",
"namespace": "plugin-timeline",
"inputs": [
{
"name": "objectName",
"type": "string",
"required": true
},
{
"name": "variant",
"type": "enum",
"enum": [
"vertical",
"horizontal",
"gantt"
]
},
{
"name": "filter",
"type": "array",
"description": "Base query filter in the rule-array form `[{ field, operator, value }, ...]`, narrowing the records the timeline fetches. Context tokens such as `{current_user_id}` are resolved first, then the filter is lowered to `$filter` on the query. Authored `items` or `data` suppress that query, so the key then narrows nothing. The MongoDB-style record form is not this key’s shape."
},
{
"name": "sort",
"type": "array",
"description": "Entry order in `[{ field, order }]` form, ordering the records the timeline fetches. Lowered to `$orderby` on the same query."
},
{
"name": "navigation",
"type": "object",
"description": "What an entry click opens — the `{ mode, size, openNewTab, preventNavigation }` block a list view declares. Write it with `mode`: with the key ABSENT, or with a block that omits `mode` (it takes the spec’s `page` default), a click opens nothing on a timeline no parent view navigates for. `drawer`, `modal` and `popover` open the entry’s record in that overlay; `new_window` opens the record page in a new tab; `page`, `none` and `split` open nothing here, because the timeline hands the split shell no main panel. `openNewTab: true` opens the record page in a new tab and outranks the mode, `preventNavigation: true` opens nothing, and `size` sets the overlay width. A click handler from a parent view outranks the whole key."
},
{
"name": "dataSource",
"type": "object",
"binding": "object",
"description": "Per-element data binding: { object, view, filter, sort, limit }. Overrides the page-level object context for this block; `view` names a saved view of `object`, and `filter` is ANDed with the view’s own rather than replacing it."
}
]
},
"object-map": {
"type": "object-map",
"namespace": "plugin-map",
"inputs": [
{
"name": "objectName",
"type": "string",
"description": "ObjectQL object name. The record source is one of `data`, `staticData` and `objectName`, or the node’s `dataSource` binding; the `object-map` schema refuses a block that declares none of them."
},
{
"name": "map",
"type": "object",
"description": "latitudeField, longitudeField, titleField"
},
{
"name": "data",
"type": "object",
"description": "A `{ provider, … }` data-source configuration, read FIRST on the record-source ladder: a map carrying one never reaches `staticData` and never queries `objectName`. `{ provider: 'value', items }` plots those rows and `{ provider: 'object', object }` queries that object, both narrowed by `filter` and ordered by `sort`. The `api` provider is not implemented on the map and plots no markers. A bare array is not this key’s shape and is not a record source: the map falls through to `staticData`, then `objectName`, so inline rows belong under `staticData`."
},
{
"name": "staticData",
"type": "array",
"description": "Inline records, read SECOND on the record-source ladder: a `data` configuration wins and this key is then never reached, while `objectName` is read AFTER it, so a map carrying both plots these rows and never queries that object. `filter` and `sort` narrow and order these rows exactly as they do fetched ones."
},
{
"name": "filter",
"type": "array",
"description": "Base query filter in the rule-array form `[{ field, operator, value }, ...]`, narrowing the markers the map plots — fetched rows and inline (`staticData`, `{ provider: 'value' }`) rows alike. Context tokens such as `{current_user_id}` are resolved first, then the filter is lowered to `$filter` on the query. The MongoDB-style record form is not this key’s shape."
},
{
"name": "sort",
"type": "array",
"description": "Marker order in `[{ field, order }]` form, ordering the rows the map plots. Lowered to `$orderby` on the same query."
},
{
"name": "dataSource",
"type": "object",
"binding": "object",
"description": "Per-element data binding: { object, view, filter, sort, limit }. Overrides the page-level object context for this block; `view` names a saved view of `object`, and `filter` is ANDed with the view’s own rather than replacing it."
}
]
},
"object-tree": {
"type": "object-tree",
"namespace": "plugin-tree",
"inputs": [
{
"name": "objectName",
"type": "string",
"required": true
},
{
"name": "tree",
"type": "object",
"description": "parentField, labelField, fields, defaultExpandedDepth"
}
]
},
"object-metric": {
"type": "object-metric",
"namespace": "plugin-dashboard",
"inputs": [
{
"name": "objectName",
"type": "string",
"required": true
},
{
"name": "label",
"type": [
"string",
"object"
],
"description": "Heading of the tile, and of the drill-down panel when `title` is not set. Accepts either a plain string or an inline per-locale map (`{ en: \"Pipeline\", \"zh-CN\": \"销售管道\" }`) — the `I18nLabel` union the contract admits on this key — and the tile resolves the map against the active UI language, falling back through base language, a region-qualified sibling, `default`, then `en`, and finally to any remaining entry."
},
{
"name": "aggregate",
"type": "object",
"description": "Aggregation config: { field, function, groupBy }"
},
{
"name": "icon",
"type": "string"
},
{
"name": "description",
"type": [
"string",
"object"
],
"description": "Helper text rendered under the value. Accepts either a plain string or an inline per-locale map (`{ en: \"This quarter\", \"zh-CN\": \"本季度\" }`), resolved against the active UI language with the same fallback chain as `label`."
},
{
"name": "title",
"type": [
"string",
"object"
],
"description": "Heading of the drill-down panel. Defaults to `label` — set it only when the records list wants a different name from the tile. Accepts either a plain string or an inline per-locale map (`{ en: \"Open deals\", \"zh-CN\": \"进行中的商机\" }`), resolved against the active UI language with the same fallback chain as `label`."
},
{
"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."
},