@dereekb/dbx-form 13.4.1 → 13.4.2

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.
@@ -243,9 +243,13 @@ declare class DbxActionFormDirective<T = object, O = T> implements OnInit {
243
243
  * used by {@link DbxActionFormDirective.checkIsValidAndIsModified}.
244
244
  */
245
245
  interface CheckValidAndModifiedOverrides<T> {
246
- /** Override function for the modification check. */
246
+ /**
247
+ * Override function for the modification check.
248
+ */
247
249
  isModifiedFunction?: Maybe<IsModifiedFunction<T>>;
248
- /** Override function for the validity check. */
250
+ /**
251
+ * Override function for the validity check.
252
+ */
249
253
  isValidFunction?: Maybe<IsValidFunction<T>>;
250
254
  }
251
255
 
@@ -291,6 +295,8 @@ interface DbxFormlyContextDelegate<T = unknown> extends Omit<DbxMutableForm<T>,
291
295
  }
292
296
  /**
293
297
  * Allows a directive to provide a formly context and form.
298
+ *
299
+ * @returns An array of Angular providers that register DbxFormlyContext and its mutable form delegate
294
300
  */
295
301
  declare function provideFormlyContext(): Provider[];
296
302
  /**
@@ -395,6 +401,9 @@ declare class DbxFormActionDialogComponent<O> extends AbstractDialogDirective<O,
395
401
  ngOnInit(): void;
396
402
  /**
397
403
  * Action handler that marks the action as successful and closes the dialog with the submitted value.
404
+ *
405
+ * @param value - The submitted form value
406
+ * @param context - The action context used to signal success
398
407
  */
399
408
  readonly handleSubmitValue: WorkUsingContext<O>;
400
409
  /**
@@ -785,7 +794,9 @@ declare class DbxFormSubsectionWrapperComponent extends FieldWrapper<FieldTypeCo
785
794
  * Configuration for the info wrapper that adds an info icon button beside the field.
786
795
  */
787
796
  interface DbxFormInfoConfig extends FormlyFieldProps {
788
- /** Callback invoked when the info button is clicked. */
797
+ /**
798
+ * Callback invoked when the info button is clicked.
799
+ */
789
800
  readonly onInfoClick: () => void;
790
801
  }
791
802
  /**
@@ -808,7 +819,9 @@ declare class DbxFormInfoWrapperComponent extends FieldWrapper<FormlyFieldConfig
808
819
  * function to determine whether the field's value is "populated" (which auto-expands the section).
809
820
  */
