@dereekb/dbx-form 13.6.16 → 13.7.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/dbx-form",
-  "version": "13.6.16",
+  "version": "13.7.0",
   "peerDependencies": {
     "@angular/cdk": "21.2.3",
     "@angular/common": "21.2.3",
@@ -10,12 +10,13 @@
     "@angular/material-date-fns-adapter": "21.2.3",
     "@angular/platform-browser": "21.2.3",
     "@bobbyquantum/ngx-editor": "21.0.0",
-    "@dereekb/date": "13.6.16",
-    "@dereekb/dbx-core": "13.6.16",
-    "@dereekb/dbx-web": "13.6.16",
-    "@dereekb/model": "13.6.16",
-    "@dereekb/rxjs": "13.6.16",
-    "@dereekb/util": "13.6.16",
+    "@dereekb/date": "13.7.0",
+    "@dereekb/dbx-core": "13.7.0",
+    "@dereekb/dbx-web": "13.7.0",
+    "@dereekb/model": "13.7.0",
+    "@dereekb/rxjs": "13.7.0",
+    "@dereekb/util": "13.7.0",
+    "@dereekb/vitest": "13.7.0",
     "@ng-web-apis/geolocation": "^5.1.0",
     "@ngbracket/ngx-layout": "^21.0.0",
     "@ngrx/component-store": "^21.0.0",

package/types/dereekb-dbx-form.d.ts

@@ -638,26 +638,32 @@ declare const INVALID_PHONE_NUMBER_EXTENSION_MESSAGE: {
  * Returns a validation message indicating the duration is below the minimum allowed.
  *
  * @param err - The validation error object containing `min` and `actual` values.
- * @param field - The Formly field configuration.
+ * @param err.min - The minimum allowed duration value.
+ * @param err.actual - The actual duration value that failed validation.
+ * @param err.unit - The duration unit label (e.g. "minutes", "hours").
+ * @param _field - The Formly field configuration.
  * @returns A human-readable validation message string.
  */
 declare function durationMinValidationMessage(err: {
     min: number;
     actual: number;
     unit: string;
-}, field: FieldTypeConfig): string;
+}, _field: FieldTypeConfig): string;
 /**
  * Returns a validation message indicating the duration exceeds the maximum allowed.
  *
  * @param err - The validation error object containing `max`, `actual`, and `unit` values.
- * @param field - The Formly field configuration.
+ * @param err.max - The maximum allowed duration value.
+ * @param err.actual - The actual duration value that failed validation.
+ * @param err.unit - The duration unit label (e.g. "minutes", "hours").
+ * @param _field - The Formly field configuration.
  * @returns A human-readable validation message string.
  */
 declare function durationMaxValidationMessage(err: {
     max: number;
     actual: number;
     unit: string;
-}, field: FieldTypeConfig): string;
+}, _field: FieldTypeConfig): string;
 /**
  * Validation message option for duration minimum violations.
  */
@@ -3944,6 +3950,8 @@ declare class DbxTimeDurationFieldComponent extends FieldType$1<FieldTypeConfig<
     /**
      * Units used for decomposing/displaying duration text.
      * Includes 'ms' if the smallest picker unit would leave a remainder.
+     *
+     * @returns The list of time units used for display, always including 'ms'.
      */
     get displayUnits(): TimeUnit[];
     ngOnInit(): void;
@@ -3953,6 +3961,8 @@ declare class DbxTimeDurationFieldComponent extends FieldType$1<FieldTypeConfig<
     onTextBlur(): void;
     /**
      * Called when Enter is pressed in the text input.
+     *
+     * @param event - The keyboard event from pressing Enter; prevented to avoid form submission.
      */
     onTextEnter(event: Event): void;
     /**
@@ -3966,10 +3976,15 @@ declare class DbxTimeDurationFieldComponent extends FieldType$1<FieldTypeConfig<
     private _parseAndSync;
     /**
      * Converts duration data to the output value and sets it on the form control.
+     *
+     * @param data - The decomposed duration data to convert and emit.
      */
     private _syncOutputFromDurationData;
     /**
      * Converts an output value (number, HoursAndMinutes, or TimeDurationData) to milliseconds.
+     *
+     * @param value - The output value to convert, interpreted according to the current {@link valueMode}.
+     * @returns The equivalent duration in milliseconds.
      */
     private _outputValueToMilliseconds;
     static ɵfac: i0.ɵɵFactoryDeclaration<DbxTimeDurationFieldComponent, never>;
@@ -4107,6 +4122,7 @@ declare class DbxDurationPickerPopoverComponent extends AbstractPopoverDirective
      * When carryOver is enabled, normalizes the data by converting to total milliseconds
      * and decomposing back into the picker's units (e.g., 60s becomes 1m, 7d becomes 1w).
      *
+     * @param data - The duration data to potentially normalize.
      * @returns Normalized or original data
      */
     private _normalizeIfCarryOver;
@@ -4125,6 +4141,8 @@ declare class DbxDurationPickerPopoverComponent extends AbstractPopoverDirective
     onHoldStart(action: 'increment' | 'decrement', unit: TimeUnit, event: Event): void;
     /**
      * Returns the current step based on whether shift is held.
+     *
+     * @returns 2 if shift is held, 1 otherwise.
      */
     private get _currentStep();
     /**
@@ -4141,7 +4159,10 @@ declare class DbxDurationPickerPopoverComponent extends AbstractPopoverDirective
     /**
      * Executes an increment or decrement action if allowed.
      *
-     * @returns True if the action was performed
+     * @param action - Whether to increment or decrement the value.
+     * @param unit - The time unit to modify (e.g., 'h', 'min', 's').
+     * @param step - The number of units to add or subtract per action.
+     * @returns True if the action was performed.
      */
     private _doAction;
     static ɵfac: i0.ɵɵFactoryDeclaration<DbxDurationPickerPopoverComponent, never>;