@dereekb/dbx-form 13.10.8 → 13.11.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dereekb/dbx-form",
-  "version": "13.10.8",
+  "version": "13.11.0",
   "sideEffects": [
     "*.scss",
     "*.css"
@@ -14,15 +14,15 @@
     "@angular/material-date-fns-adapter": "21.2.9",
     "@angular/platform-browser": "21.2.11",
     "@bobbyquantum/ngx-editor": "21.0.0",
-    "@dereekb/date": "13.10.8",
-    "@dereekb/dbx-core": "13.10.8",
-    "@dereekb/dbx-web": "13.10.8",
-    "@dereekb/model": "13.10.8",
-    "@dereekb/rxjs": "13.10.8",
-    "@dereekb/util": "13.10.8",
-    "@dereekb/vitest": "13.10.8",
-    "@ng-forge/dynamic-forms": "0.9.0-next.3",
-    "@ng-forge/dynamic-forms-material": "0.9.0-next.3",
+    "@dereekb/date": "13.11.0",
+    "@dereekb/dbx-core": "13.11.0",
+    "@dereekb/dbx-web": "13.11.0",
+    "@dereekb/model": "13.11.0",
+    "@dereekb/rxjs": "13.11.0",
+    "@dereekb/util": "13.11.0",
+    "@dereekb/vitest": "13.11.0",
+    "@ng-forge/dynamic-forms": "0.9.0-next.6",
+    "@ng-forge/dynamic-forms-material": "0.9.0-next.6",
     "@ng-web-apis/geolocation": "^5.2.0",
     "@ngbracket/ngx-layout": "^21.0.0",
     "@ngrx/component-store": "^21.1.0",

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

@@ -113,6 +113,8 @@ declare abstract class DbxForm<T = unknown> {
      * value to feed user-supplied isValid/isModified functions even while the form is invalid.
      * Defaults to {@link getValue}; implementations that gate {@link getValue} on validity
      * should override this to bypass that gate.
+     *
+     * @returns An observable of the form's current value, even when validity gates would suppress {@link getValue}.
      */
     currentValue(): Observable<T>;
     /**
@@ -598,6 +600,8 @@ declare class DbxForgeFormContext<T = unknown> implements DbxMutableForm<T>, OnD
      * Emits the current form value regardless of {@link requireValid}. Used by infrastructure
      * that needs the underlying value while the form is invalid (e.g. {@link DbxActionFormDirective}
      * feeding the value into user-supplied isModified functions to drive the action's disabled state).
+     *
+     * @returns An observable of the latest non-null form value, regardless of validity.
      */
     currentValue(): Observable<T>;
     getDisabled(): Observable<BooleanStringKeyArray>;
@@ -941,7 +945,7 @@ declare function dbxFormSourceObservableFromStream<T>(streamObs: Observable<DbxF
 /**
  * Modes that define when to copy data from the source to the form.
  *
- * - `'reset'`: Only copy data when the form is reset.
+ * - `'reset'`: Only copy data when the form is reset or is untouched.
  * - `'always'`: Always copy data when the data observable emits a value. Has a throttle of 20ms to prevent too many emissions. If emissions occur in a manner that appears to be a loop (more than 30 emissions in 1 second), then an error is thrown and warning printed to the console.
  * - `'every'`: Equal to always, but has no throttle or error message warning.
  */
@@ -6967,11 +6971,21 @@ interface DbxForgeFlexLayoutConfig extends Omit<DbxForgeFlexWrapper, 'type'> {
      */
     readonly size?: DbxFlexSize;
 }
+/**
+ * Preferred overload: configure the flex layout with a single {@link DbxForgeFlexLayoutConfig} object.
+ *
+ * @param config - Layout configuration carrying `fields` and breakpoint/sizing defaults.
+ * @returns A {@link ContainerField} with the flex wrapper applied and per-child sizing classes.
+ */
 declare function dbxForgeFlexLayout(config: DbxForgeFlexLayoutConfig): ContainerField;
 /**
  * @deprecated Pass a {@link DbxForgeFlexLayoutConfig} object instead — the array form
  * diverges from how every other forge field factory is configured. Move array entries
  * into the `fields` property of the config object.
+ *
+ * @param fields - Child fields (or {@link DbxForgeFlexLayoutFieldConfig} entries with per-field size overrides).
+ * @param config - Optional layout config (without `fields`) carrying breakpoint/sizing defaults.
+ * @returns A {@link ContainerField} with the flex wrapper applied and per-child sizing classes.
  */
 declare function dbxForgeFlexLayout(fields: readonly (FieldDef<unknown> | DbxForgeFlexLayoutFieldConfig)[], config?: Omit<DbxForgeFlexLayoutConfig, 'fields'>): ContainerField;
 
@@ -7030,8 +7044,8 @@ declare function configureDbxForgeFormFieldWrapper<C extends DbxForgeFieldFuncti
  * config entirely when no values remain — keeps the wrapper bare in the common case
  * (e.g. a checkbox/toggle with no label override).
  *
- * @param props - wrapper props applied to the inserted wrapper config
- * @returns a configurator that mutates the builder instance to add the wrapper
+ * @param inputProps - Wrapper props applied to the inserted wrapper config; undefined entries are stripped and the `props` block is omitted entirely when no values remain.
+ * @returns A configurator that mutates the builder instance to add the form-field wrapper with the resolved props.
  */
 declare function configureDbxForgeFormFieldWrapperWith(inputProps?: Maybe<DbxForgeFormFieldWrapperProps>): <C extends DbxForgeFieldFunctionDef<any>>(instance: DbxForgeFieldFunctionFieldDefBuilderFunctionInstance<C>) => void;