Add property constraints

common/api/appui-abstract.api.md

@@ -154,6 +154,14 @@ export enum AlternateDateFormats {
     UtcShortWithDay = 5
 }
 
+// @public
+export interface ArrayPropertyValueConstraints {
+    // (undocumented)
+    maxOccurs?: number;
+    // (undocumented)
+    minOccurs?: number;
+}
+
 // @public
 export interface ArrayValue extends BasePropertyValue {
     // (undocumented)
@@ -802,6 +810,14 @@ export interface MultilineTextEditorParams extends BasePropertyEditorParams {
     type: PropertyEditorParamTypes.MultilineText;
 }
 
+// @public
+export interface NumericPropertyValueConstraints {
+    // (undocumented)
+    maximumValue?: number;
+    // (undocumented)
+    minimumValue?: number;
+}
+
 // @public
 export type OnCancelFunc = () => void;
 
@@ -910,6 +926,7 @@ export interface PropertyConverterInfo {
 
 // @public
 export interface PropertyDescription {
+    constraints?: PropertyValueConstraints;
     converter?: PropertyConverterInfo;
     dataController?: string;
     displayLabel: string;
@@ -1002,6 +1019,9 @@ export interface PropertyRendererInfo {
 // @public
 export type PropertyValue = PrimitiveValue | StructValue | ArrayValue;
 
+// @public
+export type PropertyValueConstraints = StringPropertyValueConstraints | ArrayPropertyValueConstraints | NumericPropertyValueConstraints;
+
 // @public
 export enum PropertyValueFormat {
     // (undocumented)
@@ -1309,6 +1329,14 @@ export enum StatusBarSection {
 // @public
 export type StringGetter = () => string;
 
+// @public
+export interface StringPropertyValueConstraints {
+    // (undocumented)
+    maximumLength?: number;
+    // (undocumented)
+    minimumLength?: number;
+}
+
 // @public
 export interface StructValue extends BasePropertyValue {
     // (undocumented)

common/api/presentation-common.api.md

@@ -48,6 +48,14 @@ export interface ArrayPropertiesFieldJSON<TClassInfoJSON = ClassInfo> extends Pr
     itemsField: PropertiesFieldJSON<TClassInfoJSON>;
 }
 
+// @public
+export interface ArrayPropertyValueConstraints {
+    // (undocumented)
+    maxOccurs?: number;
+    // (undocumented)
+    minOccurs?: number;
+}
+
 // @public
 export interface ArrayTypeDescription extends BaseTypeDescription {
     memberType: TypeDescription;
@@ -2122,6 +2130,14 @@ export interface NodeUpdateInfoJSON {
     type: "Update";
 }
 
+// @public
+export interface NumericPropertyValueConstraints {
+    // (undocumented)
+    maximumValue?: number;
+    // (undocumented)
+    minimumValue?: number;
+}
+
 // @public
 type Omit_2<T, K> = Pick<T, Exclude<keyof T, K>>;
 export { Omit_2 as Omit }
@@ -2464,6 +2480,7 @@ export enum PropertyGroupingValue {
 // @public
 export interface PropertyInfo {
     classInfo: ClassInfo;
+    constraints?: PropertyValueConstraints;
     enumerationInfo?: EnumerationInfo;
     extendedType?: string;
     kindOfQuantity?: KindOfQuantityInfo;
@@ -2538,6 +2555,9 @@ export interface PropertySpecification extends PropertyOverrides {
     name: string;
 }
 
+// @public
+export type PropertyValueConstraints = StringPropertyValueConstraints | ArrayPropertyValueConstraints | NumericPropertyValueConstraints;
+
 // @public
 export enum PropertyValueFormat {
     Array = "Array",
@@ -3111,6 +3131,14 @@ export interface StartStructProps {
     valueType: TypeDescription;
 }
 
+// @public
+export interface StringPropertyValueConstraints {
+    // (undocumented)
+    maximumLength?: number;
+    // (undocumented)
+    minimumLength?: number;
+}
+
 // @public
 export interface StringQuerySpecification extends QuerySpecificationBase {
     query: string;

common/api/summary/appui-abstract.exports.csv

@@ -21,6 +21,7 @@ public;interface;ActionButton
 public;interface;AllowedUiItemProviderOverrides
 deprecated;interface;AllowedUiItemProviderOverrides
 public;enum;AlternateDateFormats
+public;interface;ArrayPropertyValueConstraints
 public;interface;ArrayValue
 public;interface;BackstageActionItem
 deprecated;interface;BackstageActionItem
@@ -122,6 +123,7 @@ deprecated;function;matchesWords
 public;interface;MessagePresenter
 public;enum;MessageSeverity
 public;interface;MultilineTextEditorParams
+public;interface;NumericPropertyValueConstraints
 public;type;OnCancelFunc
 public;type;OnItemExecutedFunc
 public;type;OnNumberCommitFunc
@@ -142,6 +144,7 @@ public;enum;PropertyEditorParamTypes
 public;class;PropertyRecord
 public;interface;PropertyRendererInfo
 public;type;PropertyValue
+public;type;PropertyValueConstraints
 public;enum;PropertyValueFormat
 public;interface;ProvidedItem
 deprecated;interface;ProvidedItem
@@ -169,6 +172,7 @@ deprecated;enum;StatusBarLabelSide
 public;enum;StatusBarSection
 deprecated;enum;StatusBarSection
 public;type;StringGetter
+public;interface;StringPropertyValueConstraints
 public;interface;StructValue
 public;interface;SuppressLabelEditorParams
 public;class;SyncPropertiesChangeEvent

common/api/summary/presentation-common.exports.csv

@@ -3,6 +3,7 @@ Release Tag;API Item Type;API Item Name
 public;function;addFieldHierarchy
 public;class;ArrayPropertiesField
 public;interface;ArrayPropertiesFieldJSON
+public;interface;ArrayPropertyValueConstraints
 public;interface;ArrayTypeDescription
 internal;class;AsyncTasksTracker
 public;interface;BaseFieldJSON
@@ -297,6 +298,7 @@ deprecated;interface;NodePathFilteringDataJSON
 public;interface;NodeUpdateInfo
 public;interface;NodeUpdateInfoJSON
 deprecated;interface;NodeUpdateInfoJSON
+public;interface;NumericPropertyValueConstraints
 public;type;Paged
 public;interface;PagedResponse
 public;interface;PageOptions
@@ -354,6 +356,7 @@ public;interface;PropertyOverrides
 public;interface;PropertyRangeGroupSpecification
 public;interface;PropertySortingRule
 public;interface;PropertySpecification
+public;type;PropertyValueConstraints
 public;enum;PropertyValueFormat
 public;type;QuerySpecification
 public;interface;QuerySpecificationBase
@@ -428,6 +431,7 @@ public;interface;StartContentProps
 public;interface;StartFieldProps
 public;interface;StartItemProps
 public;interface;StartStructProps
+public;interface;StringPropertyValueConstraints
 public;interface;StringQuerySpecification
 public;interface;StringRulesetVariable
 public;interface;StringRulesetVariableJSON

common/changes/@itwin/appui-abstract/JonasD-property-coinstraints_2025-01-10-13-51.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/appui-abstract",
+      "comment": "Add value constraints to `PropertyDescription`",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/appui-abstract"
+}

common/changes/@itwin/presentation-common/JonasD-property-coinstraints_2025-01-10-13-51.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@itwin/presentation-common",
+      "comment": "Add value constraints to `PropertyInfo`",
+      "type": "none"
+    }
+  ],
+  "packageName": "@itwin/presentation-common"
+}

presentation/common/src/presentation-common/EC.ts

@@ -267,6 +267,41 @@ export interface PropertyInfo {
   extendedType?: string;
   /** Navigation property info if the field is navigation type */
   navigationPropertyInfo?: NavigationPropertyInfo;
+  /** Constraints for values of ECProperty */
+  constraints?: PropertyValueConstraints;
+}
+
+/**
+ * Constraints for values of ECProperty
+ * @public
+ */
+export type PropertyValueConstraints = StringPropertyValueConstraints | ArrayPropertyValueConstraints | NumericPropertyValueConstraints;
+
+/**
+ * Describes constraints for `string` type ECProperty values
+ * @public
+ */
+export interface StringPropertyValueConstraints {
+  minimumLength?: number;
+  maximumLength?: number;
+}
+
+/**
+ * Describes constraints for `int` | `double` | `float` type ECProperty values
+ * @public
+ */
+export interface NumericPropertyValueConstraints {
+  minimumValue?: number;
+  maximumValue?: number;
+}
+
+/**
+ * Describes constraints for `array` type ECProperty values
+ * @public
+ */
+export interface ArrayPropertyValueConstraints {
+  minOccurs?: number;
+  maxOccurs?: number;
 }
 
 /** @public */

ui/appui-abstract/src/appui-abstract/properties/Description.ts

@@ -7,7 +7,12 @@
  */
 
 import {
-  BasePropertyEditorParams, ColorEditorParams, ImageCheckBoxParams, PropertyEditorParams, PropertyEditorParamTypes, RangeEditorParams,
+  BasePropertyEditorParams,
+  ColorEditorParams,
+  ImageCheckBoxParams,
+  PropertyEditorParams,
+  PropertyEditorParamTypes,
+  RangeEditorParams,
   SuppressLabelEditorParams,
 } from "./EditorParams";
 import { StandardEditorNames } from "./StandardEditorNames";
@@ -92,6 +97,41 @@ export interface PropertyDescription {
   dataController?: string;
   /** Should property label for composite (struct & array) properties be rendered. */
   hideCompositePropertyLabel?: boolean;
+  /** Constraints for values of property */
+  constraints?: PropertyValueConstraints;
+}
+
+/**
+ * Constraints for values of property
+ * @public
+ */
+export type PropertyValueConstraints = StringPropertyValueConstraints | ArrayPropertyValueConstraints | NumericPropertyValueConstraints;
+
+/**
+ * Describes constraints for `string` type property values
+ * @public
+ */
+export interface StringPropertyValueConstraints {
+  minimumLength?: number;
+  maximumLength?: number;
+}
+
+/**
+ * Describes constraints for `int` | `double` | `float` type property values
+ * @public
+ */
+export interface NumericPropertyValueConstraints {
+  minimumValue?: number;
+  maximumValue?: number;
+}
+
+/**
+ * Describes constraints for `array` type property values
+ * @public
+ */
+export interface ArrayPropertyValueConstraints {
+  minOccurs?: number;
+  maxOccurs?: number;
 }
 
 /** Helper class that builds property descriptions for specific PropertyEditors and processes descriptions.