@declarion/react 0.57.0 → 0.59.2

package/dist-lib/types/schema.d.ts

@@ -2,6 +2,7 @@ import { OrderedMap } from "./ordmap";
 import type { FileFieldDef } from "./files";
 import type { IconDef } from "../stores/icon-registry.d.ts";
 import type { FilterNode } from "../lib/filters.d.ts";
+import type { TextFn } from "../lib/language.d.ts";
 export { OrderedMap };
 export type { IconDef };
 export type LocalizedString = Record<string, string>;
@@ -14,9 +15,8 @@ export type LocalizedString = Record<string, string>;
  *   none   — no request at all; render the globe placeholder.
  *
  * Declared per column by `field.display.favicon_source`, and nowhere else -
- * there is no parameter (plan 2026-07-09 Decision 23). Absent = `google`,
- * today's rendered default. Mirrors `validFaviconSources` in
- * golang/internal/engine/types_field_display.go.
+ * there is no parameter. Absent = `google`, today's rendered default. The
+ * server accepts exactly these three values.
  */
 export type FaviconSource = "google" | "direct" | "none";
 /**
@@ -37,9 +37,8 @@ export interface EmptyStateDef {
  * with Go's engine.DetailScreenNone - keep the literal "none" in sync.
  */
 export declare const DETAIL_SCREEN_NONE = "none";
-export declare function loc(ls: LocalizedString | undefined, lang?: string): string;
 export declare const DISPLAY_KEY = "$display";