810
821
  interface AbstractFormExpandSectionConfig<T extends object = object> extends Pick<FormlyFieldProps, 'label'> {
811
- /** Label shown on the expand trigger. Falls back to the field label or first child field label. */
822
+ /**
823
+ * Label shown on the expand trigger. Falls back to the field label or first child field label.
824
+ */
812
825
  expandLabel?: string;
813
826
  /**
814
827
  * Optional function to use for checking value existence.
@@ -817,6 +830,11 @@ interface AbstractFormExpandSectionConfig<T extends object = object> extends Pic
817
830
  }
818
831
  /**
819
832
  * Default value existence check that returns `true` if the object is non-empty.
833
+ *
834
+ * @param x - The object to check for non-emptiness
835
+ * @returns True if the object has at least one own property
836
+ *
837
+ * @param x - The object to check for non-emptiness
820
838
  */
821
839
  declare const DEFAULT_HAS_VALUE_FN: (x: object) => boolean;
822
840
  /**
@@ -844,14 +862,18 @@ declare class AbstractFormExpandSectionWrapperDirective<T extends object = objec
844
862
  static ɵdir: i0.ɵɵDirectiveDeclaration<AbstractFormExpandSectionWrapperDirective<any, any>, never, never, {}, {}, never, never, true, never>;
845
863
  }
846
864
 
847
- /** The visual style of the expand button: a styled button or plain text link. */
865
+ /**
866
+ * The visual style of the expand button: a styled button or plain text link.
867
+ */
848
868
  type DbxFormExpandWrapperButtonType = 'button' | 'text';
849
869
  /**
850
870
  * Configuration for the expand wrapper, extending the base expand section config
851
871
  * with an optional button type.
852
872
  */
853
873
  interface DbxFormExpandWrapperConfig<T extends object = object> extends AbstractFormExpandSectionConfig<T> {
854
- /** Visual style of the expand trigger. Defaults to `'button'`. */
874
+ /**
875
+ * Visual style of the expand trigger. Defaults to `'button'`.
876
+ */
855
877
  readonly buttonType?: DbxFormExpandWrapperButtonType;
856
878
  }
857
879
  /**
@@ -869,7 +891,9 @@ declare class DbxFormExpandWrapperComponent<T extends object = object> extends A
869
891
  * reactive label function.
870
892
  */
871
893
  interface DbxFormToggleWrapperConfig<T extends object = object> extends AbstractFormExpandSectionConfig<T> {
872
- /** Optional function that returns an observable of the toggle label based on open state. */
894
+ /**
895
+ * Optional function that returns an observable of the toggle label based on open state.
896
+ */
873
897
  toggleLabelObs?: (open: Maybe<boolean>) => Observable<string>;
874
898
  }
875
899
  /**
@@ -916,7 +940,9 @@ declare class DbxFormFlexWrapperComponent extends FieldWrapper<FormlyFieldConfig
916
940
  static ɵcmp: i0.ɵɵComponentDeclaration<DbxFormFlexWrapperComponent, "ng-component", never, {}, {}, never, never, true, never>;
917
941
  }
918
942
 
919
- /** A map of CSS style properties to their values, used with `[ngStyle]`. */
943
+ /**
944
+ * A map of CSS style properties to their values, used with `[ngStyle]`.
945
+ */
920
946
  type DbxFormStyleObject = {
921
947
  [styleClass: string]: any;
922
948
  };
@@ -924,9 +950,13 @@ type DbxFormStyleObject = {
924
950
  * Configuration for the style wrapper that applies dynamic CSS classes and inline styles.
925
951
  */
926
952
  interface DbxFormStyleWrapperConfig {
927
- /** Observable or static value providing inline styles via `[ngStyle]`. */
953
+ /**
954
+ * Observable or static value providing inline styles via `[ngStyle]`.
955
+ */
928
956
  styleGetter?: Maybe<ObservableOrValue<DbxFormStyleObject>>;
929
- /** Observable or static value providing CSS class names via `[ngClass]`. */
957
+ /**
958
+ * Observable or static value providing CSS class names via `[ngClass]`.
959
+ */
930
960
  classGetter?: Maybe<ObservableOrValue<string>>;
931
961
  }
932
962
  /**
@@ -969,14 +999,18 @@ declare class DbxFormWorkingWrapperComponent extends FieldWrapper<FormlyFieldCon
969
999
  static ɵcmp: i0.ɵɵComponentDeclaration<DbxFormWorkingWrapperComponent, "ng-component", never, {}, {}, never, never, true, never>;
970
1000
  }
971
1001
 
972
- /** Registers all Formly field wrapper types (section, flex, expand, toggle, style, info, working, autotouch, subsection). */
1002
+ /**
1003
+ * Registers all Formly field wrapper types (section, flex, expand, toggle, style, info, working, autotouch, subsection).
1004
+ */
973
1005
  declare class DbxFormFormlyWrapperModule {
974
1006
  static ɵfac: i0.ɵɵFactoryDeclaration<DbxFormFormlyWrapperModule, never>;
975
1007
  static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFormFormlyWrapperModule, never, [typeof AutoTouchFieldWrapperComponent, typeof DbxFormSectionWrapperComponent, typeof DbxFormSubsectionWrapperComponent, typeof DbxFormInfoWrapperComponent, typeof DbxFormExpandWrapperComponent, typeof DbxFormToggleWrapperComponent, typeof DbxFormFlexWrapperComponent, typeof DbxFormStyleWrapperComponent, typeof DbxFormWorkingWrapperComponent, typeof _ngx_formly_core.FormlyModule, typeof i1.FormlyMaterialModule, typeof _ngx_formly_core.FormlyModule], [typeof AutoTouchFieldWrapperComponent, typeof DbxFormSectionWrapperComponent, typeof DbxFormSubsectionWrapperComponent, typeof DbxFormInfoWrapperComponent, typeof DbxFormExpandWrapperComponent, typeof DbxFormToggleWrapperComponent, typeof DbxFormFlexWrapperComponent, typeof DbxFormStyleWrapperComponent, typeof DbxFormWorkingWrapperComponent, typeof _ngx_formly_core.FormlyModule, typeof i1.FormlyMaterialModule]>;
976
1008
  static ɵinj: i0.ɵɵInjectorDeclaration<DbxFormFormlyWrapperModule>;
977
1009
  }
978
1010
 
979
- /** Registers the `checklistitem` Formly field type with wrapper support. */
1011
+ /**
1012
+ * Registers the `checklistitem` Formly field type with wrapper support.
1013
+ */
980
1014
  declare class DbxFormFormlyChecklistItemFieldModule {
981
1015
  static ɵfac: i0.ɵɵFactoryDeclaration<DbxFormFormlyChecklistItemFieldModule, never>;
982
1016
  static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFormFormlyChecklistItemFieldModule, never, [typeof DbxChecklistItemFieldComponent, typeof DbxChecklistItemContentComponent, typeof DbxDefaultChecklistItemFieldDisplayComponent, typeof DbxFormFormlyWrapperModule, typeof _ngx_formly_core.FormlyModule], [typeof DbxChecklistItemFieldComponent, typeof DbxChecklistItemContentComponent, typeof DbxDefaultChecklistItemFieldDisplayComponent]>;
@@ -1050,6 +1084,11 @@ interface DescriptionFieldConfig {
1050
1084
  type PartialPotentialFieldConfig = Partial<FieldConfig> & Partial<LabeledFieldConfig> & Partial<AttributesFieldConfig> & Partial<DescriptionFieldConfig>;
1051
1085
  /**
1052
1086
  * Validates the configuration on the input field.
1087
+ *
1088
+ * @param fieldConfig - The Formly field configuration to validate
1089
+ * @returns The validated field configuration
1090
+ *
1091
+ * @param fieldConfig - The Formly field configuration to validate
1053
1092
  */
1054
1093
  declare function formlyField<T extends FormlyFieldConfig = FormlyFieldConfig>(fieldConfig: T): T;
1055
1094
  /**
@@ -1071,13 +1110,21 @@ declare function propsAndConfigForFieldConfig<O extends object = object>(fieldCo
1071
1110
  }) | undefined;
1072
1111
  parsers: ((value: any) => any)[] | undefined;
1073
1112
  };
1074
- /** Keys from {@link PartialPotentialFieldConfig} that are merged into Formly props. */
1113
+ /**
1114
+ * Keys from {@link PartialPotentialFieldConfig} that are merged into Formly props.
1115
+ */
1075
1116
  declare const partialPotentialFieldConfigKeys: (keyof PartialPotentialFieldConfig)[];
1076
- /** Filter configuration for extracting field config keys from objects. */
1117
+ /**
1118
+ * Filter configuration for extracting field config keys from objects.
1119
+ */
1077
1120
  declare const partialPotentialFieldConfigKeysFilter: FilterKeyValueTuplesInput<PartialPotentialFieldConfig>;
1078
- /** Merge function that combines multiple partial field configs, picking only the recognized keys. */
1121
+ /**
1122
+ * Merge function that combines multiple partial field configs, picking only the recognized keys.
1123
+ */
1079
1124
  declare const mergePropsValueObjects: _dereekb_util.MergeObjectsFunction<PartialPotentialFieldConfig>;
1080
- /** Filter function that extracts only the recognized field config keys from an object. */
1125
+ /**
1126
+ * Filter function that extracts only the recognized field config keys from an object.
1127
+ */
1081
1128
  declare const filterPartialPotentialFieldConfigValuesFromObject: GeneralFilterFromPOJOFunction<PartialPotentialFieldConfig>;
1082
1129
  /**
1083
1130
  * Builds a Formly props object from a field config and optional overrides.
@@ -1092,6 +1139,8 @@ declare const filterPartialPotentialFieldConfigValuesFromObject: GeneralFilterFr
1092
1139
  declare function propsValueForFieldConfig<T extends FormlyFieldProps, O extends object = object>(fieldConfig: PartialPotentialFieldConfig, override?: PartialPotentialFieldConfig & O): Partial<T> & O;
1093
1140
  /**
1094
1141
  * Returns configuration for a formlyField that will disable autofill/autocomplete for a field.
1142
+ *
1143
+ * @returns An attributes object that disables browser autofill
1095
1144
  */
1096
1145
  declare function disableFormlyFieldAutofillAttributes(): {
1097
1146
  name: string;
@@ -1177,13 +1226,21 @@ type ChecklistItemFieldBuilderInput<T = unknown> = Partial<ChecklistItemFieldCon
1177
1226
  */
1178
1227
  declare function checklistItemField<T = unknown>(config: ChecklistItemFieldBuilderInput<T>): FormlyFieldConfig<DbxChecklistItemFieldProps<T>>;
1179
1228
 
1180
- /** A field key from the data set type, constrained to string keys. */
1229
+ /**
1230
+ * A field key from the data set type, constrained to string keys.
1231
+ */
1181
1232
  type ChecklistItemFieldDataSetFieldKey<D> = keyof D & string;
1182
- /** The value type for a specific key in the data set. */
1233
+ /**
1234
+ * The value type for a specific key in the data set.
1235
+ */
1183
1236
  type ChecklistItemFieldDataSetFieldValueForKey<D, K extends keyof D = keyof D> = D[K];
1184
- /** Maps all keys of a data type to boolean values, representing a checklist. */
1237
+ /**
1238
+ * Maps all keys of a data type to boolean values, representing a checklist.
1239
+ */
1185
1240
  type ChecklistType<D> = KeyValueTransformMap<D, boolean>;
1186
- /** Input for adding a checklist item to the data set builder, combining a key with field builder input. */
1241
+ /**
1242
+ * Input for adding a checklist item to the data set builder, combining a key with field builder input.
1243
+ */
1187
1244
  type ChecklistItemFieldDataSetBuilderInput<D, T> = {
1188
1245
  key: ChecklistItemFieldDataSetFieldKey<D>;
1189
1246
  } & ChecklistItemFieldBuilderInput<T>;
@@ -1211,6 +1268,12 @@ declare class ChecklistItemFieldDataSetBuilder<D extends object, C extends Check
1211
1268
  * Merges the input config with existing configuration.
1212
1269
  *
1213
1270
  * The displayContentObs, if provided, will merge with the existing observable and the two objects merged.
1271
+ *
1272
+ * @param key - The key identifying which checklist field to merge into
1273
+ * @param config - Partial configuration to merge with the existing field config
1274
+ *
1275
+ * @param key - The key identifying which checklist field to merge into
1276
+ * @param config - Partial configuration to merge with the existing field config
1214
1277
  */
1215
1278
  merge<T>(key: ChecklistItemFieldDataSetFieldKey<D>, config: Partial<ChecklistItemFieldBuilderInput<T>>): void;
1216
1279
  override<T>(key: ChecklistItemFieldDataSetFieldKey<D>, config: Partial<ChecklistItemFieldBuilderInput<T>>): void;
@@ -1224,9 +1287,13 @@ declare class ChecklistItemFieldDataSetBuilder<D extends object, C extends Check
1224
1287
  contentWithDisplayValueFromData<T extends ChecklistItemFieldDataSetFieldValueForKey<D> = ChecklistItemFieldDataSetFieldValueForKey<D>>(key: ChecklistItemFieldDataSetFieldKey<D>, labelFn?: (value: T) => Maybe<string>): Observable<ChecklistItemDisplayContent<T>>;
1225
1288
  }
1226
1289
 
1227
- /** Configuration for the custom component to inject into the form field. Alias for {@link DbxInjectionComponentConfig}. */
1290
+ /**
1291
+ * Configuration for the custom component to inject into the form field. Alias for {@link DbxInjectionComponentConfig}.
1292
+ */
1228
1293
  type DbxFormComponentFieldConfig<T> = DbxInjectionComponentConfig<T>;
1229
- /** Formly field config extended with a {@link DbxFormComponentFieldConfig} for custom component rendering. */
1294
+ /**
1295
+ * Formly field config extended with a {@link DbxFormComponentFieldConfig} for custom component rendering.
1296
+ */
1230
1297
  interface DbxFormComponentFormlyFieldConfig<T = unknown> extends FormlyFieldConfig {
1231
1298
  componentField: DbxFormComponentFieldConfig<T>;
1232
1299
  }
@@ -1242,14 +1309,18 @@ declare class DbxFormComponentFieldComponent<T = unknown> extends FieldType<DbxF
1242
1309
  static ɵcmp: i0.ɵɵComponentDeclaration<DbxFormComponentFieldComponent<any>, "ng-component", never, {}, {}, never, never, true, never>;
1243
1310
  }
1244
1311
 
1245
- /** Registers the `component` Formly field type for custom Angular component injection. */
1312
+ /**
1313
+ * Registers the `component` Formly field type for custom Angular component injection.
1314
+ */
1246
1315
  declare class DbxFormFormlyComponentFieldModule {
1247
1316
  static ɵfac: i0.ɵɵFactoryDeclaration<DbxFormFormlyComponentFieldModule, never>;
1248
1317
  static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFormFormlyComponentFieldModule, never, [typeof DbxFormComponentFieldComponent, typeof _ngx_formly_core.FormlyModule], [typeof DbxFormComponentFieldComponent]>;
1249
1318
  static ɵinj: i0.ɵɵInjectorDeclaration<DbxFormFormlyComponentFieldModule>;
1250
1319
  }
1251
1320
 
1252
- /** Configuration for a custom Angular component embedded as a Formly field. */
1321
+ /**
1322
+ * Configuration for a custom Angular component embedded as a Formly field.
1323
+ */
1253
1324
  type ComponentFieldConfig<T = unknown> = DbxFormComponentFieldConfig<T>;
1254
1325
  /**
1255
1326
  * Creates a Formly field configuration that renders a custom Angular component.
@@ -1341,7 +1412,9 @@ interface DbxListFieldConfig<T = unknown, C extends AbstractDbxSelectionListWrap
1341
1412
  */
1342
1413
  declare function dbxListField<T = unknown, C extends AbstractDbxSelectionListWrapperDirective<T> = AbstractDbxSelectionListWrapperDirective<T>, K extends PrimativeKey = PrimativeKey>(config: DbxListFieldConfig<T, C, K>): FormlyFieldConfig;
1343
1414
 
1344
- /** Registers the `dbxlistfield` Formly field type for item list selection. */
1415
+ /**
1416
+ * Registers the `dbxlistfield` Formly field type for item list selection.
1417
+ */
1345
1418
  declare class DbxFormFormlyDbxListFieldModule {
1346
1419
  static ɵfac: i0.ɵɵFactoryDeclaration<DbxFormFormlyDbxListFieldModule, never>;
1347
1420
  static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFormFormlyDbxListFieldModule, never, [typeof DbxItemListFieldComponent, typeof _ngx_formly_core.FormlyModule], [typeof DbxItemListFieldComponent]>;
@@ -1380,9 +1453,13 @@ interface SelectionDisplayValue<T, M = unknown> extends SelectionValue<T, M>, La
1380
1453
  */
1381
1454
  type SelectionValueHashFunction<T, H extends PrimativeKey = PrimativeKey> = MapFunction<T, H>;
1382
1455
 
1383
- /** A pickable field value wrapping a {@link SelectionValue}. */
1456
+ /**
1457
+ * A pickable field value wrapping a {@link SelectionValue}.
1458
+ */
1384
1459
  type PickableValueFieldValue<T, M = unknown> = SelectionValue<T, M>;
1385
- /** A pickable field display value wrapping a {@link SelectionDisplayValue}. */
1460
+ /**
1461
+ * A pickable field display value wrapping a {@link SelectionDisplayValue}.
1462
+ */
1386
1463
  type PickableValueFieldDisplayValue<T, M = unknown> = SelectionDisplayValue<T, M>;
1387
1464
  /**
1388
1465
  * PickableValueField function for retrieving all values.
@@ -1410,7 +1487,9 @@ type PickableValueFieldHashFunction<T, H extends PrimativeKey = PrimativeKey> =
1410
1487
  * A list item wrapping a {@link PickableValueFieldDisplayValue} with selection state.
1411
1488
  */
1412
1489
  type PickableItemFieldItem<T, M = unknown> = DbxValueListItem<PickableValueFieldDisplayValue<T, M>>;
1413
- /** Sort function for ordering pickable items before display. */
1490
+ /**
1491
+ * Sort function for ordering pickable items before display.
1492
+ */
1414
1493
  type PickableItemFieldItemSortFn<T, M = unknown> = (items: PickableItemFieldItem<T, M>[]) => PickableItemFieldItem<T, M>[];
1415
1494
  /**
1416
1495
  * Formly field properties for configuring a pickable value selection field.
@@ -1649,7 +1728,9 @@ declare class DbxPickableListFieldComponent<T> extends AbstractDbxPickableItemFi
1649
1728
  static ɵcmp: i0.ɵɵComponentDeclaration<DbxPickableListFieldComponent<any>, "ng-component", never, {}, {}, never, never, true, never>;
1650
1729
  }
1651
1730
 
1652
- /** Registers the `pickablechipfield` and `pickablelistfield` Formly field types. */
1731
+ /**
1732
+ * Registers the `pickablechipfield` and `pickablelistfield` Formly field types.
1733
+ */
1653
1734
  declare class DbxFormFormlyPickableFieldModule {
1654
1735
  static ɵfac: i0.ɵɵFactoryDeclaration<DbxFormFormlyPickableFieldModule, never>;
1655
1736
  static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFormFormlyPickableFieldModule, never, [typeof DbxPickableChipListFieldComponent, typeof DbxPickableListFieldComponent, typeof DbxPickableListFieldItemListComponent, typeof DbxPickableListFieldItemListViewComponent, typeof DbxPickableListFieldItemListViewItemComponent, typeof _ngx_formly_core.FormlyModule], [typeof DbxPickableChipListFieldComponent, typeof DbxPickableListFieldComponent, typeof DbxPickableListFieldItemListComponent, typeof DbxPickableListFieldItemListViewComponent, typeof DbxPickableListFieldItemListViewItemComponent]>;
@@ -1698,7 +1779,9 @@ declare function pickableItemChipField<T = unknown, M = unknown>(config: Pickabl
1698
1779
  */
1699
1780
  declare function pickableItemListField<T = unknown, M = unknown>(config: PickableItemFieldConfig<T, M>): FormlyFieldConfig;
1700
1781
 
1701
- /** Case-insensitive filter function that matches pickable display values by their label using indexOf. */
1782
+ /**
1783
+ * Case-insensitive filter function that matches pickable display values by their label using indexOf.
1784
+ */
1702
1785
  declare const filterPickableItemFieldValuesByLabelFilterFunction: SearchStringFilterFunction<PickableValueFieldDisplayValue<any>>;
1703
1786
  /**
1704
1787
  * Filters pickable display values by label text, returning their underlying values.
@@ -1710,7 +1793,9 @@ declare const filterPickableItemFieldValuesByLabelFilterFunction: SearchStringFi
1710
1793
  * @returns Observable emitting the filtered value array
1711
1794
  */
1712
1795
  declare function filterPickableItemFieldValuesByLabel<T>(filterText: Maybe<string>, values: PickableValueFieldDisplayValue<T>[]): Observable<T[]>;
1713
- /** String sort comparator that orders pickable items alphabetically by label. */
1796
+ /**
1797
+ * String sort comparator that orders pickable items alphabetically by label.
1798
+ */
1714
1799
  declare const sortPickableItemsByLabelStringFunction: _dereekb_util.SortByStringFunction<PickableItemFieldItem<any>>;
1715
1800
  /**
1716
1801
  * Sorts pickable items alphabetically by their label.
@@ -1719,9 +1804,13 @@ declare const sortPickableItemsByLabelStringFunction: _dereekb_util.SortByString
1719
1804
  * @returns The sorted array (mutated in place)
1720
1805
  */
1721
1806
  declare function sortPickableItemsByLabel<T>(chips: PickableItemFieldItem<T>[]): PickableItemFieldItem<T>[];
1722
- /** Subset of {@link PickableValueFieldsFieldProps} needed for static labeled value configuration. */
1807
+ /**
1808
+ * Subset of {@link PickableValueFieldsFieldProps} needed for static labeled value configuration.
1809
+ */
1723
1810
  type PickableValueFieldValuesConfigForStaticLabeledValues<T, M extends LabeledValue<T>> = Pick<PickableValueFieldsFieldProps<T, M>, 'loadValues' | 'displayForValue' | 'filterValues'>;
1724
- /** Configuration for creating a pickable field from a static set of labeled values. */
1811
+ /**
1812
+ * Configuration for creating a pickable field from a static set of labeled values.
1813
+ */
1725
1814
  interface PickableValueFieldValuesConfigForStaticLabeledValuesConfig<T, M extends LabeledValue<T>> {
1726
1815
  readonly allOptions: M[];
1727
1816
  readonly unknownOptionLabel?: string;
@@ -1784,10 +1873,14 @@ type SearchableValueFieldDisplayFn<T, M = unknown> = MapFunction<SearchableValue
1784
1873
  * SearchableValueField function for setting anchor values on a field value.
1785
1874
  */
1786
1875
  type SearchableValueFieldAnchorFn<T, M = unknown> = MapFunction<SearchableValueFieldValue<T, M>, ClickableAnchor>;
1787
- /** Hash function for searchable field values, used to identify and deduplicate selections. */
1876
+ /**
1877
+ * Hash function for searchable field values, used to identify and deduplicate selections.
1878
+ */
1788
1879
  type SearchableValueFieldHashFn<T, H extends PrimativeKey = PrimativeKey> = SelectionValueHashFunction<T, H>;
1789
1880
 
1790
- /** Formly field properties for text input with optional custom validators. */
1881
+ /**
1882
+ * Formly field properties for text input with optional custom validators.
1883
+ */
1791
1884
  interface StringValueFieldsFieldProps extends FormlyFieldProps {
1792
1885
  /**
1793
1886
  * Custom input validators.
@@ -1932,11 +2025,17 @@ declare abstract class AbstractDbxSearchableValueFieldDirective<T, M = unknown,
1932
2025
  * Used to sync the input control with the selected value.
1933
2026
  *
1934
2027
  * Only used when multiSelect is false.
2028
+ *
2029
+ * @param value - The display value to synchronize the input control with
2030
+ *
2031
+ * @param value - The display value to synchronize the input control with
1935
2032
  */
1936
2033
  protected _syncSingleValue(value: SearchableValueFieldDisplayValue<T>): void;
1937
2034
  protected _addWithTextValue(text: string): void;
1938
2035
  /**
1939
2036
  * Returns the first validation error message from the input control, if any.
2037
+ *
2038
+ * @returns The first error message string, or undefined if there are no errors
1940
2039
  */
1941
2040
  get inputErrorMessage(): string | undefined;
1942
2041
  addWithDisplayValue(displayValue: SearchableValueFieldDisplayValue<T>): void;
@@ -1978,7 +2077,7 @@ declare class DbxSearchableChipFieldComponent<T, M = unknown, H extends Primativ
1978
2077
  selected(event: MatAutocompleteSelectedEvent): void;
1979
2078
  tabPressedOnInput(event: KeyboardEvent): boolean;
1980
2079
  addChip(event: MatChipInputEvent): void;
1981
- protected _syncSingleValue(value: SearchableValueFieldDisplayValue<T>): void;
2080
+ protected _syncSingleValue(_value: SearchableValueFieldDisplayValue<T>): void;
1982
2081
  ngOnInit(): void;
1983
2082
  ngOnDestroy(): void;
1984
2083
  onBlur(): void;
@@ -1986,7 +2085,9 @@ declare class DbxSearchableChipFieldComponent<T, M = unknown, H extends Primativ
1986
2085
  static ɵcmp: i0.ɵɵComponentDeclaration<DbxSearchableChipFieldComponent<any, any, any>, "ng-component", never, {}, {}, never, never, true, never>;
1987
2086
  }
1988
2087
 
1989
- /** Injection token providing the {@link ConfiguredSearchableValueFieldDisplayValue} to autocomplete item display components. */
2088
+ /**
2089
+ * Injection token providing the {@link ConfiguredSearchableValueFieldDisplayValue} to autocomplete item display components.
2090
+ */
1990
2091
  declare const DBX_SEARCHABLE_FIELD_COMPONENT_DATA_TOKEN: InjectionToken<unknown>;
1991
2092
  /**
1992
2093
  * Renders a single autocomplete suggestion item using dynamic component injection.
@@ -2053,14 +2154,18 @@ declare class DbxSearchableTextFieldComponent<T, M = unknown, H extends Primativ
2053
2154
  /**
2054
2155
  * Used to create a SearchableValueFieldDisplayFn function that will retrieve the metadata for items that are missing their metadata so they can be displayed properly.
2055
2156
  *
2056
- * @param param0
2057
- * @returns
2157
+ * @param param0 - Configuration object
2158
+ * @param param0.loadMetaForValues - Function to load metadata for values that are missing it
2159
+ * @param param0.makeDisplayForValues - Function to convert values with metadata into display values
2160
+ * @returns A display function that lazily loads metadata before generating display values
2058
2161
  */
2059
2162
  declare function makeMetaFilterSearchableFieldValueDisplayFn<T extends string | number = string | number, M = unknown>({ loadMetaForValues, makeDisplayForValues }: {
2060
2163
  loadMetaForValues: (values: SearchableValueFieldValue<T, M>[]) => Observable<SearchableValueFieldValue<T, M>[]>;
2061
2164
  makeDisplayForValues: (values: SearchableValueFieldValue<T, M>[]) => Observable<SearchableValueFieldDisplayValue<T, M>[]>;
2062
2165
  }): SearchableValueFieldDisplayFn<T, M>;
2063
- /** Configuration for a searchable chip field that uses string values directly. */
2166
+ /**
2167
+ * Configuration for a searchable chip field that uses string values directly.
2168
+ */
2064
2169
  type StringSearchableChipFieldConfig<M = unknown> = Omit<SearchableChipFieldConfig<string, M>, 'allowStringValues'>;
2065
2170
  /**
2066
2171
  * Creates a searchable chip field pre-configured for string values.
@@ -2112,7 +2217,9 @@ interface SearchableTextFieldConfig<T = unknown, M = unknown, H extends Primativ
2112
2217
  */
2113
2218
  declare function searchableTextField<T, M = unknown, H extends PrimativeKey = PrimativeKey>(config: SearchableTextFieldConfig<T, M, H>): FormlyFieldConfig;
2114
2219
 
2115
- /** Registers the `searchablechipfield` and `searchabletextfield` Formly field types. */
2220
+ /**
2221
+ * Registers the `searchablechipfield` and `searchabletextfield` Formly field types.
2222
+ */
2116
2223
  declare class DbxFormFormlySearchableFieldModule {
2117
2224
  static ɵfac: i0.ɵɵFactoryDeclaration<DbxFormFormlySearchableFieldModule, never>;
2118
2225
  static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFormFormlySearchableFieldModule, never, [typeof DbxSearchableChipFieldComponent, typeof DbxSearchableTextFieldComponent, typeof DbxSearchableFieldAutocompleteItemComponent, typeof DbxDefaultSearchableFieldDisplayComponent, typeof _ngx_formly_core.FormlyModule], [typeof DbxSearchableChipFieldComponent, typeof DbxSearchableTextFieldComponent, typeof DbxSearchableFieldAutocompleteItemComponent, typeof DbxDefaultSearchableFieldDisplayComponent]>;
@@ -2123,7 +2230,9 @@ declare class DbxFormFormlySearchableFieldModule {
2123
2230
  * Configuration for a plain text chip field that allows freeform string entry.
2124
2231
  */
2125
2232
  interface ChipTextFieldConfig extends LabeledFieldConfig, StringValueFieldsFieldProps {
2126
- /** Whether text values are case-sensitive. Defaults to false (lowercased). */
2233
+ /**
2234
+ * Whether text values are case-sensitive. Defaults to false (lowercased).
2235
+ */
2127
2236
  caseSensitive?: boolean;
2128
2237
  }
2129
2238
  /**
@@ -2381,7 +2490,9 @@ interface SourceSelectFieldConfig<T extends PrimativeKey = PrimativeKey, M = unk
2381
2490
  */
2382
2491
  declare function sourceSelectField<T extends PrimativeKey = PrimativeKey, M = unknown>(config: SourceSelectFieldConfig<T, M>): FormlyFieldConfig;
2383
2492
 
2384
- /** Registers the `sourceselectfield` Formly field type. */
2493
+ /**
2494
+ * Registers the `sourceselectfield` Formly field type.
2495
+ */
2385
2496
  declare class DbxFormFormlySourceSelectModule {
2386
2497
  static ɵfac: i0.ɵɵFactoryDeclaration<DbxFormFormlySourceSelectModule, never>;
2387
2498
  static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFormFormlySourceSelectModule, never, [typeof DbxFormSourceSelectFieldComponent, typeof _ngx_formly_core.FormlyModule], [typeof DbxFormSourceSelectFieldComponent]>;
@@ -2455,7 +2566,9 @@ declare function valueSelectionField<T>(config: ValueSelectionFieldConfig<T>): F
2455
2566
  */
2456
2567
  declare function addValueSelectionOptionFunction<T>(label?: string | undefined): (options: ValueSelectionOption<T>[]) => ValueSelectionOption<T>[];
2457
2568
 
2458
- /** Formly field properties for the text editor component. */
2569
+ /**
2570
+ * Formly field properties for the text editor component.
2571
+ */
2459
2572
  type TextEditorComponentFieldProps = FormlyFieldProps;
2460
2573
  /**
2461
2574
  * Formly field component providing a rich text editor powered by ngx-editor.
@@ -2480,7 +2593,9 @@ declare class DbxTextEditorFieldComponent<T extends TextEditorComponentFieldProp
2480
2593
  static ɵcmp: i0.ɵɵComponentDeclaration<DbxTextEditorFieldComponent<any>, "ng-component", never, {}, {}, never, never, true, never>;
2481
2594
  }
2482
2595
 
2483
- /** Registers the `texteditor` Formly field type for rich text editing. */
2596
+ /**
2597
+ * Registers the `texteditor` Formly field type for rich text editing.
2598
+ */
2484
2599
  declare class DbxFormFormlyTextEditorFieldModule {
2485
2600
  static ɵfac: i0.ɵɵFactoryDeclaration<DbxFormFormlyTextEditorFieldModule, never>;
2486
2601
  static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFormFormlyTextEditorFieldModule, never, [typeof DbxTextEditorFieldComponent, typeof _ngx_formly_core.FormlyModule], [typeof DbxTextEditorFieldComponent]>;
@@ -2511,9 +2626,13 @@ type TextFieldInputType = 'text' | 'password' | 'email';
2511
2626
  * and Material form field styling into one config object.
2512
2627
  */
2513
2628
  interface TextFieldConfig extends LabeledFieldConfig, DescriptionFieldConfig, TextFieldPatternConfig, TextFieldLengthConfig, AttributesFieldConfig, Partial<TransformStringFunctionConfigRef>, MaterialFormFieldConfig {
2514
- /** HTML input type. Defaults to `'text'`. */
2629
+ /**
2630
+ * HTML input type. Defaults to `'text'`.
2631
+ */
2515
2632
  inputType?: TextFieldInputType;
2516
- /** String transformation applied as a value parser (e.g., trim, uppercase). */
2633
+ /**
2634
+ * String transformation applied as a value parser (e.g., trim, uppercase).
2635
+ */
2517
2636
  transform?: TransformStringFunctionConfig;
2518
2637
  }
2519
2638
  /**
@@ -2545,7 +2664,9 @@ declare function textField(config: TextFieldConfig): FormlyFieldConfig;
2545
2664
  * Configuration for a multi-line textarea input field.
2546
2665
  */
2547
2666
  interface TextAreaFieldConfig extends LabeledFieldConfig, DescriptionFieldConfig, TextFieldPatternConfig, TextFieldLengthConfig, AttributesFieldConfig, Partial<TransformStringFunctionConfigRef>, MaterialFormFieldConfig {
2548
- /** Number of visible text rows. Defaults to 3. */
2667
+ /**
2668
+ * Number of visible text rows. Defaults to 3.
2669
+ */
2549
2670
  rows?: number;
2550
2671
  }
2551
2672
  /**
@@ -2689,7 +2810,9 @@ declare class DbxFormRepeatArrayTypeComponent<T = unknown> extends FieldArrayTyp
2689
2810
  static ɵcmp: i0.ɵɵComponentDeclaration<DbxFormRepeatArrayTypeComponent<any>, "ng-component", never, {}, {}, never, never, true, never>;
2690
2811
  }
2691
2812
 
2692
- /** Registers the `repeatarray` Formly field type for dynamic array fields. */
2813
+ /**
2814
+ * Registers the `repeatarray` Formly field type for dynamic array fields.
2815
+ */
2693
2816
  declare class DbxFormFormlyArrayFieldModule {
2694
2817
  static ɵfac: i0.ɵɵFactoryDeclaration<DbxFormFormlyArrayFieldModule, never>;
2695
2818
  static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFormFormlyArrayFieldModule, never, [typeof DbxFormRepeatArrayTypeComponent, typeof _ngx_formly_core.FormlyModule], [typeof DbxFormRepeatArrayTypeComponent]>;
@@ -2701,7 +2824,9 @@ declare class DbxFormFormlyArrayFieldModule {
2701
2824
  * groups of fields (e.g., multiple addresses, phone numbers).
2702
2825
  */
2703
2826
  interface RepeatArrayFieldConfig<T = unknown> extends DbxFormRepeatArrayConfig<T>, FieldConfig {
2704
- /** Field group template that is repeated for each array entry. */
2827
+ /**
2828
+ * Field group template that is repeated for each array entry.
2829
+ */
2705
2830
  repeatFieldGroup: ArrayOrValue<FormlyFieldConfig>;
2706
2831
  }
2707
2832
  /**
@@ -2757,7 +2882,9 @@ declare function repeatArrayField<T = unknown>(config: RepeatArrayFieldConfig<T>
2757
2882
  type: string;
2758
2883
  };
2759
2884
 
2760
- /** Provides Formly Material checkbox and toggle field support. */
2885
+ /**
2886
+ * Provides Formly Material checkbox and toggle field support.
2887
+ */
2761
2888
  declare class DbxFormFormlyBooleanFieldModule {
2762
2889
  static ɵfac: i0.ɵɵFactoryDeclaration<DbxFormFormlyBooleanFieldModule, never>;
2763
2890
  static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFormFormlyBooleanFieldModule, never, [typeof i1.FormlyMaterialModule, typeof i2.FormlyMatCheckboxModule, typeof i3.FormlyMatToggleModule], [typeof i1.FormlyMaterialModule, typeof i2.FormlyMatCheckboxModule, typeof i3.FormlyMatToggleModule]>;
@@ -2855,7 +2982,8 @@ interface DateTimePreset {
2855
2982
  /**
2856
2983
  * Creates a DateTimePreset from a DateTimePresetConfiguration
2857
2984
  *
2858
- * @param config
2985
+ * @param config - The preset configuration with label and value getter
2986
+ * @returns A DateTimePreset with a lazy value getter
2859
2987
  */
2860
2988
  declare function dateTimePreset(config: DateTimePresetConfiguration): DateTimePreset;
2861
2989
 
@@ -2982,6 +3110,11 @@ interface DbxDateTimeFieldTimeDateConfig<I = unknown> {
2982
3110
  }
2983
3111
  /**
2984
3112
  * Type guard that checks whether the input is a {@link DbxDateTimeFieldTimeDateConfig}.
3113
+ *
3114
+ * @param input - The value to check
3115
+ * @returns True if the input is a DbxDateTimeFieldTimeDateConfig with a string path property
3116
+ *
3117
+ * @param input - The value to check
2985
3118
  */
2986
3119
  declare function isDbxDateTimeFieldTimeDateConfig(input: unknown): input is DbxDateTimeFieldTimeDateConfig;
2987
3120
  interface DbxDateTimeFieldProps extends FormlyFieldProps {
@@ -3281,7 +3414,9 @@ type DbxFixedDateRangePickerConfiguration = Omit<DateTimeMinuteConfig, 'date'>;
3281
3414
  * - `'arbitrary_quick'` — Like arbitrary, but immediately sets the value on first click.
3282
3415
  */
3283
3416
  type DbxFixedDateRangeSelectionMode = 'single' | 'normal' | 'arbitrary' | 'arbitrary_quick';
3284
- /** Whether the user is currently picking the start or end of a range. */
3417
+ /**
3418
+ * Whether the user is currently picking the start or end of a range.
3419
+ */
3285
3420
  type DbxFixedDateRangePicking = 'start' | 'end';
3286
3421
  interface DbxFixedDateRangeFieldProps extends FormlyFieldProps {
3287
3422
  /**
@@ -3325,7 +3460,9 @@ interface DbxFixedDateRangeFieldProps extends FormlyFieldProps {
3325
3460
  */
3326
3461
  readonly showRangeInput?: boolean;
3327
3462
  }
3328
- /** Type of the most recent date range pick action. */
3463
+ /**
3464
+ * Type of the most recent date range pick action.
3465
+ */
3329
3466
  type FixedDateRangeScanType = 'start' | 'end' | 'startRepeat';
3330
3467
  /**
3331
3468
  * Internal scan state used to track the progressive date range selection process.
@@ -3439,8 +3576,8 @@ declare class DbxFixedDateRangeFieldComponent extends FieldType$1<FieldTypeConfi
3439
3576
  declare class DbxFixedDateRangeFieldSelectionStrategy<D> implements MatDateRangeSelectionStrategy<D> {
3440
3577
  private readonly _dateAdapter;
3441
3578
  readonly dbxFixedDateRangeFieldComponent: DbxFixedDateRangeFieldComponent;
3442
- selectionFinished(date: D | null, currentRange: DateRange$1<D>, event: Event): DateRange$1<D>;
3443
- createPreview(activeDate: D | null, currentRange: DateRange$1<D>, event: Event): DateRange$1<D>;
3579
+ selectionFinished(date: D | null, currentRange: DateRange$1<D>, _event: Event): DateRange$1<D>;
3580
+ createPreview(activeDate: D | null, _currentRange: DateRange$1<D>, _event: Event): DateRange$1<D>;
3444
3581
  private _createDateRangeWithDate;
3445
3582
  private _createDateRange;
3446
3583
  dateFromAdapterDate(input: D): Date;
@@ -3449,7 +3586,9 @@ declare class DbxFixedDateRangeFieldSelectionStrategy<D> implements MatDateRange
3449
3586
  static ɵprov: i0.ɵɵInjectableDeclaration<DbxFixedDateRangeFieldSelectionStrategy<any>>;
3450
3587
  }
3451
3588
 
3452
- /** Registers the `datetime` and `fixeddaterange` Formly field types with style and form-field wrappers. */
3589
+ /**
3590
+ * Registers the `datetime` and `fixeddaterange` Formly field types with style and form-field wrappers.
3591
+ */
3453
3592
  declare class DbxFormFormlyDateFieldModule {
3454
3593
  static ɵfac: i0.ɵɵFactoryDeclaration<DbxFormFormlyDateFieldModule, never>;
3455
3594
  static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFormFormlyDateFieldModule, never, [typeof DbxDateTimeFieldComponent, typeof DbxFixedDateRangeFieldComponent, typeof DbxFormFormlyWrapperModule, typeof _ngx_formly_core.FormlyModule], [typeof DbxDateTimeFieldComponent, typeof DbxFixedDateRangeFieldComponent, typeof DbxFormFormlyWrapperModule]>;
@@ -3468,10 +3607,17 @@ type TimeFieldConfig = Omit<DateTimeFieldConfig, 'showDate' | 'timeOnly'>;
3468
3607
  /**
3469
3608
  * Factory that returns an observable of a date-time picker configuration
3470
3609
  * that automatically selects the next upcoming time, rounded down to the nearest minute.
3610
+ *
3611
+ * @returns An observable emitting a picker configuration with takeNextUpcomingTime and roundDownToMinute enabled
3471
3612
  */
3472
3613
  declare const TAKE_NEXT_UPCOMING_TIME_CONFIG_OBS: () => Observable<DbxDateTimePickerConfiguration>;
3473
3614
  /**
3474
3615
  * Same as DateTime field but with the Date input hidden by default.
3616
+ *
3617
+ * @param config - Optional time field configuration overrides
3618
+ * @returns A {@link FormlyFieldConfig} configured as a time-only input
3619
+ *
3620
+ * @param config - Optional time field configuration overrides
3475
3621
  */
3476
3622
  declare function timeOnlyField(config?: Partial<TimeFieldConfig>): FormlyFieldConfig;
3477
3623
  /**
@@ -3487,7 +3633,9 @@ declare function timeOnlyField(config?: Partial<TimeFieldConfig>): FormlyFieldCo
3487
3633
  * ```
3488
3634
  */
3489
3635
  declare function dateTimeField(config?: Partial<DateTimeFieldConfig>): FormlyFieldConfig<DbxDateTimeFieldProps>;
3490
- /** Configuration for a single date within a date range (no time mode or sync). */
3636
+ /**
3637
+ * Configuration for a single date within a date range (no time mode or sync).
3638
+ */
3491
3639
  type DateDateRangeFieldDateConfig = Omit<DateTimeFieldConfig, 'dateLabel' | 'timeOnly' | 'timeMode' | 'getSyncFieldsObs'>;
3492
3640
  /**
3493
3641
  * Configuration for a date range field with separate start and end date pickers.
@@ -3510,7 +3658,9 @@ interface DateDateRangeFieldConfig extends Pick<DateTimeFieldConfig, 'timeDate'
3510
3658
  * ```
3511
3659
  */
3512
3660
  declare function dateRangeField(config?: DateDateRangeFieldConfig): FormlyFieldConfig;
3513
- /** Configuration for a single time within a date-time range (no full-day options). */
3661
+ /**
3662
+ * Configuration for a single time within a date-time range (no full-day options).
3663
+ */
3514
3664
  type DateTimeRangeFieldTimeConfig = Omit<DateDateRangeFieldDateConfig, 'allDayLabel' | 'fullDayFieldName' | 'fullDayInUTC'>;
3515
3665
  /**
3516
3666
  * Configuration for a date-time range field with separate start and end time pickers.
@@ -3581,12 +3731,18 @@ declare const DEFAULT_DATE_TIME_FIELD_MENU_PRESETS_PRESETS: DateTimePresetConfig
3581
3731
  interface NumberFieldNumberConfig {
3582
3732
  readonly min?: number;
3583
3733
  readonly max?: number;
3584
- /** Step increment for the input. */
3734
+ /**
3735
+ * Step increment for the input.
3736
+ */
3585
3737
  readonly step?: number;
3586
- /** When true, adds a validator that enforces the value is divisible by `step`. */
3738
+ /**
3739
+ * When true, adds a validator that enforces the value is divisible by `step`.
3740
+ */
3587
3741
  readonly enforceStep?: boolean;
3588
3742
  }
3589
- /** HTML input type for number fields. */
3743
+ /**
3744
+ * HTML input type for number fields.
3745
+ */
3590
3746
  type NumberFieldInputType = 'number';
3591
3747
  /**
3592
3748
  * Full configuration for a numeric input field.
@@ -3666,7 +3822,9 @@ interface NumberSliderFieldConfig extends NumberFieldConfig {
3666
3822
  * ```
3667
3823
  */
3668
3824
  declare function numberSliderField(config: NumberSliderFieldConfig): FormlyFieldConfig;
3669
- /** Configuration for a dollar amount field, which enforces cent-level precision. */
3825
+ /**
3826
+ * Configuration for a dollar amount field, which enforces cent-level precision.
3827
+ */
3670
3828
  type DollarAmountFieldConfig = Omit<NumberFieldConfig, 'roundToStep' | 'precision'>;
3671
3829
  /**
3672
3830
  * Creates a number field pre-configured for dollar amount input with cent-level precision.
@@ -3683,7 +3841,9 @@ declare function dollarAmountField(config: DollarAmountFieldConfig): FormlyField
3683
3841
  [additionalProperties: string]: any;
3684
3842
  }>;
3685
3843
 
3686
- /** Provides Formly Material number input and slider support. */
3844
+ /**
3845
+ * Provides Formly Material number input and slider support.
3846
+ */
3687
3847
  declare class DbxFormFormlyNumberFieldModule {
3688
3848
  static ɵfac: i0.ɵɵFactoryDeclaration<DbxFormFormlyNumberFieldModule, never>;
3689
3849
  static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFormFormlyNumberFieldModule, never, [typeof i1.FormlyMaterialModule, typeof i2$1.FormlyMatSliderModule], [typeof i1.FormlyMaterialModule, typeof i2$1.FormlyMatSliderModule]>;
@@ -3694,9 +3854,13 @@ declare class DbxFormFormlyNumberFieldModule {
3694
3854
  * Formly field props for the international phone number component.
3695
3855
  */
3696
3856
  interface InternationalPhoneFormlyFieldProps extends FormlyFieldProps {
3697
- /** ISO country codes for countries shown first in the dropdown. */
3857
+ /**
3858
+ * ISO country codes for countries shown first in the dropdown.
3859
+ */
3698
3860
  readonly preferredCountries?: Maybe<string[]>;
3699
- /** ISO country codes to restrict the dropdown to. */
3861
+ /**
3862
+ * ISO country codes to restrict the dropdown to.
3863
+ */
3700
3864
  readonly onlyCountries?: Maybe<string[]>;
3701
3865
  /**
3702
3866
  * Whether or not to enable the search feature. True by default.
@@ -3707,7 +3871,9 @@ interface InternationalPhoneFormlyFieldProps extends FormlyFieldProps {
3707
3871
  */
3708
3872
  readonly allowExtension?: boolean;
3709
3873
  }
3710
- /** Default preferred countries shown at the top of the phone country dropdown. */
3874
+ /**
3875
+ * Default preferred countries shown at the top of the phone country dropdown.
3876
+ */
3711
3877
  declare const DEFAULT_PREFERRED_COUNTRIES: string[];
3712
3878
  /**
3713
3879
  * Formly custom field type for international phone number input with optional extension support.
@@ -3738,7 +3904,9 @@ declare class DbxPhoneFieldComponent extends FieldType$1<FieldTypeConfig<Interna
3738
3904
  static ɵcmp: i0.ɵɵComponentDeclaration<DbxPhoneFieldComponent, "ng-component", never, {}, {}, never, never, true, never>;
3739
3905
  }
3740
3906
 
3741
- /** Registers the `intphone` Formly field type for international phone number input. */
3907
+ /**
3908
+ * Registers the `intphone` Formly field type for international phone number input.
3909
+ */
3742
3910
  declare class DbxFormFormlyPhoneFieldModule {
3743
3911
  static ɵfac: i0.ɵɵFactoryDeclaration<DbxFormFormlyPhoneFieldModule, never>;
3744
3912
  static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFormFormlyPhoneFieldModule, never, [typeof DbxPhoneFieldComponent, typeof _ngx_formly_core.FormlyModule], [typeof DbxPhoneFieldComponent]>;
@@ -3775,6 +3943,8 @@ interface WrappedPhoneAndLabelFieldConfig {
3775
3943
  * useful for collecting named phone numbers (e.g., "Work", "Home").
3776
3944
  *
3777
3945
  * @param config - Optional phone and label field configurations
3946
+ * @param config.phoneField - Optional configuration overrides for the phone number input
3947
+ * @param config.labelField - Optional configuration overrides for the label text input
3778
3948
  * @returns A flex-layout-wrapped {@link FormlyFieldConfig}
3779
3949
  *
3780
3950
  * @example
@@ -3793,6 +3963,11 @@ interface PhoneAndLabelFieldSectionConfig extends DbxFormSectionConfig, WrappedP
3793
3963
  * Creates a section-wrapped phone + label field pair with a configurable header.
3794
3964
  *
3795
3965
  * @param config - Optional overrides; defaults to header `'Phone Number'`
3966
+ * @param config.key - Optional form model key for the section group
3967
+ * @param config.header - Section header text; defaults to `'Phone Number'`
3968
+ * @param config.hint - Optional hint text displayed below the section header
3969
+ * @param config.phoneField - Optional phone field configuration overrides
3970
+ * @param config.labelField - Optional label field configuration overrides
3796
3971
  * @returns A section-wrapped {@link FormlyFieldConfig}
3797
3972
  *
3798
3973
  * @example
@@ -3821,11 +3996,17 @@ interface PhoneListFieldConfig extends Omit<RepeatArrayFieldConfig, 'repeatField
3821
3996
  */
3822
3997
  declare function phoneListField(repeatConfig?: Partial<PhoneListFieldConfig>): FormlyFieldConfig;
3823
3998
 
3824
- /** Maximum character length for a phone label field. */
3999
+ /**
4000
+ * Maximum character length for a phone label field.
4001
+ */
3825
4002
  declare const PHONE_LABEL_MAX_LENGTH = 100;
3826
- /** Maximum character length for a generic label string field. */
4003
+ /**
4004
+ * Maximum character length for a generic label string field.
4005
+ */
3827
4006
  declare const LABEL_STRING_MAX_LENGTH = 100;
3828
- /** Maximum character length for a search string field. */
4007
+ /**
4008
+ * Maximum character length for a search string field.
4009
+ */
3829
4010
  declare const SEARCH_STRING_MAX_LENGTH = 100;
3830
4011
  /**
3831
4012
  * Creates a text field pre-configured for a person's full name.
@@ -3857,7 +4038,9 @@ interface EmailFieldConfig extends Partial<LabeledFieldConfig>, DescriptionField
3857
4038
  * ```
3858
4039
  */
3859
4040
  declare function emailField(config?: EmailFieldConfig): FormlyFieldConfig;
3860
- /** Configuration for a city input field. */
4041
+ /**
4042
+ * Configuration for a city input field.
4043
+ */
3861
4044
  type CityFieldConfig = Partial<TextFieldConfig>;
3862
4045
  /**
3863
4046
  * Creates a text field pre-configured for city name input with autocomplete support.
@@ -3875,7 +4058,9 @@ declare function cityField(config?: CityFieldConfig): FormlyFieldConfig;
3875
4058
  * Configuration for a US state input field.
3876
4059
  */
3877
4060
  interface StateFieldConfig extends Partial<TextFieldConfig> {
3878
- /** When true, validates and formats as a 2-letter state code (e.g., `'CA'`). */
4061
+ /**
4062
+ * When true, validates and formats as a 2-letter state code (e.g., `'CA'`).
4063
+ */
3879
4064
  readonly asCode?: boolean;
3880
4065
  }
3881
4066
  /**
@@ -3892,7 +4077,9 @@ interface StateFieldConfig extends Partial<TextFieldConfig> {
3892
4077
  * ```
3893
4078
  */
3894
4079
  declare function stateField(config?: StateFieldConfig): FormlyFieldConfig;
3895
- /** Configuration for a country input field. */
4080
+ /**
4081
+ * Configuration for a country input field.
4082
+ */
3896
4083
  type CountryFieldConfig = Partial<TextFieldConfig>;
3897
4084
  /**
3898
4085
  * Creates a text field pre-configured for country name input with autocomplete support.
@@ -3906,7 +4093,9 @@ type CountryFieldConfig = Partial<TextFieldConfig>;
3906
4093
  * ```
3907
4094
  */
3908
4095
  declare function countryField(config?: CountryFieldConfig): FormlyFieldConfig;
3909
- /** Configuration for a zip/postal code input field. */
4096
+ /**
4097
+ * Configuration for a zip/postal code input field.
4098
+ */
3910
4099
  type ZipCodeFieldConfig = Partial<TextFieldConfig>;
3911
4100
  /**
3912
4101
  * Creates a text field pre-configured for US zip code input with pattern validation.
@@ -3920,14 +4109,19 @@ type ZipCodeFieldConfig = Partial<TextFieldConfig>;
3920
4109
  * ```
3921
4110
  */
3922
4111
  declare function zipCodeField(config?: ZipCodeFieldConfig): FormlyFieldConfig;
3923
- /** Default placeholder text for a latitude/longitude text field. */
4112
+ /**
4113
+ * Default placeholder text for a latitude/longitude text field.
4114
+ */
3924
4115
  declare const DEFAULT_LAT_LNG_TEXT_FIELD_PLACEHOLDER = "12.345,-67.8910";
3925
- /** Default validation error message for invalid coordinate input. */
4116
+ /**
4117
+ * Default validation error message for invalid coordinate input.
4118
+ */
3926
4119
  declare const DEFAULT_LAT_LNG_TEXT_FIELD_PATTERN_MESSAGE = "Invalid/unknown coordinates";
3927
4120
  /**
3928
4121
  * Creates a text field pre-configured for latitude/longitude coordinate input with pattern validation.
3929
4122
  *
3930
4123
  * @param config - Optional overrides; defaults to key `'latLng'`
4124
+ * @param config.key - The form model key; defaults to `'latLng'`
3931
4125
  * @returns A {@link FormlyFieldConfig} for coordinate input
3932
4126
  *
3933
4127
  * @example
@@ -3970,7 +4164,9 @@ interface AddressFormlyFieldsConfig {
3970
4164
  * Configuration for a single address line field.
3971
4165
  */
3972
4166
  interface AddressLineFieldConfig extends Partial<TextFieldConfig> {
3973
- /** Address line number: 0 for single "Street" line, 1 for "Line 1", 2 for "Line 2". */
4167
+ /**
4168
+ * Address line number: 0 for single "Street" line, 1 for "Line 1", 2 for "Line 2".
4169
+ */
3974
4170
  readonly line?: 0 | 1 | 2;
3975
4171
  }
3976
4172
  /**
@@ -4020,7 +4216,9 @@ declare function addressField(config?: Partial<AddressFieldConfig>): FormlyField
4020
4216
  * Configuration for a repeatable list of address field groups.
4021
4217
  */
4022
4218
  interface AddressListFieldConfig extends Readonly<FieldConfig>, AddressFormlyFieldsConfig {
4023
- /** Maximum number of addresses allowed. Defaults to 6. */
4219
+ /**
4220
+ * Maximum number of addresses allowed. Defaults to 6.
4221
+ */
4024
4222
  readonly maxAddresses?: number;
4025
4223
  }
4026
4224
  /**
@@ -4036,7 +4234,9 @@ interface AddressListFieldConfig extends Readonly<FieldConfig>, AddressFormlyFie
4036
4234
  */
4037
4235
  declare function addressListField(config?: Partial<AddressListFieldConfig>): FormlyFieldConfig;
4038
4236
 
4039
- /** Aggregates Formly Material input, array field, and wrapper modules for text field support. */
4237
+ /**
4238
+ * Aggregates Formly Material input, array field, and wrapper modules for text field support.
4239
+ */
4040
4240
  declare class DbxFormFormlyTextFieldModule {
4041
4241
  static ɵfac: i0.ɵɵFactoryDeclaration<DbxFormFormlyTextFieldModule, never>;
4042
4242
  static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFormFormlyTextFieldModule, never, [typeof DbxFormFormlyArrayFieldModule, typeof i1.FormlyMaterialModule, typeof i3$1.FormlyMatInputModule, typeof DbxFormFormlyWrapperModule], [typeof DbxFormFormlyArrayFieldModule, typeof i1.FormlyMaterialModule, typeof i3$1.FormlyMatInputModule, typeof DbxFormFormlyWrapperModule]>;
@@ -4053,6 +4253,8 @@ type HiddenFieldConfig = Pick<LabeledFieldConfig, 'key' | 'required'>;
4053
4253
  * Useful for passing programmatic values through the form model without user interaction.
4054
4254
  *
4055
4255
  * @param config - Key and optional required flag
4256
+ * @param config.key - The form model key for this hidden field
4257
+ * @param config.required - Whether the hidden field must have a value; defaults to `false`
4056
4258
  * @returns A validated {@link FormlyFieldConfig} with no visible type
4057
4259
  *
4058
4260
  * @example
@@ -4089,34 +4291,90 @@ type WrapperFormlyFieldConfig<P, C extends FormlyFieldConfig> = FormlyFieldConfi
4089
4291
  declare function addWrapperToFormlyFieldConfig<C extends FormlyFieldConfig, P extends object>(fieldConfig: C, wrapperKey: string, wrapperProps: P): WrapperFormlyFieldConfig<P, C>;
4090
4292
  /**
4091
4293
  * Wraps a field with the auto-touch wrapper that marks the control as touched on value change.
4294
+ *
4295
+ * @param fieldConfig - The field configuration to wrap
4296
+ * @param autoTouchWrapper - Optional expand wrapper configuration
4297
+ * @returns A wrapped field configuration with auto-touch behavior
4298
+ *
4299
+ * @param fieldConfig - The field configuration to wrap
4300
+ * @param autoTouchWrapper - Optional expand wrapper configuration
4092
4301
  */
4093
4302
  declare function autoTouchWrapper<T extends object, C extends FormlyFieldConfig>(fieldConfig: C, autoTouchWrapper?: DbxFormExpandWrapperConfig<T>): WrapperFormlyFieldConfig<DbxFormExpandWrapperConfig<T>, C>;
4094
4303
  /**
4095
4304
  * Wraps a field with the expand wrapper that shows/hides the field based on value or user click.
4305
+ *
4306
+ * @param fieldConfig - The field configuration to wrap
4307
+ * @param expandWrapper - Optional expand wrapper configuration
4308
+ * @returns A wrapped field configuration with expand/collapse behavior
4309
+ *
4310
+ * @param fieldConfig - The field configuration to wrap
4311
+ * @param expandWrapper - Optional expand wrapper configuration
4096
4312
  */
4097
4313
  declare function expandWrapper<T extends object, C extends FormlyFieldConfig>(fieldConfig: C, expandWrapper?: DbxFormExpandWrapperConfig<T>): WrapperFormlyFieldConfig<DbxFormExpandWrapperConfig<T>, C>;
4098
4314
  /**
4099
4315
  * Wraps a field with the toggle wrapper that uses a slide toggle to show/hide content.
4316
+ *
4317
+ * @param fieldConfig - The field configuration to wrap
4318
+ * @param toggleWrapper - Optional toggle wrapper configuration
4319
+ * @returns A wrapped field configuration with toggle show/hide behavior
4320
+ *
4321
+ * @param fieldConfig - The field configuration to wrap
4322
+ * @param toggleWrapper - Optional toggle wrapper configuration
4100
4323
  */
4101
4324
  declare function toggleWrapper<C extends FormlyFieldConfig>(fieldConfig: C, toggleWrapper?: DbxFormToggleWrapperConfig): WrapperFormlyFieldConfig<DbxFormToggleWrapperConfig<object>, C>;
4102
4325
  /**
4103
4326
  * Wraps a field group in a section layout with an optional header and hint.
4327
+ *
4328
+ * @param fieldConfig - The field configuration to wrap
4329
+ * @param sectionWrapper - Optional section configuration with header and hint
4330
+ * @returns A wrapped field configuration with section layout
4331
+ *
4332
+ * @param fieldConfig - The field configuration to wrap
4333
+ * @param sectionWrapper - Optional section configuration with header and hint
4104
4334
  */
4105
4335
  declare function sectionWrapper<C extends FormlyFieldConfig>(fieldConfig: C, sectionWrapper?: DbxFormSectionConfig): WrapperFormlyFieldConfig<_dereekb_dbx_web.DbxSectionHeaderConfig, C>;
4106
4336
  /**
4107
4337
  * Wraps a field group in a subsection layout with an optional header and hint.
4338
+ *
4339
+ * @param fieldConfig - The field configuration to wrap
4340
+ * @param subsectionWrapper - Optional subsection configuration with header and hint
4341
+ * @returns A wrapped field configuration with subsection layout
4342
+ *
4343
+ * @param fieldConfig - The field configuration to wrap
4344
+ * @param subsectionWrapper - Optional subsection configuration with header and hint
4108
4345
  */
4109
4346
  declare function subsectionWrapper<C extends FormlyFieldConfig>(fieldConfig: C, subsectionWrapper?: DbxFormSubsectionConfig): WrapperFormlyFieldConfig<_dereekb_dbx_web.DbxSectionHeaderConfig, C>;
4110
4347
  /**
4111
4348
  * Wraps a field with an info button that triggers a callback when clicked.
4349
+ *
4350
+ * @param fieldConfig - The field configuration to wrap
4351
+ * @param infoWrapper - Info wrapper configuration with callback
4352
+ * @returns A wrapped field configuration with info button
4353
+ *
4354
+ * @param fieldConfig - The field configuration to wrap
4355
+ * @param infoWrapper - Info wrapper configuration with callback
4112
4356
  */
4113
4357
  declare function infoWrapper<C extends FormlyFieldConfig>(fieldConfig: C, infoWrapper: DbxFormInfoConfig): WrapperFormlyFieldConfig<DbxFormInfoConfig, C>;
4114
4358
  /**
4115
4359
  * Wraps a field with dynamic CSS class and style bindings.
4360
+ *
4361
+ * @param fieldConfig - The field configuration to wrap
4362
+ * @param styleWrapper - Style wrapper configuration with CSS classes and styles
4363
+ * @returns A wrapped field configuration with dynamic styling
4364
+ *
4365
+ * @param fieldConfig - The field configuration to wrap
4366
+ * @param styleWrapper - Style wrapper configuration with CSS classes and styles
4116
4367
  */
4117
4368
  declare function styleWrapper<C extends FormlyFieldConfig>(fieldConfig: C, styleWrapper: DbxFormStyleWrapperConfig): WrapperFormlyFieldConfig<DbxFormStyleWrapperConfig, C>;
4118
4369
  /**
4119
4370
  * Wraps a field with a loading indicator that shows during async validation.
4371
+ *
4372
+ * @param fieldConfig - The field configuration to wrap
4373
+ * @param workingWrapper - Optional working wrapper configuration
4374
+ * @returns A wrapped field configuration with loading indicator
4375
+ *
4376
+ * @param fieldConfig - The field configuration to wrap
4377
+ * @param workingWrapper - Optional working wrapper configuration
4120
4378
  */
4121
4379
  declare function workingWrapper<C extends FormlyFieldConfig>(fieldConfig: C, workingWrapper?: DbxFormWorkingWrapperConfig): WrapperFormlyFieldConfig<object, C>;
4122
4380
  /**
@@ -4139,6 +4397,11 @@ interface DbxFlexLayoutWrapperGroupFieldConfigDefaults extends DbxFlexWrapperCon
4139
4397
  /**
4140
4398
  * Type guard that checks if the input is a {@link DbxFlexLayoutWrapperGroupFieldConfig}
4141
4399
  * (has a `field` property) rather than a plain {@link FormlyFieldConfig}.
4400
+ *
4401
+ * @param input - The field config or wrapper group config to check
4402
+ * @returns True if the input has a `field` property identifying it as a wrapper group config
4403
+ *
4404
+ * @param input - The field config or wrapper group config to check
4142
4405
  */
4143
4406
  declare function checkIsFieldFlexLayoutGroupFieldConfig(input: FormlyFieldConfig | DbxFlexLayoutWrapperGroupFieldConfig): input is DbxFlexLayoutWrapperGroupFieldConfig;
4144
4407
  /**
@@ -4147,6 +4410,10 @@ declare function checkIsFieldFlexLayoutGroupFieldConfig(input: FormlyFieldConfig
4147
4410
  *
4148
4411
  * @param fieldConfigs - Array of field configs or field config pairs with size overrides
4149
4412
  * @param options - Flex layout defaults including breakpoint, relative sizing, and default size
4413
+ * @param options.relative - Whether sizes are relative to the container
4414
+ * @param options.breakpoint - Responsive breakpoint at which to stack fields vertically
4415
+ * @param options.breakToColumn - Whether to break to column layout at the breakpoint
4416
+ * @param options.size - Default flex size for fields without an explicit size; defaults to 2
4150
4417
  * @returns A {@link FormlyFieldConfig} with flex wrapper applied
4151
4418
  *
4152
4419
  * @example
@@ -4159,7 +4426,9 @@ declare function checkIsFieldFlexLayoutGroupFieldConfig(input: FormlyFieldConfig
4159
4426
  */
4160
4427
  declare function flexLayoutWrapper(fieldConfigs: (FormlyFieldConfig | DbxFlexLayoutWrapperGroupFieldConfig)[], { relative, breakpoint, breakToColumn, size: defaultSize }?: DbxFlexLayoutWrapperGroupFieldConfigDefaults): FormlyFieldConfig<DbxFlexWrapperConfig>;
4161
4428
 
4162
- /** Aggregates all custom Formly field type modules (checklist, component, texteditor) and wrappers. */
4429
+ /**
4430
+ * Aggregates all custom Formly field type modules (checklist, component, texteditor) and wrappers.
4431
+ */
4163
4432
  declare class DbxFormFormlyFieldModule {
4164
4433
  static ɵfac: i0.ɵɵFactoryDeclaration<DbxFormFormlyFieldModule, never>;
4165
4434
  static ɵmod: i0.ɵɵNgModuleDeclaration<DbxFormFormlyFieldModule, never, [typeof DbxFormFormlyChecklistItemFieldModule, typeof DbxFormFormlyComponentFieldModule, typeof DbxFormFormlyTextEditorFieldModule, typeof DbxFormFormlyWrapperModule], [typeof DbxFormFormlyChecklistItemFieldModule, typeof DbxFormFormlyComponentFieldModule, typeof DbxFormFormlyTextEditorFieldModule, typeof DbxFormFormlyWrapperModule]>;
@@ -4173,6 +4442,12 @@ interface DbxFormSearchFormFieldsConfig extends MaterialFormFieldConfig {
4173
4442
  readonly label?: string;
4174
4443
  readonly placeholder?: string;
4175
4444
  }
4445
+ /**
4446
+ * Creates a Formly field array for a simple search form with a single text input.
4447
+ *
4448
+ * @param config - Optional search field configuration with label and placeholder
4449
+ * @returns An array of Formly field configs for the search form
4450
+ */
4176
4451
  declare function dbxFormSearchFormFields(config: Maybe<DbxFormSearchFormFieldsConfig>): FormlyFieldConfig[];
4177
4452
 
4178
4453
  /**
@@ -4397,8 +4672,11 @@ interface DefaultUsernameLoginFieldsValue extends DefaultUsernameLoginFieldValue
4397
4672
  /**
4398
4673
  * Template for login field that takes in a username and password.
4399
4674
  *
4400
- * @param param0
4401
- * @returns
4675
+ * @param param0 - Login fields configuration
4676
+ * @param param0.username - Optional username field configuration
4677
+ * @param param0.password - Optional password field configuration
4678
+ * @param param0.verifyPassword - Optional verify-password field configuration, or `true` to use defaults
4679
+ * @returns An array of Formly field configs for the login form
4402
4680
  */
4403
4681
  declare function usernamePasswordLoginFields({ username, password, verifyPassword }: UsernameLoginFieldsConfig): FormlyFieldConfig[];
4404
4682
  /**
@@ -4444,6 +4722,11 @@ declare function timezoneStringSearchFunction(): SearchableValueFieldStringSearc
4444
4722
  *
4445
4723
  * Maps each timezone value to a display object with the timezone name as the label
4446
4724
  * and its abbreviation as the sublabel.
4725
+ *
4726
+ * @param values - The timezone values to convert to display values
4727
+ * @returns An observable emitting display values with label and sublabel
4728
+ *
4729
+ * @param values - The timezone values to convert to display values
4447
4730
  */
4448
4731
  declare const DISPLAY_FOR_TIMEZONE_STRING_VALUE: SearchableValueFieldDisplayFn<string, TimezoneInfo>;
4449
4732
  /**
@@ -4504,10 +4787,11 @@ interface IsWebsiteUrlValidatorConfig {
4504
4787
  readonly validDomains?: Maybe<ArrayOrValue<WebsiteDomain>>;
4505
4788
  }
4506
4789
  /**
4507
- * Angular Form ValidationFn for checking isDivisibleBy the input divisor.
4790
+ * Angular form validator that checks whether the control value is a valid website URL,
4791
+ * optionally requiring an http/https prefix, allowing port numbers, and restricting to specific domains.
4508
4792
  *
4509
- * @param divisor
4510
- * @returns
4793
+ * @param config - Optional validation configuration for prefix, port, and domain requirements
4794
+ * @returns A ValidatorFn that validates website URLs
4511
4795
  */
4512
4796
  declare function isWebsiteUrlValidator(config?: IsWebsiteUrlValidatorConfig): ValidatorFn;
4513
4797
 
@@ -4603,6 +4887,11 @@ declare class DbxFormlyFormComponentImportsModule {
4603
4887
  static ɵinj: i0.ɵɵInjectorDeclaration<DbxFormlyFormComponentImportsModule>;
4604
4888
  }
4605
4889
 
4890
+ /**
4891
+ * Registers all dbx-form Formly field types, wrappers, and the core Formly + Material modules as providers.
4892
+ *
4893
+ * @returns Environment providers for all Formly field declarations
4894
+ */
4606
4895
  declare function provideDbxFormFormlyFieldDeclarations(): i0.EnvironmentProviders;
4607
4896
 
4608
4897
  /**
@@ -4617,8 +4906,18 @@ declare class DbxFormSpacerDirective {
4617
4906
  static ɵdir: i0.ɵɵDirectiveDeclaration<DbxFormSpacerDirective, "dbx-form-spacer,[dbxFormSpacer],.dbx-form-spacer", never, {}, {}, never, never, true, never>;
4618
4907
  }
4619
4908
 
4909
+ /**
4910
+ * Angular form validator that requires the control value to be truthy.
4911
+ *
4912
+ * @returns A ValidatorFn that fails when the value is falsy
4913
+ */
4620
4914
  declare function isTruthy(): ValidatorFn;
4621
4915
 
4916
+ /**
4917
+ * Angular form validator that checks whether the control value matches a website domain name pattern.
4918
+ *
4919
+ * @returns A ValidatorFn that validates against the domain name regex
4920
+ */
4622
4921
  declare function isDomain(): ValidatorFn;
4623
4922
 
4624
4923
  declare const FIELD_VALUES_ARE_EQUAL_VALIDATION_KEY = "fieldValuesAreEqual";
@@ -4676,19 +4975,23 @@ interface IsDivisibleByError {
4676
4975
  declare function isDivisibleBy(divisor: number): ValidatorFn;
4677
4976
 
4678
4977
  /**
4679
- * Angular Form ValidationFn for checking isE164PhoneNumber the input divisor.
4978
+ * Angular form validator that checks whether the control value is a valid E.164 phone number.
4680
4979
  *
4681
- * @param divisor
4682
- * @returns
4980
+ * @param allowExtension - Whether to allow phone number extensions in the value
4981
+ * @returns A ValidatorFn that validates E.164 phone numbers
4683
4982
  */
4684
4983
  declare function isE164PhoneNumber(allowExtension: boolean): ValidatorFn;
4685
4984
  /**
4686
4985
  * Angular Form ValidationFn for checking the input is a valid phone extension. Empty values return true.
4687
4986
  *
4688
- * @param divisor
4689
- * @returns
4987
+ * @returns A ValidatorFn that validates phone extension numbers
4690
4988
  */
4691
4989
  declare function isPhoneExtension(): ValidatorFn;
4990
+ /**
4991
+ * Angular form validator that checks the value is a valid E.164 phone number with a valid extension (if present).
4992
+ *
4993
+ * @returns A ValidatorFn that validates E.164 phone numbers with optional extensions
4994
+ */
4692
4995
  declare function isE164PhoneNumberWithValidExtension(): ValidatorFn;
4693
4996
 
4694
4997
  declare class DbxFormExtensionModule {
@@ -4701,6 +5004,13 @@ interface ProvideDbxFormConfigurationConfig {
4701
5004
  readonly provideDateAdapter?: boolean;
4702
5005
  readonly defaultDateTimePresets?: Maybe<DateTimePresetConfiguration[]>;
4703
5006
  }
5007
+ /**
5008
+ * Provides the core dbx-form configuration including Material form field defaults,
5009
+ * date adapter, and optional date-time presets.
5010
+ *
5011
+ * @param config - Optional configuration for the date adapter and default date-time presets
5012
+ * @returns Environment providers for dbx-form
5013
+ */
4704
5014
  declare function provideDbxFormConfiguration(config?: ProvideDbxFormConfigurationConfig): EnvironmentProviders;
4705
5015
 
4706
5016
  export { APP_ACTION_FORM_DISABLED_KEY, AbstractAsyncFormlyFormDirective, AbstractConfigAsyncFormlyFormDirective, AbstractDbxPickableItemFieldDirective, AbstractDbxSearchableFieldDisplayDirective, AbstractDbxSearchableValueFieldDirective, AbstractFormExpandSectionWrapperDirective, AbstractFormlyFormDirective, AbstractSyncFormlyFormDirective, AutoTouchFieldWrapperComponent, ChecklistItemFieldDataSetBuilder, DBX_DATE_TIME_FIELD_DATE_NOT_IN_SCHEDULE_ERROR, DBX_DATE_TIME_FIELD_MENU_PRESETS_TOKEN, DBX_DATE_TIME_FIELD_TIME_NOT_IN_RANGE_ERROR, DBX_FORMLY_FORM_COMPONENT_TEMPLATE, DBX_SEARCHABLE_FIELD_COMPONENT_DATA_TOKEN, DEFAULT_DATE_TIME_FIELD_MENU_PRESETS_PRESETS, DEFAULT_FORM_DISABLED_KEY, DEFAULT_HAS_VALUE_FN, DEFAULT_LAT_LNG_TEXT_FIELD_PATTERN_MESSAGE, DEFAULT_LAT_LNG_TEXT_FIELD_PLACEHOLDER, DEFAULT_PREFERRED_COUNTRIES, DISPLAY_FOR_TIMEZONE_STRING_VALUE, DbxActionFormDirective, DbxActionFormSafetyDirective, DbxChecklistItemContentComponent, DbxChecklistItemFieldComponent, DbxDateTimeFieldComponent, DbxDateTimeFieldMenuPresetsService, DbxDateTimeFieldTimeMode, DbxDateTimeValueMode, DbxDefaultChecklistItemFieldDisplayComponent, DbxDefaultSearchableFieldDisplayComponent, DbxFixedDateRangeFieldComponent, DbxFixedDateRangeFieldSelectionStrategy, DbxForm, DbxFormActionDialogComponent, DbxFormComponentFieldComponent, DbxFormExpandWrapperComponent, DbxFormExtensionModule, DbxFormFlexWrapperComponent, DbxFormFormlyArrayFieldModule, DbxFormFormlyBooleanFieldModule, DbxFormFormlyChecklistItemFieldModule, DbxFormFormlyComponentFieldModule, DbxFormFormlyDateFieldModule, DbxFormFormlyDbxListFieldModule, DbxFormFormlyFieldModule, DbxFormFormlyNumberFieldModule, DbxFormFormlyPhoneFieldModule, DbxFormFormlyPickableFieldModule, DbxFormFormlySearchableFieldModule, DbxFormFormlySourceSelectModule, DbxFormFormlyTextEditorFieldModule, DbxFormFormlyTextFieldModule, DbxFormFormlyWrapperModule, DbxFormInfoWrapperComponent, DbxFormLoadingSourceDirective, DbxFormLoginFieldModule, DbxFormModule, DbxFormRepeatArrayTypeComponent, DbxFormSearchFormComponent, DbxFormSectionWrapperComponent, DbxFormSourceDirective, DbxFormSourceSelectFieldComponent, DbxFormSpacerDirective, DbxFormState, DbxFormStyleWrapperComponent, DbxFormSubsectionWrapperComponent, DbxFormTextAvailableFieldModule, DbxFormTimezoneStringFieldModule, DbxFormToggleWrapperComponent, DbxFormValueChangeDirective, DbxFormWorkingWrapperComponent, DbxFormlyComponent, DbxFormlyContext, DbxFormlyFieldsContextDirective, DbxFormlyFormComponentImportsModule, DbxItemListFieldComponent, DbxMutableForm, DbxPhoneFieldComponent, DbxPickableChipListFieldComponent, DbxPickableListFieldComponent, DbxPickableListFieldItemListComponent, DbxPickableListFieldItemListViewComponent, DbxPickableListFieldItemListViewItemComponent, DbxSearchableChipFieldComponent, DbxSearchableFieldAutocompleteItemComponent, DbxSearchableTextFieldComponent, DbxTextEditorFieldComponent, FIELD_VALUES_ARE_EQUAL_VALIDATION_KEY, FIELD_VALUE_IS_AVAILABLE_ERROR_VALIDATION_KEY, FIELD_VALUE_IS_AVAILABLE_VALIDATION_KEY, INVALID_PHONE_NUMBER_EXTENSION_MESSAGE, INVALID_PHONE_NUMBER_MESSAGE, IS_DIVISIBLE_BY_VALIDATION_KEY, IS_NOT_WEBSITE_URL_VALIDATION_KEY, IS_NOT_WEBSITE_URL_WITH_EXPECTED_DOMAIN_VALIDATION_KEY, IS_NOT_WEBSITE_URL_WITH_PREFIX_VALIDATION_KEY, LABEL_STRING_MAX_LENGTH, MAX_LENGTH_VALIDATION_MESSAGE, MAX_VALIDATION_MESSAGE, MIN_LENGTH_VALIDATION_MESSAGE, MIN_VALIDATION_MESSAGE, PHONE_LABEL_MAX_LENGTH, REQUIRED_VALIDATION_MESSAGE, SEARCH_STRING_MAX_LENGTH, TAKE_NEXT_UPCOMING_TIME_CONFIG_OBS, addValueSelectionOptionFunction, addWrapperToFormlyFieldConfig, addressField, addressFormlyFields, addressLineField, addressListField, autoTouchWrapper, checkIsFieldFlexLayoutGroupFieldConfig, checkboxField, checklistItemField, chipTextField, cityField, componentField, countryField, dateRangeField, dateTimeField, dateTimePreset, dateTimeRangeField, dbxDateRangeIsSameDateRangeFieldValue, dbxDateTimeInputValueParseFactory, dbxDateTimeIsSameDateTimeFieldValue, dbxDateTimeOutputValueFactory, dbxFormSearchFormFields, dbxFormSourceObservable, dbxFormSourceObservableFromStream, dbxFormlyFormComponentProviders, dbxListField, defaultValidationMessages, disableFormlyFieldAutofillAttributes, dollarAmountField, emailField, expandWrapper, fieldValueIsAvailableValidator, fieldValuesAreEqualValidator, filterPartialPotentialFieldConfigValuesFromObject, filterPickableItemFieldValuesByLabel, filterPickableItemFieldValuesByLabelFilterFunction, fixedDateRangeField, flexLayoutWrapper, formlyField, hiddenField, infoWrapper, isDbxDateTimeFieldTimeDateConfig, isDivisibleBy, isDomain, isE164PhoneNumber, isE164PhoneNumberWithValidExtension, isInRange, isPhoneExtension, isTruthy, isWebsiteUrlValidator, latLngTextField, makeMetaFilterSearchableFieldValueDisplayFn, maxLengthValidationMessage, maxValidationMessage, mergePropsValueObjects, minLengthValidationMessage, minValidationMessage, nameField, numberField, numberFieldTransformParser, numberSliderField, partialPotentialFieldConfigKeys, partialPotentialFieldConfigKeysFilter, phoneAndLabelSectionField, phoneField, phoneListField, pickableItemChipField, pickableItemListField, pickableValueFieldValuesConfigForStaticLabeledValues, propsAndConfigForFieldConfig, propsValueForFieldConfig, provideDbxForm, provideDbxFormConfiguration, provideDbxFormFormlyFieldDeclarations, provideDbxMutableForm, provideFormlyContext, repeatArrayField, searchableChipField, searchableStringChipField, searchableTextField, sectionWrapper, sortPickableItemsByLabel, sortPickableItemsByLabelStringFunction, sourceSelectField, stateField, streamValueFromControl, styleWrapper, subsectionWrapper, syncConfigValueObs, textAreaField, textEditorField, textField, textFieldTransformParser, textIsAvailableField, textPasswordField, textPasswordWithVerifyFieldGroup, textVerifyPasswordField, timeOnlyField, timezoneStringField, timezoneStringSearchFunction, toggleDisableFormControl, toggleField, toggleWrapper, usernameLoginField, usernamePasswordLoginFields, validatorsForFieldConfig, valueSelectionField, websiteUrlField, workingWrapper, wrappedPhoneAndLabelField, zipCodeField };