@xyo-network/react-form-group 4.1.5 → 4.1.7

package/dist/browser/FormGroup.d.ts

@@ -15,6 +15,11 @@ export type FormGroupParams<TStorageValue extends Payload = Payload> = {
     };
     ttlStorage?: number;
 };
+/**
+ * Organize form controls in a group.
+ *
+ * NOTE: This is a work in progress and only supports top level controls.  Nested controls are not supported.
+ */
 export declare class FormGroup<TValue extends PayloadWithTimestamp = PayloadWithTimestamp, TStorageValue extends PayloadWithTimestamp = PayloadWithTimestamp> extends AbstractControl {
     private fgParams?;
     private _controls;

package/dist/browser/FormGroup.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FormGroup.d.ts","sourceRoot":"","sources":["../../src/FormGroup.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAGzD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AACnD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAE1D,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAAA;AAElE,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,MAAM,CAAC,SAAS,MAAM,GAAG,MAAM,CAAC,GAAG,KAAK,CAAA;AAErE,KAAK,eAAe,CAAC,MAAM,IAAI,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAA;AAElE,MAAM,MAAM,eAAe,CAAC,aAAa,SAAS,OAAO,GAAG,OAAO,IAAI;IACrE,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,OAAO,CAAC,EAAE;QACR,SAAS,CAAC,EAAE,gBAAgB,CAAC,aAAa,CAAC,CAAA;QAC3C,OAAO,CAAC,EAAE,gBAAgB,CAAC,aAAa,CAAC,CAAA;KAC1C,CAAA;IACD,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AASD,qBAAa,SAAS,CACpB,MAAM,SAAS,oBAAoB,GAAG,oBAAoB,EAC1D,aAAa,SAAS,oBAAoB,GAAG,oBAAoB,CACjE,SAAQ,eAAe;IAQX,OAAO,CAAC,QAAQ,CAAC;IAP7B,OAAO,CAAC,SAAS,CAAqD;IAEtE,OAAO,CAAC,kBAAkB,CAA+C;IAEzE,OAAO,CAAC,wBAAwB,CAAmD;IACnF,OAAO,CAAC,eAAe,CAAmD;gBAEtD,QAAQ,CAAC,EAAE,eAAe,CAAC,aAAa,CAAC,YAAA;IAI7D,IAAI,YAAY,iBAaf;IAED,IAAI,MAAM,IAAI,eAAe,CAAC,MAAM,CAAC,CAOpC;IAED,IAAI,mBAAmB,gDAEtB;IAED,IAAI,gBAAgB,gDAEnB;IAED,IAAa,OAAO,YAEnB;IAED,IAAa,KAAK,YAEjB;IAED,IAAI,MAAM,IAAI,MAAM,CAOnB;IAED,UAAU,CAAC,IAAI,EAAE,MAAM;IAIjB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,UAAQ,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAwBtF,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe;IAMtD,aAAa;IAMb,WAAW;IAMX,iBAAiB,CAAC,IAAI,EAAE,MAAM;IAW9B,cAAc,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS;IAWpD,OAAO,CAAC,qBAAqB;IAuC7B,OAAO,CAAC,eAAe;IAUvB,OAAO,CAAC,wBAAwB;CAcjC"}
+{"version":3,"file":"FormGroup.d.ts","sourceRoot":"","sources":["../../src/FormGroup.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AAGzD,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAA;AACnD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAA;AAE1D,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC;IAAE,SAAS,CAAC,EAAE,MAAM,CAAA;CAAE,CAAC,CAAA;AAElE,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI,MAAM,CAAC,SAAS,MAAM,GAAG,MAAM,CAAC,GAAG,KAAK,CAAA;AAErE,KAAK,eAAe,CAAC,MAAM,IAAI,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,CAAA;AAElE,MAAM,MAAM,eAAe,CAAC,aAAa,SAAS,OAAO,GAAG,OAAO,IAAI;IACrE,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,OAAO,CAAC,EAAE;QACR,SAAS,CAAC,EAAE,gBAAgB,CAAC,aAAa,CAAC,CAAA;QAC3C,OAAO,CAAC,EAAE,gBAAgB,CAAC,aAAa,CAAC,CAAA;KAC1C,CAAA;IACD,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAID;;;;GAIG;AACH,qBAAa,SAAS,CACpB,MAAM,SAAS,oBAAoB,GAAG,oBAAoB,EAC1D,aAAa,SAAS,oBAAoB,GAAG,oBAAoB,CACjE,SAAQ,eAAe;IAQX,OAAO,CAAC,QAAQ,CAAC;IAP7B,OAAO,CAAC,SAAS,CAAqD;IAEtE,OAAO,CAAC,kBAAkB,CAA+C;IAEzE,OAAO,CAAC,wBAAwB,CAAmD;IACnF,OAAO,CAAC,eAAe,CAAmD;gBAEtD,QAAQ,CAAC,EAAE,eAAe,CAAC,aAAa,CAAC,YAAA;IAI7D,IAAI,YAAY,iBAaf;IAED,IAAI,MAAM,IAAI,eAAe,CAAC,MAAM,CAAC,CAOpC;IAED,IAAI,mBAAmB,gDAEtB;IAED,IAAI,gBAAgB,gDAEnB;IAED,IAAa,OAAO,YAEnB;IAED,IAAa,KAAK,YAEjB;IAED,IAAI,MAAM,IAAI,MAAM,CAOnB;IAED,UAAU,CAAC,IAAI,EAAE,MAAM;IAIjB,kBAAkB,CAAC,IAAI,EAAE,MAAM,EAAE,SAAS,UAAQ,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAwBtF,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,eAAe;IAMtD,aAAa;IAMb,WAAW;IAMX,iBAAiB,CAAC,IAAI,EAAE,MAAM;IAW9B,cAAc,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,GAAG,SAAS;IAWpD,OAAO,CAAC,qBAAqB;IAuC7B,OAAO,CAAC,eAAe;IAUvB,OAAO,CAAC,wBAAwB;CAcjC"}

package/dist/browser/context/Provider.d.ts

@@ -4,5 +4,8 @@ import type { FormGroupParams } from '../FormGroup.ts';
 export interface FormGroupPayloadProviderProps<TStorage extends Payload = Payload> extends PropsWithChildren {
     params?: FormGroupParams<TStorage>;
 }
+/**
+ * Provides a FormGroup to child components.
+ */
 export declare const FormGroupPayloadProvider: ({ children, params, ...props }: FormGroupPayloadProviderProps) => import("react/jsx-runtime").JSX.Element;
 //# sourceMappingURL=Provider.d.ts.map

package/dist/browser/context/Provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Provider.d.ts","sourceRoot":"","sources":["../../../src/context/Provider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAA;AAG9C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAItD,MAAM,WAAW,6BAA6B,CAAC,QAAQ,SAAS,OAAO,GAAG,OAAO,CAAE,SAAQ,iBAAiB;IAC1G,MAAM,CAAC,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAA;CACnC;AAKD,eAAO,MAAM,wBAAwB,mCAElC,6BAA6B,4CAiB/B,CAAA"}
+{"version":3,"file":"Provider.d.ts","sourceRoot":"","sources":["../../../src/context/Provider.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,4BAA4B,CAAA;AACzD,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAA;AAG9C,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAA;AAItD,MAAM,WAAW,6BAA6B,CAAC,QAAQ,SAAS,OAAO,GAAG,OAAO,CAAE,SAAQ,iBAAiB;IAC1G,MAAM,CAAC,EAAE,eAAe,CAAC,QAAQ,CAAC,CAAA;CACnC;AAED;;GAEG;AACH,eAAO,MAAM,wBAAwB,mCAElC,6BAA6B,4CAiB/B,CAAA"}

package/dist/browser/control/AbstractControl.d.ts

@@ -5,15 +5,67 @@ export type AbstractControlEvents<TValue> = ControlValueAccessorBaseEvents<TValu
         status: FormControlStatus;
     };
 };
+/**
+ * This is the base class for `Control` classes (i.e. FormControl),
+ *
+ * It provides some of the shared behavior that all controls and groups of controls have, like
+ * running validators, calculating status, and resetting state. It also defines the properties
+ * that are shared between all sub-classes, like `value`, `valid`, and `dirty`. It shouldn't be
+ * instantiated directly.
+ *
+ * NOTE: Heavily borrowed from Angular's AbstractControl:
+ * https://github.com/angular/angular/blob/5dcdbfcba934a930468aec140a7183b034466bdf/packages/forms/src/model/abstract_model.ts
+ */
 export declare class AbstractControl<TValue extends ValidControlValue = ValidControlValue> extends ControlValueAccessorBase<TValue, AbstractControlEvents<TValue>> {
     private _status;
     constructor();
+    /**
+     * A control is `disabled` when its `status` is `DISABLED`.
+     *
+     * Disabled controls are exempt from validation checks and
+     * are not included in the aggregate value of their ancestor
+     * controls.
+     *
+     * @returns True if the control is disabled, false otherwise.
+     */
+    /** @deprecated - disabled functionality not implemented */
     get disabled(): boolean;
+    /**
+     * A control is `enabled` as long as its `status` is not `DISABLED`.
+     *
+     * @returns True if the control has any status other than 'DISABLED',
+     * false if the status is 'DISABLED'.
+     */
     get enabled(): boolean;
+    /**
+     * A control is `invalid` when its `status` is `INVALID`.
+  
+     *
+     * @returns True if this control has failed one or more of its validation checks,
+     * false otherwise.
+     */
     get invalid(): boolean;
+    /**
+     * A control is `pending` when its `status` is `PENDING`.
+     *
+     * @returns True if this control is in the process of conducting a validation check,
+     * false otherwise.
+     */
     get pending(): boolean;
+    /**
+     * The raw value of the control.
+     */
     get rawValue(): TValue;
+    /**
+     * The current status of the control.
+     */
     get status(): FormControlStatus | undefined;
+    /**
+     * A control is `valid` when its `status` is `VALID`.
+     *
+     * @returns True if the control has passed all of its validation tests,
+     * false otherwise.
+     */
     get valid(): boolean;
     setErrorAndValidity(error: string, status: FormControlStatus): void;
     setStatus(status: FormControlStatus): void;

package/dist/browser/control/AbstractControl.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractControl.d.ts","sourceRoot":"","sources":["../../../src/control/AbstractControl.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,8BAA8B,EAC9B,iBAAiB,EACjB,iBAAiB,EAClB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EACL,wBAAwB,EAKzB,MAAM,qBAAqB,CAAA;AAE5B,MAAM,MAAM,qBAAqB,CAAC,MAAM,IAAI,8BAA8B,CAAC,MAAM,CAAC,GAAG;IACnF,aAAa,EAAE;QAAE,MAAM,EAAE,iBAAiB,CAAA;KAAE,CAAA;CAC7C,CAAA;AAaD,qBAAa,eAAe,CAAC,MAAM,SAAS,iBAAiB,GAAG,iBAAiB,CAAE,SAAQ,wBAAwB,CACjH,MAAM,EACN,qBAAqB,CAAC,MAAM,CAAC,CAC9B;IACC,OAAO,CAAC,OAAO,CAA2C;;IAgB1D,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAQD,IAAI,OAAO,IAAI,OAAO,CAErB;IASD,IAAI,OAAO,IAAI,OAAO,CAErB;IAQD,IAAI,OAAO,IAAI,OAAO,CAErB;IAKD,IAAI,QAAQ,IAAI,MAAM,CAErB;IAKD,IAAI,MAAM,kCAET;IAQD,IAAI,KAAK,IAAI,OAAO,CAEnB;IAED,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB;IAK5D,SAAS,CAAC,MAAM,EAAE,iBAAiB;IASnC,QAAQ,IAAI,OAAO;CAGpB"}
+{"version":3,"file":"AbstractControl.d.ts","sourceRoot":"","sources":["../../../src/control/AbstractControl.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,8BAA8B,EAC9B,iBAAiB,EACjB,iBAAiB,EAClB,MAAM,qBAAqB,CAAA;AAC5B,OAAO,EACL,wBAAwB,EAKzB,MAAM,qBAAqB,CAAA;AAE5B,MAAM,MAAM,qBAAqB,CAAC,MAAM,IAAI,8BAA8B,CAAC,MAAM,CAAC,GAAG;IACnF,aAAa,EAAE;QAAE,MAAM,EAAE,iBAAiB,CAAA;KAAE,CAAA;CAC7C,CAAA;AAED;;;;;;;;;;GAUG;AACH,qBAAa,eAAe,CAAC,MAAM,SAAS,iBAAiB,GAAG,iBAAiB,CAAE,SAAQ,wBAAwB,CACjH,MAAM,EACN,qBAAqB,CAAC,MAAM,CAAC,CAC9B;IACC,OAAO,CAAC,OAAO,CAA2C;;IAM1D;;;;;;;;OAQG;IACH,2DAA2D;IAC3D,IAAI,QAAQ,IAAI,OAAO,CAEtB;IAED;;;;;OAKG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;;;;;OAMG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;;;;OAKG;IACH,IAAI,OAAO,IAAI,OAAO,CAErB;IAED;;OAEG;IACH,IAAI,QAAQ,IAAI,MAAM,CAErB;IAED;;OAEG;IACH,IAAI,MAAM,kCAET;IAED;;;;;OAKG;IACH,IAAI,KAAK,IAAI,OAAO,CAEnB;IAED,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,iBAAiB;IAK5D,SAAS,CAAC,MAAM,EAAE,iBAAiB;IASnC,QAAQ,IAAI,OAAO;CAGpB"}

package/dist/browser/control/FormControlBase.d.ts

@@ -2,7 +2,13 @@ import type { EmptyObject } from '@xylabs/object';
 import { AbstractControl } from './AbstractControl.ts';
 import type { SetOptions } from './accessor/index.ts';
 import type { CursorPosition, FormControl } from './FormControl.ts';
+/**
+ * A base class for form controls and their validation.
+ */
 export declare abstract class FormControlBase<TProps extends EmptyObject = EmptyObject> extends AbstractControl implements FormControl {
+    /**
+     * The current and previous cursor position of the input element.
+     */
     cursorPosition: CursorPosition;
     invalidMessage: string;
     pattern: RegExp;

package/dist/browser/control/FormControlBase.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FormControlBase.d.ts","sourceRoot":"","sources":["../../../src/control/FormControlBase.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAOnE,8BAAsB,eAAe,CAAC,MAAM,SAAS,WAAW,GAAG,WAAW,CAAE,SAAQ,eAAgB,YAAW,WAAW;IAI5H,cAAc,EAAE,cAAc,CAA8C;IAE5E,cAAc,SAAkB;IAChC,OAAO,SAAgB;IACvB,aAAa,SAAgB;IAC7B,KAAK,EAAS,MAAM,CAAA;IACpB,QAAQ,UAAQ;IAEhB,OAAO,CAAC,KAAK,CAAgC;;IAM7C,IAAI,IAAI,uBAEP;IAED,IAAa,QAAQ,gEAEpB;IAED,SAAS,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAC3C,WAAW,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IACjC,iBAAiB,CAAC,IAAI,MAAM,GAAG,SAAS;IACxC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAC5B,cAAc,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,KAAK,IAAI,CAAW;IAEtD,QAAQ,CAAC,KAAK,EAAE,MAAM,YAAK,EAAE,UAAU,EAAE,UAAU;IA0B5D,MAAM,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAGrB,QAAQ,IAAI,OAAO;IAQ5B,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;CAG3C"}
+{"version":3,"file":"FormControlBase.d.ts","sourceRoot":"","sources":["../../../src/control/FormControlBase.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAA;AAEjD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AACtD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAA;AACrD,OAAO,KAAK,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAA;AAInE;;GAEG;AACH,8BAAsB,eAAe,CAAC,MAAM,SAAS,WAAW,GAAG,WAAW,CAAE,SAAQ,eAAgB,YAAW,WAAW;IAC5H;;OAEG;IACH,cAAc,EAAE,cAAc,CAA8C;IAE5E,cAAc,SAAkB;IAChC,OAAO,SAAgB;IACvB,aAAa,SAAgB;IAC7B,KAAK,EAAS,MAAM,CAAA;IACpB,QAAQ,UAAQ;IAEhB,OAAO,CAAC,KAAK,CAAgC;;IAM7C,IAAI,IAAI,uBAEP;IAED,IAAa,QAAQ,gEAEpB;IAED,SAAS,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS;IAC3C,WAAW,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IACjC,iBAAiB,CAAC,IAAI,MAAM,GAAG,SAAS;IACxC,IAAI,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAC5B,cAAc,EAAE,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,KAAK,IAAI,CAAW;IAEtD,QAAQ,CAAC,KAAK,EAAE,MAAM,YAAK,EAAE,UAAU,EAAE,UAAU;IA0B5D,MAAM,CAAC,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAGrB,QAAQ,IAAI,OAAO;IAQ5B,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS;CAG3C"}

package/dist/browser/control/accessor/ControlValueAccessorBase.d.ts

@@ -17,6 +17,9 @@ export type ControlValueAccessorBaseEvents<TValue = ValidControlValue> = {
         value: TValue;
     };
 };
+/**
+ * The base class for control value accessors interface
+ */
 export declare class ControlValueAccessorBase<TValue = ValidControlValue, TEventData extends ControlValueAccessorBaseEvents<TValue> = ControlValueAccessorBaseEvents<TValue>> extends BaseEmitter<BaseParams, TEventData> implements ControlValueAccessor<TValue> {
     private config;
     private _error;
@@ -25,21 +28,82 @@ export declare class ControlValueAccessorBase<TValue = ValidControlValue, TEvent
     private _touched;
     private _value;
     constructor(config: ControlValueAccessorBaseConfig);
+    /**
+     * The error message for the control.
+     */
     get error(): string;
+    /**
+     * The "previous value" of the input element.
+     */
     get previousValue(): TValue;
+    /**
+     * The serialize settings of the input element.
+     */
     get serializeSettings(): ControlSerializeSettings;
+    /**
+     * The "touched" state of the input element.
+     */
     get touched(): boolean;
+    /**
+     * The current value of the input element.
+     */
     get value(): TValue;
+    /**
+     * The registered callback function called when a change or input event occurs on the input
+     * element.
+     */
     onChange: (_: TValue) => void;
+    /**
+     * Registers a function called when the control error changes.
+     */
     onErrorChange: (error: string) => void;
+    /**
+     * The registered callback function called when a blur event occurs on the input element.
+     */
     onTouched: (_isTouched: boolean) => void;
+    /**
+     * Registers a function called when the control value changes.
+     * @param  {(_value:ValidControlValue)=>void} fn
+     * @returns void
+     */
     registerOnChange(fn: (_value: TValue) => void): void;
+    /**
+     * Registers a function called when the control error changes.
+     * @param  {(error:string)=>void} fn
+     */
     registerOnErrorChange(fn: (error: string) => void): void;
+    /**
+     * Registers a function called when the control is touched.
+     * @param  {(isTouched:boolean)=>void} fn
+     * @returns void
+     */
     registerOnTouched(fn: (isTouched: boolean) => void): void;
+    /**
+     * Sets the "touched" state of the input element.
+     * @param  {boolean} isTouched
+     */
     setTouched(isTouched: boolean): void;
+    /**
+     * Sets the "value" property on the input element.
+     * @param  {ValidControlValue} value
+     * @returns void
+     */
     setValue(value: TValue, options?: SetOptions): void;
+    /**
+     * Set the error message for the control.
+     * @param  {string} error
+     */
     protected setError(error: string): void;
+    /**
+     * Sets the "previous value" of the input element.
+     * @param  {ValidControlValue} value
+     * @returns void
+     */
     protected setPreviousValue(value: TValue): void;
+    /**
+     * Sets the serialize settings  of the input element.
+     * @param  {ControlSerializeSettings} settings
+     */
     protected setSerializeSettings(settings: ControlSerializeSettings): void;
 }
 //# sourceMappingURL=ControlValueAccessorBase.d.ts.map

package/dist/browser/control/accessor/ControlValueAccessorBase.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ControlValueAccessorBase.d.ts","sourceRoot":"","sources":["../../../../src/control/accessor/ControlValueAccessorBase.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAE1D,OAAO,KAAK,EACV,wBAAwB,EAAE,oBAAoB,EAAE,UAAU,EAC3D,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAE/D,MAAM,MAAM,8BAA8B,GAAG;IAC3C,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB,CAAA;AAED,eAAO,MAAM,iBAAiB,EAAE,UAAmC,CAAA;AAEnE,MAAM,MAAM,8BAA8B,CAAC,MAAM,GAAG,iBAAiB,IAAI;IACvE,YAAY,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IAC/B,YAAY,EAAE;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAA;IAClC,YAAY,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;CAChC,CAAA;AAKD,qBAAa,wBAAwB,CACnC,MAAM,GAAG,iBAAiB,EAC1B,UAAU,SAAS,8BAA8B,CAAC,MAAM,CAAC,GAAG,8BAA8B,CAAC,MAAM,CAAC,CAElG,SAAQ,WAAW,CAAC,UAAU,EAAE,UAAU,CAC1C,YAAW,oBAAoB,CAAC,MAAM,CAAC;IAW3B,OAAO,CAAC,MAAM;IAV1B,OAAO,CAAC,MAAM,CAAa;IAE3B,OAAO,CAAC,cAAc,CAAsB;IAE5C,OAAO,CAAC,kBAAkB,CAAsE;IAEhG,OAAO,CAAC,QAAQ,CAAiB;IAEjC,OAAO,CAAC,MAAM,CAAsB;gBAEhB,MAAM,EAAE,8BAA8B;IAO1D,IAAI,KAAK,WAER;IAKD,IAAI,aAAa,WAEhB;IAKD,IAAI,iBAAiB,6BAEpB;IAKD,IAAI,OAAO,YAEV;IAKD,IAAI,KAAK,WAER;IAMD,QAAQ,MAAO,MAAM,UAAO;IAK5B,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAW;IAKjD,SAAS,eAAgB,OAAO,UAAO;IAOvC,gBAAgB,CAAC,EAAE,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAQpD,qBAAqB,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI;IASjD,iBAAiB,CAAC,EAAE,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,GAAG,IAAI;IAQzD,UAAU,CAAC,SAAS,EAAE,OAAO;IAgB7B,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,aAAoB,GAAG,IAAI;IAmB1D,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM;IAgBhC,SAAS,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAQ/C,SAAS,CAAC,oBAAoB,CAAC,QAAQ,EAAE,wBAAwB;CAGlE"}
+{"version":3,"file":"ControlValueAccessorBase.d.ts","sourceRoot":"","sources":["../../../../src/control/accessor/ControlValueAccessorBase.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAA;AAChD,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAE1D,OAAO,KAAK,EACV,wBAAwB,EAAE,oBAAoB,EAAE,UAAU,EAC3D,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAE/D,MAAM,MAAM,8BAA8B,GAAG;IAC3C,aAAa,CAAC,EAAE,OAAO,CAAA;CACxB,CAAA;AAED,eAAO,MAAM,iBAAiB,EAAE,UAAmC,CAAA;AAEnE,MAAM,MAAM,8BAA8B,CAAC,MAAM,GAAG,iBAAiB,IAAI;IACvE,YAAY,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;IAC/B,YAAY,EAAE;QAAE,OAAO,EAAE,OAAO,CAAA;KAAE,CAAA;IAClC,YAAY,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,CAAA;CAChC,CAAA;AAED;;GAEG;AACH,qBAAa,wBAAwB,CACnC,MAAM,GAAG,iBAAiB,EAC1B,UAAU,SAAS,8BAA8B,CAAC,MAAM,CAAC,GAAG,8BAA8B,CAAC,MAAM,CAAC,CAElG,SAAQ,WAAW,CAAC,UAAU,EAAE,UAAU,CAC1C,YAAW,oBAAoB,CAAC,MAAM,CAAC;IAW3B,OAAO,CAAC,MAAM;IAV1B,OAAO,CAAC,MAAM,CAAa;IAE3B,OAAO,CAAC,cAAc,CAAsB;IAE5C,OAAO,CAAC,kBAAkB,CAAsE;IAEhG,OAAO,CAAC,QAAQ,CAAiB;IAEjC,OAAO,CAAC,MAAM,CAAsB;gBAEhB,MAAM,EAAE,8BAA8B;IAI1D;;OAEG;IACH,IAAI,KAAK,WAER;IAED;;OAEG;IACH,IAAI,aAAa,WAEhB;IAED;;OAEG;IACH,IAAI,iBAAiB,6BAEpB;IAED;;OAEG;IACH,IAAI,OAAO,YAEV;IAED;;OAEG;IACH,IAAI,KAAK,WAER;IAED;;;OAGG;IACH,QAAQ,MAAO,MAAM,UAAO;IAE5B;;OAEG;IACH,aAAa,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAW;IAEjD;;OAEG;IACH,SAAS,eAAgB,OAAO,UAAO;IAEvC;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,IAAI;IAIpD;;;OAGG;IACH,qBAAqB,CAAC,EAAE,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI;IAIjD;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,EAAE,CAAC,SAAS,EAAE,OAAO,KAAK,IAAI,GAAG,IAAI;IAIzD;;;OAGG;IACH,UAAU,CAAC,SAAS,EAAE,OAAO;IAW7B;;;;OAIG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,aAAoB,GAAG,IAAI;IAe1D;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,KAAK,EAAE,MAAM;IAWhC;;;;OAIG;IACH,SAAS,CAAC,gBAAgB,CAAC,KAAK,EAAE,MAAM,GAAG,IAAI;IAI/C;;;OAGG;IACH,SAAS,CAAC,oBAAoB,CAAC,QAAQ,EAAE,wBAAwB;CAGlE"}

package/dist/browser/control/accessor/FormControlStatus.d.ts

@@ -1,6 +1,33 @@
+/**
+ * Reports that a control is valid, meaning that no errors exist in the input value.
+ */
 export declare const VALID: "VALID";
+/**
+ * Reports that a control is invalid, meaning that an error exists in the input value.
+ */
 export declare const INVALID: "INVALID";
+/**
+ * Reports that a control is pending, meaning that async validation is occurring and
+ * errors are not yet available for the input value.
+ */
 export declare const PENDING: "PENDING";
+/**
+ * Reports that a control is disabled, meaning that the control is exempt from ancestor
+ * calculations of validity or value.
+ */
 export declare const DISABLED: "DISABLED";
+/**
+ * A control can have several different statuses. Each
+ * possible status is returned as a string literal.
+ *
+ * * **VALID**: Reports that a control is valid, meaning that no errors exist in the input
+ * value.
+ * * **INVALID**: Reports that a control is invalid, meaning that an error exists in the input
+ * value.
+ * * **PENDING**: Reports that a control is pending, meaning that async validation is
+ * occurring and errors are not yet available for the input value.
+ * * **DISABLED**: Reports that a control is
+ * disabled, meaning that the control is exempt from ancestor calculations of validity or value.
+ */
 export type FormControlStatus = typeof VALID | typeof INVALID | typeof PENDING | typeof DISABLED;
 //# sourceMappingURL=FormControlStatus.d.ts.map

package/dist/browser/control/accessor/FormControlStatus.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"FormControlStatus.d.ts","sourceRoot":"","sources":["../../../../src/control/accessor/FormControlStatus.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,KAAK,SAAmB,CAAA;AAKrC,eAAO,MAAM,OAAO,WAAqB,CAAA;AAMzC,eAAO,MAAM,OAAO,WAAqB,CAAA;AAMzC,eAAO,MAAM,QAAQ,YAAsB,CAAA;AAe3C,MAAM,MAAM,iBAAiB,GAAG,OAAO,KAAK,GAAG,OAAO,OAAO,GAAG,OAAO,OAAO,GAAG,OAAO,QAAQ,CAAA"}
+{"version":3,"file":"FormControlStatus.d.ts","sourceRoot":"","sources":["../../../../src/control/accessor/FormControlStatus.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,eAAO,MAAM,KAAK,SAAmB,CAAA;AAErC;;GAEG;AACH,eAAO,MAAM,OAAO,WAAqB,CAAA;AAEzC;;;GAGG;AACH,eAAO,MAAM,OAAO,WAAqB,CAAA;AAEzC;;;GAGG;AACH,eAAO,MAAM,QAAQ,YAAsB,CAAA;AAE3C;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,KAAK,GAAG,OAAO,OAAO,GAAG,OAAO,OAAO,GAAG,OAAO,QAAQ,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyo-network/react-form-group",
-  "version": "4.1.5",
+  "version": "4.1.7",
   "description": "Common React library for all XYO projects that use React",
   "keywords": [
     "xyo",
@@ -43,22 +43,22 @@
     "lint-pkg": "npmPkgJsonLint ."
   },
   "dependencies": {
-    "@mui/icons-material": "^6.1.4",
-    "@xylabs/forget": "^4.2.2",
-    "@xylabs/object": "^4.2.2",
-    "@xylabs/promise": "^4.2.2",
+    "@mui/icons-material": "^6.1.5",
+    "@xylabs/forget": "^4.3.2",
+    "@xylabs/object": "^4.3.2",
+    "@xylabs/promise": "^4.3.2",
     "@xyo-network/archivist-model": "^3.3.0",
     "@xyo-network/module-abstract": "^3.3.0",
     "@xyo-network/module-events": "^3.3.0",
     "@xyo-network/payload-model": "^3.3.0",
-    "@xyo-network/react-shared": "^4.1.5"
+    "@xyo-network/react-shared": "^4.1.7"
   },
   "devDependencies": {
-    "@mui/material": "^6.1.4",
-    "@mui/styles": "^6.1.4",
+    "@mui/material": "^6.1.5",
+    "@mui/styles": "^6.1.5",
     "@storybook/react": "^8.3.6",
-    "@xylabs/ts-scripts-yarn3": "^4.2.1",
-    "@xylabs/tsconfig-react": "^4.2.1",
+    "@xylabs/ts-scripts-yarn3": "^4.2.3",
+    "@xylabs/tsconfig-react": "^4.2.3",
     "react": "^18.3.1",
     "react-dom": "^18.3.1",
     "storybook": "^8.3.6",