-export declare function getDisplayValue(row: Record<string, unknown> | null | undefined, entity: {
+export declare function getDisplayValue(t: TextFn, row: Record<string, unknown> | null | undefined, entity: {
     display?: {
         display_field?: string;
     };
@@ -47,12 +46,13 @@ export declare function getDisplayValue(row: Record<string, unknown> | null | un
         get(name: string): EntityField | undefined;
     };
 } | null | undefined): string | undefined;
-export declare function resolveRefRecordLabel(record: Record<string, unknown>, displayKey: string | undefined, fallback: string): string;
-export declare function screenTitleForPath(pathname: string, screens: Record<string, Screen> | undefined, entities?: Record<string, Entity>): {
+export declare function resolveRefRecordLabel(t: TextFn, record: Record<string, unknown>, displayKey: string | undefined, fallback: string): string;
+export declare function screenTitleForPath(t: TextFn, pathname: string, screens: Record<string, Screen> | undefined, entities?: Record<string, Entity>): {
     title: string;
     icon?: string;
+    exact: boolean;
 } | undefined;
-export declare function fieldDisplayName(field: EntityField, fieldName: string, entities?: Record<string, Entity>): string;
+export declare function fieldDisplayName(t: TextFn, field: EntityField, fieldName: string, entities?: Record<string, Entity>): string;
 export interface RefDisplay {
     field: string;
 }
@@ -163,8 +163,7 @@ export interface EntityField {
     array?: boolean;
     copyable?: boolean;
     /**
-     * Plan 2026-05-26 §4 / B13. Names the data_classifications tier
-     * gating reads + writes on this field. Read-side: stripped from the
+     * Names the data_classifications tier gating reads + writes on this field. Read-side: stripped from the
      * row when the caller lacks `classification:<tier>:read`. Write-side:
      * 422 FIELDS_FORBIDDEN when the caller writes the key without
      * `classification:<tier>:write`. Frontend reads the tier's localized
@@ -176,7 +175,7 @@ export interface EntityField {
 }
 /**
  * Per-caller classification decision for one classified field on one
- * entity. Plan 2026-05-26 §8 / B9. Populated by the schema endpoint
+ * entity. Populated by the schema endpoint
  * from the caller's grants + authority tier; the frontend reads this
  * to render the locked-widget badge ("🔒 Compensation"), disable write
  * inputs, and surface the operator-facing `required_permission` hint
@@ -332,8 +331,7 @@ export interface EntityVariant {
     actions?: string[];
 }
 /** A set of CRUD op flags, each present or absent. The YAML-decoded shape of
- *  an entity's `public` opt-out block (deny-by-default authorization, plan
- *  2026-06-17). A flag being true means that op is open to ALL authenticated
+ *  an entity's `public` opt-out block (deny-by-default authorization). A flag being true means that op is open to ALL authenticated
  *  callers with no grant required. Mirrors engine.OpSet. On the /api/schema
  *  wire it always serializes as this object (never a bare bool, even though
  *  YAML accepts `public: true`). */
@@ -396,8 +394,7 @@ export interface Entity {
     associations?: Record<string, AssociationDef>;
     files?: OrderedMap<FileFieldDef>;
     detail_screen?: string;
-    /** Standard CSV export gate per docs/plans/2026-05-01-standard-table-export.md.
-     *  Absent block (or absent `enabled`) means export is enabled. Only an
+    /** Standard CSV export gate. Absent block (or absent `enabled`) means export is enabled. Only an
      *  explicit `enabled: false` opts out, mirroring the Go ExportEnabled()
      *  helper. Same shape ships on Screen for per-screen overrides. */
     export?: ExportConfig;
@@ -410,8 +407,8 @@ export interface Entity {
      *  profile -> "user"). Absent = writes land under the entity's own code. Used
      *  by ParamsBlock to compute the attachable parameter set. */
     params_scope?: string;
-    /** Server-enforced WHERE applied unconditionally on every read/write
-     *  via server/handlers/data_prefilter.go. Values may be literal scalars
+    /** Server-enforced WHERE applied unconditionally on every read/write.
+     *  Values may be literal scalars
      *  OR `$caller.*` expressions (`$caller.user_id`, `$caller.tenant_id`)
      *  resolved at request time. Security boundary, not a UX hint. */
     prefilter?: Record<string, unknown>;
@@ -421,9 +418,9 @@ export interface Entity {
      *  with_check). `"tenant_admin"` admits any administrative standing in the
      *  active tenant (superadmin / tenant_owner / any role grant). `"superadmin"`
      *  admits only the platform-wide god flag. Empty = no tier floor (standard
-     *  RBAC). The legacy `"platform_admin"` alias was removed (plan 2026-06-17). */
+     *  RBAC). The legacy `"platform_admin"` alias was removed. */
     access?: "self" | "tenant_admin" | "superadmin";
-    /** Deny-by-default authorization (plan 2026-06-17). Absent = every op
+    /** Deny-by-default authorization. Absent = every op
      *  requires its `entity:<code>:<op>` grant. `public.<op>: true` opts that op
      *  out of the grant requirement, opening it to all authenticated callers
      *  (NOT anonymous). The Entity.Access floor is checked first and is never
@@ -435,11 +432,11 @@ export interface Entity {
      * Optional structural tree for placing and grouping actions across all
      * placement slots. Absent = runtime composes a flat list from all actions
      * matching each slot's visibility[], sorted by position ascending.
-     * Server delivers RBAC-pruned nodes in tagged-union wire format (plan §8).
+     * Server delivers RBAC-pruned nodes in tagged-union wire format.
      */
     action_layout?: ActionLayoutNode[];
     /**
-     * Plan 2026-05-26 §B9 / §B13. Per-caller classification access
+     * Per-caller classification access
      * decision keyed by field name. Only present for entities that
      * declare at least one classified field; absent on non-classification
      * entities so the wire stays byte-equivalent for non-classification
@@ -454,8 +451,7 @@ export interface Entity {
      * toolbar shows a green "Live" indicator. Absent or false (default OFF)
      * means the entity is not live: no indicator, and the always-present
      * manual refresh control is the only freshness mechanism. Server emits
-     * this with `omitempty`, so `false` arrives as absent. See
-     * docs/plans/completed/2026-05-18-realtime-cdc-redesign.md.
+     * this with `omitempty`, so `false` arrives as absent.
      */
     realtime?: boolean;
     /**
@@ -464,8 +460,7 @@ export interface Entity {
      * O(1) query-planner estimate, rendered coarse (~3.6M) for high-volume
      * tables. Independent of `realtime`. The SDK keys list-view count
      * precision on the response `meta.count_mode`, not this field, so a
-     * forced exact count still renders precisely. See
-     * docs/plans/2026-05-18-declarative-row-count.md.
+     * forced exact count still renders precisely.
      */
     count?: "exact" | "estimated";
     /**
@@ -475,7 +470,7 @@ export interface Entity {
      * AND the deployment has ClickHouse wired at boot - a cross-store hot+cold
      * read cannot offset-paginate. Absent means "offset" (every plain Postgres /
      * ClickHouse-only / ClickHouse-disabled-archive entity). The SDK branches the
-     * list UI on this. See docs/plans/2026-06-20-cross-store-list-cursor-pagination.md.
+     * list UI on this.
      */
     list_pagination?: "offset" | "cursor";
     /**
@@ -488,7 +483,7 @@ export interface Entity {
      * template is found via the lazy `document.templates.available` runtime
      * probe (tenant templates are runtime data and are never baked into the
      * schema). `generate_one` gates the detail-scope toolbar; `generate_many`
-     * gates the list-scope toolbar. See docs/document-generation.md.
+     * gates the list-scope toolbar.
      */
     documents?: {
         generate_one?: boolean;
@@ -603,8 +598,8 @@ export interface AuditConfig {
     enabled?: boolean;
     lines?: AuditLineDef[];
 }
-/** Resolved per-screen visibility decision (deny-by-default authorization,
- *  plan 2026-06-17). Computed by the engine at load - authors write
+/** Resolved per-screen visibility decision (deny-by-default authorization).
+ *  Computed by the engine at load - authors write
  *  `public` / `required_permission`, never this. `public` and
  *  `required_permission` are mutually exclusive; `source` is the audit
  *  provenance (authored:public | authored | authored->public |
@@ -717,8 +712,7 @@ export interface Screen {
      *  viewer's own default view wins over it. */
     default_view?: string;
     /** Action slot promotion for list screens (rule-of-2). UI honors first 2.
-     *  Note: primary_record_actions (detail header) was removed in Task 5 of plan
-     *  2026-04-21-action-toolbar-priority-overflow. Use action_layout instead. */
+     *  The detail-header `primary_record_actions` was removed; use action_layout. */
     primary_actions?: string[];
     primary_bulk_actions?: string[];
     /** "open" (default) navigates to detail; "peek" opens QuickPeek drawer. */
@@ -735,7 +729,7 @@ export interface Screen {
      * Optional per-screen structural tree for placing and grouping actions.
      * When set, fully replaces entity.action_layout for this screen.
      * Absent = inherit entity.action_layout (then default-flat if also absent).
-     * Server delivers RBAC-pruned nodes in tagged-union wire format (plan §8).
+     * Server delivers RBAC-pruned nodes in tagged-union wire format.
      */
     action_layout?: ActionLayoutNode[];
 }
@@ -860,7 +854,7 @@ export interface UIStep {
 }
 /**
  * Leaf node in an action_layout tree. References a single action by code.
- * Wire format (plan §8): {"kind": "action", "code": "<code>"}
+ * Wire format: {"kind": "action", "code": "<code>"}
  */
 export interface ActionLayoutLeaf {
     kind: "action";
@@ -868,7 +862,7 @@ export interface ActionLayoutLeaf {
 }
 /**
  * Branch node in an action_layout tree. Groups child nodes under a labelled dropdown.
- * Wire format (plan §8): {"kind": "group", "name": {...}, "icon": "...", "items": [...]}
+ * Wire format: {"kind": "group", "name": {...}, "icon": "...", "items": [...]}
  * Items is always non-empty (enforced by loader).
  */
 export interface ActionLayoutGroup {
@@ -900,7 +894,7 @@ export interface ActionConditionEntry {
 export type ActionConditionList = ActionConditionEntry[];
 export interface Action {
     /**
-     * Server-side handler code. One of four dispatch fields - see plan §1-§2.
+     * Server-side handler code. One of four dispatch fields.
      * Reason: the new wire format encodes dispatch mode by which field is set
      * (handler | association | widget | href), so an explicit `type` enum is
      * redundant and was removed. Exactly one of the four should be set per action.
@@ -908,12 +902,12 @@ export interface Action {
     handler?: string;
     /**
      * Association code for nav-only actions that navigate to a related list.
-     * Reason: same dispatch-by-field-presence rule; see plan §1-§2.
+     * Reason: same dispatch-by-field-presence rule.
      */
     association?: string;
     /**
-     * SDK widget registry name. Phase 2 wires the registry; today the field
-     * is plumbed through the schema and consumed by Task 38's toolbar pipeline.
+     * SDK widget registry name. The SDK has no widget registry yet: an action
+     * carrying `widget` logs a warning and falls back to `onRun`.
      * Reason: lets actions render bespoke UI (e.g. inline picker) instead of
      * server-handled forms, without inventing a new entity per widget.
      */
@@ -956,15 +950,15 @@ export interface Action {
          */
         size?: "sm" | "md" | "lg";
         /**
-         * Keyboard shortcut hint (e.g. "Cmd+S"). Rendered in tooltip/menu.
-         * Reason: discoverability for power users; binding is wired in Task 38.
+         * Keyboard shortcut hint (e.g. "Cmd+S"), carried on the wire. The SDK
+         * neither renders it nor binds the key yet.
          */
         shortcut?: string;
         /**
          * Localized explanation of what the action does. Surfaces as the control
          * tooltip (precedence: disabled-reason > description > name) and the
          * ActionDialog subtitle. Optional; absent renders exactly as before.
-         * (Supersedes the removed `help` field - plan 2026-07-02 Decision 16.)
+         * Supersedes the removed `help` field.
          */
         description?: LocalizedString;
     };
@@ -973,25 +967,24 @@ export interface Action {
     conditions?: ActionCondition[];
     /**
      * Ordering within a placement slot and overflow priority. Lower = earlier
-     * in bar AND last to overflow. Default 0; ties broken by declaration order.
-     * Step-10 convention. See plan §1 and §3.
+     * in bar AND last to overflow. Default 0; ties broken by action code.
+     * Convention: step by 10 so a later action fits between two.
      */
     position?: number;
     /**
      * Hide the action when condition does not hold against current row.
      * Distinct from RBAC hide and from `enabled_if` disable. AND semantics
-     * across array elements. See plan §1, §5.
+     * across array elements.
      */
     visible_if?: ActionConditionList;
     /**
      * Disable the action (greyed out + tooltip) when condition does not hold.
      * For bulk-mode multi-row selection, disabled if ANY selected row fails.
-     * See plan §1, §5.
      */
     enabled_if?: ActionConditionList;
     /**
      * Localized tooltip shown when action is disabled by `enabled_if`.
-     * Required when `enabled_if` is set (loader validates in Task 3).
+     * Required when `enabled_if` is set; the schema loader enforces it.
      */
     enabled_if_reason?: LocalizedString;
     /** Forces confirm + danger styling. */
@@ -1037,6 +1030,8 @@ export interface HandlerDef {
 }
 export interface Schema {
     languages: LanguageDef[];
+    language: string;
+    deployment_language: string;
     structures: Record<string, StructureDef>;
     entities: Record<string, Entity>;
     screens: Record<string, Screen>;
@@ -1059,7 +1054,7 @@ export interface Schema {
     areas?: AreaDef[];
     accents?: Record<string, AccentDef>;
     /**
-     * Plan 2026-05-26 §B9 / §B13. data_classifications catalog keyed by
+     * data_classifications catalog keyed by
      * tier code — display name + description + audit_on_read flag + icon
      * + sod_protected flag. Absent when the consumer declares no tiers
      * (preserves byte-equivalent wire shape for non-classification
@@ -1072,13 +1067,12 @@ export interface Schema {
      * call sites. Carries ONLY declared/overridden entries (the built-in ~119
      * travel as bare names, never here); absent when no module declares an
      * `icons:` block. The Admin loads this into the runtime icon registry
-     * (setIconRegistry) so custom glyphs render across the chrome. Plan
-     * 2026-06-12-consumer-extensible-icons.md §4.
+     * (setIconRegistry) so custom glyphs render across the chrome.
      */
     icons?: Record<string, IconDef>;
 }
 /**
- * Plan 2026-05-26 §B9. One entry in the top-level classifications map.
+ * One entry in the top-level classifications map.
  * Mirrors engine.DataClassification.
  */
 export interface ClassificationTierDef {