@veil-runtime/ui 0.4.2 → 0.5.0

package/dist/interface.d.ts

@@ -1,3 +1,4 @@
+export type InterfacePresentationPhase = "loading" | "ready" | "empty" | "error";
 export type InterfaceValue = string | number | boolean | null;
 export interface InterfaceBinding {
     source: "data" | "state";
@@ -29,15 +30,32 @@ export interface InterfaceOption {
     value: string;
     label: string;
 }
+export type InterfaceCellPresentation = "text" | "badge";
 export interface InterfaceColumn {
     key: string;
     label: string;
+    presentation?: InterfaceCellPresentation;
 }
-export interface InterfaceNode {
+export interface InterfaceRowAction {
+    action: string;
+    label: string;
+}
+export interface InterfaceTableOptions {
+    rowKey?: string;
+    rowActions?: InterfaceRowAction[];
+}
+export type GridColumns = 1 | 2 | 3 | 4;
+export type GridGap = "none" | "sm" | "md" | "lg";
+export interface GridBreakpoints {
+    sm?: GridColumns;
+    lg?: GridColumns;
+}
+export interface InterfaceNode extends InterfaceTableOptions {
     key: string;
     component: string;
     children?: InterfaceNode[];
     text?: string | InterfaceBinding;
+    phase?: InterfacePresentationPhase | InterfaceBinding;
     binding?: InterfaceBinding;
     visible?: InterfaceConditionExpression;
     disabled?: InterfaceConditionExpression;
@@ -46,8 +64,12 @@ export interface InterfaceNode {
     validate?: boolean;
     action?: string;
     label?: string;
+    description?: string;
+    readOnly?: boolean;
     inputType?: "text" | "number" | "checkbox";
-    columns?: InterfaceColumn[];
+    columns?: InterfaceColumn[] | GridColumns;
+    columnsAt?: GridBreakpoints;
+    gap?: GridGap;
     ariaLabel?: string;
 }
 export interface InterfaceDefinition {
@@ -58,32 +80,50 @@ export interface InterfaceDefinition {
     state?: Record<string, unknown>;
 }
 /** Use `satisfies BuiltinInterfaceDefinition` for compile-time checks on JSON-only built-in screens. */
+type FieldOptions = Pick<InterfaceNode, "description" | "disabled">;
+type InputMode = {
+    inputType?: "text" | "number";
+    readOnly?: boolean;
+} | {
+    inputType: "checkbox";
+    readOnly?: never;
+};
 type BuiltinBase = Pick<InterfaceNode, "key" | "visible" | "ariaLabel">;
 export type BuiltinInterfaceNode = (BuiltinBase & {
     component: "Stack" | "Row";
     children?: BuiltinInterfaceNode[];
 }) | (BuiltinBase & {
-    component: "Text" | "Status";
+    component: "Grid";
+    children?: BuiltinInterfaceNode[];
+    columns?: GridColumns;
+    columnsAt?: GridBreakpoints;
+    gap?: GridGap;
+}) | (BuiltinBase & {
+    component: "Text";
     text?: string | InterfaceBinding;
+}) | (BuiltinBase & {
+    component: "Status";
+    text?: string | InterfaceBinding;
+    phase?: InterfacePresentationPhase | InterfaceBinding;
 }) | (BuiltinBase & {
     component: "Heading";
     text: string | InterfaceBinding;
-}) | (BuiltinBase & {
+}) | (BuiltinBase & FieldOptions & {
     component: "Input";
     label: string;
     binding: InterfaceBinding & {
         source: "state";
     };
-    inputType?: "text" | "number" | "checkbox";
     validation?: InterfaceValidation;
-}) | (BuiltinBase & {
+} & InputMode) | (BuiltinBase & FieldOptions & {
     component: "Textarea";
+    readOnly?: boolean;
     label: string;
     binding: InterfaceBinding & {
         source: "state";
     };
     validation?: InterfaceValidation;
-}) | (BuiltinBase & {
+}) | (BuiltinBase & FieldOptions & {
     component: "Select";
     label: string;
     binding: InterfaceBinding & {
@@ -101,7 +141,7 @@ export type BuiltinInterfaceNode = (BuiltinBase & {
     component: "Table";
     binding: InterfaceBinding;
     columns: InterfaceColumn[];
-}) | (BuiltinBase & {
+} & InterfaceTableOptions) | (BuiltinBase & {
     component: "List";
     binding: InterfaceBinding;
 });
@@ -109,6 +149,8 @@ export type BuiltinInterfaceDefinition = Omit<InterfaceDefinition, "screen"> & {
     screen: BuiltinInterfaceNode;
 };
 export interface InterfaceEvent {
+    /** Opaque lookup reference; the host must authorize access to the actual record. */
+    rowId?: string;
     action: string;
     source: string;
     state: Record<string, unknown>;
@@ -126,6 +168,7 @@ export interface InterfaceController {
     updateDefinition(definition: InterfaceDefinition, expectedRevision?: number): boolean;
     setState(path: string, value: InterfaceValue): void;
     dispatch(action: string, source: string): void;
+    dispatchRow(action: string, source: string, rowId: string, expectedRevision: number): boolean;
     subscribe(listener: (snapshot: InterfaceSnapshot) => void): () => void;
     dispose(): void;
 }
@@ -145,6 +188,12 @@ export declare function getInterfaceCapabilities(): {
             readonly children: true;
             readonly event: null;
         };
+        readonly Grid: {
+            readonly properties: readonly ["key", "component", "visible", "ariaLabel", "children", "columns", "columnsAt", "gap"];
+            readonly required: readonly [];
+            readonly children: true;
+            readonly event: null;
+        };
         readonly Text: {
             readonly properties: readonly ["key", "component", "visible", "ariaLabel", "text"];
             readonly required: readonly [];
@@ -158,25 +207,25 @@ export declare function getInterfaceCapabilities(): {
             readonly event: null;
         };
         readonly Status: {
-            readonly properties: readonly ["key", "component", "visible", "ariaLabel", "text"];
+            readonly properties: readonly ["key", "component", "visible", "ariaLabel", "text", "phase"];
             readonly required: readonly [];
             readonly children: false;
             readonly event: null;
         };
         readonly Input: {
-            readonly properties: readonly ["key", "component", "visible", "ariaLabel", "label", "binding", "inputType", "validation"];
+            readonly properties: readonly ["key", "component", "visible", "ariaLabel", "description", "disabled", "readOnly", "label", "binding", "inputType", "validation"];
             readonly required: readonly ["label", "binding"];
             readonly children: false;
             readonly event: "state change";
         };
         readonly Textarea: {
-            readonly properties: readonly ["key", "component", "visible", "ariaLabel", "label", "binding", "validation"];
+            readonly properties: readonly ["key", "component", "visible", "ariaLabel", "description", "disabled", "readOnly", "label", "binding", "validation"];
             readonly required: readonly ["label", "binding"];
             readonly children: false;
             readonly event: "state change";
         };
         readonly Select: {
-            readonly properties: readonly ["key", "component", "visible", "ariaLabel", "label", "binding", "validation", "options"];
+            readonly properties: readonly ["key", "component", "visible", "ariaLabel", "description", "disabled", "label", "binding", "validation", "options"];
             readonly required: readonly ["label", "binding", "options"];
             readonly children: false;
             readonly event: "state change";
@@ -188,10 +237,10 @@ export declare function getInterfaceCapabilities(): {
             readonly event: "action";
         };
         readonly Table: {
-            readonly properties: readonly ["key", "component", "visible", "ariaLabel", "binding", "columns"];
+            readonly properties: readonly ["key", "component", "visible", "ariaLabel", "binding", "columns", "rowKey", "rowActions"];
             readonly required: readonly ["binding", "columns"];
             readonly children: false;
-            readonly event: null;
+            readonly event: "row action (opt-in)";
         };
         readonly List: {
             readonly properties: readonly ["key", "component", "visible", "ariaLabel", "binding"];
@@ -205,8 +254,17 @@ export declare function getInterfaceCapabilities(): {
         path: string;
         missing: string;
         visibility: string;
+        pathPattern: string;
+        separator: string;
+        emptyInteriorSegmentsAccepted: boolean;
+        forbiddenSegments: string[];
+        ownPropertiesOnly: boolean;
+        exactProperties: string[];
     };
     propertyTypes: {
+        phase: string;
+        rowKey: string;
+        rowActions: string;
         key: string;
         component: string;
         children: string;
@@ -214,6 +272,8 @@ export declare function getInterfaceCapabilities(): {
         binding: string;
         visible: string;
         disabled: string;
+        description: string;
+        readOnly: string;
         validation: string;
         validate: string;
         options: string;
@@ -221,11 +281,14 @@ export declare function getInterfaceCapabilities(): {
         label: string;
         inputType: string[];
         columns: string;
+        columnsAt: string;
+        gap: string[];
         ariaLabel: string;
     };
     events: {
         action: {
             fields: string[];
+            optionalFields: string[];
             declaration: string;
         };
         state: {
@@ -234,13 +297,135 @@ export declare function getInterfaceCapabilities(): {
         };
     };
     limits: {
-        treeDepth: number;
-        nodes: number;
-        textLength: number;
-        tableRows: number;
-        tableColumns: number;
-        listItems: number;
-        transportBytes: number;
+        treeDepth: 15;
+        nodes: 512;
+        textLength: 4096;
+        tableRows: 100;
+        tableColumns: 20;
+        listItems: 100;
+        transportBytes: 1048576;
+        selectOptions: 100;
+        conditionDepth: 8;
+        conditionNodes: 64;
+        conditionTerms: 16;
+        rowActions: 8;
+        rowIdLength: 128;
+        aggregate: {
+            readonly depth: 32;
+            readonly nodes: 10000;
+            readonly keys: 256;
+            readonly items: 1000;
+            readonly string: 65536;
+            readonly bytes: 1048576;
+        };
+        treeDepthMeaning: string;
+    };
+    behavior: {
+        presentation: {
+            component: string;
+            phases: string[];
+            phaseBinding: string;
+            message: string;
+            defaults: {
+                loading: string;
+                ready: string;
+                empty: string;
+                error: string;
+            };
+            accessibility: string;
+            focus: string;
+            retry: string;
+            transitions: string;
+            orchestration: string;
+        };
+        collections: {
+            component: string;
+            rowKey: string;
+            rowIdPattern: string;
+            rowIdMatching: string;
+            duplicateOrMissingIds: string;
+            missingBinding: string;
+            rowActionsRequire: string[];
+            presentations: string[];
+            defaultPresentation: string;
+            badge: string;
+            dispatch: string;
+            source: string;
+            staleRevisionOrMissingRow: string;
+            identityScope: string[];
+            reconciliation: string;
+            keyboard: string;
+            gesture: string;
+            authorization: string;
+            eventRowData: boolean;
+        };
+        grid: {
+            columns: number[];
+            defaultColumns: number;
+            breakpoints: {
+                sm: number;
+                lg: number;
+            };
+            semantics: string;
+            gaps: {
+                none: string;
+                sm: string;
+                md: string;
+                lg: string;
+            };
+            defaultGap: string;
+            tracks: string;
+            order: string;
+        };
+        conditions: {
+            forms: string[];
+            operators: string[];
+            orderedValueType: string;
+            equality: string;
+            minTerms: number;
+            maxTerms: 16;
+            maxDepth: 8;
+            maxNodes: 64;
+            missingNumericMatches: boolean;
+        };
+        validation: {
+            fields: string[];
+            rules: string[];
+            lengthIntegerRange: number[];
+            numericRulesRequire: {
+                component: string;
+                inputType: string;
+            };
+            lengthExcludedInputTypes: string[];
+            reversedBounds: string;
+            hiddenFields: string;
+            disabledFields: string;
+            readOnlyFields: string;
+            feedback: string;
+            submissionFocus: string;
+            trigger: string;
+        };
+        actions: {
+            declaration: string;
+            hostAllowlist: string;
+            source: string;
+            optionalEventFields: string[];
+            hiddenOrDisabled: string;
+            eventFields: string[];
+            stateCopy: boolean;
+            authorization: string;
+        };
+        updates: {
+            data: string;
+            definition: string;
+            expectedRevision: string;
+            invalidCandidate: string;
+            rendererPreparation: string;
+            subscriptions: string;
+            listenerFeedbackPasses: number;
+            compatibleState: string[];
+            disposal: string;
+        };
     };
 };
 export declare function defineInterface<const T extends InterfaceDefinition>(definition: T): T;
@@ -256,6 +441,6 @@ export declare function resolveInterfaceBinding(snapshot: InterfaceSnapshot, bin
 /** Evaluate a validated condition without coercion or side effects. Missing numeric values never match. */
 export declare function evaluateInterfaceCondition(condition: InterfaceConditionExpression, snapshot: Pick<InterfaceSnapshot, "data" | "state">): boolean;
 export declare function isInterfaceField(node: Pick<InterfaceNode, "component">): boolean;
-/** Errors are recomputed from accepted state; hidden fields are excluded, including hidden ancestors. */
+/** Errors are recomputed from accepted state; hidden and disabled fields are excluded, including hidden ancestors. */
 export declare function getInterfaceValidation(snapshot: Pick<InterfaceSnapshot, "definition" | "data" | "state">): Record<string, string>;
 export {};