@websolutespa/bom-mixer-forms 1.9.0 → 1.9.1

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @websolutespa/bom-mixer-forms
 
+## 1.9.1
+
+### Patch Changes
+
+- Added: FormState, FormEmitter
+- Modified: FormAbstract, FormAbstractCollection, useControl, useForm
+
 ## 1.9.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -11,15 +11,32 @@ declare class EventEmitter {
     once(event: string, listener: (...args: any[]) => any): void;
 }
 
+declare class FormState$1 {
+    invalid: boolean;
+    disabled: boolean;
+    hidden: boolean;
+    readonly: boolean;
+    dirty: boolean;
+    touched: boolean;
+    submitted: boolean;
+    get valid(): boolean;
+    get enabled(): boolean;
+    get visible(): boolean;
+    get writeable(): boolean;
+    get pristine(): boolean;
+    get untouched(): boolean;
+    get unsubmitted(): boolean;
+}
+
 declare class FormAbstractCollection<U extends Record<string, FormValue> | FormValue[], T extends FormControls> extends FormAbstract<U> {
     controls_: T;
     constructor(controls: T, validators?: (FormValidator | FormValidator[]));
     initControl_(controlOrValue: FormAbstract | FormValue, key: any): FormAbstract;
     protected setInitialOptions(options?: FormOptions): void;
-    protected checkAsyncPropState_(key: keyof FormFlags, option?: FormActivator, root?: FormCollection): Promise<boolean>;
-    updateState_(): void;
+    protected checkAsyncPropState_(key: keyof FormFlags, activator?: FormActivator, root?: FormCollection): Promise<void>;
     revalidate_(): Promise<void>;
-    protected validate_(root?: FormCollection): Promise<void>;
+    validate_(root?: FormCollection): Promise<void>;
+    updateState_(): void;
     reset(): void;
     patch(value: any): void;
     get(key: keyof T): FormAbstract;
@@ -44,12 +61,8 @@ declare class FormAbstractCollection<U extends Record<string, FormValue> | FormV
     set touched(touched: boolean);
     get value(): U;
     set value(value: U);
-    get errors(): {
-        [key: string]: any;
-    };
-    set errors(errors: {
-        [key: string]: any;
-    });
+    get errors(): ValidationError;
+    set errors(errors: ValidationError);
 }
 
 declare class FormArray<T extends FormValue[] = FormValue[]> extends FormAbstractCollection<T, FormArrayControls> {
@@ -126,6 +139,8 @@ type FormFlags = {
     dirty: boolean;
     touched: boolean;
     submitted: boolean;
+};
+type FormDerivedFlags = {
     valid: boolean;
     enabled: boolean;
     visible: boolean;
@@ -142,9 +157,10 @@ type FormValidationError = {
 type FormValidationErrors = FormValidationError[];
 type FormState<T> = {
     value: T | null;
-    flags: FormFlags;
+    flags: FormFlags & FormDerivedFlags;
     errors: FormValidationErrors;
 };
+type FormCustomData = Record<string, any>;
 type ControlType = 'group' | 'array' | string;
 type IFormBuilderControlSchema = {
     schema: ControlType;
@@ -169,61 +185,35 @@ type IFormBuilderArraySchema = IFormBuilderControlSchema[];
 type IFormBuilderGroupValues = Record<string, FormGroup | FormArray | FormControl>;
 type IFormBuilderSchema = IFormBuilderGroupSchema | IFormBuilderArraySchema;
 
-declare class FormAbstract<T = any> extends EventEmitter {
-    errors_: ValidationError;
-    value_: T | null;
-    validators_: FormValidator[];
-    state_: FormFlags;
+declare class FormEmitter<T = FormValue> extends EventEmitter {
+    protected markAsDirty_: boolean;
+    get isDirty(): boolean;
     name?: string | number;
-    parent?: FormCollection;
-    schema: ControlType;
-    options?: IOption[];
-    optionsExtra?: {
-        asEquatable: boolean;
-    };
-    customData?: Record<string, any>;
-    protected initialOptions_?: FormOptions;
-    private markAsDirty_;
-    constructor(value: FormValue, validators?: (FormValidator | FormValidator[]));
-    protected setInitialOptions(options?: FormOptions): void;
-    protected checkAsyncState_(root?: FormCollection): Promise<boolean>;
-    protected checkAsyncPropState_(key: keyof FormFlags, option?: FormActivator, root?: FormCollection): Promise<boolean>;
-    protected revalidate_(): Promise<void>;
-    protected validate_(root?: FormCollection): Promise<void>;
-    validateAndChange_(root?: FormCollection): Promise<void>;
-    protected updateStateAndChange_(): Promise<void>;
-    protected change_(propagate?: boolean): void;
-    protected updateState_(): void;
-    reset(): void;
-    patch(value: FormValue): void;
-    addValidators(...validators: FormValidator[]): void;
-    replaceValidators(...validators: FormValidator[]): void;
-    clearValidators(): void;
-    protected get path(): (string | number)[];
-    protected get root(): FormCollection | FormAbstract;
-    private label_?;
+    protected label_: string | undefined;
     get label(): string;
-    set label(label: string);
-    private placeholder_?;
+    protected placeholder_: string | undefined;
     get placeholder(): string;
-    set placeholder(placeholder: string);
-    get validators(): FormValidator[];
-    set validators(validators: FormValidator[]);
-    get state(): FormFlags;
-    get errors(): ValidationError;
+    protected options_: IOption[] | undefined;
+    get options(): IOption[] | undefined;
+    protected optionsExtra_: {
+        asEquatable: boolean;
+    } | undefined;
+    get optionsExtra(): {
+        asEquatable: boolean;
+    } | undefined;
+    protected customData_: FormCustomData | undefined;
+    get customData(): FormCustomData | undefined;
+    protected value_: T | null;
+    get value(): T | null;
+    protected state_: FormState$1;
+    get state(): FormState$1;
     get invalid(): boolean;
     get disabled(): boolean;
-    set disabled(disabled: boolean);
     get hidden(): boolean;
-    set hidden(hidden: boolean);
     get readonly(): boolean;
-    set readonly(readonly: boolean);
     get dirty(): boolean;
-    set dirty(dirty: boolean);
     get touched(): boolean;
-    set touched(touched: boolean);
     get submitted(): boolean;
-    set submitted(submitted: boolean);
     get valid(): boolean;
     get enabled(): boolean;
     get visible(): boolean;
@@ -231,12 +221,62 @@ declare class FormAbstract<T = any> extends EventEmitter {
     get pristine(): boolean;
     get untouched(): boolean;
     get unsubmitted(): boolean;
-    get value(): T | null;
+    protected errors_: ValidationError;
+    get errors(): ValidationError;
+    protected validators_: FormValidator[];
+    get validators(): FormValidator[];
+    constructor(value: T | null, validators?: (FormValidator | FormValidator[]));
+    /**
+     * SETTERS
+     */
+    set label(label: string | undefined);
+    set placeholder(placeholder: string | undefined);
+    set options(options: IOption[] | undefined);
+    set optionsExtra(optionsExtra: {
+        asEquatable: boolean;
+    } | undefined);
+    set customData(customData: FormCustomData | undefined);
     set value(value: T | null);
+    set invalid(invalid: boolean);
+    set disabled(disabled: boolean);
+    set hidden(hidden: boolean);
+    set readonly(readonly: boolean);
+    set dirty(dirty: boolean);
+    set touched(touched: boolean);
+    set submitted(submitted: boolean);
+    set errors(errors: ValidationError);
+    set validators(validators: FormValidator[]);
+    protected revalidate_(): void;
+    protected updateStateAndChange_(): Promise<boolean>;
+    protected emitChange_(): boolean;
+}
+
+declare class FormAbstract<T = FormValue> extends FormEmitter {
+    schema: ControlType;
+    parent?: FormCollection;
+    protected initialOptions_?: FormOptions;
+    constructor(value: T | null, validators?: (FormValidator | FormValidator[]));
+    protected setInitialOptions(options?: FormOptions): void;
+    protected checkAsyncState_(root?: FormCollection): Promise<void>;
+    protected checkAsyncPropState_(key: keyof FormFlags, activator?: FormActivator, root?: FormCollection): Promise<void>;
+    protected revalidate_(): Promise<void>;
+    validateAndChange_(root?: FormCollection): Promise<boolean>;
+    validate_(root?: FormCollection): Promise<void>;
+    protected updateStateAndChange_(): Promise<boolean>;
+    protected updateState_(): void;
+    change_(propagate?: boolean): boolean;
+    reset(): void;
+    patch(value: FormValue): void;
+    addValidators(...validators: FormValidator[]): void;
+    replaceValidators(...validators: FormValidator[]): void;
+    clearValidators(): void;
+    protected get path(): (string | number)[];
+    protected get root(): FormCollection | FormAbstract;
 }
 
 declare function validValue(value: FormValue): any;
 declare function mapErrors_(errors: FormErrors): FormValidationError[];
+declare function mapState_(state: FormState$1): FormFlags & FormDerivedFlags;
 declare function valueToString(value: IOption | IOption[] | IEquatable | IEquatable[] | null): string | string[] | undefined;
 declare function stringToValue(value: string | string[] | undefined, options?: IOption[], optionsExtra?: {
     asEquatable: boolean;
@@ -307,11 +347,10 @@ declare function useForm<T, U extends (FormGroup | FormArray)>(factory: () => U,
 declare function useFormBuilder<T extends (Record<string, FormValue> | FormValue[]) = Record<string, FormValue>, U extends (T extends FormValue[] ? FormArray<T> : FormGroup<T>) = T extends FormValue[] ? FormArray<T> : FormGroup<T>>(schema: IFormBuilderSchema, deps?: DependencyList): [FormState<T>, (value: Partial<T>) => void, () => void, () => void, U];
 
 declare function useFormSchema<T extends (Record<string, FormValue> | FormValue[]) = Record<string, FormValue>, U extends (T extends FormValue[] ? FormArray<T> : FormGroup<T>) = T extends FormValue[] ? FormArray<T> : FormGroup<T>>(schema: IFormBuilderSchema, deps?: DependencyList): {
-    state: FormState<T>;
     setValue: (value: Partial<T>) => void;
     setTouched: () => void;
     reset: () => void;
     form: U;
 };
 
-export { ControlType, EmailValidator, FormAbstract, FormAbstractCollection, FormActivator, FormArray, FormArrayControls, FormAsyncValidator, FormCollection, FormControl, FormControls, FormErrors, FormFlags, FormGroup, FormGroupControls, FormOptions, FormState, FormValidationError, FormValidationErrors, FormValidator, FormValue, FormValueArray, FormValueGroup, IControlParam, IFormBuilderArraySchema, IFormBuilderControlSchema, IFormBuilderGroupSchema, IFormBuilderGroupValues, IFormBuilderSchema, IFormOption, MatchValidator, MaxLengthValidator, MaxValidator, MinLengthValidator, MinValidator, NullValidator, PatternValidator, RequiredIfValidator, RequiredTrueValidator, RequiredValidator, ValidationError, formArray, formControl, formGroup, mapErrors_, stringToValue, useControl, useForm, useFormBuilder, useFormSchema, validValue, valueToString };
+export { ControlType, EmailValidator, FormAbstract, FormAbstractCollection, FormActivator, FormArray, FormArrayControls, FormAsyncValidator, FormCollection, FormControl, FormControls, FormCustomData, FormDerivedFlags, FormErrors, FormFlags, FormGroup, FormGroupControls, FormOptions, FormState, FormValidationError, FormValidationErrors, FormValidator, FormValue, FormValueArray, FormValueGroup, IControlParam, IFormBuilderArraySchema, IFormBuilderControlSchema, IFormBuilderGroupSchema, IFormBuilderGroupValues, IFormBuilderSchema, IFormOption, MatchValidator, MaxLengthValidator, MaxValidator, MinLengthValidator, MinValidator, NullValidator, PatternValidator, RequiredIfValidator, RequiredTrueValidator, RequiredValidator, ValidationError, formArray, formControl, formGroup, mapErrors_, mapState_, stringToValue, useControl, useForm, useFormBuilder, useFormSchema, validValue, valueToString };