@cosmicdrift/kumiko-framework 0.418.0 → 0.420.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/agents/api/framework-engine.md +4 -0
- package/agents/api/framework-ui-types.md +18 -1
- package/agents/api/renderer-web.md +6 -0
- package/agents/api/types.md +10 -1
- package/agents/api.md +2 -2
- package/agents/boot-rules.md +10 -0
- package/agents/examples/pdf-letterhead.md +473 -0
- package/agents/examples.md +1 -0
- package/agents/features.md +11 -0
- package/agents/widgets.md +1 -0
- package/dist/crypto/subject-resolver.d.ts +1 -0
- package/dist/crypto/subject-resolver.js +8 -2
- package/dist/db/queries/backfill-pii.js +29 -3
- package/dist/engine/boot-validator/action-form-preview-rules.d.ts +5 -0
- package/dist/engine/boot-validator/action-form-preview-rules.js +5 -0
- package/dist/engine/boot-validator/action-form-preview.js +13 -0
- package/dist/engine/boot-validator/boot-phases-app.js +2 -0
- package/dist/engine/boot-validator/boot-rules.d.ts +26 -0
- package/dist/engine/boot-validator/boot-rules.js +2 -0
- package/dist/engine/boot-validator/page-help-rules.d.ts +17 -0
- package/dist/engine/boot-validator/page-help-rules.js +17 -0
- package/dist/engine/boot-validator/page-help.d.ts +2 -0
- package/dist/engine/boot-validator/page-help.js +109 -0
- package/dist/engine/boot-validator/screens-actions.d.ts +5 -0
- package/dist/engine/boot-validator/screens-actions.js +15 -6
- package/dist/engine/boot-validator/screens-forms-rules.d.ts +5 -0
- package/dist/engine/boot-validator/screens-forms-rules.js +5 -0
- package/dist/engine/boot-validator/screens-forms.js +13 -1
- package/dist/engine/boot-validator/url-prefill-fields.js +5 -11
- package/dist/engine/registry-ingest.js +11 -0
- package/dist/i18n/required-surface-keys.d.ts +2 -0
- package/dist/i18n/required-surface-keys.js +11 -1
- package/dist/migrations/pii-event-backfill.js +4 -1
- package/dist/ui-types/index.d.ts +1 -1
- package/package.json +3 -3
- package/src/changes.json +18 -0
|
@@ -538,6 +538,7 @@ type EditFieldSpec =
|
|
|
538
538
|
suffix?: FieldAffix; // Same as `prefix`, shown after the input.
|
|
539
539
|
fillAction?: FieldFillAction; // Button beside the input that runs a query and writes one scalar of its result into this field.
|
|
540
540
|
aiAssist?: FieldAiAssist; // Helper under a `text` or `longText` input: stackable chips and an optional free instruction call a query and write its `resultField` into the field.
|
|
541
|
+
editor?: "document"; // `longText` fields only: edits the value with the rich-text editor registered for "document" (the value is an HTML string) instead of a textarea.
|
|
541
542
|
valueChips?: FieldValueChips; // Quick-pick chips under a `number`, `decimal`, `bigInt` or `money` input; a chip sets the field to its value.
|
|
542
543
|
concealed?: true; // Read-only display of a value the viewer may not see: the value (or the mask the query returns) shows muted with a lock icon instead of a replacement text.
|
|
543
544
|
badge?: FieldBadge; // Pill next to the label, e.g. "price source open" in `warn`.
|
|
@@ -555,6 +556,7 @@ type EditRelatedListSection = EditSectionPresentation & {
|
|
|
555
556
|
visibleWhen?: Exclude<FieldCondition, boolean>; // projectionDetail only: shows the section (and its tab) only while the loaded record matches, same `{ field, eq | ne | in | notIn }` syntax as a field's `visibleWhen`.
|
|
556
557
|
kind: "relatedList";
|
|
557
558
|
title: string;
|
|
559
|
+
pageHelp?: PageHelpSpec; // Joins the help of the surrounding screen; a status section's entity defaults to `entity` of this section.
|
|
558
560
|
readOnly?: boolean; // Rows are aggregates or other values with no record of their own, so they lead nowhere on purpose.
|
|
559
561
|
query: string; // Fully qualified query QN.
|
|
560
562
|
parentParam?: string; // Query-payload key the parent record's id is passed under.
|
|
@@ -699,6 +701,7 @@ type EntityListScreenDefinition = {
|
|
|
699
701
|
toolbarSort?: true; // From `sm` up, a "Sorted by" select in the filter row (same options as the narrow sort control); column headers stay sortable.
|
|
700
702
|
narrowFacets?: ListNarrowFacets; // "pills": below `sm` the select facets render as rounded pill triggers with a stronger border; from `sm` up unchanged.
|
|
701
703
|
toolbarActionsPlacement?: ListToolbarActionsPlacement; // "toolbar": from `md` up the `toolbarActions` end the filter row, after the "Sorted by" select and the create button, instead of standing in the page header.
|
|
704
|
+
pageHelp?: PageHelpSpec; // General help of the page: a question-mark button in the shell header opens a drawer with the sections.
|
|
702
705
|
itemNounKey?: string; // i18n key of the plural noun for the list size in the phone sort line (`{count}` pluralised).
|
|
703
706
|
searchPlaceholder?: string; // i18n key for the search field placeholder (default `kumiko.list.search-placeholder`).
|
|
704
707
|
searchable?: boolean;
|
|
@@ -1442,6 +1445,7 @@ type ProjectionDetailScreenDefinition = {
|
|
|
1442
1445
|
listScreenId?: string; // Parent list screen (short id) for a "back" navigation.
|
|
1443
1446
|
slots?: ScreenSlots;
|
|
1444
1447
|
access?: AccessRule;
|
|
1448
|
+
pageHelp?: PageHelpSpec; // General help of the page, plus the help sections of its relatedList sections; a status section needs `entity` here.
|
|
1445
1449
|
actions?: EntityEditAction[]; // Header action buttons.
|
|
1446
1450
|
primaryAction?: string; // Id of the action that stays the visible header button when the actions collapse into a menu (and the one that keeps the phone icon slot when it has an icon and no confirm).
|
|
1447
1451
|
inlineActions?: string[]; // Action ids that stay visible buttons next to the primary action when the rest collapses into the menu.
|
|
@@ -71,6 +71,7 @@ type ActionFormPreview = { // Preview panel above the submit button: runs a quer
|
|
|
71
71
|
query: string; // Query QN.
|
|
72
72
|
fields?: string[]; // Form fields sent to the query; they also trigger a rerun when they change.
|
|
73
73
|
title?: string; // Panel title (i18n key).
|
|
74
|
+
section?: string; // Id of a layout section: the panel renders at the end of that section instead of below the form.
|
|
74
75
|
facts?: ActionFormSuccessFact[]; // Key figures from the query result, shown like the success box facts.
|
|
75
76
|
list?: ActionFormPreviewList; // Table of rows from the query result.
|
|
76
77
|
};
|
|
@@ -87,7 +88,7 @@ type ActionFormRedirect = { // Redirect target plus the success-payload field ca
|
|
|
87
88
|
type ActionFormSuccessFact = { // One key figure of the success box, read from the handler's success payload.
|
|
88
89
|
field: string; // Flat field name in the handler's success payload.
|
|
89
90
|
label: string; // Label (i18n key).
|
|
90
|
-
type?: ActionFormValueType; // Format of the value (a money object, a date string, a number); default `text`.
|
|
91
|
+
type?: ActionFormValueType | "file"; // Format of the value (a money object, a date string, a number); default `text`.
|
|
91
92
|
};
|
|
92
93
|
type ActionFormSuccessItems = { // Per-entry hints of the success box, read from an array in the handler's success payload.
|
|
93
94
|
field: string; // Flat field name of an array in the success payload.
|
|
@@ -490,6 +491,7 @@ type FieldAiAssist = {
|
|
|
490
491
|
resultField: string; // Key in the query result written into the field; the value must be a string.
|
|
491
492
|
noteField?: string; // Key in the query result with a short note for the user (e.g. "could not rewrite, draft unchanged").
|
|
492
493
|
contextFields?: string[]; // Other fields of the same form whose current values are sent in the payload (under their field names).
|
|
494
|
+
autoRun?: boolean; // Default `true`: a change of a `contextFields` field re-runs the query while the field is empty or AI-written.
|
|
493
495
|
chips?: FieldAiAssistChip[];
|
|
494
496
|
prompt?: {
|
|
495
497
|
param: string;
|
|
@@ -569,6 +571,21 @@ type ListTableSummaryRow = { // The query receives the list's current search, fi
|
|
|
569
571
|
};
|
|
570
572
|
type ListToolbarActionsPlacement = (typeof LIST_TOOLBAR_ACTIONS_PLACEMENTS)[number];
|
|
571
573
|
type OptionsQueryPayload = Readonly<Record<string, OptionsQueryPayloadValue>>;
|
|
574
|
+
type PageHelpSection = PageHelpStatusSection | PageHelpTextSection;
|
|
575
|
+
type PageHelpSpec = { // General help of a page: a question-mark button at the end of the shell header actions opens a drawer with one card per section.
|
|
576
|
+
sections: PageHelpSection[];
|
|
577
|
+
};
|
|
578
|
+
type PageHelpStatusSection = { // Explains every option of one select field (typically a status).
|
|
579
|
+
kind: "status";
|
|
580
|
+
field: string;
|
|
581
|
+
entity?: string;
|
|
582
|
+
title?: string; // i18n key of the card heading.
|
|
583
|
+
};
|
|
584
|
+
type PageHelpTextSection = { // Free help text; `title` and `text` are i18n keys.
|
|
585
|
+
kind: "text";
|
|
586
|
+
title: string;
|
|
587
|
+
text: string;
|
|
588
|
+
};
|
|
572
589
|
type ParsedRefTarget = {
|
|
573
590
|
featureName: string;
|
|
574
591
|
entityName: string;
|
|
@@ -41,6 +41,7 @@ function EditorInfoBar(props: { tone: InfoBarTone; testId: string; origin?: Reac
|
|
|
41
41
|
function EditorLocaleSwitch(props: { testIdPrefix: string; locales: string[]; locale: string; onLocale: (locale: string) => void; }): ReactNode;
|
|
42
42
|
function EditorModeSwitch(props: { testIdPrefix: string; mode: EditorMode; onMode: (mode: EditorMode) => void; }): ReactNode;
|
|
43
43
|
function EditorPanel(props: EditorPanelProps): ReactNode;
|
|
44
|
+
function EditorToolbarPill(props: { children: ReactNode; }): ReactNode;
|
|
44
45
|
function EditorWorkbench(props: EditorWorkbenchProps): ReactNode;
|
|
45
46
|
function EmptyState(props: { icon?: ReactNode; title: string; description?: string; action?: ReactNode; testId?: string; }): ReactNode; // Empty state with an optional icon and CTA, using the dashed-box style of entityList empty states as a standalone widget for custom screens.
|
|
46
47
|
function ErrorState(props: { error: DispatcherError; onRetry?: () => void; testId?: string; }): ReactNode; // Error state based on the Banner primitive, with a retry button.
|
|
@@ -697,6 +698,8 @@ type GridProps = { // Column-based layout.
|
|
|
697
698
|
ariaLabelledBy?: string; // Id of the element naming this grid (a Field label).
|
|
698
699
|
tight?: boolean; // With `columns: "auto"`: the small gap of a chip row instead of the tile gap.
|
|
699
700
|
facts?: boolean; // Read-only label/value facts: a true `columns`-wide grid with a tight gap, at most 2 columns below `sm`.
|
|
701
|
+
legend?: boolean; // Legend rows as flat child pairs (term, explanation): the first column is as wide as its widest term and never wraps, the second takes the rest, with a fixed gap between them.
|
|
702
|
+
ruled?: boolean; // With `legend`: the term column is a fixed 13rem (12rem plus gap) in every grid (sentences start at one x across cards) and the rows are separated by hairlines.
|
|
700
703
|
};
|
|
701
704
|
type HeaderActionGroupProps = {
|
|
702
705
|
children: ReactNode;
|
|
@@ -1042,6 +1045,8 @@ type MenuItemDef =
|
|
|
1042
1045
|
kind: "item";
|
|
1043
1046
|
id: string;
|
|
1044
1047
|
label: string;
|
|
1048
|
+
description?: string;
|
|
1049
|
+
testId?: string;
|
|
1045
1050
|
icon?: ReactNode; // Optional icon displayed before the label (16px).
|
|
1046
1051
|
shortcut?: string; // Display-only shortcut hint on the right (monospace, muted).
|
|
1047
1052
|
onSelect: () => void;
|
|
@@ -1378,6 +1383,7 @@ type RenderEditProps<TValues extends FormValues, TCtx = unknown> = {
|
|
|
1378
1383
|
fillScreenHeight?: boolean; // Screen body fills the shell height: the form gets `fillHeight` and `stickyActions` (sections scroll, footer pinned).
|
|
1379
1384
|
leadContent?: ReactNode; // Rendered first inside the form, above the sections, in the same column and rhythm — for content that belongs to the form but is no field (e.g. the secret a confirm step refers to).
|
|
1380
1385
|
belowSections?: (values: Readonly<Record<string, unknown>>) => ReactNode; // Rendered after the sections, above the form actions, with the live form values.
|
|
1386
|
+
afterSection?: (sectionId: string, values: Readonly<Record<string, unknown>>) => ReactNode; // Rendered at the end of the fields section with this id, with the live form values.
|
|
1381
1387
|
submitBlocked?: boolean; // Blocks submit (button and Enter) while fields stay editable — unlike `disabled`, which locks the whole form.
|
|
1382
1388
|
formDerivation?: FormDerivationScreen; // actionForm `derive`: derived fields are recomputed into the form state on every change and render read-only.
|
|
1383
1389
|
actionFormScreenQn?: string; // QN of the actionForm screen this form renders; its file fields upload as pending for that screen.
|
package/agents/api/types.md
CHANGED
|
@@ -1605,6 +1605,7 @@ type ContentEditorProps = {
|
|
|
1605
1605
|
onChange: (value: string) => void;
|
|
1606
1606
|
variables: string[]; // Variable names insertable as chips (from the collection's variableSchema).
|
|
1607
1607
|
readOnly: boolean;
|
|
1608
|
+
formatting?: "text"; // "text" asks for plain text formatting only (bold, italic, lists, link): no images, tables or other blocks.
|
|
1608
1609
|
};
|
|
1609
1610
|
```
|
|
1610
1611
|
|
|
@@ -2264,6 +2265,8 @@ type EditFieldViewModel = {
|
|
|
2264
2265
|
suffix?: FieldAffix;
|
|
2265
2266
|
fillAction?: FieldFillAction; // From EditFieldSpec.fillAction, `label` already translated.
|
|
2266
2267
|
aiAssist?: FieldAiAssist; // From EditFieldSpec.aiAssist, chip labels and the prompt placeholder already translated.
|
|
2268
|
+
editor?: "document"; // From EditFieldSpec.editor.
|
|
2269
|
+
contextDocumentFields?: string[]; // aiAssist.contextFields that name a document-editor field of the same form (their HTML is sent as text).
|
|
2267
2270
|
valueChips?: FieldValueChips; // From EditFieldSpec.valueChips.
|
|
2268
2271
|
concealed?: true; // From EditFieldSpec.concealed.
|
|
2269
2272
|
badge?: FieldBadge; // From EditFieldSpec.badge, a fixed `label` already translated.
|
|
@@ -2519,6 +2522,7 @@ type ActionMenuItemSpec = { // One item in an `ActionOverflowMenu` (header/row a
|
|
|
2519
2522
|
type ActionOverflowMenuProps = {
|
|
2520
2523
|
items: ActionMenuItemSpec[];
|
|
2521
2524
|
label: string; // aria-label for the three-dots trigger.
|
|
2525
|
+
triggerLabel?: string; // Renders a labelled button (plus icon, text, chevron) instead of the three-dots icon.
|
|
2522
2526
|
testId?: string;
|
|
2523
2527
|
};
|
|
2524
2528
|
type ButtonBaseProps = {
|
|
@@ -2530,6 +2534,7 @@ type ButtonBaseProps = {
|
|
|
2530
2534
|
size?: "sm" | "md" | "icon"; // Size—default="md".
|
|
2531
2535
|
ariaLabel?: string; // Accessible label—required for icon-only buttons (when children contain only an icon or character), otherwise the button has no accessible name.
|
|
2532
2536
|
title?: string; // Tooltip — rendered as the `title` attribute.
|
|
2537
|
+
collapseLabel?: boolean; // Below the `sm` breakpoint only the icon shows (in a square), the label stays the accessible name.
|
|
2533
2538
|
pressed?: boolean; // Toggle state for toggle buttons — web sets `aria-pressed`; leave unset for plain buttons.
|
|
2534
2539
|
expanded?: boolean; // Disclosure state for buttons that open a menu or panel — web sets `aria-expanded`.
|
|
2535
2540
|
width?: "full" | "auto"; // Width—default="auto" (content width).
|
|
@@ -2589,6 +2594,7 @@ type DialogProps = { // Modal dialog for confirmations or compact sub-forms.
|
|
|
2589
2594
|
description?: string; // Optional description, typically a sentence explaining the consequence ("This action cannot be undone.").
|
|
2590
2595
|
confirmLabel?: string; // Confirm-button label.
|
|
2591
2596
|
cancelLabel?: string; // Cancel-Button-Label.
|
|
2597
|
+
hideCancel?: boolean; // Leaves out the cancel button, for an information dialog whose only button closes it.
|
|
2592
2598
|
variant?: "default" | "danger"; // `default` = Confirm primary, `danger` = Confirm danger.
|
|
2593
2599
|
initialFocus?: "confirm" | "cancel"; // Which button takes focus on open.
|
|
2594
2600
|
onConfirm: () => void | Promise<void>; // Called when the user confirms.
|
|
@@ -2664,12 +2670,14 @@ type ModalProps = { // Bare content shell for hosting an existing self-contained
|
|
|
2664
2670
|
title: string; // Screen-reader-only accessible title (required by the underlying dialog primitive) — not shown visually since the hosted content is expected to render its own heading.
|
|
2665
2671
|
children: ReactNode;
|
|
2666
2672
|
testId?: string;
|
|
2673
|
+
size?: "default" | "wide"; // "wide" suits content with lists beside actions; web caps it at the viewport.
|
|
2667
2674
|
};
|
|
2668
2675
|
type PageHeaderProps = { // Page title area rendered by the app shell's header instead of inside the screen: `title` replaces the last breadcrumb, `status` sits right after it, `actions` at the right edge.
|
|
2669
2676
|
title?: string;
|
|
2670
2677
|
recordTitle?: string; // Name of the loaded record; shown as an extra breadcrumb before the last one.
|
|
2671
2678
|
narrowRecordTitle?: string; // Short record title for the phone top bar; wins over `recordTitle` there.
|
|
2672
2679
|
status?: ReactNode;
|
|
2680
|
+
help?: ReactNode; // Page help trigger, shown at the end of the shell header actions.
|
|
2673
2681
|
actions?: ReactNode;
|
|
2674
2682
|
bodyTitle?: boolean; // Screen renders its own h1: the shell header shows only the parent crumb, as text.
|
|
2675
2683
|
overflowItems?: ActionMenuItemSpec[]; // Land in the shell header's overflow menu at phone width.
|
|
@@ -5069,6 +5077,7 @@ type EditFieldsSectionBase = EditSectionPresentation & {
|
|
|
5069
5077
|
description?: string; // Optional help text under the block heading (i18n key or raw string, like `title`) — makes a form usable without training instead of falling back to custom JSX for help text.
|
|
5070
5078
|
descriptionNarrow?: string; // i18n key of a short text shown instead of `description` below `sm`.
|
|
5071
5079
|
columns?: number;
|
|
5080
|
+
flow?: boolean; // Screen forms and drawers lay fields out as a flow: each field is sized by its type and `columns` is ignored.
|
|
5072
5081
|
icon?: IconKey; // Rendered left of the section title, `text-muted-foreground` — closed IconKey vocabulary into the ICONS registry (renderer/web), analogous to EditFieldSpec.icon.
|
|
5073
5082
|
countField?: string; // Record field rendered as a count badge in the tab label when the enclosing `EditLayout.mode` is "tabs" (e.g. an open-items counter).
|
|
5074
5083
|
subtitle?: string; // Short line (i18n key) under this step's title in the wizard step rail and in the "up next" box.
|
|
@@ -5127,7 +5136,7 @@ type ScreenFilterOp = "eq" | "ne" | "lt" | "gt" | "lte" | "gte" | "in";
|
|
|
5127
5136
|
## packages/types/src/screen-expandable-row.ts
|
|
5128
5137
|
|
|
5129
5138
|
```ts
|
|
5130
|
-
type EntityListExpandableRow = Omit<EditRelatedListSection, "id" | "countField" | "count" | "table" | "bulkActions"> & { // Expandable area of an `entityList` row: a relatedList of the row's record.
|
|
5139
|
+
type EntityListExpandableRow = Omit<EditRelatedListSection, "id" | "countField" | "count" | "table" | "bulkActions" | "pageHelp"> & { // Expandable area of an `entityList` row: a relatedList of the row's record.
|
|
5131
5140
|
table?: {
|
|
5132
5141
|
grouping?: ExpandableRowGrouping;
|
|
5133
5142
|
};
|
package/agents/api.md
CHANGED
|
@@ -10,11 +10,11 @@ Format: one line per function or constant, object and options types as property
|
|
|
10
10
|
| --- | --- | --- |
|
|
11
11
|
| `@cosmicdrift/kumiko-framework/engine` | `api/framework-engine.md` | 446 |
|
|
12
12
|
| `@cosmicdrift/kumiko-framework/errors` | `api/framework-errors.md` | 27 |
|
|
13
|
-
| `@cosmicdrift/kumiko-framework/ui-types` | `api/framework-ui-types.md` |
|
|
13
|
+
| `@cosmicdrift/kumiko-framework/ui-types` | `api/framework-ui-types.md` | 197 |
|
|
14
14
|
| `@cosmicdrift/kumiko-framework/db` | `api/framework-db.md` | 157 |
|
|
15
15
|
| `@cosmicdrift/kumiko-framework/event-store` | `api/framework-event-store.md` | 41 |
|
|
16
16
|
| `@cosmicdrift/kumiko-framework/seeding` | `api/framework-seeding.md` | 6 |
|
|
17
|
-
| `@cosmicdrift/kumiko-renderer/web` | `api/renderer-web.md` |
|
|
17
|
+
| `@cosmicdrift/kumiko-renderer/web` | `api/renderer-web.md` | 380 |
|
|
18
18
|
| `@cosmicdrift/kumiko-testing/stack` | `api/testing-stack.md` | 23 |
|
|
19
19
|
| `@cosmicdrift/kumiko-testing/helpers` | `api/testing-helpers.md` | 72 |
|
|
20
20
|
| `@cosmicdrift/kumiko-dev-server/testing` | `api/dev-server-testing.md` | 5 |
|
package/agents/boot-rules.md
CHANGED
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
| <a id="action-form-preview-field-unknown"></a>`action-form-preview/field-unknown` | preview.fields names fields of the form. | Name an existing field of the form, or drop fields to send all of them. | `packages/framework/src/engine/boot-validator/action-form-preview-rules.ts` |
|
|
13
13
|
| <a id="action-form-preview-label-missing"></a>`action-form-preview/label-missing` | Every preview fact and list column has a label. | Add label: the i18n key of the fact or column header. | `packages/framework/src/engine/boot-validator/action-form-preview-rules.ts` |
|
|
14
14
|
| <a id="action-form-preview-list-field-missing"></a>`action-form-preview/list-field-missing` | preview.list names the result field of its rows and at least one column. | Set list.field to the array in the query result and list the columns to show. | `packages/framework/src/engine/boot-validator/action-form-preview-rules.ts` |
|
|
15
|
+
| <a id="action-form-preview-section-unknown"></a>`action-form-preview/section-unknown` | preview.section names a fields section of the layout. | Give a layout section that id, or drop section to show the preview below the form. | `packages/framework/src/engine/boot-validator/action-form-preview-rules.ts` |
|
|
15
16
|
|
|
16
17
|
## agent-effect
|
|
17
18
|
|
|
@@ -476,6 +477,7 @@
|
|
|
476
477
|
| <a id="form-confirm-layout-mode"></a>`form/confirm-layout-mode` | A secretMint confirm layout is a single-step form. | Remove mode or set it to "single". | `packages/framework/src/engine/boot-validator/screens-forms-layout-rules.ts` |
|
|
477
478
|
| <a id="form-draft-feature-missing"></a>`form/draft-feature-missing` | A draft layout needs the form-draft feature mounted. | Add createFormDraftFeature() from @cosmicdrift/kumiko-bundled-features to the app's features. | `packages/framework/src/engine/boot-validator/screens-forms-layout-rules.ts` |
|
|
478
479
|
| <a id="form-draft-without-wizard"></a>`form/draft-without-wizard` | layout.draft is set only on a wizard layout. | Remove draft: true or set mode: "wizard". | `packages/framework/src/engine/boot-validator/screens-forms-layout-rules.ts` |
|
|
480
|
+
| <a id="form-editor-field-type"></a>`form/editor-field-type` | The editor option targets a longText field without fillAction or valueChips. | Remove editor, or use a longText field and drop fillAction and valueChips. | `packages/framework/src/engine/boot-validator/screens-forms-rules.ts` |
|
|
479
481
|
| <a id="form-embedded-list-card-hidden-editable"></a>`form/embedded-list-card-hidden-editable` | embeddedList.cardHiddenCells lists only read-only cells. | Add the cell to readOnlyCells or remove it from cardHiddenCells. | `packages/framework/src/engine/boot-validator/screens-forms-rules.ts` |
|
|
480
482
|
| <a id="form-embedded-list-on-non-list-field"></a>`form/embedded-list-on-non-list-field` | embeddedList is set only on an embedded list field. | Remove embeddedList or point it at an embedded list field. | `packages/framework/src/engine/boot-validator/screens-forms-rules.ts` |
|
|
481
483
|
| <a id="form-embedded-list-unknown-sub-field"></a>`form/embedded-list-unknown-sub-field` | embeddedList cell options name sub-fields of the embedded schema. | Name an existing sub-field. | `packages/framework/src/engine/boot-validator/screens-forms-rules.ts` |
|
|
@@ -898,6 +900,14 @@
|
|
|
898
900
|
| <a id="ownership-where-on-field-read"></a>`ownership/where-on-field-read` | A field-level read access map uses from(...) rules, not where(...). | Replace the where rule with a from rule on the field read path. | `packages/framework/src/engine/boot-validator/ownership-rules.ts` |
|
|
899
901
|
| <a id="ownership-where-on-write-path"></a>`ownership/where-on-write-path` | A write access map uses from(...) rules, not where(...), because where is read-only SQL. | Replace the where rule with a from rule on the write path. | `packages/framework/src/engine/boot-validator/ownership-rules.ts` |
|
|
900
902
|
|
|
903
|
+
## page-help
|
|
904
|
+
|
|
905
|
+
| Rule | Summary | Fix | Source |
|
|
906
|
+
| --- | --- | --- | --- |
|
|
907
|
+
| <a id="page-help-option-help-missing"></a>`page-help/option-help-missing` | Every option of the pageHelp field has a `:help` translation, in the feature that owns the entity, in each locale its option label has. | Add `<option label key>:help` via r.translations(...) in the owning feature for the listed options and locales. | `packages/framework/src/engine/boot-validator/page-help-rules.ts` |
|
|
908
|
+
| <a id="page-help-status-field-invalid"></a>`page-help/status-field-invalid` | Every status section of a pageHelp names a select field of an existing entity, bare for the own feature or `<feature>:<entity>` for another one (entity is required on a projectionDetail; a relatedList defaults to its section entity). | Point the status section's field at a select field and its entity at an existing entity (`<feature>:<entity>` for a foreign one). | `packages/framework/src/engine/boot-validator/page-help-rules.ts` |
|
|
909
|
+
| <a id="page-help-unsupported-site"></a>`page-help/unsupported-site` | A relatedList's pageHelp only joins the help of a projectionDetail; on a relatedList of an entityEdit it would be ignored. | Declare pageHelp on the projectionDetail or entityList instead. | `packages/framework/src/engine/boot-validator/page-help-rules.ts` |
|
|
910
|
+
|
|
901
911
|
## parent-ref
|
|
902
912
|
|
|
903
913
|
| Rule | Summary | Fix | Source |
|