@formspec/build 0.1.0-alpha.23 → 0.1.0-alpha.26

package/dist/build-alpha.d.ts

@@ -150,11 +150,17 @@ export { BuiltinConstraintName }
  * @public
  */
 export declare interface Categorization {
+    /** Discriminator identifying a categorization layout. */
     readonly type: "Categorization";
+    /** Categories rendered as tabs or steps. */
     readonly elements: Category[];
+    /** Optional label for the overall categorization container. */
     readonly label?: string | undefined;
+    /** Optional rule controlling visibility or enablement. */
     readonly rule?: Rule | undefined;
+    /** Renderer-specific categorization options. */
     readonly options?: Record<string, unknown> | undefined;
+    /** Additional renderer-specific extension properties. */
     readonly [k: string]: unknown;
 }
 
@@ -164,11 +170,17 @@ export declare interface Categorization {
  * @public
  */
 export declare interface Category {
+    /** Discriminator identifying a category inside a categorization layout. */
     readonly type: "Category";
+    /** Category label shown in tabs or step navigation. */
     readonly label: string;
+    /** Child elements rendered inside the category. */
     readonly elements: UISchemaElement[];
+    /** Optional rule controlling visibility or enablement. */
     readonly rule?: Rule | undefined;
+    /** Renderer-specific category options. */
     readonly options?: Record<string, unknown> | undefined;
+    /** Additional renderer-specific extension properties. */
     readonly [k: string]: unknown;
 }
 
@@ -184,11 +196,17 @@ export { ConstraintTagRegistration }
  * @public
  */
 export declare interface ControlElement {
+    /** Discriminator identifying a JSON Forms control element. */
     readonly type: "Control";
+    /** JSON Pointer scope that this control binds to. */
     readonly scope: string;
+    /** Optional label override, or `false` to suppress the label. */
     readonly label?: string | false | undefined;
+    /** Optional rule controlling visibility or enablement. */
     readonly rule?: Rule | undefined;
+    /** Renderer-specific control options. */
     readonly options?: Record<string, unknown> | undefined;
+    /** Additional renderer-specific extension properties. */
     readonly [k: string]: unknown;
 }
 
@@ -489,11 +507,17 @@ export { Group }
  * @public
  */
 export declare interface GroupLayout {
+    /** Discriminator identifying a labeled group container. */
     readonly type: "Group";
+    /** Group label shown by compatible renderers. */
     readonly label: string;
+    /** Child elements rendered inside the group. */
     readonly elements: UISchemaElement[];
+    /** Optional rule controlling visibility or enablement. */
     readonly rule?: Rule | undefined;
+    /** Renderer-specific group options. */
     readonly options?: Record<string, unknown> | undefined;
+    /** Additional renderer-specific extension properties. */
     readonly [k: string]: unknown;
 }
 
@@ -503,10 +527,15 @@ export declare interface GroupLayout {
  * @public
  */
 export declare interface HorizontalLayout {
+    /** Discriminator identifying a horizontal layout container. */
     readonly type: "HorizontalLayout";
+    /** Child elements rendered side by side. */
     readonly elements: UISchemaElement[];
+    /** Optional rule controlling visibility or enablement. */
     readonly rule?: Rule | undefined;
+    /** Renderer-specific layout options. */
     readonly options?: Record<string, unknown> | undefined;
+    /** Additional renderer-specific extension properties. */
     readonly [k: string]: unknown;
 }
 
@@ -519,35 +548,65 @@ export declare interface HorizontalLayout {
  * @public
  */
 export declare interface JsonSchema2020 {
+    /** Declared JSON Schema dialect URI for the document root. */
     $schema?: string;
+    /** Reference to another schema location. */
     $ref?: string;
+    /** Named reusable schema definitions keyed by definition name. */
     $defs?: Record<string, JsonSchema2020>;
+    /** JSON Schema type keyword for the current node. */
     type?: string;
+    /** Object properties keyed by property name. */
     properties?: Record<string, JsonSchema2020>;
+    /** Property names that must be present on object values. */
     required?: string[];
+    /** Item schema applied to array elements. */
     items?: JsonSchema2020;
+    /** Whether, or how, additional object properties are allowed. */
     additionalProperties?: boolean | JsonSchema2020;
+    /** Closed set of allowed scalar values. */
     enum?: readonly (string | number)[];
+    /** Literal value the instance must equal. */
     const?: unknown;
+    /** Schemas that must all validate successfully. */
     allOf?: readonly JsonSchema2020[];
+    /** Schemas of which exactly one should validate successfully. */
     oneOf?: readonly JsonSchema2020[];
+    /** Schemas of which at least one may validate successfully. */
     anyOf?: readonly JsonSchema2020[];
+    /** Inclusive numeric lower bound. */
     minimum?: number;
+    /** Inclusive numeric upper bound. */
     maximum?: number;
+    /** Exclusive numeric lower bound. */
     exclusiveMinimum?: number;
+    /** Exclusive numeric upper bound. */
     exclusiveMaximum?: number;
+    /** Required numeric step interval. */
     multipleOf?: number;
+    /** Inclusive minimum string length. */
     minLength?: number;
+    /** Inclusive maximum string length. */
     maxLength?: number;
+    /** Inclusive minimum array length. */
     minItems?: number;
+    /** Inclusive maximum array length. */
     maxItems?: number;
+    /** Regular expression pattern applied to string values. */
     pattern?: string;
+    /** Whether array elements must be unique. */
     uniqueItems?: boolean;
+    /** Format hint for downstream validators and tooling. */
     format?: string;
+    /** Human-readable title for the schema node. */
     title?: string;
+    /** Human-readable description for the schema node. */
     description?: string;
+    /** Default value suggested for the schema node. */
     default?: unknown;
+    /** Whether the schema node is deprecated. */
     deprecated?: boolean;
+    /** Additional vendor-prefixed extension keywords. */
     [key: `x-${string}`]: unknown;
 }
 
@@ -557,36 +616,67 @@ export declare interface JsonSchema2020 {
  * @beta
  */
 export declare interface JSONSchema7 {
+    /** Declared JSON Schema dialect URI for the document root. */
     $schema?: string;
+    /** Stable identifier for the schema document or sub-schema. */
     $id?: string;
+    /** Reference to another schema location. */
     $ref?: string;
+    /** Human-readable title for the schema node. */
     title?: string;
+    /** Human-readable description for the schema node. */
     description?: string;
+    /** Whether the schema node is deprecated. */
     deprecated?: boolean;
+    /** JSON Schema type keyword for the current node. */
     type?: JSONSchemaType | JSONSchemaType[];
+    /** Inclusive minimum string length. */
     minLength?: number;
+    /** Inclusive maximum string length. */
     maxLength?: number;
+    /** Regular expression pattern applied to string values. */
     pattern?: string;
+    /** Inclusive numeric lower bound. */
     minimum?: number;
+    /** Inclusive numeric upper bound. */
     maximum?: number;
+    /** Exclusive numeric lower bound. */
     exclusiveMinimum?: number;
+    /** Exclusive numeric upper bound. */
     exclusiveMaximum?: number;
+    /** Closed set of allowed scalar values. */
     enum?: readonly (string | number | boolean | null)[];
+    /** Literal value the instance must equal. */
     const?: string | number | boolean | null;
+    /** Object properties keyed by property name. */
     properties?: Record<string, JSONSchema7>;
+    /** Property names that must be present on object values. */
     required?: string[];
+    /** Whether, or how, additional object properties are allowed. */
     additionalProperties?: boolean | JSONSchema7;
+    /** Item schema or tuple schemas applied to array elements. */
     items?: JSONSchema7 | JSONSchema7[];
+    /** Inclusive minimum array length. */
     minItems?: number;
+    /** Inclusive maximum array length. */
     maxItems?: number;
+    /** Schemas that must all validate successfully. */
     allOf?: JSONSchema7[];
+    /** Schemas of which at least one may validate successfully. */
     anyOf?: JSONSchema7[];
+    /** Schemas of which exactly one should validate successfully. */
     oneOf?: JSONSchema7[];
+    /** Schema that must not validate successfully. */
     not?: JSONSchema7;
+    /** Conditional branch predicate schema. */
     if?: JSONSchema7;
+    /** Schema applied when the `if` branch matches. */
     then?: JSONSchema7;
+    /** Schema applied when the `if` branch does not match. */
     else?: JSONSchema7;
+    /** Format hint for downstream validators and tooling. */
     format?: string;
+    /** Default value suggested for the schema node. */
     default?: unknown;
     /**
      * Data source key for dynamic enum fields.
@@ -623,10 +713,15 @@ export declare type JSONSchemaType = "string" | "number" | "integer" | "boolean"
  * @public
  */
 export declare interface LabelElement {
+    /** Discriminator identifying a static text label element. */
     readonly type: "Label";
+    /** Static text content rendered by the label element. */
     readonly text: string;
+    /** Optional rule controlling visibility or enablement. */
     readonly rule?: Rule | undefined;
+    /** Renderer-specific label options. */
     readonly options?: Record<string, unknown> | undefined;
+    /** Additional renderer-specific extension properties. */
     readonly [k: string]: unknown;
 }
 
@@ -652,7 +747,9 @@ export { ObjectField }
  * @public
  */
 export declare interface Rule {
+    /** UI effect to apply when the rule condition matches. */
     readonly effect: RuleEffect;
+    /** Predicate that controls when the UI effect applies. */
     readonly condition: SchemaBasedCondition;
 }
 
@@ -662,17 +759,29 @@ export declare interface Rule {
  * @public
  */
 export declare interface RuleConditionSchema {
+    /** Literal value the condition schema must equal. */
     const?: unknown;
+    /** Allowed values for the condition schema. */
     enum?: readonly unknown[];
+    /** JSON Schema type required by the condition schema. */
     type?: string;
+    /** Negated branch of the condition schema. */
     not?: RuleConditionSchema;
+    /** Inclusive numeric lower bound in the condition schema. */
     minimum?: number;
+    /** Inclusive numeric upper bound in the condition schema. */
     maximum?: number;
+    /** Exclusive numeric lower bound in the condition schema. */
     exclusiveMinimum?: number;
+    /** Exclusive numeric upper bound in the condition schema. */
     exclusiveMaximum?: number;
+    /** Inclusive minimum string length in the condition schema. */
     minLength?: number;
+    /** Nested property conditions keyed by property name. */
     properties?: Record<string, RuleConditionSchema>;
+    /** Property names that must be present for the condition to match. */
     required?: string[];
+    /** Schemas that must all match for the condition to succeed. */
     allOf?: RuleConditionSchema[];
 }
 
@@ -697,7 +806,9 @@ export declare type RuleEffect = "SHOW" | "HIDE" | "ENABLE" | "DISABLE";
  * @public
  */
 export declare interface SchemaBasedCondition {
+    /** JSON Pointer scope the rule evaluates against. */
     readonly scope: string;
+    /** JSON Schema fragment evaluated at the scoped location. */
     readonly schema: RuleConditionSchema;
 }
 
@@ -747,8 +858,11 @@ export declare type UISchemaElement = ControlElement | VerticalLayout | Horizont
  * @public
  */
 export declare interface UISchemaElementBase {
+    /** Discriminator for the concrete JSON Forms element type. */
     type: UISchemaElementType;
+    /** Optional rule controlling visibility or enablement. */
     rule?: Rule;
+    /** Renderer-specific options shared by UI schema elements. */
     options?: Record<string, unknown>;
 }
 
@@ -765,10 +879,15 @@ export declare type UISchemaElementType = "Control" | "VerticalLayout" | "Horizo
  * @public
  */
 export declare interface VerticalLayout {
+    /** Discriminator identifying a vertical layout container. */
     readonly type: "VerticalLayout";
+    /** Child elements rendered in vertical order. */
     readonly elements: UISchemaElement[];
+    /** Optional rule controlling visibility or enablement. */
     readonly rule?: Rule | undefined;
+    /** Renderer-specific layout options. */
     readonly options?: Record<string, unknown> | undefined;
+    /** Additional renderer-specific extension properties. */
     readonly [k: string]: unknown;
 }
 

package/dist/build-beta.d.ts

@@ -150,11 +150,17 @@ export { BuiltinConstraintName }
  * @public
  */
 export declare interface Categorization {
+    /** Discriminator identifying a categorization layout. */
     readonly type: "Categorization";
+    /** Categories rendered as tabs or steps. */
     readonly elements: Category[];
+    /** Optional label for the overall categorization container. */
     readonly label?: string | undefined;
+    /** Optional rule controlling visibility or enablement. */
     readonly rule?: Rule | undefined;
+    /** Renderer-specific categorization options. */
     readonly options?: Record<string, unknown> | undefined;
+    /** Additional renderer-specific extension properties. */
     readonly [k: string]: unknown;
 }
 
@@ -164,11 +170,17 @@ export declare interface Categorization {
  * @public
  */
 export declare interface Category {
+    /** Discriminator identifying a category inside a categorization layout. */
     readonly type: "Category";
+    /** Category label shown in tabs or step navigation. */
     readonly label: string;
+    /** Child elements rendered inside the category. */
     readonly elements: UISchemaElement[];
+    /** Optional rule controlling visibility or enablement. */
     readonly rule?: Rule | undefined;
+    /** Renderer-specific category options. */
     readonly options?: Record<string, unknown> | undefined;
+    /** Additional renderer-specific extension properties. */
     readonly [k: string]: unknown;
 }
 
@@ -184,11 +196,17 @@ export { ConstraintTagRegistration }
  * @public
  */
 export declare interface ControlElement {
+    /** Discriminator identifying a JSON Forms control element. */
     readonly type: "Control";
+    /** JSON Pointer scope that this control binds to. */
     readonly scope: string;
+    /** Optional label override, or `false` to suppress the label. */
     readonly label?: string | false | undefined;
+    /** Optional rule controlling visibility or enablement. */
     readonly rule?: Rule | undefined;
+    /** Renderer-specific control options. */
     readonly options?: Record<string, unknown> | undefined;
+    /** Additional renderer-specific extension properties. */
     readonly [k: string]: unknown;
 }
 
@@ -489,11 +507,17 @@ export { Group }
  * @public
  */
 export declare interface GroupLayout {
+    /** Discriminator identifying a labeled group container. */
     readonly type: "Group";
+    /** Group label shown by compatible renderers. */
     readonly label: string;
+    /** Child elements rendered inside the group. */
     readonly elements: UISchemaElement[];
+    /** Optional rule controlling visibility or enablement. */
     readonly rule?: Rule | undefined;
+    /** Renderer-specific group options. */
     readonly options?: Record<string, unknown> | undefined;
+    /** Additional renderer-specific extension properties. */
     readonly [k: string]: unknown;
 }
 
@@ -503,10 +527,15 @@ export declare interface GroupLayout {
  * @public
  */
 export declare interface HorizontalLayout {
+    /** Discriminator identifying a horizontal layout container. */
     readonly type: "HorizontalLayout";
+    /** Child elements rendered side by side. */
     readonly elements: UISchemaElement[];
+    /** Optional rule controlling visibility or enablement. */
     readonly rule?: Rule | undefined;
+    /** Renderer-specific layout options. */
     readonly options?: Record<string, unknown> | undefined;
+    /** Additional renderer-specific extension properties. */
     readonly [k: string]: unknown;
 }
 
@@ -519,35 +548,65 @@ export declare interface HorizontalLayout {
  * @public
  */
 export declare interface JsonSchema2020 {
+    /** Declared JSON Schema dialect URI for the document root. */
     $schema?: string;
+    /** Reference to another schema location. */
     $ref?: string;
+    /** Named reusable schema definitions keyed by definition name. */
     $defs?: Record<string, JsonSchema2020>;
+    /** JSON Schema type keyword for the current node. */
     type?: string;
+    /** Object properties keyed by property name. */
     properties?: Record<string, JsonSchema2020>;
+    /** Property names that must be present on object values. */
     required?: string[];
+    /** Item schema applied to array elements. */
     items?: JsonSchema2020;
+    /** Whether, or how, additional object properties are allowed. */
     additionalProperties?: boolean | JsonSchema2020;
+    /** Closed set of allowed scalar values. */
     enum?: readonly (string | number)[];
+    /** Literal value the instance must equal. */
     const?: unknown;
+    /** Schemas that must all validate successfully. */
     allOf?: readonly JsonSchema2020[];
+    /** Schemas of which exactly one should validate successfully. */
     oneOf?: readonly JsonSchema2020[];
+    /** Schemas of which at least one may validate successfully. */
     anyOf?: readonly JsonSchema2020[];
+    /** Inclusive numeric lower bound. */
     minimum?: number;
+    /** Inclusive numeric upper bound. */
     maximum?: number;
+    /** Exclusive numeric lower bound. */
     exclusiveMinimum?: number;
+    /** Exclusive numeric upper bound. */
     exclusiveMaximum?: number;
+    /** Required numeric step interval. */
     multipleOf?: number;
+    /** Inclusive minimum string length. */
     minLength?: number;
+    /** Inclusive maximum string length. */
     maxLength?: number;
+    /** Inclusive minimum array length. */
     minItems?: number;
+    /** Inclusive maximum array length. */
     maxItems?: number;
+    /** Regular expression pattern applied to string values. */
     pattern?: string;
+    /** Whether array elements must be unique. */
     uniqueItems?: boolean;
+    /** Format hint for downstream validators and tooling. */
     format?: string;
+    /** Human-readable title for the schema node. */
     title?: string;
+    /** Human-readable description for the schema node. */
     description?: string;
+    /** Default value suggested for the schema node. */
     default?: unknown;
+    /** Whether the schema node is deprecated. */
     deprecated?: boolean;
+    /** Additional vendor-prefixed extension keywords. */
     [key: `x-${string}`]: unknown;
 }
 
@@ -557,36 +616,67 @@ export declare interface JsonSchema2020 {
  * @beta
  */
 export declare interface JSONSchema7 {
+    /** Declared JSON Schema dialect URI for the document root. */
     $schema?: string;
+    /** Stable identifier for the schema document or sub-schema. */
     $id?: string;
+    /** Reference to another schema location. */
     $ref?: string;
+    /** Human-readable title for the schema node. */
     title?: string;
+    /** Human-readable description for the schema node. */
     description?: string;
+    /** Whether the schema node is deprecated. */
     deprecated?: boolean;
+    /** JSON Schema type keyword for the current node. */
     type?: JSONSchemaType | JSONSchemaType[];
+    /** Inclusive minimum string length. */
     minLength?: number;
+    /** Inclusive maximum string length. */
     maxLength?: number;
+    /** Regular expression pattern applied to string values. */
     pattern?: string;
+    /** Inclusive numeric lower bound. */
     minimum?: number;
+    /** Inclusive numeric upper bound. */
     maximum?: number;
+    /** Exclusive numeric lower bound. */
     exclusiveMinimum?: number;
+    /** Exclusive numeric upper bound. */
     exclusiveMaximum?: number;
+    /** Closed set of allowed scalar values. */
     enum?: readonly (string | number | boolean | null)[];
+    /** Literal value the instance must equal. */
     const?: string | number | boolean | null;
+    /** Object properties keyed by property name. */
     properties?: Record<string, JSONSchema7>;
+    /** Property names that must be present on object values. */
     required?: string[];
+    /** Whether, or how, additional object properties are allowed. */
     additionalProperties?: boolean | JSONSchema7;
+    /** Item schema or tuple schemas applied to array elements. */
     items?: JSONSchema7 | JSONSchema7[];
+    /** Inclusive minimum array length. */
     minItems?: number;
+    /** Inclusive maximum array length. */
     maxItems?: number;
+    /** Schemas that must all validate successfully. */
     allOf?: JSONSchema7[];
+    /** Schemas of which at least one may validate successfully. */
     anyOf?: JSONSchema7[];
+    /** Schemas of which exactly one should validate successfully. */
     oneOf?: JSONSchema7[];
+    /** Schema that must not validate successfully. */
     not?: JSONSchema7;
+    /** Conditional branch predicate schema. */
     if?: JSONSchema7;
+    /** Schema applied when the `if` branch matches. */
     then?: JSONSchema7;
+    /** Schema applied when the `if` branch does not match. */
     else?: JSONSchema7;
+    /** Format hint for downstream validators and tooling. */
     format?: string;
+    /** Default value suggested for the schema node. */
     default?: unknown;
     /**
      * Data source key for dynamic enum fields.
@@ -623,10 +713,15 @@ export declare type JSONSchemaType = "string" | "number" | "integer" | "boolean"
  * @public
  */
 export declare interface LabelElement {
+    /** Discriminator identifying a static text label element. */
     readonly type: "Label";
+    /** Static text content rendered by the label element. */
     readonly text: string;
+    /** Optional rule controlling visibility or enablement. */
     readonly rule?: Rule | undefined;
+    /** Renderer-specific label options. */
     readonly options?: Record<string, unknown> | undefined;
+    /** Additional renderer-specific extension properties. */
     readonly [k: string]: unknown;
 }
 
@@ -652,7 +747,9 @@ export { ObjectField }
  * @public
  */
 export declare interface Rule {
+    /** UI effect to apply when the rule condition matches. */
     readonly effect: RuleEffect;
+    /** Predicate that controls when the UI effect applies. */
     readonly condition: SchemaBasedCondition;
 }
 
@@ -662,17 +759,29 @@ export declare interface Rule {
  * @public
  */
 export declare interface RuleConditionSchema {
+    /** Literal value the condition schema must equal. */
     const?: unknown;
+    /** Allowed values for the condition schema. */
     enum?: readonly unknown[];
+    /** JSON Schema type required by the condition schema. */
     type?: string;
+    /** Negated branch of the condition schema. */
     not?: RuleConditionSchema;
+    /** Inclusive numeric lower bound in the condition schema. */
     minimum?: number;
+    /** Inclusive numeric upper bound in the condition schema. */
     maximum?: number;
+    /** Exclusive numeric lower bound in the condition schema. */
     exclusiveMinimum?: number;
+    /** Exclusive numeric upper bound in the condition schema. */
     exclusiveMaximum?: number;
+    /** Inclusive minimum string length in the condition schema. */
     minLength?: number;
+    /** Nested property conditions keyed by property name. */
     properties?: Record<string, RuleConditionSchema>;
+    /** Property names that must be present for the condition to match. */
     required?: string[];
+    /** Schemas that must all match for the condition to succeed. */
     allOf?: RuleConditionSchema[];
 }
 
@@ -697,7 +806,9 @@ export declare type RuleEffect = "SHOW" | "HIDE" | "ENABLE" | "DISABLE";
  * @public
  */
 export declare interface SchemaBasedCondition {
+    /** JSON Pointer scope the rule evaluates against. */
     readonly scope: string;
+    /** JSON Schema fragment evaluated at the scoped location. */
     readonly schema: RuleConditionSchema;
 }
 
@@ -747,8 +858,11 @@ export declare type UISchemaElement = ControlElement | VerticalLayout | Horizont
  * @public
  */
 export declare interface UISchemaElementBase {
+    /** Discriminator for the concrete JSON Forms element type. */
     type: UISchemaElementType;
+    /** Optional rule controlling visibility or enablement. */
     rule?: Rule;
+    /** Renderer-specific options shared by UI schema elements. */
     options?: Record<string, unknown>;
 }
 
@@ -765,10 +879,15 @@ export declare type UISchemaElementType = "Control" | "VerticalLayout" | "Horizo
  * @public
  */
 export declare interface VerticalLayout {
+    /** Discriminator identifying a vertical layout container. */
     readonly type: "VerticalLayout";
+    /** Child elements rendered in vertical order. */
     readonly elements: UISchemaElement[];
+    /** Optional rule controlling visibility or enablement. */
     readonly rule?: Rule | undefined;
+    /** Renderer-specific layout options. */
     readonly options?: Record<string, unknown> | undefined;
+    /** Additional renderer-specific extension properties. */
     readonly [k: string]: unknown;
 }